1. 程式人生 > >spring註解大全

spring註解大全

活動 進行 web資源 oot truct fig loader nim transacti

這裏匯總一下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(WebMvcAut

技術分享圖片

spring註解大全