Spring注解类的整理

二、Spring内置注解

     1、@Component注解

          @Component("Bean的名称")  通过注解标注一个类为受管Bean。默认情况下通过@Component定义的Bean都是singleton的，如果需要使用其它作用范围的Bean，可以通过@Scope注释来达到目标。

 

      注解类层次关系：

          @Component

                  @Configuration

                  @Controller

                          @RestController

                  @Service

                  @Repository

 

     2、@Service注解

          用于标注业务层组件

 

     3、@Repository注解

          用于标注数据访问组件

 

     4、@Autowired注解

          默认按类型装配bean，且容器中匹配的候选Bean数目必须有且仅有一个，可以设置required=false让其成为可选的。想使用名称装配可以结合@Qualifier注解进行使用。

 

           @Qualifier注解

                   @Qualifier("Bean的名称")  指定注入Bean的名称。只能用于类的成员变量、方法的参数和构造子的参数。如果它与@Autowired联合使用，则自动装配的策略就变为byName了。

 

     注解使用范例：

public class Person {
	private Long id;
	private String name;
	private Address address;
	
	public Person(){
		
	}
	
	public Person(Long id, String name){
		this.id = id;
		this.name = name;
	}

	@Autowired(required=false)
	public void setAddress(@Qualifier("address2")Address address) {
		this.address = address;
	}
}

 

<!-- 通过注解定义bean。默认同时也通过注解自动注入 -->
<context:component-scan base-package="com.cjm"/>

<bean id="address1" class="com.cjm.model.Address" p:city="gz1" p:zipCode="111"/>
<bean id="address2" class="com.cjm.model.Address" p:city="gz2" p:zipCode="222"/>

<bean id="person" class="com.cjm.model.Person">
	<constructor-arg index="0" value="111"/>
	<constructor-arg index="1" value="cjm"/>
</bean>

 

     自定义限定符注解：

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface MyQulifier {
	String value();
}

 

public class Person {
	private Long id;
	private String name;
	private Address address;
	
	public Person(){
		
	}
	
	public Person(Long id, String name){
		this.id = id;
		this.name = name;
	}

	@Autowired
	public void setAddress(@MyQulifier("a2")Address address) {
		this.address = address;
	}
}

 

<bean id="address1" class="com.cjm.model.Address" p:city="gz1" p:zipCode="111">
	<qualifier type="com.cjm.annotation.MyQulifier" value="a1"/>
</bean>

<bean id="address2" class="com.cjm.model.Address" p:city="gz2" p:zipCode="222">
	<qualifier type="com.cjm.annotation.MyQulifier" value="a2"/>
</bean>

 

     5、@ComponentScan

          该注解默认会自动扫描该类所在包下所有的配置类，相当于之前的 <context:component-scan>。

          useDefaultFilters属性的默认值为true，也就是说spring默认会自动发现被 @Component、@Controller、@Service和@Repository 标注的类，并注册进容器中。

 

          可以使用value属性来指定要扫描的包。

                  @ComponentScan(value="com.seasy.controller")

 

          使用 excludeFilters 来按照规则排除某些包的扫描。

                 @ComponentScan(value="com.seasy", excludeFilters={@Filter(type=FilterType.ANNOTATION, value={Controller.class})}, useDefaultFilters=false)

 

          使用 includeFilters 来按照规则只包含某些包的扫描。

                @ComponentScan(value="com.seasy", includeFilters={@Filter(type=FilterType.ANNOTATION, classes={Controller.class})}, useDefaultFilters=false)

 

          添加多种扫描规则

                  可以使用 @ComponentScans 来添加多个 @ComponentScan，从而实现添加多个扫描规则。同样，也需要加上 @Configuration 注解，否则无效。

                 

                  @ComponentScans(value={@ComponentScan(value="com.seasy.controller"), @ComponentScan(value="com.seasy.service")})

                  @Configuration

                  public class BeanConfig {    }

 

     6、@Scope注解

          @Scope("Bean的作用范围")  通过@Scope注解为受管bean指定作用域。Bean的作用范围有：singleton、prototype、request、session、globalsession等。

 

     7、@ImportResource

           导入Spring的xml配置文件，让配置文件的内容生效，同时需要配合@Configuration注解一起使用：

          @Configuration

          @ImportResource("classpath:/com/acme/properties-config.xml")

          public class AppConfig{

                   

          }

 

     8、@PropertySource

          加载指定的属性文件，文件中的属性可以配合@value注解一起使用

          @PropertySource("classpath:person.properties")

          public class AppConfig{

                 @value("${key}")

                 private String username;

                

          }

 

       9、@Value

              通过@Value将外部的值动态注入到Bean中

 

              @Value的值有两类：

                     ${ property : default_value }注入的是外部参数对应的property

                     #{ obj.property? : default_value }注入的是SpEL表达式对应的内容

 

              注入普通字符串

                     @Value("normal")

                     private String normal;

 

              //注入文件资源

                     @Value("classpath:com/seasy/config/config.txt")

                     private Resource resourceFile;

 

              //注入URL资源

                     @Value("http://www.baidu.com")

                     private Resource testUrl;

 

              //注入操作系统属性

                     @Value("#{systemProperties['os.name']}")

                     private String systemPropertiesName;

 

              //注入表达式结果，T表示使用类的静态方法

                     @Value("#{ T(java.lang.Math).random() * 100.0 }")

                     private double randomNumber;

 

              //注入其他Bean属性

                     @Value("#{beanInject.another}")

                     private String fromAnotherBean;

 

              //将外部配置文件的值动态注入到Bean中。

              //在Springboot中默认可以使用application.properties属性文件的配置，自定义属性文件可以通过@PropertySource加载

                     @Value("${app.name}")

                     private String appName;

 

      10、@Required

             该注解适用于bean属性的setter方法，并表示bean属性必须要设值。否则，容器会抛出一个BeanInitializationException异常。

 

             @Required

             public void setAge(Integer age) {

                    this.age = age;

             }

 

      11、@Primary

             自动装配时当出现多个Bean候选者时，被注解为@Primary的Bean将作为首选者，否则将抛出异常

 

      12、@DependsOn

            用于强制初始化其他Bean，可以修饰Bean类或方法。

            @DependsOn({"bean1", "bean2"})  

 

      13、@Lazy

             用于指定是否延迟初始化Bean，主要用于修饰Bean类。

             @Lazy(true) 

 

      14、@EnableAspectJAutoProxy

             启用AOP。该注解类用于自动注册AnnotationAwareAspectJAutoProxyCreator对象到Spring容器中，该对象除了会自动将容器的所有Advisor作用于所有的Bean外，也会自动将标注有@Aspect注解的切面类织入到目标bean中。

 

三、JSR规范的注解（需要common-annotations.jar包的支持）

     1、@Resource  由JSR-250提供

           作用与@Autowired注解相同。默认按名称进行装配bean，名称可以通过name属性进行指定。

          @Resource(name="person")         name属性用于指定注入的Bean的名称。

          @Resource(type=Person.class)    type属性用于指定注入的Bean的类型。

 

     2、@PostContsuct

          用于指定受管Bean的初始化方法，作用与Bean的init-method属性类似。

 

     3、@PreDestory

          用于指定受管Bean的析构方法，作用与Bean的destory-method属性类似。

 

     4、@Inject  由JSR-330提供

          和spring中的 @Autowired 相同。

 

     5、@Named

          和spring中的 @Component 相同。

          @Name可以有值，如果没有值生成的bean名称默认和类名相同。