Spring 最常用的 7 大類註解，史上最強整理！

隨著技術的更新迭代，Java5.0開始支援註解。而作為java中的領導框架spring，自從更新了2.5版本之後也開始慢慢捨棄xml配置，更多使用註解來控制spring框架。

而spring的的註解那麼多，可能做java很多年，都用不上。這裡依照類型總結了這7種最常用的註解。

#1

 核心註解

#

@Required

#此註解用於bean的setter方法上。表示此屬性是必須的，必須在配置階段注入，否則會拋出BeanInitializationExcepion。

@Autowired

此註解用於bean的field、setter方法以及建構方法上，明確地宣告依賴。根據type來autowiring。

當在field上使用此註解，並且使用屬性來傳遞值時，Spring會自動把值賦給此field。也可以將此註解用於私有屬性(不建議)，如下。

@Componentpublic class User {    @Autowired    private Address address;}

最常的用法是將此註解用於settter上，這樣可以在setter方法中加入自訂程式碼。如下：

<br/>

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

當在建構方法上使用此註解的時候，需要注意的一點就是一個類別中只允許有一個建構方法使用此註解。

<br/>

此外，在Spring4.3後，如果一個類別僅只有一個建構方法，那麼即使不使用此註解，那麼Spring也會自動注入相關的bean。如下：

<br/>

@Component
public class User {
    private Address address;
    
    public User(Address address) {
       this.address=address;
     }
}

<bean id="user" class="xx.User"/>

@Qualifier<br/>

此注解是和@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的属性中。

推荐大家看下：Java 必须掌握的 12 种 Spring 常用注解，这篇也是必看了。<br/>

此注解值的注入发生在AutowiredAnnotationBeanPostProcessor类中。

2

Spring MVC和REST注解

@Controller

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

@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";
    }
}

这篇也推荐大家看下：Spring MVC常用注解。此外，Spring4.3之后引入了一系列@RequestMapping的变种。如下：

@GetMapping

@PostMapping

@PutMapping

@PatchMapping

@DeleteMapping

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

关注微信公众号：Java技术栈，在后台回复：spring，可以获取我整理的 N 篇最新 Spring 教程，都是干货。

@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<br/>

此注解使用在方法级别，声明对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" />

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

<br/>

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

@PathVariable<br/>此注解使用在请求handler方法的参数上。@RequestMapping可以定义动态路径，如:

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

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

<br/>

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

关注微信公众号：Java技术栈，在后台回复：spring，可以获取我整理的 N 篇最新 Spring 系列程，都是干货。

<br/>

@RequestAttribute

<br/>

此註解用在請求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 {}

3

Spring Boot注解

@EnableAutoConfiguration

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

@SpringBootApplication

此注解用在Spring Boot项目的应用主类上（此类需要在base package中）。

使用了此注解的类首先会让Spring Boot启动对base package以及其sub-pacakage下的类进行component scan。这篇整理的也非常全：Spring Boot 最核心的 25 个注解，建议大家看下。

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

@Configuration

@EnableAutoConfiguration

@ComponentScan

4

Stereotype注解

@Component

#此註解使用在class上來宣告一個Spring元件(Bean), 將其加入到應用上下文中。

@Controller

前文已經提到過

#@Service

此註解使用在class上，聲明此類是一個服務類，執行業務邏輯、計算、呼叫內部api等。是@Component註解的一種具體形式。

@Repository

這類使用在class上宣告此類用於存取資料庫，一般作為DAO的角色。

此註解有自動翻譯的特性，例如：當此種component拋出了一個異常，那麼會有一個handler來處理此異常，無需使用try-catch塊。

<br/>

#5

# 資料存取註解

@Transactional

此註解使用在介面定義、介面中的方法、類別定義或類別中的public方法上。需要注意的是此註解並不會啟動事務行為，它只是一個元數據，會被一些運行時基礎設施來消費。

#6

任务执行、调度注解

@Scheduled

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

@Scheduled(fixedDelay=1000)
public void schedule() {

}

@Scheduled(fixedRate=1000)
public void schedulg() {

}

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

@Async

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

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

7

测试注解

@ContextConfiguration

此注解使用在Class上，声明测试使用的配置文件，此外，也可以指定加载上下文的类。

此注解一般需要搭配SpringJUnit4ClassRunner使用。

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

}

以上是Spring 最常用的 7 大類註解，史上最強整理！的詳細內容。更多資訊請關注PHP中文網其他相關文章！