常见的 Spring 注解概览

港控/mmm° 2021-09-02 07:47 390阅读 0赞

点击上方 [Java后端][Java]，选择 设为星标

优质文章，及时送达

--------------------

从Java5.0开始，Java开始支持注解。Spring做为Java生态中的领军框架，从2.5版本后也开始支持注解。相比起之前使用xml来配置Spring框架，使用注解提供了更多的控制Spring框架的方式。

现在越来越多的项目也都在使用注解做相关的配置，但Spring的注解非常多，相信很多注解大家都没有使用过。本文就尽量全面地概括介绍一下Spring中常用的注解。

## 一. 核心注解 ##

### @Required ###

此注解用于`bean`的`setter`方法上。表示此属性是必须的，必须在配置阶段注入，否则会抛出`BeanInitializationExcepion`。

### @Autowired ###

此注解用于`bean`的`field`、`setter`方法以及构造方法上，显式地声明依赖。根据type来`autowiring`。

当在`field`上使用此注解，并且使用属性来传递值时，Spring会自动把值赋给此`field`。也可以将此注解用于私有属性(不推荐)，如下。

@Component
    public class User {
       @Autowired   
       private Address address;        
    }

最经常的用法是将此注解用于`settter`上，这样可以在`setter`方法中添加自定义代码。如下：

@Component
    public class User {
       private Address address;
    
       @AutoWired
       public setAddress(Address address) {
          // custom code
          this.address=address;
       }
    }

当在构造方法上使用此注解的时候，需要注意的一点就是一个类中只允许有一个构造方法使用此注解。此外，在Spring4.3后，如果一个类仅仅只有一个构造方法，那么即使不使用此注解，那么Spring也会自动注入相关的`bean`。如下：

@Component
    public class User {
        private Address address;
    
         public User(Address address) {       
            this.address=address;
         }
    }
    
    <bean id="user" class="xx.User"/>

### @Qualifier ###

此注解是和`@Autowired`一起使用的。使用此注解可以让你对注入的过程有更多的控制。

\`\`@Qualifier`可以被用在单个构造器或者方法的参数上。当上下文有几个相同类型的bean, 使用`@Autowired`则无法区分要绑定的bean，此时可以使用`@Qualifier\`来指定名称。

@Component
    public class User {
        @Autowired
        @Qualifier("address1")
        private Address address;
        ...
    }

### @Configuration ###

此注解用在class上来定义`bean`。其作用和xml配置文件相同，表示此`bean`是一个Spring配置。此外，此类可以使用`@Bean`注解来初始化定义`bean`。

@Configuartion
    public class SpringCoreConfig {
        @Bean
        public AdminUser adminUser() {
            AdminUser adminUser = new AdminUser();
            return adminUser;
        }
    }

### @ComponentScan ###

此注解一般和`@Configuration`注解一起使用，指定Spring扫描注解的package。如果没有指定包，那么默认会扫描此配置类所在的package。

### @Lazy ###

此注解使用在Spring的组件类上。默认的，Spring中Bean的依赖一开始就被创建和配置。如果想要延迟初始化一个bean，那么可以在此类上使用Lazy注解，表示此bean只有在第一次被使用的时候才会被创建和初始化。此注解也可以使用在被`@Configuration`注解的类上，表示其中所有被`@Bean`注解的方法都会延迟初始化。

### @Value ###

此注解使用在字段、构造器参数和方法参数上。`@Value`可以指定属性取值的表达式，支持通过\#\{\}使用SpringEL来取值，也支持使用$\{\}来将属性来源中(Properties文件、本地环境变量、系统属性等)的值注入到bean的属性中。此注解值的注入发生在`AutowiredAnnotationBeanPostProcessor`类中。

## 二. Stereotype注解 ##

### @Component ###

此注解使用在class上来声明一个Spring组件(Bean), 将其加入到应用上下文中。

### @Controller ###

此注解使用在class上声明此类是一个`Spring controller`，是`@Component`注解的一种具体形式。

### @Service ###

此注解使用在class上，声明此类是一个服务类，执行业务逻辑、计算、调用内部api等。是`@Component`注解的一种具体形式。

### @Repository ###

此类使用在class上声明此类用于访问数据库，一般作为DAO的角色。

此注解有自动翻译的特性，例如：当此种`component`抛出了一个异常，那么会有一个`handler`来处理此异常，无需使用`try-catch`块。

## 三. Spring Boot注解 ##

### @EnableAutoConfiguration ###

此注解通常被用在主应用class上，告诉Spring Boot自动基于当前包添加`Bean`、对`bean`的属性进行设置等。

### @SpringBootApplication ###

此注解用在Spring Boot项目的应用主类上（此类需要在base package中）。使用了此注解的类首先会让Spring Boot启动对base package以及其sub-pacakage下的类进行`componentScan`。

此注解同时添加了以下几个注解：

*  @Configuration
 *  @EnableAutoConfiguration
 *  @ComponentScan

## 四. Spring MVC和REST注解 ##

### @Controller ###

上文已经提到过此注解。

### @RequestMapping ###

此注解可以用在`class`和`method`上，用来映射web请求到某一个handler类或者handler方法上。当此注解用在`Class`上时，就创造了一个基础url，其所有的方法上的`@RequestMapping`都是在此url之上的。

可以使用其method属性来限制请求匹配的http method。

@Controller
    @RequestMapping("/users")
    public class UserController {
        @RequestMapping(method = RequestMethod.GET)
        public String getUserList() {
            return "users";
        }
    }

此外，Spring4.3之后引入了一系列`@RequestMapping`的变种。如下：

*  @GetMapping
 *  @PostMapping
 *  @PutMapping
 *  @PatchMapping
 *  @DeleteMapping

分别对应了相应`method`的`RequestMapping`配置。

### @CookieValue ###

此注解用在`@RequestMapping`声明的方法的参数上，可以把`HTTP cookie`中相应名称的`cookie`绑定上去。

@ReuestMapping("/cookieValue")
    public void getCookieValue(@CookieValue("JSESSIONID") String cookie){
    
    }

`cookie`即`http`请求中name为`JSESSIONID`的`cookie`值。

### @CrossOrigin ###

此注解用在`class`和`method`上用来支持跨域请求，是Spring 4.2后引入的。

@CrossOrigin(maxAge = 3600)
    @RestController
    @RequestMapping("/users")
    public class AccountController {
        @CrossOrigin(origins = "http://xx.com")
        @RequestMapping("/login")
        public Result userLogin() {
            // ...
        }
    }

### @ExceptionHandler ###

此注解使用在方法级别，声明对`Exception`的处理逻辑。可以指定目标`Exception`。

### @InitBinder ###

此注解使用在方法上，声明对`WebDataBinder`的初始化(绑定请求参数到`JavaBean`上的`DataBinder`)。在`controller`上使用此注解可以自定义请求参数的绑定。

### @MatrixVariable ###

此注解使用在请求`handler`方法的参数上，Spring可以注入matrix url中相关的值。这里的矩阵变量可以出现在url中的任何地方，变量之间用;分隔。如下：

// GET /pets/42;q=11;r=22
    @RequestMapping(value = "/pets/{petId}")
    public void findPet(@PathVariable String petId, @MatrixVariable int q) {
        // petId == 42
        // q == 11
    }

需要注意的是默认Spring mvc是不支持矩阵变量的，需要开启。

<mvc:annotation-driven enable-matrix-variables="true" />

注解配置则需要如下开启：

@Configuration
    public class WebConfig extends WebMvcConfigurerAdapter {
    
        @Override
        public void configurePathMatch(PathMatchConfigurer configurer) {
            UrlPathHelper urlPathHelper = new UrlPathHelper();
            urlPathHelper.setRemoveSemicolonContent(false);
            configurer.setUrlPathHelper(urlPathHelper);
        }
    }

### @PathVariable ###

@RequestMapping("/users/{uid}")

可以使用`@PathVariable`将路径中的参数绑定到请求方法参数上。

@RequestMapping("/users/{uid}")
    public String execute(@PathVariable("uid") String uid){
    }

### @RequestAttribute ###

此注解用在请求handler方法的参数上，用于将web请求中的属性(`request attributes`，是服务器放入的属性值)绑定到方法参数上。

### @RequestBody ###

此注解用在请求`handler`方法的参数上，用于将`http`请求的`Body`映射绑定到此参数上。`HttpMessageConverter`负责将对象转换为`http`请求。

### @RequestHeader ###

此注解用在请求`handler`方法的参数上，用于将`http`请求头部的值绑定到参数上。

### @RequestParam ###

此注解用在请求`handler`方法的参数上，用于将`http`请求参数的值绑定到参数上。

### @RequestPart ###

此注解用在请求`handler`方法的参数上，用于将文件之类的`multipart`绑定到参数上。

@ResponseBody

此注解用在请求`handler`方法上。和`@RequestBody`作用类似，用于将方法的返回对象直接输出到`http`响应中。

### @ResponseStatus ###

此注解用于方法和`exception`类上，声明此方法或者异常类返回的`http`状态码。可以在`Controller`上使用此注解，这样所有的`@RequestMapping`都会继承。

@ControllerAdvice

此注解用于`class`上。前面说过可以对每一个`controller`声明一个`ExceptionMethod`。这里可以使用`@ControllerAdvice`来声明一个类来统一对所有`@RequestMapping`方法来做`@ExceptionHandler`、\`\`@InitBinder`以及`@ModelAttribute\`处理。

### @RestController ###

此注解用于class上，声明此`controller`返回的不是一个视图而是一个领域对象。其同时引入了`@Controller`和`@ResponseBody`两个注解。

### @RestControllerAdvice ###

此注解用于`class`上，同时引入了`@ControllerAdvice`和`@ResponseBody`两个注解。

### @SessionAttribute ###

此注解用于方法的参数上，用于将`session`中的属性绑定到参数。

### @SessionAttributes ###

此注解用于`type`级别，用于将`JavaBean`对象存储到`session`中。一般和`@ModelAttribute`注解一起使用。如下：

@ModelAttribute("user")
    
    public PUser getUser() {}
    
    // controller和上面的代码在同一controller中
    @Controller
    @SeesionAttributes(value = "user", types = {
        User.class
    })
    
    public class UserController {}

## 五. 数据访问注解 ##

### @Transactional ###

此注解使用在接口定义、接口中的方法、类定义或者类中的`public`方法上。需要注意的是此注解并不激活事务行为，它仅仅是一个元数据，会被一些运行时基础设施来消费。

## 六. 任务执行、调度注解 ##

### @Scheduled ###

此注解使用在方法上，声明此方法被定时调度。使用了此注解的方法返回类型需要是`Void`，并且不能接受任何参数。

@Scheduled(fixedDelay=1000)
    public void schedule() {
    
    }
    
    @Scheduled(fixedRate=1000)
    public void schedulg() { 
    
    }

第二个与第一个不同之处在于其不会等待上一次的任务执行结束。

### @Async ###

此注解使用在方法上，声明此方法会在一个单独的线程中执行。不同于`Scheduled`注解，此注解可以接受参数。

使用此注解的方法的返回类型可以是Void也可是返回值。但是返回值的类型必须是一个`Future`。

## 七. 测试注解 ##

### @ContextConfiguration ###

@RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(classes = SpringCoreConfig.class)
    public class UserServiceTest {
    
    }

作者:飒然Hang

来源:rowkey.cn/blog

- END -
    最近整理一份面试资料《Java技术栈学习手册》，覆盖了Java技术、面试题精选、Spring全家桶、Nginx、SSM、微服务、数据库、数据结构、架构等等。获取方式：点“ 在看，关注公众号 Java后端 并回复 777 领取，更多内容陆续奉上。推荐阅读 1. 介绍一款 API 敏捷开发工具2. 这 4 种 ThreadLocal 你都知道吗？3. Windows 给力！可以扔掉 Linux 虚拟机了！4. 25 张图搞懂「文件系统」5. 干掉烦人的 Null ！喜欢文章，点个在看

[Java]: http://mp.weixin.qq.com/s?__biz=Mzg2MjEwMjI1Mg%3D%3D&chksm=ce0da17bf97a286df119047a25b7de51621fe542816673bb4aa3ebd8ab97b09a86ed7db2e2ee&idx=3&mid=2247489272&scene=21&sn=ce74938072fc73a808d83ccb474db46d#wechat_redirect