Spring常用注解

注:
本文轉(zhuǎn)載,主要為方便記錄學習,原文作者和鏈接在最下。
這里是另兩篇優(yōu)秀文章。
https://www.cnblogs.com/xiaoxi/p/5935009.html
https://zhuanlan.zhihu.com/p/137507309

注解本身沒有功能的,就和xml一樣。注解和xml都是一種元數(shù)據(jù),元數(shù)據(jù)即解釋數(shù)據(jù)的數(shù)據(jù),這就是所謂配置。

本文主要羅列Spring|SpringMVC相關(guān)注解的簡介。

Spring部分

1.聲明bean的注解

@Component 組件,沒有明確的角色

@Service 在業(yè)務(wù)邏輯層使用(service層)

@Repository 在數(shù)據(jù)訪問層使用(dao層)

@Controller 在展現(xiàn)層使用,控制器的聲明(C)

2.注入bean的注解

@Autowired:由Spring提供

@Inject:由JSR-330提供

@Resource:由JSR-250提供

都可以注解在set方法和屬性上,推薦注解在屬性上(一目了然,少寫代碼)。

關(guān)于 @Autowired 的歧義性問題可詳見@Autowired 詳解-三種實現(xiàn)方式,多種歧義性解決方法
@Qualifier 與 @Primary 都可以用于bean的歧義性問題

3.java配置類相關(guān)注解

@Configuration 聲明當前類為配置類,相當于xml形式的Spring配置(類上)

@Bean 注解在方法上,聲明當前方法的返回值為一個bean,替代xml中的方式(方法上)

@Configuration 聲明當前類為配置類,其中內(nèi)部組合了@Component注解,表明這個類是一個bean(類上)

@ComponentScan 用于對Component進行掃描,相當于xml中的context:component-scan/(類上)

@WishlyConfiguration 為@Configuration與@ComponentScan的組合注解,可以替代這兩個注解

4.切面(AOP)相關(guān)注解

Spring支持AspectJ的注解式切面編程。

@Aspect 聲明一個切面(類上)
使用@After、@Before、@Around定義建言(advice),可直接將攔截規(guī)則(切點)作為參數(shù)。

@After 在方法執(zhí)行之后執(zhí)行(方法上)
@Before 在方法執(zhí)行之前執(zhí)行(方法上)
@Around 在方法執(zhí)行之前與之后執(zhí)行(方法上)

@PointCut 聲明切點
在java配置類中使用@EnableAspectJAutoProxy注解開啟Spring對AspectJ代理的支持(類上)

5.@Bean的屬性支持

@Scope 設(shè)置Spring容器如何新建Bean實例(方法上,得有@Bean)
其設(shè)置類型包括:

Singleton (單例,一個Spring容器中只有一個bean實例,默認模式),
Protetype (每次調(diào)用新建一個bean),
Request (web項目中,給每個http request新建一個bean),
Session (web項目中,給每個http session新建一個bean),
GlobalSession(給每一個 global http session新建一個Bean實例)

@StepScope 在Spring Batch中還有涉及

@PostConstruct 由JSR-250提供,在構(gòu)造函數(shù)執(zhí)行完之后執(zhí)行,等價于xml配置文件中bean的initMethod

@PreDestory 由JSR-250提供,在Bean銷毀之前執(zhí)行,等價于xml配置文件中bean的destroyMethod

6.@Value注解

@Value 為屬性注入值(屬性上)
支持如下方式的注入:
》注入普通字符

@Value("Michael Jackson")
String name;

》注入操作系統(tǒng)屬性

@Value("#{systemProperties['os.name']}")
String osName;

》注入表達式結(jié)果

@Value("#{ T(java.lang.Math).random() * 100 }")
String randomNumber;

》注入其它bean屬性

@Value("#{domeClass.name}")
String name;

》注入文件資源

@Value("classpath:com/hgs/hello/test.txt")
String Resource file;

》注入網(wǎng)站資源

@Value("http://www.cznovel.com")
Resource url;

》注入配置文件

@Value("${book.name}")
String bookName;

注入配置使用方法:
① 編寫配置文件(test.properties)

book.name=《三體》

② @PropertySource 加載配置文件(類上)

@PropertySource("classpath:com/hgs/hello/test/test.propertie")

③ 還需配置一個PropertySourcesPlaceholderConfigurer的bean。

7.環(huán)境切換

@Profile 通過設(shè)定Environment的ActiveProfiles來設(shè)定當前context需要使用的配置環(huán)境。(類或方法上)

@Conditional Spring4中可以使用此注解定義條件話的bean,通過實現(xiàn)Condition接口,并重寫matches方法,從而決定該bean是否被實例化。(方法上)

8.異步相關(guān)

@EnableAsync 配置類中,通過此注解開啟對異步任務(wù)的支持,敘事性AsyncConfigurer接口(類上)

@Async 在實際執(zhí)行的bean方法使用該注解來申明其是一個異步任務(wù)(方法上或類上所有的方法都將異步,需要@EnableAsync開啟異步任務(wù))

9.定時任務(wù)相關(guān)

@EnableScheduling 在配置類上使用,開啟計劃任務(wù)的支持(類上)

@Scheduled 來申明這是一個任務(wù),包括cron,fixDelay,fixRate等類型(方法上,需先開啟計劃任務(wù)的支持)

10.@Enable注解說明*

這些注解主要用來開啟對xxx的支持。
@EnableAspectJAutoProxy 開啟對AspectJ自動代理的支持

@EnableAsync 開啟異步方法的支持

@EnableScheduling 開啟計劃任務(wù)的支持

@EnableWebMvc 開啟Web MVC的配置支持

@EnableConfigurationProperties 開啟對@ConfigurationProperties注解配置Bean的支持

@EnableJpaRepositories 開啟對SpringData JPA Repository的支持

@EnableTransactionManagement 開啟注解式事務(wù)的支持

@EnableTransactionManagement 開啟注解式事務(wù)的支持

@EnableCaching 開啟注解式的緩存支持

11.測試相關(guān)注解

@RunWith 運行器,Spring中通常用于對JUnit的支持

@RunWith(SpringJUnit4ClassRunner.class)

@ContextConfiguration 用來加載配置ApplicationContext,其中classes屬性用來加載配置類

@ContextConfiguration(classes={TestConfig.class})

SpringMVC部分

@EnableWebMvc 在配置類中開啟Web MVC的配置支持,如一些ViewResolver或者MessageConverter等,若無此句,重寫WebMvcConfigurerAdapter方法(用于對SpringMVC的配置)。

@Controller 聲明該類為SpringMVC中的Controller

@RequestMapping 用于映射Web請求,包括訪問路徑和參數(shù)(類或方法上)

@ResponseBody 支持將返回值放在response內(nèi),而不是一個頁面,通常用戶返回json數(shù)據(jù)(返回值旁或方法上)

@RequestBody 允許request的參數(shù)在request體中,而不是在直接連接在地址后面。(放在參數(shù)前)

@PathVariable 用于接收路徑參數(shù),比如@RequestMapping("/hello/{name}")申明的路徑,將注解放在參數(shù)中前,即可獲取該值,通常作為Restful的接口實現(xiàn)方法。

@RestController 該注解為一個組合注解,相當于@Controller和@ResponseBody的組合,注解在類上,意味著,該Controller的所有方法都默認加上了@ResponseBody。

@ControllerAdvice 通過該注解,我們可以將對于控制器的全局配置放置在同一個位置,注解了@Controller的類的方法可使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上,
這對所有注解了 @RequestMapping的控制器內(nèi)的方法有效。

@ExceptionHandler 用于全局處理控制器里的異常

@InitBinder 用來設(shè)置WebDataBinder,WebDataBinder用來自動綁定前臺請求參數(shù)到Model中。

@ModelAttribute 本來的作用是綁定鍵值對到Model里,在@ControllerAdvice中是讓全局的@RequestMapping都能獲得在此處設(shè)置的鍵值對。

@CrossOrigin 用于解決跨域問題,只需在接口上進行聲明即可,替代過慮器或攔截方式。

如有遺漏或有誤的地方,希望幫忙指出。
作者:IT_faquir
原文:https://blog.csdn.net/IT_faquir/article/details/78025203

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 注解本身沒有功能的,就和 xml 一樣。注解和 xml 都是一種元數(shù)據(jù),元數(shù)據(jù)即解釋數(shù)據(jù)的數(shù)據(jù),這就是所謂配置。 ...
    salt丶閱讀 144評論 0 1
  • 注解本身沒有功能的,就和xml一樣。注解和xml都是一種元數(shù)據(jù),元數(shù)據(jù)即解釋數(shù)據(jù)的數(shù)據(jù),這就是所謂配置。 本文主要...
    Zal哥哥閱讀 147評論 0 0
  • Spring部分 1.聲明bean的注解 @Component 組件,沒有明確的角色@Service 在業(yè)務(wù)邏輯層...
    鹿白_tz閱讀 418評論 0 8
  • 注解本身沒有功能的,就和 xml 一樣。 注解和 xml 都是一種元數(shù)據(jù),元數(shù)據(jù)即解釋數(shù)據(jù)的數(shù)據(jù),這就是所謂配置。...
    凱??词澜?/span>閱讀 668評論 0 18
  • 久違的晴天,家長會。 家長大會開好到教室時,離放學已經(jīng)沒多少時間了。班主任說已經(jīng)安排了三個家長分享經(jīng)驗。 放學鈴聲...
    飄雪兒5閱讀 7,866評論 16 22

友情鏈接更多精彩內(nèi)容