使用Spring的JavaConfig 和 @Autowired注解与自动装配

Posted 2020-09-13 Keven King

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了使用Spring的JavaConfig 和 @Autowired注解与自动装配相关的知识，希望对你有一定的参考价值。

1 JavaConfig 配置方法

之前我们都是在xml文件中定义bean的，比如：

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
  
    <bean id="helloBean" class="com.mkyong.hello.impl.HelloWorldImpl">
  
</beans>

其实我们可以使用注解来完成这些事情，例如下面的代码，完成的功能和上面的xml配置的功能是一样的：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.mkyong.hello.HelloWorld;
import com.mkyong.hello.impl.HelloWorldImpl;
  
@Configuration
public class AppConfig {
  
    @Bean(name="helloBean")
    public HelloWorld helloWorld() {
        return new HelloWorldImpl();
    }
  
}

　想象一个场景，我们有一个很大的工程项目，如果将所有的bean都配置在一个xml文件中，那么这个文件就会非常的大。所以在很多的时候我们都会将一个大的xml配置文件分割为好几份。这样方便管理，最后在总的那个xml文件中导入就行了，比如：

<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
  
    <import resource="config/customer.xml"/>
        <import resource="config/scheduler.xml"/>
  
</beans>

　但是现在我们也可以使用JavaConfig来完成同样的工作了：

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
  
@Configuration
@Import({ CustomerConfig.class, SchedulerConfig.class })
public class AppConfig {
  
}

　　我们对这个例子来看一个demo：

CustomerBo.java

public class CustomerBo {
  
    public void printMsg(String msg) {
  
        System.out.println("CustomerBo : " + msg);
    }
  
}

　SchedulerBo.java

public class SchedulerBo {
  
    public void printMsg(String msg) {
  
        System.out.println("SchedulerBo : " + msg);
    }
  
}

　　现在我们来使用注解：

@Configuration
public class CustomerConfig {
  
    @Bean(name="customer")
    public CustomerBo customerBo(){
  
        return new CustomerBo();
  
    }
}

@Configuration
public class SchedulerConfig {
  
    @Bean(name="scheduler")
    public SchedulerBo suchedulerBo(){
  
        return new SchedulerBo();
  
    }
  
}

　　AppConfig.java

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
  
@Configuration
@Import({ CustomerConfig.class, SchedulerConfig.class })
public class AppConfig {
  
}

　　然后运行：

public class App {
    public static void main(String[] args) {
  
        ApplicationContext context = new AnnotationConfigApplicationContext(
                AppConfig.class);
  
        CustomerBo customer = (CustomerBo) context.getBean("customer");
        customer.printMsg("Hello 1");
  
        SchedulerBo scheduler = (SchedulerBo) context.getBean("scheduler");
        scheduler.printMsg("Hello 2");
  
    }
}

2 set注入方法构造器注入也是很类似

我们编写spring 框架的代码时候。一直遵循是这样一个规则：所有在spring中注入的bean 都建议定义成私有的域变量。并且要配套写上 get 和 set方法。

Boss 拥有 Office 和 Car 类型的两个属性：


清单 3. Boss.Java

[java] view plain copy

print ?

package com.baobaotao;
public class Boss {
private Car car;
private Office office;
// 省略 get/setter
@Override
public String toString() {
return "car:" + car + "/n" + "office:" + office;
}
}

  System.out.println必须实现toString方法

我们在 Spring 容器中将 Office 和 Car 声明为 Bean，并注入到 Boss Bean 中：下面是使用传统 XML 完成这个工作的配置文件 beans.xml：


清单 4. beans.xml 将以上三个类配置成 Bean

[xhtml] view plain copy

print ?

<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
<bean id="boss" class="com.baobaotao.Boss">
<property name="car" ref="car"/>
<property name="office" ref="office" />
</bean>
<bean id="office" class="com.baobaotao.Office">
<property name="officeNo" value="002"/>
</bean>
<bean id="car" class="com.baobaotao.Car" scope="singleton">
<property name="brand" value=" 红旗 CA72"/>
<property name="price" value="2000"/>
</bean>
</beans>

当我们运行以下代码时，控制台将正确打出 boss 的信息：


清单 5. 测试类：AnnoIoCTest.java

[java] view plain copy

print ?

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class AnnoIoCTest {
public static void main(String[] args) {
String[] locations = {"beans.xml"};
ApplicationContext ctx =
new ClassPathXmlApplicationContext(locations);
Boss boss = (Boss) ctx.getBean("boss");
System.out.println(boss);
}
}

这说明 Spring 容器已经正确完成了 Bean 创建和装配的工作。

3 @Autowired 自动注入

Spring 2.5 引入了 @Autowired 注释，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。通过 @Autowired的使用来消除 set ，get方法。

要实现我们要精简程序的目的。需要这样来处理：

* 在applicationContext.xml中加入：

<!-- 该 BeanPostProcessor 将自动对标注 @Autowired 的 Bean 进行注入 -->     
  <bean class="org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor"/>

Spring 通过一个 BeanPostProcessor 对 @Autowired 进行解析，所以要让 @Autowired 起作用必须事先在 Spring 容器中声明 AutowiredAnnotationBeanPostProcessor Bean。

* 修改在原来注入spirng容器中的bean的方法。
在域变量上加上标签@Autowired,并且去掉相应的get 和set方法

清单 6. 使用 @Autowired 注释的 Boss.java

package com.baobaotao;     
import org.springframework.beans.factory.annotation.Autowired;     
    
public class Boss {     
    
    @Autowired    
    private Car car;     
    
    @Autowired    
    private Office office;     
    
    …     
}

* 在applicatonContext.xml中把原来引用的<porpery >标签也去掉。

<?xml version="1.0" encoding="UTF-8" ?>     
<beans xmlns="http://www.springframework.org/schema/beans"    
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    
    xsi:schemaLocation="http://www.springframework.org/schema/beans      
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">     
    
    <!-- 该 BeanPostProcessor 将自动起作用，对标注 @Autowired 的 Bean 进行自动注入 -->     
    <bean class="org.springframework.beans.factory.annotation.     
        AutowiredAnnotationBeanPostProcessor"/>     
    
    <!-- 移除 boss Bean 的属性注入配置的信息 -->     
    <bean id="boss" class="com.baobaotao.Boss"/>     
      
    <bean id="office" class="com.baobaotao.Office">     
        <property name="officeNo" value="001"/>     
    </bean>     
    <bean id="car" class="com.baobaotao.Car" scope="singleton">     
        <property name="brand" value=" 红旗 CA72"/>     
        <property name="price" value="2000"/>     
    </bean>     
</beans>

这样，当 Spring 容器启动时，AutowiredAnnotationBeanPostProcessor 将扫描 Spring 容器中所有 Bean，当发现 Bean 中拥有 @Autowired 注释时就找到和其匹配（默认按类型匹配）的 Bean，并注入到对应的地方中去。

按照上面的配置，Spring 将直接采用 Java 反射机制对 Boss 中的 car 和 office 这两个私有成员变量进行自动注入。所以对成员变量使用 @Autowired 后，您大可将它们的 setter 方法（setCar() 和 setOffice()）从 Boss 中删除。

当然，您也可以通过 @Autowired 对方法或构造函数进行标注，如果构造函数有两个入参，分别是 bean1 和 bean2，@Autowired 将分别寻找和它们类型匹配的 Bean，将它们作为 CountryService (Bean1 bean1 ,Bean2 bean2) 的入参来创建 CountryService Bean。来看下面的代码：  对方法

package com.baobaotao;     
    
public class Boss {     
    private Car car;     
    private Office office;     
    
     @Autowired    
    public void setCar(Car car) {     
        this.car = car;     
    }     
      
    @Autowired    
    public void setOffice(Office office) {     
        this.office = office;     
    }     
    …     
}

这时，@Autowired 将查找被标注的方法的入参类型的 Bean，并调用方法自动注入这些 Bean。而下面的使用方法则对构造函数进行标注：

package com.baobaotao;     
    
public class Boss {     
    private Car car;     
    private Office office;     
      
    @Autowired    
    public Boss(Car car ,Office office){     
        this.car = car;     
        this.office = office ;     
    }     
      
    …     
}

由于 Boss() 构造函数有两个入参，分别是 car 和 office，@Autowired 将分别寻找和它们类型匹配的 Bean，将它们作为 Boss(Car car ,Office office) 的入参来创建 Boss Bean。

转载自 http://www.cnblogs.com/rollenholt/archive/2012/12/27/2835087.html

http://blog.csdn.net/heyutao007/article/details/5981555

以上是关于使用Spring的JavaConfig 和 @Autowired注解与自动装配的主要内容，如果未能解决你的问题，请参考以下文章

使用JavaConfig方式配置dubbox

Spring重温--Spring JavaConfig

Spring JavaConfig实例

SpringBoot - SpringBoot入门简介；JavaConfig；核心配置application.yml(properties)，多环境设置

使用 JavaConfig 使用 Spring 应用程序的 HSQLDB 新手

使用Spring的JavaConfig 和 @Autowired注解与自动装配