Spring常见注解

矫情吗；* 2024-03-31 16:55 89阅读 0赞

**普通CURD框架结构**

1、@controller 控制器（注入服务）  
用于标注控制层，相当于[struts][]中的action层

2、@service 服务（注入dao）  
用于标注服务层，主要用来进行业务的逻辑处理

3、@repository/@Mapper（实现dao访问）  
用于标注数据访问层，也可以说用于标注数据访问组件，即DAO组件.

4、@component （把普通pojo实例化到spring容器中，相当于配置文件中的 <bean id="" class=""/>）  
泛指各种组件，就是说当我们的类不属于各种归类的时候（不属于@Controller、@Services等的时候），我们就可以使用@Component来标注这个类。

**Spring****注解**

**1.****组件类注解**

思考：Spring怎么知道应该把哪些Java类当成bean注册到容器中呢？

答案：使用配置文件或者注解的方式进行标识需要处理的java类!

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

Spring 自 2.0 版本开始，陆续引入了一些注解用于简化 Spring 的开发。@Repository注解便属于最先引入的一批，它用于将数据访问层 (DAO 层 ) 的类标识为 Spring Bean。具体只需将该注解标注在 DAO类上即可。同时，为了让 Spring 能够扫描类路径中的类并识别出 @Repository 注解，需要在 XML 配置文件中启用Bean 的自动扫描功能，这可以通过<context:component-scan/>实现。如下所示：

<table> 
 <tbody> 
  <tr> 
   <td style="background-color:#FFFFFF;border-color:#000000;vertical-align:top;"> 
    <table> 
     <tbody> 
      <tr> 
       <td> 
        <div> 
         <p style="margin-left:.0001pt;text-align:justify;">// 首先使用 @Repository 将 DAO 类声明为 Bean</p> 
         <p style="margin-left:.0001pt;text-align:justify;">&nbsp;package bookstore.dao;</p> 
         <p style="margin-left:.0001pt;text-align:justify;">&nbsp;@Repository</p> 
         <p style="margin-left:.0001pt;text-align:justify;">&nbsp;public class UserDaoImpl implements UserDao{ …… }</p> 
         <p style="margin-left:.0001pt;text-align:justify;"></p> 
         <p style="margin-left:.0001pt;text-align:justify;">&nbsp;// 其次，在 XML 配置文件中启动 Spring 的自动扫描功能</p> 
         <p style="margin-left:.0001pt;text-align:justify;">&nbsp;&lt;beans … &gt;</p> 
         <p style="margin-left:.0001pt;text-align:justify;">&nbsp;&nbsp;&nbsp; ……</p> 
         <p style="margin-left:.0001pt;text-align:justify;">&nbsp;&lt;context:component-scan base-package=”bookstore.dao” /&gt;</p> 
         <p style="margin-left:.0001pt;text-align:justify;">……</p> 
         <p style="margin-left:.0001pt;text-align:justify;">&nbsp;&lt;/beans&gt;</p> 
        </div> </td> 
      </tr> 
     </tbody> 
    </table></td> 
  </tr> 
 </tbody> 
</table>

如此，我们就不再需要在 XML 中显式使用 <bean/> 进行Bean 的配置。Spring 在容器初始化时将自动扫描 base-package 指定的包及其子包下的所有 class文件，所有标注了 @Repository 的类都将被注册为 Spring Bean。

为什么 @Repository 只能标注在 DAO 类上呢？这是因为该注解的作用不只是将类识别为Bean，同时它还能将所标注的类中抛出的数据访问异常封装为 Spring 的数据访问异常类型。 Spring本身提供了一个丰富的并且是与具体的数据访问技术无关的数据访问异常结构，用于封装不同的持久层框架抛出的异常，使得异常独立于底层的框架。

Spring 2.5 在 @Repository的基础上增加了功能类似的额外三个注解：@Component、@Service、@Controller，它们分别用于软件系统的不同层次：

*  @Component 是一个泛化的概念，仅仅表示一个组件 (Bean) ，可以作用在任何层次。
 *  @Service 通常作用在业务层，但是目前该功能与 @Component 相同。
 *  @Controller 通常作用在控制层，但是目前该功能与 @Component 相同。

也就是说，@Component可以代替@Repository、@Service、@Controller，因为这三个注解是被@Component标注的。这四个注解均可将类标识为bean。

通过在类上使用 @Repository、@Component、@Service 和 @Controller 注解，Spring 会自动创建相应的 BeanDefinition 对象，并注册到 ApplicationContext 中。这些类就成了 Spring 受管组件。@Component、@Service 和 @Controller这三个注解除了作用于不同软件层次的类，其使用方式与 @Repository 是完全相同的。

a. @Component  
标注一个普通的Spring Bean类  
表示一个带注解的类是一个“组件”，成为Spring管理的Bean。当使用基于注解的配置和类路径扫描时，这些类被视为自动检测的候选对象。同时@Component还是一个元注解（注解其他注解）。  
虽然我们可以通过 @Autowired 或 @Resource 在 Bean 类中使用自动注入功能，但是 Bean 还是在 XML 文件中通过 <bean> 进行定义 —— 也就是说，在 XML 配置文件中定义 Bean，通过@Autowired 或 @Resource 为 Bean 的成员变量、方法入参或构造函数入参提供自动注入的功能。能否也通过注解定义 Bean，从 XML 配置文件中完全移除 Bean 定义的配置呢？答案是肯定的，我们通过 Spring 2.5 提供的@Component 注解就可以达到这个目标了。

b. @Repository  
标注一个DAO组件类。  
当一个组件代表数据访问层（DAO）的时候，我们使用@Repository进行注解

为什么 @Repository 只能标注在 DAO 类上呢？  
这是因为该注解的作用不只是将类识别为 Bean，同时它还能将所标注的类中抛出的数据访问异常封装为 Spring 的数据访问异常类型。 Spring 本身提供了一个丰富的并且是与具体的数据访问技术无关的数据访问异常结构，用于封装不同的持久层框架抛出的异常，使得异常独立于底层的框架。

如下

@Repository

public class HappyDaoImpl implements HappyDao\{

private final static Logger LOGGER = LoggerFactory.getLogger(HappyDaoImpl .class);

public void club()\{

//do something ,like drinking and singing

c. @Service  
目前该功能与 @Component 相同。  
当一个组件代表业务层时，我们使用@Service进行注解，如下

@Service(value="goodClubService")

//使用@Service注解不加value ,默认名称是clubService

public class ClubServiceImpl implements ClubService \{

@Autowired

private ClubDao clubDao;

public void doHappy()\{

//do some Happy

d. @Controller  
标注一个控制器组件类。  
但是目前该功能与 @Component 相同。  
当一个组件作为前端交互的控制层，使用@Controller进行注解

**2.** **注意点**

a. 被注解的java类当做Bean实例，Bean实例的名称默认是Bean类的首字母小写，其他部分不变。@Service也可以自定义Bean名称，但是必须是唯一的！

b. 指定了某些类可作为Spring Bean类使用后，最好还需要让Spring搜索指定路径，在Spring配置文件加入如下配置：

<context:component-scan base-package="org.springframework.\*"/>

**3.** **装配bean时常用的注解**

**（****1****）共同点**

两者都可以写在字段和setter方法上。两者如果都写在字段上，那么就不需要再写setter方法。

**（****2****）不同点**

@Autowired

@Autowired为Spring提供的注解，需要导入包org.springframework.beans.factory.annotation.Autowired，可以对成员变量、方法和构造函数进行标注，来完成自动装配的工作。只按照byType注入。

![4141725e56fa49f68ee5cc8352c4355a.png][]

@Autowired注解是按照类型（byType）装配依赖对象，默认情况下它要求依赖对象必须存在，如果允许null值，可以设置它的required属性为false。如果我们想使用按照名称（byName）来装配，可以结合@Qualifier注解一起使用。

如果容器中包含多个同一类型的Bean，那么启动容器时会报找不到指定类型bean的异常，解决办法是结合@Qualified注解进行限定，指定注入的bean名称。如下：

![38f179a5f2c04698bc7aa0f1d532d472.png][]

@Controller

public class HappyController \{

@Autowired //默认依赖的ClubDao 对象（Bean）必须存在

//@Autowired(required = false) 改变默认方式，允许null值，即依赖的ClubDao 对象（Bean）可以不存在

@Qualifier("goodClubService")

private ClubService clubService;

// Control the people entering the Club

// do something

\}  
@Resource

@Resource默认按照ByName自动注入，由J2EE提供，需要导入包javax.annotation.Resource。@Resource有两个重要的属性：name和type，而Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。

所以，如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不制定name也不制定type属性，这时将通过反射机制使用byName自动注入策略。

![0e8e023acab74cfb89d509daa10ebf17.png][]

注：最好是将@Resource放在setter方法上，因为这样更符合面向对象的思想，通过set、get去操作属性，而不是直接去操作属性。

@Resource装配顺序：

*  如果同时指定了name和type，则从Spring上下文中找到唯一匹配的bean进行装配，找不到则抛出异常。
 *  如果指定了name，则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常。
 *  如果指定了type，则从上下文中找到类型匹配的唯一bean进行装配，找不到或是找到多个，都会抛出异常。
 *  如果既没有指定name，又没有指定type，则自动按照byName方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配。
 *  name属性指定byName，如果没有指定name属性，当注解标注在字段上，即默认取字段的名称作为bean名称寻找依赖对象，当注解标注在属性的setter方法上，即默认取属性名作为bean名称寻找依赖对象。
 *  @Resource的作用相当于@Autowired，只不过@Autowired按照byType自动注入。

**（****3****）注意点**

@Resource要注意添加配置文件到Spring

<context:component-scan>

如果没有配置component-scan，则一定要配置 annotation-config  
<context:annotation-config/>

推荐使用：@Resource注解在字段上，且这个注解是属于J2EE的，减少了与spring的耦合。最重要的这样代码看起就比较优雅。

**4. java****配置**

a.  @Bean

主要用于方法上，有点类似于工厂方法，当使用了@Bean注解，我们可以连续使用多种定义bean时用到的注解，譬如用@Qualifier注解定义工厂方法的名称。

b. @Scope  
注解在类上

![54d88a74738a4008a1051e62772bcb51.jpeg][]

c. 使用@Configuration 来注解类表示类可以被 Spring 的 IoC 容器所使用，作为 bean 定义的资源。  
@Configuration

public class AppConfig \{

@Bean

public MyService myService() \{

return new MyServiceImpl();

d. @Component & @Configuration

@Configuration Indicates that a class declares one or more @Bean methods and may be processed by the Spring container to generate bean definitions and service requests for those beans at runtime

@Component Indicates that an annotated class is a "component". Such classes are considered as candidates for auto-detection when using annotation-based configuration and classpath scanning.

@Configuration is meta-annotated with @Component, therefore @Configuration classes are candidates for component scanning

e. 举例

![844ee767e20b49e7abb64a4a96755657.png][]

![95201dbfa06844efb10c86f15f1cbc6c.png][]

第一个代码正常工作，正如预期的那样，SimpleBeanConsumer将会得到一个单例SimpleBean的链接。第二个配置是完全错误的，因为Spring会创建一个SimpleBean的单例bean，但是SimpleBeanConsumer将获得另一个SimpleBean实例（也就是相当于直接调用new SimpleBean() ，这个bean是不归Spring管理的），既new SimpleBean() 实例是Spring上下文控件之外的。

main difference is that when annotated class with @Configuration @Bean annotated methods are proxy using CGLIB which made in code calls after the first one to return bean from context instead of execute method again and create another instance as happens when using @Component with @Bean

使用@configuration，所有标记为@bean的方法将被包装成一个CGLIB包装器，如果第一次调用该方法，那么原始方法的主体将被执行，最终的对象将在spring上下文中注册。所有进一步的调用只返回从上下文检索的bean。

在上面的第二个代码块中，新的SimpleBeanConsumer(simpleBean())只调用一个纯java方法。为了纠正第二个代码块，我们可以这样做

![7a325829d6144f4eafc5be80d70fb191.png][]

**5. Spring IoC**

spring ioc的实现原理，实际上就是简单工厂+sax解析xml+反射获取类对象

![5baa52fa7e05491caf7e35807c3ea061.jpeg][]

对于BeanFactory中，我们如下做：

public class BeanFactory\{

public Object getBean(String beanName)\{

// 反射 + 解析配置文件

return Class.forName("类名").new Instance();

通过id，我们通过解析spring配置文件解析到id所对应的类，然后获取全名，通过反射创建类。这样，我们 想获得bean，不需要修改代码，只需要新增类，然后再在配置文件中配置一下。

[struts]: https://so.csdn.net/so/search?q=struts&spm=1001.2101.3001.7020
[4141725e56fa49f68ee5cc8352c4355a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/383747aec3ed488aa60f8e5e5b0bbd42.png
[38f179a5f2c04698bc7aa0f1d532d472.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/0a24a3af487046b5bea658980850e122.png
[0e8e023acab74cfb89d509daa10ebf17.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/52021f2d94e54fb196ebeb5b8b498f33.png
[54d88a74738a4008a1051e62772bcb51.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/0ad3cd380073478a87a14e4d4a97ce66.jpeg
[844ee767e20b49e7abb64a4a96755657.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/d7052263c41b4965a84f3c2752653e27.png
[95201dbfa06844efb10c86f15f1cbc6c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/223c636d810345e4a565c135b4f514d6.png
[7a325829d6144f4eafc5be80d70fb191.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/cbfe69ca8c604933bfdc12a49f92d132.png
[5baa52fa7e05491caf7e35807c3ea061.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/1fe359fa75664b0c9fda072b3ea94421.jpeg