Spring使用的註解大全和解釋
阿新 • • 發佈：2021-11-11
| 註解 | 解釋 |
|---|---|
| @Controller | 組合註解（組合了@Component註解），應用在MVC層（控制層）,DispatcherServlet會自動掃描註解了此註解的類，然後將web請求對映到註解了@RequestMapping的方法上。 |
| @Service | 組合註解（組合了@Component註解），應用在service層（業務邏輯層） |
| @Reponsitory | 組合註解（組合了@Component註解），應用在dao層（資料訪問層） |
| @Component | 表示一個帶註釋的類是一個“元件”，成為Spring管理的Bean。當使用基於註解的配置和類路徑掃描時，這些類被視為自動檢測的候選物件。同時@Component還是一個元註解。 |
| @Autowired | Spring提供的工具（由Spring的依賴注入工具（BeanPostProcessor、BeanFactoryPostProcessor）自動注入。） |
| @Resource | JSR-250提供的註解 |
| @Inject | JSR-330提供的註解 |
| @Configuration | 聲明當前類是一個配置類（相當於一個Spring配置的xml檔案） |
| @ComponentScan | 自動掃描指定包下所有使用@Service,@Component,@Controller,@Repository的類並註冊 |
| @Bean | 註解在方法上，聲明當前方法的返回值為一個Bean。返回的Bean對應的類中可以定義init()方法和destroy()方法，然後在@Bean(initMethod=”init”,destroyMethod=”destroy”)定義，在構造之後執行init，在銷燬之前執行destroy。 |
| @Aspect | 宣告一個切面（就是說這是一個額外功能） |
| @After | 後置建言（advice），在原方法前執行。 |
| @Before | 前置建言（advice），在原方法後執行。 |
| @Around | 環繞建言（advice），在原方法執行前執行，在原方法執行後再執行（@Around可以實現其他兩種advice） |
| @PointCut | 宣告切點，即定義攔截規則，確定有哪些方法會被切入 |
| @Transactional | 宣告事務（一般預設配置即可滿足要求，當然也可以自定義） |
| @Cacheable | 宣告資料快取 |
| @EnableAspectJAutoProxy | 開啟Spring對AspectJ的支援 |
| @Value | 值得注入。經常與Sping EL表示式語言一起使用，注入普通字元，系統屬性，表示式運算結果，其他Bean的屬性，檔案內容，網址請求內容，配置檔案屬性值等等 |
| @PropertySource | 指定檔案地址。提供了一種方便的、宣告性的機制，用於向Spring的環境新增PropertySource。與@configuration類一起使用。 |
| @PostConstruct | 標註在方法上，該方法在建構函式執行完成之後執行。 |
| @PreDestroy | 標註在方法上，該方法在物件銷燬之前執行。 |
| @Profile | 表示當一個或多個指定的檔案是活動的時，一個元件是有資格註冊的。使用@Profile註解類或者方法，達到在不同情況下選擇例項化不同的Bean。@Profile(“dev”)表示為dev時例項化。 |
| @EnableAsync | 開啟非同步任務支援。註解在配置類上。 |
| @Async | 註解在方法上標示這是一個非同步方法，在類上標示這個類所有的方法都是非同步方法。 |
| @EnableScheduling | 註解在配置類上，開啟對計劃任務的支援。 |
| @Scheduled | 註解在方法上，宣告該方法是計劃任務。支援多種型別的計劃任務：cron,fixDelay,fixRate |
| @Conditional | 根據滿足某一特定條件建立特定的Bean |
| @Enable* | 通過簡單的@Enable來開啟一項功能的支援。所有@Enable註解都有一個@Import註解，@Import是用來匯入配置類的，這也就意味著這些自動開啟的實現其實是匯入了一些自動配置的Bean(1.直接匯入配置類2.依據條件選擇配置類3.動態註冊配置類) |
| @RunWith | 這個是Junit的註解，springboot集成了junit。一般在測試類裡使用:@RunWith(SpringJUnit4ClassRunner.class) — SpringJUnit4ClassRunner在JUnit環境下提供Sprng TestContext Framework的功能 |
| @ContextConfiguration | 用來載入配置ApplicationContext，其中classes屬性用來載入配置類:@ContextConfiguration(classes = {TestConfig.class(自定義的一個配置類)}) |
| @ActiveProfiles | 用來宣告活動的profile–@ActiveProfiles(“prod”(這個prod定義在配置類中)) |
| @EnableWebMvc | 用在配置類上，開啟SpringMvc的Mvc的一些預設配置：如ViewResolver，MessageConverter等。同時在自己定製SpringMvc的相關配置時需要做到兩點：1.配置類繼承WebMvcConfigurerAdapter類2.就是必須使用這個@EnableWebMvc註解。 |
| @RequestMapping | 用來對映web請求（訪問路徑和引數），處理類和方法的。可以註解在類和方法上，註解在方法上的@RequestMapping路徑會繼承註解在類上的路徑。同時支援Serlvet的request和response作為引數，也支援對request和response的媒體型別進行配置。其中有value(路徑)，produces(定義返回的媒體型別和字符集)，method(指定請求方式)等屬性。 |
| @ResponseBody | 將返回值放在response體內。返回的是資料而不是頁面 |
| @RequestBody | 允許request的引數在request體中，而不是在直接連結在地址的後面。此註解放置在引數前。 |
| @PathVariable | 放置在引數前，用來接受路徑引數。 |
| @RestController | 組合註解，組合了@Controller和@ResponseBody,當我們只開發一個和頁面互動資料的控制層的時候可以使用此註解。 |
| @ControllerAdvice | 用在類上，宣告一個控制器建言，它也組合了@Component註解，會自動註冊為Spring的Bean。 |
| @ExceptionHandler | 用在方法上定義全域性處理，通過他的value屬性可以過濾攔截的條件：@ExceptionHandler(value=Exception.class)–表示攔截所有的Exception。 |
| @ModelAttribute | 將鍵值對新增到全域性，所有註解了@RequestMapping的方法可獲得次鍵值對（就是在請求到達之前，往model裡addAttribute一對name-value而已）。 |
| @InitBinder | 通過@InitBinder註解定製WebDataBinder（用在方法上，方法有一個WebDataBinder作為引數，用WebDataBinder在方法內定製資料繫結，例如可以忽略request傳過來的引數Id等）。 |
| @WebAppConfiguration | 一般用在測試上，註解在類上，用來宣告載入的ApplicationContext是一個WebApplicationContext。他的屬性指定的是Web資源的位置，預設為src/main/webapp,我們可以修改為：@WebAppConfiguration(“src/main/resources”)。 |
| @EnableAutoConfiguration | 此註釋自動載入應用程式所需的所有Bean——這依賴於Spring Boot在類路徑中的查詢。該註解組合了@Import註解，@Import註解匯入了EnableAutoCofigurationImportSelector類，它使用SpringFactoriesLoader.loaderFactoryNames方法來掃描具有META-INF/spring.factories檔案的jar包。而spring.factories裡聲明瞭有哪些自動配置。 |
| @SpingBootApplication | SpringBoot的核心註解，主要目的是開啟自動配置。它也是一個組合註解，主要組合了@Configurer，@EnableAutoConfiguration（核心）和@ComponentScan。可以通過@SpringBootApplication(exclude={想要關閉的自動配置的類名.class})來關閉特定的自動配置。 |
| @ImportResource | 雖然Spring提倡零配置，但是還是提供了對xml檔案的支援，這個註解就是用來載入xml配置的。例：@ImportResource({“classpath |
| @ConfigurationProperties | 將properties屬性與一個Bean及其屬性相關聯，從而實現型別安全的配置。例：@ConfigurationProperties(prefix=”authot”，locations={“classpath |
| @ConditionalOnBean | 條件註解。當容器裡有指定Bean的條件下。 |
| @ConditionalOnClass | 條件註解。當類路徑下有指定的類的條件下。 |
| @ConditionalOnExpression | 條件註解。基於SpEL表示式作為判斷條件。 |
| @ConditionalOnJava | 條件註解。基於JVM版本作為判斷條件。 |
| @ConditionalOnJndi | 條件註解。在JNDI存在的條件下查詢指定的位置。 |
| @ConditionalOnMissingBean | 條件註解。當容器裡沒有指定Bean的情況下。 |
| @ConditionalOnMissingClass | 條件註解。當類路徑下沒有指定的類的情況下。 |
| @ConditionalOnNotWebApplication | 條件註解。當前專案不是web專案的條件下。 |
| @ConditionalOnResource | 條件註解。類路徑是否有指定的值。 |
| @ConditionalOnSingleCandidate | 條件註解。當指定Bean在容器中只有一個，後者雖然有多個但是指定首選的Bean。 |
| @ConditionalOnWebApplication | 條件註解。當前專案是web專案的情況下。 |
| @EnableConfigurationProperties | 註解在類上，宣告開啟屬性注入，使用@Autowired注入。例：@EnableConfigurationProperties(HttpEncodingProperties.class)。 |
| @AutoConfigureAfter | 在指定的自動配置類之後再配置。例：@AutoConfigureAfter(WebMvcAutoConfiguration.class) |