Spring Annotation Facility

鲁浩言

2023-12-01

JDK 在1.5之后加入了Annotation功能，同时Spring到2.5版本后，基本上开发人员也可以不再使用XML文件来配置bean了，都是使用Annotation来声明一个bean，因此，本节对Spring的Annotation做一个简单总结。

@Autowired(spring)

@Autowired可以对成员变量、方法和构造函数进行标注，来完成自动装配的工作。推荐使用@Resource来代替Spring专有的@Autowired注解。例如：

//类的实现1--对成员变量进行标注：
public class UserServiceImpl implements IUserService {

    @Autowired  
    private UserDao userDao;
    ……
}

//类的实现2--对方法进行标注：
public class UserServiceImpl implements IUserService {

    private UserDao userDao;

    @Autowired  
    public void setUserDao(UserDao userDao) {   
        this.userDao = userDao;
    }

}

配置文件：

<bean id="userService" class="com.basis.system.core.user.service.UserServiceImpl">
</bean>

<bean id="userDao" class="com.basis.system.core.user.dao.UserDao">
<property name="sessionFactory" ref="sessionFactory" />
</bean>

<bean class="org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor" />

以上两种不同实现方式中，@Autowired的标注位置不同，它们都会在Spring初始化userServiceImpl这个bean时，自动装配userDao这个属性，区别是：
第一种实现中，Spring会直接将UserDao类型的唯一一个bean赋值给userDao这个成员变量；
第二种实现中，Spring会调用setUserDao方法来将UserDao类型的唯一一个bean装配到userDao这个属性。

@Autowired是根据类型进行自动装配的，在上面的例子中，如果当Spring上下文中存在不止一个UserDao类型的bean时，就会抛出BeanCreationException异常；如果Spring上下文中不存在UserDao类型的bean，也会抛出BeanCreationException异常。我们可以使用@Qualifier配合@Autowired来解决这些问题，例如：

//1) 可能存在多个UserDao实例
    @Autowired
    public void setUserDao(@Qualifier("userDao") UserDao userDao) {
       this.userDao = userDao;
    }
//这样，Spring会找到id为userDao的bean进行装配。

//2) 可能不存在UserDao实例
    @Autowired(required = false)
    public void setUserDao(UserDao userDao) {
       this.userDao = userDao;
    }

@Resource（JSR-250）

@Resource 是JSR-250标准注解，推荐使用它来代替Spring专有的@Autowired注解

Spring 不但支持自己定义的@Autowired注解，还支持几个由JSR-250规范定义的注解，它们分别是@Resource、@PostConstruct以及@PreDestroy。
@Resource的作用相当于@Autowired，只不过@Autowired按byType自动注入，而@Resource默认按byName自动注入罢了。@Resource有两个属性是比较重要的，分别是name和type，Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。所以如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不指定name也不指定type属性，这时将通过反射机制使用byName自动注入策略。

1) @Resource装配顺序

如果同时指定了name和type，则从Spring上下文中找到唯一匹配的bean进行装配，找不到则抛出异常；

如果指定了name，则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常；

如果指定了type，则从上下文中找到类型匹配的唯一bean进行装配，找不到或者找到多个，都会抛出异常；

如果既没有指定name，又没有指定type，则自动按照byName方式进行装配；如果没有匹配，则回退为一个原始类型（UserDao）进行匹配，如果匹配则自动装配。

@PostConstruct（JSR-250）

在方法上加上注解@PostConstruct，这个方法就会在Bean初始化之后被Spring容器执行（注：Bean初始化包括，实例化Bean，并装配Bean的属性（依赖注入））。

它的一个典型的应用场景是，当你需要往Bean里注入一个其父类中定义的属性，而你又无法复写父类的属性或属性的setter方法时，如：

@Repository("logDao")
public class LogDao extends HibernateDaoSupport{

    @Resource
    private SessionFactory sessionFactory;
    /** 
     * 类初始化时初始化父类的session工厂 
     * */
    @PostConstruct
    void injectSessionFactory() {
       super.setSessionFactory(sessionFactory);
    }
    
    public void addLog(Log log) {
       this.getHibernateTemplate().save(log);
    }
}

@PreDestroy（JSR-250）

在方法上加上注解@PreDestroy，这个方法就会在Bean初始化之后被Spring容器执行。由于我们当前还没有需要用到它的场景，这里不去演示。其用法同@PostConstruct。

@Qualifier(spring)
当Spring上下文中存在不止一个UserDao类型的bean时，就会抛出BeanCreationException异常；如果Spring上下文中不存在UserDao类型的bean，也会抛出BeanCreationException异常。我们可以使用@Qualifier配合@Autowired来解决这些问题。参考上面例子。

@Required(spring)

@Required 负责检查一个bean在初始化时其声明的 set方法是否被执行，当某个被标注了 @Required 的 Setter 方法没有被调用，则 Spring 在解析的时候会抛出异常，以提醒开发者对相应属性进行设置。 @Required 注解只能标注在 Setter 方法之上。因为依赖注入的本质是检查 Setter 方法是否被调用了，而不是真的去检查属性是否赋值了以及赋了什么样的值。如果将该注解标注在非 setXxxx() 类型的方法则被忽略。它的作用等同于在配置文件中使用dependency-check来进行DI检查。

使用这个功能需要在配置文件中定义Bean:
<bean id="requiredChecker" class="rog.springframework.beans.factory.annotation.RequiredAnnotationBeanPostProcessor"/>

@Inject & @Named(JSR 330)

Instead of @Autowired, javax.inject.Inject may be used as follows:

import javax.inject.Inject;
  public class SimpleMovieLister {

  private MovieFinder movieFinder;

  @Inject
  public void setMovieFinder(MovieFinder movieFinder) {
      this.movieFinder = movieFinder;
  }
  // ...
 }

As for @Autowired, it is possible to use @Inject at the class-level, field-level, method-level and constructor-argument level. If you would like to use a qualified name for the dependency that should be injected, you should use the @Named annotation as follows:

import javax.inject.Inject;
  import javax.inject.Named;
  
  public class SimpleMovieLister {

  private MovieFinder movieFinder;

  @Inject
  public void setMovieFinder(@Named("main") MovieFinder movieFinder) {
      this.movieFinder = movieFinder;
  }
  // ...
}

@Named(JSR 330)

a standard equivalent to the @Component annotation

import javax.inject.Inject;
  import javax.inject.Named;
  
  @Named("movieListener")
  public class SimpleMovieLister {

  private MovieFinder movieFinder;

  @Inject
  public void setMovieFinder(MovieFinder movieFinder) {
      this.movieFinder = movieFinder;
  }
  // ...
}

使用Spring注解完成Bean的定义

@Component （不推荐使用）、@Repository、@Service、@Controller

@Component
@Scope("prototype")
public class UserAction extends BaseAction implements ModelDriven<User>{

}

使用@Component注解定义的Bean，默认的名称（id）是小写开头的非限定类名。如这里定义的Bean名称就是userDaoImpl。你也可以指定Bean的名称：

@Component("userDao")

@Component是所有受Spring管理组件的通用形式，Spring还提供了更加细化的注解形式：

@Repository、@Service、@Controller，它们分别对应持久化层Bean，业务层Bean，和展示层Bean。

版本（2.5）中，这些注解与@Component的语义是一样的，完全通用，在Spring以后的版本中可能会给它们追加更多的语义。所以，我们推荐使用@Repository、@Service、@Controller来替代@Component。

@Scope

定义Bean的作用范围

使用<context:component-scan />让Bean定义注解工作起来

使用<context:annotation-config />简化配置

Spring2.1添加了一个新的context的Schema命名空间，该命名空间对注释驱动、属性文件引入、加载期织入等功能提供了便捷的配置。我们知道注释本身是不会做任何事情的，它仅提供元数据信息。要使元数据信息真正起作用，必须让负责处理这些元数据的处理器工作起来。

AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor就是处理这些注释元数据的处理器。但是直接在Spring配置文件中定义这些Bean显得比较笨拙。Spring为我们提供了一种方便的注册这些BeanPostProcessor的方式，这就是<context:annotation-config />：

<context:annotationconfig />将隐式地向Spring容器注册：

AutowiredAnnotationBeanPostProcessor、

CommonAnnotationBeanPostProcessor、

PersistenceAnnotationBeanPostProcessor、

RequiredAnnotationBeanPostProcessor

这4个BeanPostProcessor。

Spring annotations vs standard annotations

Spring	javax.inject.*	javax.inject restrictions / comments
@Autowired	@Inject	@Inject has no 'required' attribute
@Component	@Named
@Scope("singleton")	@Singleton	jsr-330 default scope is like Spring's `prototype`. However, in order to keep it consistent with Spring's general defaults, a jsr-330 bean declared in the Spring container is a `singleton` by default. In order to use another scope than `singleton`, you should use Spring's `@Scope` annotation. `javax.inject` also provides a @Scope annotation. Nevertheless, this one only aims to be used for creating your own annotations.
@Qualifier	@Named
@Value	-	no equivalent
@Required	-	no equivalent
@Lazy	-	no equivalent

Spring Annotation Facility

相关阅读

相关文章

相关问答