Java配置是Spring4.x推荐的配置方式,可以完全替代xml配置。
1 @Configuration 和 @Bean
Spring的Java配置方式是通过 @Configuration 和 @Bean 这两个注解实现的:
1、@Configuration 作用于类上,相当于一个xml配置文件;
2、@Bean 作用于方法上,相当于xml配置中的;
当@Bean 注解使用在方法上面是,会被spring自动作为一个bean进行注入,
bean的类型为该方法的返回类型,bean的id为方法名称。方法参数会通过spring自动注入。
2 示例
该示例演示了通过Java配置的方式进行配置Spring,并且实现了Spring IOC功能。
2.1 创建工程以及导入依赖(Maven)
4.0.0
cn.qiaoliqiang
spring-boot
0.0.1-SNAPSHOT
war
org.springframework
spring-webmvc
4.3.7.RELEASE
com.jolbox
bonecp-spring
0.8.0.RELEASE
${project.artifactId}
org.apache.maven.plugins
maven-resources-plugin
UTF-8
org.apache.maven.plugins
maven-compiler-plugin
1.7
1.7
UTF-8
org.apache.tomcat.maven
tomcat7-maven-plugin
2.2
2.2 编写User对象
packagecn.qlq;public classUser {privateString username;privateString password;private intage;publicString getUsername() {returnusername;
}public voidsetUsername(String username) {this.username =username;
}publicString getPassword() {returnpassword;
}public voidsetPassword(String password) {this.password =password;
}public intgetAge() {returnage;
}public void setAge(intage) {this.age =age;
}
}
2.3 编写UserDAO 用于模拟与数据库的交互(注意此DAO没有打注解)
packagecn.qlq;importjava.util.ArrayList;importjava.util.List;/*** 模拟UserDao查询数据库
*
*@authorliqiang
**/
public classUserDao {/*** 模拟查到10个 用户
*
*@return
*/
public ListqueryUserList() {
List result = new ArrayList();//模拟数据库的查询
for (int i = 0; i < 10; i++) {
User user= newUser();
user.setUsername("username_" +i);
user.setPassword("password_" +i);
user.setAge(i+ 1);
result.add(user);
}returnresult;
}
}
2.4 编写UserService 用于实现User数据操作业务逻辑(声明service注解,且自动注入dao对象)
packagecn.qlq;importjava.util.List;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.stereotype.Service;//声明是service层对象
@Servicepublic classUserService {
@Autowired//自动注入Spring容器中的dao层对象(byType注入)
privateUserDao UserDao;public ListqueryUserList() {//调用userDAO中的方法进行查询
return this.UserDao.queryUserList();
}
}
2.5 编写SpringConfig 用于实例化Spring容器
打上@Configuration注解,同时打上@ComponentScan配置扫描的包。
@Bean用于向容器中放入对象,如果在UserDao类前面打上@Repository注解就不用@Bean方式
packagecn.qlq;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.ComponentScan;importorg.springframework.context.annotation.Configuration;
@Configuration//通过该注解来表明该类是一个Spring的配置,相当于一个xml文件
@ComponentScan(basePackages = "cn.qlq") //配置扫描包
public classSpringConfig {
@Bean//通过该注解来表明是一个Bean对象,相当于xml中的
publicUserDao getUserDAO() {return new UserDao(); //直接new对象做演示
}
}
注意:方法名是作为返回对象的名字的,因此一般不带get,也就是上述放入spring容器的bean的name为getUserDAO
2.6 编写测试方法 用于启动Spring容器
packagecn.qlq;importjava.util.List;importorg.springframework.context.annotation.AnnotationConfigApplicationContext;/*** 测试类
*
*@authorliqiang
**/
public classTest {public static voidmain(String[] args) {//通过Java配置来实例化Spring容器
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);//在Spring容器中获取Bean对象
UserService userService = context.getBean(UserService.class);//调用对象中的方法
List 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声明所起到的作用与 元素类似。被 @Configuration所注解的类则表示这个类的主要目的是作为bean定义的资源。被@Configuration声明的类可以通过在同一个类的 内部调用@bean方法来设置嵌入bean的依赖关系。
最简单的@Configuration 声明类请参考下面的代码:(放入spring的name为方法名字,因此一般不加get)
@Configuration
public class AppConfig{
@Bean
public MyService myService() {
return new MyServiceImpl();
}
}
对于上面的@Beans配置文件相同的XML配置文件如下:
上述配置方式的实例化方式如下:利用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的参数注入问题:
@BeanpublicUser user2(User user) {
System.out.println("user is -> "+user);
User user2= newUser();
user2.setUsername("user2");returnuser2;
}
如上,有参数user,若spring容器中只有一个User类型的bean,则不论参数取名为何都是按类型取bean user为参数,若有多个则参数取名必须为多个bean中的一个,否则报错。
例如:下面会报错:
@BeanpublicUser user1() {
User user= newUser();
user.setUsername("user1");returnuser;
}
@BeanpublicUser user2(User user) {
System.out.println("user is -> "+user);
User user2= newUser();
user2.setUsername("user2");returnuser2;
}
@BeanpublicUser user3(User user) {
System.out.println("user is -> "+user);
User user2= newUser();
user2.setUsername("user2");returnuser2;
}
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
修改为以下即可成功:
@BeanpublicUser user1() {
User user= newUser();
user.setUsername("user1");returnuser;
}
@BeanpublicUser user2(User user1) {
System.out.println("user1 is -> "+user1);
User user2= newUser();
user2.setUsername("user2");returnuser2;
}
@BeanpublicUser user3(User user2) {
System.out.println("user2 is -> "+user2);
User user23= newUser();
user23.setUsername("user3");returnuser23;
}
启动查看 注入的信息:(多个类型按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]