SpringFramework常用的註解說明

摘要： 在進行SpringBoot開發的時候經常要用到註解，有的時候很容易忘記某個註解的意思，現將一些常用的註解說明歸納如下： 註解 解釋 @Required ...

在進行SpringBoot開發的時候經常要用到註解，有的時候很容易忘記某個註解的意思，現將一些常用的註解說明歸納如下：

註解	解釋
@Required	@Required註解檢查。但它只檢查屬性是否已經設定而不會測試屬性是否非空。@Required只能設定在setter方法上
@Autowired	Spring提供的注入工具【由Spring的依賴注入工具（BeanPostProcessor、BeanFactoryPostProcessor）自動注入】
@Qualifier	如果需要byName（byName就是通過id去標識）注入，增加@Qualifier註釋。一般在候選Bean數目不為1時應該加@Qualifier註釋。
@Configuration	在用於指定配置資訊的類上加上 @Configuration 註解，以明確指出該類是 Bean 配置的資訊源。
@ComponentScan	@ComponentScan告訴Spring 哪個packages 的用註解標識的類 會被spring自動掃描並且裝入bean容器
@Bean	@Bean註解用於告訴方法，產生一個Bean物件，然後這個Bean物件交給Spring管理。產生這個Bean物件的方法Spring只會呼叫一次，隨後這個Spring將會將這個Bean物件放在自己的IOC/">IOC容器中。
@Lazy	如果我們想要 Spring 在啟動的時候延遲載入 bean，即在呼叫某個 bean 的時候再去初始化，那麼就可以使用 @Lazy 註解。
@Value	使用@Value註解，可以直接將屬性值注入到beans中。
@Resource	@Resource用法與@Autowired 用法 用法相似，也是做依賴注入的，從容器中自動獲取bean。
@Inject	這是jsr330中的規範，通過‘AutowiredAnnotationBeanPostProcessor’ 類實現的依賴注入。
@PropertySource	指定檔案地址。提供了一種方便的、宣告性的機制，用於向Spring的環境新增PropertySource。與@configuration類一起使用。
@PostConstruct	標註在方法上，該方法在建構函式執行完成之後執行。
@PreDestroy	標註在方法上，該方法在物件銷燬之前執行。
@ActiveProfiles	用來宣告活動的profile–@ActiveProfiles(“prod”(這個prod定義在配置類中))
@Profile	表示當一個或多個指定的檔案是活動的時，一個元件是有資格註冊的。使用@Profile註解類或者方法，達到在不同情況下選擇例項化不同的Bean。@Profile(“dev”)表示為dev時例項化。
@Component	表示一個帶註釋的類是一個“元件”，成為Spring管理的Bean。當使用基於註解的配置和類路徑掃描時，這些類被視為自動檢測的候選物件。同時@Component還是一個元註解。
@Controller	組合註解（組合了@Component註解），應用在MVC層（控制層）,DispatcherServlet會自動掃描註解了此註解的類，然後將web請求對映到註解了@RequestMapping的方法上。
@Service	組合註解（組合了@Component註解），應用在service層（業務邏輯層）
@Reponsitory	組合註解（組合了@Component註解），應用在dao層（資料訪問層）
@RestController	@RestController註解相當於@ResponseBody ＋ @Controller合在一起的作用。
@ResponseBody	將返回值放在response體內。返回的是資料而不是頁面
@RequestBody	允許request的引數在request體中，而不是在直接連結在地址的後面。此註解放置在引數前。
@PathVariable	放置在引數前，用來接受路徑引數。
@ModelAttribute	將鍵值對新增到全域性，所有註解了@RequestMapping的方法可獲得次鍵值對（就是在請求到達之前，往model裡addAttribute一對name-value而已）。
@RequestAttribute	註解@RequestAttribute 可以被用於訪問由過濾器或攔截器建立的、預先存在的請求屬性
@RequestHeader	獲得指定的請求中的Header資訊
@RequestParam	請求引數繫結
@ResponseStatus	帶有@ResponseStatus註解的異常類會被ResponseStatusExceptionResolver 解析。可以實現自定義的一些異常,同時在頁面上進行顯示。
@CookieValue	用來獲取Cookie中的值
@CrossOrigin	@CrossOrigin是用來處理跨域請求的註解
@RequestMapping	用來對映web請求（訪問路徑和引數），處理類和方法的。可以註解在類和方法上，註解在方法上的@RequestMapping路徑會繼承註解在類上的路徑。同時支援Serlvet的request和response作為引數，也支援對request和response的媒體型別進行配置。其中有value(路徑)，produces(定義返回的媒體型別和字符集)，method(指定請求方式)等屬性。
@GetMapping	GET請求
@PostMapping	POST請求
@PutMapping	PUT請求
@PatchMapping	PATCH請求
@DeleteMapping	DELETE請求
@ExceptionHandler	用在方法上定義全域性處理，通過他的value屬性可以過濾攔截的條件：@ExceptionHandler(value=Exception.class)–表示攔截所有的Exception。
@ControllerAdvice	用在類上，宣告一個控制器建言，它也組合了@Component註解，會自動註冊為Spring的Bean
@InitBinder	通過@InitBinder註解定製WebDataBinder（用在方法上，方法有一個WebDataBinder作為引數，用WebDataBinder在方法內定製資料繫結，例如可以忽略request傳過來的引數Id等）。
@SessionAttribute	@SessionAttribute作用於處理器類上，用於在多個請求之間傳遞引數，類似於Session的Attribute，但不完全一樣，一般來說@SessionAttribute設定的引數只用於暫時的傳遞，而不是長期的儲存，長期儲存的資料還是要放到Session中。
@SessionAttributes	@sessionattributes註解應用到Controller上面，可以將Model中的屬性同步到session當中。
@Aspect	宣告一個切面（就是說這是一個額外功能）
@After	後置建言（advice），在原方法前執行。
@Before	前置建言（advice），在原方法後執行。
@Around	環繞建言（advice），在原方法執行前執行，在原方法執行後再執行（@Around可以實現其他兩種advice）
@PointCut	宣告切點，即定義攔截規則，確定有哪些方法會被切入
@EnableAspectJAutoProxy	開啟Spring對AspectJ的支援
@SpingBootApplication	SpringBoot的核心註解，主要目的是開啟自動配置。它也是一個組合註解，主要組合了@Configurer，@EnableAutoConfiguration（核心）和@ComponentScan。可以通過@SpringBootApplication(exclude={想要關閉的自動配置的類名.class})來關閉特定的自動配置。
@Async	註解在方法上標示這是一個非同步方法，在類上標示這個類所有的方法都是非同步方法。
@EnableAsync	開啟非同步任務支援。註解在配置類上。
@Scheduled	註解在方法上，宣告該方法是計劃任務。支援多種型別的計劃任務：cron,fixDelay,fixRate
@EnableScheduling	註解在配置類上，開啟對計劃任務的支援。
@EnableAutoConfiguration	此註釋自動載入應用程式所需的所有Bean——這依賴於Spring Boot在類路徑中的查詢。該註解組合了@Import註解，@Import註解匯入了EnableAutoCofigurationImportSelector類，它使用SpringFactoriesLoader.loaderFactoryNames方法來掃描具有META-INF/spring.factories檔案的jar包。而spring.factories裡聲明瞭有哪些自動配置。
@WebAppConfiguration	一般用在測試上，註解在類上，用來宣告載入的ApplicationContext是一個WebApplicationContext。他的屬性指定的是Web資源的位置，預設為src/main/webapp,我們可以修改為：@WebAppConfiguration(“src/main/resources”)。
@Cacheable	宣告資料快取
@EnableWebMvc	用在配置類上，開啟SpringMvc的Mvc的一些預設配置：如ViewResolver，MessageConverter等。同時在自己定製SpringMvc的相關配置時需要做到兩點：1.配置類繼承WebMvcConfigurerAdapter類 2.就是必須使用這個@EnableWebMvc註解。
@BeforeTransaction	@BeforeTransaction在事務之前執行
@AfterTransaction	@AfterTransaction在事務之後執行
@Transactional	宣告事務（一般預設配置即可滿足要求，當然也可以自定義）
@ImportResource	雖然Spring提倡零配置，但是還是提供了對xml檔案的支援，這個註解就是用來載入xml配置的。
@ConfigurationProperties	將properties屬性與一個Bean及其屬性相關聯，從而實現型別安全的配置。
@Conditional	根據滿足某一特定條件建立特定的Bean
@ConditionalOnBean	條件註解。當容器裡有指定Bean的條件下。
@ConditionalOnClass	條件註解。當類路徑下有指定的類的條件下。
@ConditionalOnExpression	條件註解。基於SpEL表示式作為判斷條件。
@ConditionalOnJava	條件註解。基於JVM版本作為判斷條件。
@ConditionalOnJndi	條件註解。在JNDI存在的條件下查詢指定的位置。
@ConditionalOnMissingBean	條件註解。當容器裡沒有指定Bean的情況下。
@ConditionalOnMissingClass	條件註解。當類路徑下沒有指定的類的情況下。
@ConditionalOnNotWebApplication	條件註解。當前專案不是web專案的條件下。
@ConditionalOnResource	條件註解。類路徑是否有指定的值。
@ConditionalOnSingleCandidate	條件註解。當指定Bean在容器中只有一個，後者雖然有多個但是指定首選的Bean。
@ConditionalOnWebApplication	條件註解。當前專案是web專案的情況下。
@EnableConfigurationProperties	註解在類上，宣告開啟屬性注入，使用@Autowired注入。
@AutoConfigureAfter	在指定的自動配置類之後再配置。
@AutoConfigureBefore	在指定的自動配置類之前進行配置。
@RunWith	這個是Junit的註解，springboot集成了junit。一般在測試類裡使用。
@ContextConfiguration	用來載入配置ApplicationContext，其中classes屬性用來載入配置

參考：

• ofollow,noindex">Spring 註解大全與詳解
• Spring Boot學習筆記
• SPRING FRAMEWORK ANNOTATIONS