在Spring中基于Java类进行配置的完整步骤

发布时间：2020-09-02 17:04:47 作者：deniro
来源：脚本之家阅读：165

前言

JavaConfig 原来是 Spring 的一个子项目，它通过 Java 类的方式提供 Bean 的定义信息，在 Spring4 的版本， JavaConfig 已正式成为 Spring4 的核心功能。

本文将详细介绍关于Spring中基于Java类进行配置的相关内容，下面话不多说了，来一起看看详细的介绍吧

1 定义 Bean

普通的 POJO 只要标注了 @Configuration 注解，就可以为 Spring 容器提供 Bean 的定义信息。

@Configuration
public class SystemConfig {
 /**
  * 定义 Bean，并实例化
  *
  * @return
  */
 @Bean
 public UserDao userDao() {
  return new UserDao();
 }

 @Bean
 public DeptDao deptDao() {
  return new DeptDao();
 }

 /**
  * 定义 UserService，并把之前定义的 UserDao 与 DeptDao 注入进来
  *
  * @return
  */
 @Bean
 public UserService userService() {
  UserService service = new UserService();
  service.setUserDao(userDao());
  service.setDeptDao(deptDao());
  return service;
 }
}

这个类的方法标注了 @Bean 注解，即为定义 Bean， Bean 的类型由方法返回值的类型决定，名称默认和方法名同名，也可以通过入参显示指定 Bean 名称，比如 @Bean(name=”xxx”)。 @Bean 所标注的方法体提供了实例化 Bean 的逻辑。

以上配置和下面的 xml 是等效的：

<bean id="userDao" class="net.deniro.spring4.conf.UserDao"/>
<bean id="deptDao" class="net.deniro.spring4.conf.DeptDao"/>
<bean id="userService" class="net.deniro.spring4.conf.UserService"
p:userDao-ref="userDao" p:deptDao-ref="deptDao"/>

基于 Java 类的配置方式和基于 XML 或者基于注解的配置方式相比——

Java 类的配置方式通过代码编程的方式，可以更加灵活地实例化 Bean 和装配 Bean 之间的关系。
XML 或者基于注解的方式都是通过声明来定义配置的，所以灵活性上要逊一些，但在配置上更简单。

因为 @Configuration 注解类本身已经标注了 @Component，所以这些类可以像那些普通的 Bean 一样被注入到其他的 Bean 中。

@Configuration
public class ApplicationConfig {
 @Autowired
 private SystemConfig systemConfig;
 @Bean
 public AuthorityService authorityService() {
  AuthorityService service = new AuthorityService();
  service.setUserDao(systemConfig.userDao());
  service.setDeptDao(systemConfig.deptDao());
  return service;
 }
}

Spring 会对配置类中所有标注了 @Bean 的方法使用 AOP 增强，引入 Bean 的生命周期管理逻辑。比如上面的 systemConfig.userDao()，它返回的是对应 Bean 的单例。

在 @Bean 中，我们还可以通过标注 @Scope 注解来控制 Bean 的作用范围：

@Scope("prototype")
@Bean
public DeptDao deptDao() {
 return new DeptDao();
}

这样每次调用 deptDao() 方法都会返回一个新的实例：

assertNotSame(authorityService.getDeptDao().hashCode(),authorityService
    .getDeptDao().hashCode());

注意：使用基于 Java 类进行配置，类路径下必须有 Spring AOP 与 CGLib 库。

2 启动 Spring 容器

2.1 只使用 @Configuration 类

可以使用 AnnotationConfigApplicationContext 类的构造函数传入标注了 @Configuration 的 Java 类来启动 Spring 容器。

ApplicationContext context=new AnnotationConfigApplicationContext(SystemConfig
  .class);
UserService userService= (UserService) context.getBean("userService");
assertNotNull(userService);

如果存在多个 @Configuration 配置类，那么可以 AnnotationConfigApplicationContext 中注册它们，然后再通过刷新容器应用这些配置类：

AnnotationConfigApplicationContext context=new AnnotationConfigApplicationContext();

//注册多个配置类
context.register(SystemConfig.class);
context.register(ApplicationConfig.class);

//刷新容器（应用这些配置类）
context.refresh();

ApplicationConfig config=context.getBean(ApplicationConfig.class);
assertNotNull(config);

也可以通过 @Import 将多个配置类组装到一个配置类中，然后仅需注册这个组装好的配置类，即可启动容器：

@Configuration
@Import(SystemConfig.class)
public class ApplicationConfig2 {
 @Autowired
 private SystemConfig systemConfig;
 @Bean
 public AuthorityService authorityService() {
  AuthorityService service = new AuthorityService();
  service.setUserDao(systemConfig.userDao());
  service.setDeptDao(systemConfig.deptDao());
  return service;
 }
}

单元测试：

AnnotationConfigApplicationContext context=new AnnotationConfigApplicationContext(ApplicationConfig2.class);

ApplicationConfig2 config=context.getBean(ApplicationConfig2.class);
assertNotNull(config);
final AuthorityService authorityService = config.authorityService();
assertNotNull(authorityService.getDeptDao());

assertNotSame(authorityService.getDeptDao().hashCode(),authorityService
  .getDeptDao().hashCode());

2.2 使用 XML 文件引用 @Configuration 类的配置

标注了 @Configuration 的配置类也是一个 Bean，所以它也可以被 Spring 的 <context:component-scan> 扫描到。因此如果希望将配置类组装到 XML 的配置文件中，并通过 XML 的配置文件启动 Spring，那么仅需要在 XML 中通过 <context:component-scan> 扫描到相应的配置类即可。

<context:component-scan base-package="net.deniro.spring4.conf"
  resource-pattern="ApplicationConfig2.class"
  />

2.3 在 @Configuration 类中引用 XML 文件的配置

在 @Configuration 配置类中可以直接通过 @ImportResource 引入 XML 的配置文件，这样就可以直接通过 @Autowired 引用 xml 配置文件中定义的 Bean。

配置文件：

<bean id="groupDao" class="net.deniro.spring4.conf.GroupDao"/>
<bean id="roleDao" class="net.deniro.spring4.conf.RoleDao"/>

@Configuration 类：

@ImportResource("classpath:beans5-11.xml")
@Configuration
public class ServiceConfig {
 @Bean
 @Autowired
 public RelationService relationService(GroupDao groupDao,RoleDao roleDao){
  RelationService service=new RelationService();
  service.setGroupDao(groupDao);
  service.setRoleDao(roleDao);
  return service;
 }
}

单元测试：

AnnotationConfigApplicationContext context=new AnnotationConfigApplicationContext
  (ServiceConfig.class);
ServiceConfig config=context.getBean(ServiceConfig.class);
assertNotNull(config);
RelationService service=config.relationService((GroupDao) context.getBean
    ("groupDao"),
  (RoleDao) context
  .getBean
    ("roleDao"));
assertNotNull(service.getRoleDao());

只要这些不同形式 Bean 的定义信息能够加载到 Spring 容器中，那么 Spring 就可以智能的完成 Bean 之间的装配。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对亿速云的支持。

在Spring中基于Java类进行配置的完整步骤

相关阅读