Spring的Java配置方式

時間  2021-08-13
標籤 java web spring 數據庫 apache tomcat mvc maven ide spring-boot 欄目 Spring 简体版
原文   原文鏈接

Java配置是Spring4.x推薦的配置方式，能夠徹底替代xml配置。java

1     @Configuration 和 @Bean

Spring的Java配置方式是經過 @Configuration 和 @Bean 這兩個註解實現的：web

一、@Configuration 做用於類上，至關於一個xml配置文件；spring

二、@Bean 做用於方法上，至關於xml配置中的<bean>；數據庫

當@Bean 註解使用在方法上面是，會被spring自動做爲一個bean進行注入，apache

bean的類型爲該方法的返回類型，bean的id爲方法名稱。方法參數會經過spring自動注入。tomcat

2 示例

該示例演示了經過Java配置的方式進行配置Spring，而且實現了Spring IOC功能。mvc

　　2.1 建立工程以及導入依賴(Maven)

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>cn.qiaoliqiang</groupId>
    <artifactId>spring-boot</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>4.3.7.RELEASE</version>
        </dependency>
        <!-- 鏈接池 -->
        <dependency>
            <groupId>com.jolbox</groupId>
            <artifactId>bonecp-spring</artifactId>
            <version>0.8.0.RELEASE</version>
        </dependency>
    </dependencies>
    <build>
        <finalName>${project.artifactId}</finalName>
        <plugins>
            <!-- 資源文件拷貝插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <configuration>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <!-- java編譯插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
        <pluginManagement>
            <plugins>
                <!-- 配置Tomcat插件 -->
                <plugin>
                    <groupId>org.apache.tomcat.maven</groupId>
                    <artifactId>tomcat7-maven-plugin</artifactId>
                    <version>2.2</version>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

 

　　2.2   編寫User對象

package cn.qlq;

public class User {
    private String username;
    private String password;
    private int age;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

}

　

　　2.3   編寫UserDAO 用於模擬與數據庫的交互(注意此DAO沒有打註解)

package cn.qlq;

import java.util.ArrayList;
import java.util.List;

/**
 * 模擬UserDao查詢數據庫
 * 
 * @author liqiang
 *
 */
public class UserDao {
    /**
     * 模擬查到10個 用戶
     * 
     * @return
     */
    public List<User> queryUserList() {
        List<User> result = new ArrayList<User>();
        // 模擬數據庫的查詢
        for (int i = 0; i < 10; i++) {
            User user = new User();
            user.setUsername("username_" + i);
            user.setPassword("password_" + i);
            user.setAge(i + 1);
            result.add(user);
        }
        return result;
    }

}

 

　　2.4   編寫UserService 用於實現User數據操做業務邏輯(聲明service註解，且自動注入dao對象)

package cn.qlq;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

//聲明是service層對象
@Service
public class UserService {
    @Autowired // 自動注入Spring容器中的dao層對象(byType注入)
    private UserDao UserDao;

    public List<User> queryUserList() {
        // 調用userDAO中的方法進行查詢
        return this.UserDao.queryUserList();
    }

}

 

　　2.5   編寫SpringConfig 用於實例化Spring容器

打上@Configuration註解，同時打上@ComponentScan配置掃描的包。maven

@Bean用於向容器中放入對象，若是在UserDao類前面打上@Repository註解就不用@Bean方式ide

package cn.qlq;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration // 經過該註解來代表該類是一個Spring的配置，至關於一個xml文件
@ComponentScan(basePackages = "cn.qlq") // 配置掃描包
public class SpringConfig {

    @Bean // 經過該註解來代表是一個Bean對象，至關於xml中的<bean>
    public UserDao getUserDAO() {
        return new UserDao(); // 直接new對象作演示
    }

}

 

 注意:方法名是做爲返回對象的名字的，所以通常不帶get，也就是上述放入spring容器的bean的name爲getUserDAOspring-boot

 

　　2.6   編寫測試方法 用於啓動Spring容器

package cn.qlq;

import java.util.List;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

/**
 * 測試類
 * 
 * @author liqiang
 *
 */
public class Test {

    public static void main(String[] args) {
        // 經過Java配置來實例化Spring容器
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);

        // 在Spring容器中獲取Bean對象
        UserService userService = context.getBean(UserService.class);

        // 調用對象中的方法
        List<User> list = userService.queryUserList();
        for (User user : list) {
            System.out.println(user.getUsername() + ", " + user.getPassword() + ", " + user.getPassword());
        }

        // 銷燬該容器
        context.destroy();
    }

}

 

結果:

username_0, password_0, password_0
username_1, password_1, password_1
username_2, password_2, password_2
username_3, password_3, password_3
username_4, password_4, password_4
username_5, password_5, password_5
username_6, password_6, password_6
username_7, password_7, password_7
username_8, password_8, password_8
username_9, password_9, password_9

 

 

總結:

　　從以上的示例中能夠看出，使用Java代碼就完美的替代xml配置文件，而且結構更加的清晰。

 使用方法:

　　Spring對Java配置的支持是由@Configuration註解和@Bean註解來實現的。由@Bean註解的 方法將會實例化、配置和初始化一個 新對象，這個對象將由Spring的IoC容器來管理。@Bean聲明所起到的做用與<bean/> 元素相似。被 @Configuration所註解的類則表示這個類的主要目的是做爲bean定義的資源。被@Configuration聲明的類能夠經過在同一個類的 內部調用@bean方法來設置嵌入bean的依賴關係。

最簡單的@Configuration 聲明類請參考下面的代碼：(放入spring的name爲方法名字，所以通常不加get)

複製代碼 
@Configuration    
public class AppConfig{    
    @Bean    
    public MyService myService() {    
        return new MyServiceImpl();    
    }    
}
複製代碼

對於上面的@Beans配置文件相同的XML配置文件以下：

<beans> <bean id="myService" class="com.somnus.services.MyServiceImpl"/> </beans>

 

上述配置方式的實例化方式以下：利用AnnotationConfigApplicationContext 類進行實例化

 

public static void main(String[] args) {    
    ApplicationContext ctx = new AnnotationConfigApplicationContext(AppConfig.class);    
    MyService myService = ctx.getBean(MyService.class);    
    myService.doStuff();    
}

 

要使用組件組建掃描，僅需用@Configuration進行註解便可：

@Configuration    
@ComponentScan(basePackages = "com.somnus")    
public class AppConfig  {    
    ...    
}

 

在上面的例子中，com.acme包首先會被掃到，而後再容器內查找被@Component 聲明的類，找到後將這些類按照Sring bean定義進行註冊。

 

補充:關於@Bean的參數注入問題:

    @Bean
    public User user2(User user) { 
        System.out.println("user is -> "+ user);
        User user2 = new User();
        user2.setUsername("user2");
        return user2;
    }

　　如上，有參數user，若spring容器中只有一個User類型的bean，則不論參數取名爲什麼都是按類型取bean user爲參數，如有多個則參數取名必須爲多個bean中的一個，不然報錯。

 

例如:下面會報錯:

    @Bean
    public User user1() {
        User user = new User();
        user.setUsername("user1");
        return user;
    }

    @Bean
    public User user2(User user) { 
        System.out.println("user is -> "+ user);
        User user2 = new User();
        user2.setUsername("user2");
        return user2;
    }
    
    @Bean
    public User user3(User user) { 
        System.out.println("user is -> "+ user);
        User user2 = new User();
        user2.setUsername("user2");
        return user2;
    }

Description:

Parameter 0 of method user2 in cn.qlq.config.RedisCacheConfig required a single bean, but 2 were found:
- user1: defined by method 'user1' in class path resource [cn/qlq/config/RedisCacheConfig.class]
- user3: defined by method 'user3' in class path resource [cn/qlq/config/RedisCacheConfig.class]


Action:

Consider marking one of the beans as @Primary, updating the consumer to accept multiple beans, or using @Qualifier to identify the bean that should be consumed

 

修改成如下便可成功:

    @Bean
    public User user1() {
        User user = new User();
        user.setUsername("user1");
        return user;
    }

    @Bean
    public User user2(User user1) { 
        System.out.println("user1 is -> "+ user1);
        User user2 = new User();
        user2.setUsername("user2");
        return user2;
    }
    
    @Bean
    public User user3(User user2) { 
        System.out.println("user2 is -> "+ user2);
        User user23 = new User();
        user23.setUsername("user3");
        return user23;
    }

啓動查看 注入的信息:(多個類型按name進行注入)

user1 is -> User [id=null, username=user1, password=null, userfullname=null, createtime=null, isdeleted=null, sex=null, address=null]
user2 is -> User [id=null, username=user2, password=null, userfullname=null, createtime=null, isdeleted=null, sex=null, address=null]

 

 

 

【當你用心寫完每一篇博客以後,你會發現它比你用代碼實現功能更有成就感!】
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程