Spring（15）——基于注解的支持

一时失言乱红尘 2022-06-10 01:41 200阅读 0赞

# 15 基于注解的配置 #

除了单独使用XML对Spring进行配置外，我们还可以使用注解的方式来配置对应的bean定义。如哪些class要被定义为bean，对应的bean需要注入哪些内容等。在Spring的配置中XML定义与注解定义是可以同时存在的。

## 15.1 启用对注解的支持 ##

如果需要使用注解来配置bean定义，首先我们需要启用Spring对注解的支持。最简单的方式就是在Spring的配置文件中引入context对应的命名空间，然后在其中定义一个`<context:annotation-config/>`即可。

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
    	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
    	xmlns:context="http://www.springframework.org/schema/context"
    	xsi:schemaLocation="http://www.springframework.org/schema/beans
    		http://www.springframework.org/schema/beans/spring-beans.xsd
    		http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context.xsd">
    
    	
    	<context:annotation-config/>
    
    </beans>

定义好`<context:annotation-config/>`后，Spring将自动注册用于支持注解的bean定义，如`CommonAnnotationBeanPostProcessor`、`RequiredAnnotationBeanPostProcessor`、`PersistenceAnnotationBeanPostProcessor`和`AutowiredAnnotationBeanPostProcessor`。

## 15.2 @Required ##

`@Required`注解是用来标注在属性对应的set方法上的，表示在调用对应bean的初始化方法之后对应的属性不允许为空。该注解主要用来做一个标注检查作用，以防止我们在运行时使用对应的属性进行操作时出现空指针问题。

public class Hello {
    	
    	private World world;
    
    	public World getWorld() {
    		return world;
    	}
    
    	@Required
    	public void setWorld(World world) {
    		this.world = world;
    	}
    	
    }

## 15.3 @Autowired ##

`@Autowired`注解用来表示自动注入的，其可以定义在属性上，set方法上，构造方法上等。使用其进行标注后Spring将自动注入对应的内容，默认是按照类型进行注入。使用了@Autowired标注进行注入的内容，默认是就是@Required的，即在对应bean完全初始化后对应的属性不能为空，必须进行注入。可以通过@Autowired的require属性指定进行指定，默认为true，即必须进行注入。

### 15.3.1 标注在属性上 ###

public class Hello {
    	
    	@Autowired
    	private World world;
    
    }

### 15.3.2 设为非必须注入 ###

public class Hello {
    	
    	@Autowired(required=false)
    	private World world;
    
    }

### 15.3.3 标注在set方法上 ###

public class Hello {
    	
    	private World world;
    
    	@Autowired
    	public void setWorld(World world) {
    		this.world = world;
    	}
    	
    }

### 15.3.4 标注在普通方法上 ###

Spring也支持通过普通方法进行自动注入，对应的普通方法可以接收一到多个参数。

public class Hello {
    	
    	private BeanA beanA;
    	private World world;
    
    	@Autowired
    	public void inject(World world, BeanA beanA) {
    		this.world = world;
    		this.beanA = beanA;
    	}
    
    }

### 15.3.5 标注在构造方法上 ###

`@Autowired`也可以标注在构造方法上，以完成对构造方法参数的自动注入。

public class Hello {
    	
    	private World world;
    
    	@Autowired
    	public Hello(World world) {
    		this.world = world;
    	}
    	
    }

但是有一点需要注意的是使用@Autowired进行注入的内容默认是@Required的，即不能为空的。当我们的bean类定义有多个构造方法时，Spring允许我们在多个构造方法上使用@Autowired进行标注，但是当在多个构造方法上标注@Autowired时，我们必须指定对应的required属性的值为false。如下这样两个构造方法都是@Autowired，且是@Required是不行的。

public class Hello {
    	
    	private World world;
    	private BeanA beanA;
    
    	@Autowired
    	public Hello(World world) {
    		this.world = world;
    	}
    	
    	@Autowired
    	public Hello(World world, BeanA beanA) {
    		this.world = world;
    		this.beanA = beanA;
    	}
    	
    }

通过将对应的required属性设置为false后，我们的定义就又是合法的了。这个时候Spring将在bean容器中寻找对应构造方法参数类型对应的bean，然后将利用能满足最多构造方法参数进行注入的那个构造方法进行注入。如下示例当bean容器中既能寻找到World类型的bean，又能寻找到BeanA类型的bean时就将通过第二个构造方法进行注入，否则就是第一个了。

public class Hello {
    	
    	private World world;
    	private BeanA beanA;
    
    	@Autowired(required=false)
    	public Hello(World world) {
    		this.world = world;
    	}
    	
    	@Autowired(required=false)
    	public Hello(World world, BeanA beanA) {
    		this.world = world;
    		this.beanA = beanA;
    	}
    
    }

### 15.3.6 注入数组、集合类型等 ###

`@Autowired`除了能注入单个的bean对象之外，还能注入数组类型、集合类型和key为String的Map类型的bean。当需要注入的是数组类型或集合类型时，Spring将在bean容器中寻找出所有对应类型的bean，然后将它们都作为其中的元素注入给对应的数组或集合，如果这些对应类型的bean是实现了Ordered接口的，那么Spring在将它们作为一个元素进行注入时还将根据Ordered接口的getOrder()方法的返回结果按从小到大的顺序进行添加。当需要自动注入的是一个key为String类型的Map类型时，Spring将在bean容器中寻找所有Map的value对应类型的bean，然后将它们以对应bean名称即bean定义中的beanName作为key注入到对应的Map中。对于key为非String类型的Map，Spring是不能进行自动注入的。

public class Hello {
    	
    	@Autowired
    	private World[] worldArray;
    	@Autowired
    	private List<World> worldList;
    	@Autowired
    	private Set<World> worldSet;
    	@Autowired
    	private Map<String, World> worldMap;
    	
    }

### 15.3.7 注入ApplicationContext等 ###

我们还可以通过@Autowired自动注入与Spring内部机制相关的内容，如BeanFactory、ApplicationContext、Environment等。

public class Hello {
    	
    	@Autowired
    	private BeanFactory beanFactory;
    	@Autowired
    	private ApplicationContext applicationContext;
    	@Autowired
    	private ConfigurableApplicationContext configurableContext;
    	@Autowired
    	private Environment environment;
    	@Autowired
    	private ResourceLoader resourceLoader;
    	@Autowired
    	private ApplicationEventPublisher eventPublisher;
    	@Autowired
    	private MessageSource messageSource;
    	@Autowired
    	ResourcePatternResolver resourcePatternResolver;
    	
    }