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

作者：Java程式媛環環
https://blog.csdn.net/Lubanjava/article/details/100579554

隨著技術的更新迭代，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，也可以將此注解用于私有屬性(不推薦)，如下，

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

@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的屬性中，

推薦大家看下：Java 必須掌握的 12 種 Spring 常用注解，這篇也是必看了，

此注解值的注入發生在AutowiredAnnotationBeanPostProcessor類中，

2、Spring MVC和REST注解

@Controller

此注解使用在class上宣告此類是一個Spring controller，是@Component注解的一種具體形式，

@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

此注解使用在方法級別，宣告對Exception的處理邏輯，可以指定目標Exception，

@InitBinder

此注解使用在方法上，宣告對WebDataBinder的初始化(系結請求引數到JavaBean上的DataBinder)，在controller上使用此注解可以自定義請求引數的系結，

@MatrixVariable

此注解使用在請求handler方法的引數上，Spring可以注入matrix url中相關的值，這里的矩陣變數可以出現在url中的任何地方，變數之間用;分隔，如下：

// GET /pets/42;q=11;r=22
@RequestMapping(value =https://www.cnblogs.com/javastack/p/ "/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
此注解使用在請求handler方法的引數上，@RequestMapping可以定義動態路徑，如:

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

可以使用@PathVariable將路徑中的引數系結到請求方法引數上，

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

關注微信公眾號：Java技術堆疊，在后臺回復：spring，可以獲取我整理的 N 篇最新 Spring 系列程，都是干貨，

@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 =https://www.cnblogs.com/javastack/p/ "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塊，

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 {

}

關注公眾號Java技術堆疊回復"面試"獲取我整理的2020最全面試題及答案，

推薦去我的博客閱讀更多：

1.Java JVM、集合、多執行緒、新特性系列教程

2.Spring MVC、Spring Boot、Spring Cloud 系列教程

3.Maven、Git、Eclipse、Intellij IDEA 系列工具教程

4.Java、后端、架構、阿里巴巴等大廠最新面試題

覺得不錯，別忘了點贊+轉發哦！

標籤：Java

上一篇：五年java開發面經分享，注意這些細節讓你offer拿到手軟

下一篇：Java反射