Spring 注解大全與詳解
Spring使用的注解大全和解釋
| 注解 | 解釋 |
|---|---|
| @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) |
轉自：https://www.cnblogs.com/alter888/p/9083963.html
元注解：
元注解的作用就是負責注解其他注解。Java5.0定義了4個標准的meta-annotation類型，它們被用來提供對其它 annotation類型作說明。Java5.0定義的元注解：
1.@Target,
2.@Retention,
3.@Documented,
4.@Inherited
這些類型和它們所支持的類在java.lang.annotation包中可以找到。下面我們看一下每個元注解的作用和相應分參數的使用說明。
@Target：
@Target說明了Annotation所修飾的對象范圍：Annotation可被用於 packages、types（類、接口、枚舉、Annotation類型）、類型成員（方法、構造方法、成員變量、枚舉值）、方法參數和本地變量（如循環變量、catch參數）。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標。
作用：用於描述注解的使用范圍（即：被描述的注解可以用在什么地方）
取值(ElementType)有：
1.CONSTRUCTOR:用於描述構造器
2.FIELD:用於描述域
3.LOCAL_VARIABLE:用於描述局部變量
4.METHOD:用於描述方法
5.PACKAGE:用於描述包
6.PARAMETER:用於描述參數
7.TYPE:用於描述類、接口(包括注解類型) 或enum聲明
使用實例：
@Target(ElementType.TYPE)
public @interface Table {
/**
* 數據表名稱注解，默認值為類名稱
* @return
*/
public String tableName() default "className";
}
@Target(ElementType.FIELD)
public @interface NoDBColumn {
}
注解Table 可以用於注解類、接口(包括注解類型) 或enum聲明,而注解NoDBColumn僅可用於注解類的成員變量。
@Retention：
@Retention定義了該Annotation被保留的時間長短：某些Annotation僅出現在源代碼中，而被編譯器丟棄；而另一些卻被編譯在class文件中；編譯在class文件中的Annotation可能會被虛擬機忽略，而另一些在class被裝載時將被讀取（請注意並不影響class的執行，因為Annotation與class在使用上是被分離的）。使用這個meta-Annotation可以對 Annotation的“生命周期”限制。
作用：表示需要在什么級別保存該注釋信息，用於描述注解的生命周期（即：被描述的注解在什么范圍內有效）
取值（RetentionPoicy）有：
1.SOURCE:在源文件中有效（即源文件保留）
2.CLASS:在class文件中有效（即class保留）
3.RUNTIME:在運行時有效（即運行時保留）
Retention meta-annotation類型有唯一的value作為成員，它的取值來自java.lang.annotation.RetentionPolicy的枚舉類型值。具體實例如下：
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
public String name() default "fieldName";
public String setFuncName() default "setField";
public String getFuncName() default "getField";
public boolean defaultDBValue() default false;
}
Column注解的的RetentionPolicy的屬性值是RUTIME,這樣注解處理器可以通過反射，獲取到該注解的屬性值，從而去做一些運行時的邏輯處理
@Documented:
@Documented用於描述其它類型的annotation應該被作為被標注的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化。Documented是一個標記注解，沒有成員。
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
public String name() default "fieldName";
public String setFuncName() default "setField";
public String getFuncName() default "getField";
public boolean defaultDBValue() default false;
}
@Inherited：
@Inherited 元注解是一個標記注解，@Inherited闡述了某個被標注的類型是被繼承的。如果一個使用了@Inherited修飾的annotation類型被用於一個class，則這個annotation將被用於該class的子類。
注意：@Inherited annotation類型是被標注過的class的子類所繼承。類並不從它所實現的接口繼承annotation，方法並不從它所重載的方法繼承annotation。
當@Inherited annotation類型標注的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強了這種繼承性。如果我們使用java.lang.reflect去查詢一個@Inherited annotation類型的annotation時，反射代碼檢查將展開工作：檢查class和其父類，直到發現指定的annotation類型被發現，或者到達類繼承結構的頂層。
實例代碼：
/**
*
* @author peida
*
*/
@Inherited
public @interface Greeting {
public enum FontColor{ BULE,RED,GREEN};
String name();
FontColor fontColor() default FontColor.GREEN;
}
自定義注解：
使用@interface自定義注解時，自動繼承了java.lang.annotation.Annotation接口，由編譯程序自動完成其他細節。在定義注解時，不能繼承其他的注解或接口。@interface用來聲明一個注解，其中的每一個方法實際上是聲明了一個配置參數。方法的名稱就是參數的名稱，返回值類型就是參數的類型（返回值類型只能是基本類型、Class、String、enum）。可以通過default來聲明參數的默認值。
定義注解格式：
public @interface 注解名 {定義體}
注解參數的可支持數據類型：
1.所有基本數據類型（int,float,boolean,byte,double,char,long,short)
2.String類型
3.Class類型
4.enum類型
5.Annotation類型
6.以上所有類型的數組
Annotation類型里面的參數該怎么設定:
第一,只能用public或默認(default)這兩個訪問權修飾.例如,String value();這里把方法設為defaul默認類型；
第二,參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和 String,Enum,Class,annotations等數據類型,以及這一些類型的數組.例如,String value();這里的參數成員就為String;
第三,如果只有一個參數成員,最好把參數名稱設為"value",后加小括號.例:下面的例子FruitName注解就只有一個參數成員。
簡單的自定義注解和使用注解實例：
package annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 水果名稱注解
* @author peida
*
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
String value() default "";
}