Spring使用的註解大全和解釋

Spring使用的註解大全和解釋

註解	解釋
@Controller	組合註解（組合了@Component註解），應用在MVC層（控制層）,DispatcherServlet會自動掃描註解了此註解的類，而後將web請求映射到註解了@RequestMapping的方法上。
@Service	組合註解（組合了@Component註解），應用在service層（業務邏輯層）
@Reponsitory	組合註解（組合了@Component註解），應用在dao層（數據訪問層）
@Component	表示一個帶註釋的類是一個「組件」，成爲Spring管理的Bean。當使用基於註解的配置和類路徑掃描時，這些類被視爲自動檢測的候選對象。同時@Component仍是一個元註解。至關於配置文件中的 <bean id="" class=""/>。就是說當咱們的類不屬於各類歸類的時候（不屬於@Controller、@Services等的時候），咱們就可使用@Component來標註這個類。
@Autowired	Spring提供的工具（由Spring的依賴注入工具（BeanPostProcessor、BeanFactoryPostProcessor）自動注入。）默認按類型裝配，默認狀況下必需要求依賴對象必須存在，若是要容許null值，能夠設置它的required屬性爲false，如：@Autowired(required=false) ，若是咱們想使用名稱裝配能夠結合@Qualifier註解進行使用： @Autowired()@Qualifier("baseDao") private BaseDao baseDao;
@Resource	JSR-250提供的註解；這個註解屬於J2EE的，默認按照名稱進行裝配，名稱能夠經過name屬性進行指定，若是沒有指定name屬性，當註解寫在字段上時，默認取字段名進行安裝名稱查找，若是註解寫在setter方法上默認取屬性名進行裝配。當找不到與名稱匹配的bean時才按照類型進行裝配。可是須要注意的是，若是name屬性一旦指定，就只會按照名稱進行裝配。 @Resource(name="baseDao") private BaseDao baseDao;
@Inject	JSR-330提供的註解；按類型裝配，功能比@Autowired少，沒有使用的必要。
@Configuration	聲明當前類是一個配置類（至關於一個Spring配置的xml文件）。被註解的類內部包含有一個或多個被@Bean註解的方法，這些方法將會被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext類進行掃描，並用於構建bean定義，初始化Spring容器。標註在類上，至關於把該類做爲spring的xml配置文件中的<beans>，做用爲：配置spring容器(應用上下文) 註解的配置類有以下要求： 1. @Configuration不能夠是final類型；2.@Configuration不能夠是匿名類；3.嵌套的configuration必須是靜態類。
@ComponentScan	自動掃描指定包下全部使用@Service,@Component,@Controller,@Repository的類並註冊
@Bean	註解在方法上，聲明當前方法的返回值爲一個Bean。等價於spring的xml配置文件中的<bean>，做用爲：註冊bean對象。返回的Bean對應的類中能夠定義init()方法和destroy()方法，而後在@Bean(initMethod=」init」,destroyMethod=」destroy」)定義，在構造以後執行init，在銷燬以前執行destroy。 1.@Bean註解在返回實例的方法上，若是未經過@Bean指定bean的名稱，則默認與標註的方法名相同；  2.@Bean註解默認做用域爲單例singleton做用域，可經過@Scope(「prototype」)設置爲原型做用域；  3.既然@Bean的做用是註冊bean對象，那麼徹底可使用@Component、@Controller、@Service、@Ripository等註解註冊bean，固然須要配置@ComponentScan註解進行自動掃描。
@Aspect	聲明一個切面（就是說這是一個額外功能）
@After	後置建言（advice），在原方法前執行。
@Before	前置建言（advice），在原方法後執行。
@Around	環繞建言（advice），在原方法執行前執行，在原方法執行後再執行（@Around能夠實現其餘兩種advice）
@PointCut	聲明切點，即定義攔截規則，肯定有哪些方法會被切入
@Transactional	聲明事務（通常默認配置便可知足要求，固然也能夠自定義）
@Cacheable	聲明數據緩存
@EnableAspectJAutoProxy	開啓Spring對AspectJ的支持
@Value	值得注入。常常與Sping EL表達式語言一塊兒使用，注入普通字符，系統屬性，表達式運算結果，其餘Bean的屬性，文件內容，網址請求內容，配置文件屬性值等等。 @Value的值有兩類： ① ${ property : default_value } 注入的是外部配置文件對應的property ② #{ obj.property? :default_value } SpEL表達式對應的內容，obj表明對象 default_value，就是前面的值爲空時的默認值
@PropertySource	指定文件地址。提供了一種方便的、聲明性的機制，用於向Spring的環境添加PropertySource。與@configuration類一塊兒使用。 可使用@Value 用${}佔位符注入屬性，但PropertySourcesPlaceholderConfigurer這個bean是必須的，這個就是佔位bean,另外一種方式是不用value直接用Envirment變量直接getProperty('key')
@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)