隨著技術的更新迭代忆某,Java5.0開始支持注解。而作為java中的領軍框架spring阔蛉,自從更新了2.5版本之后也開始慢慢舍棄xml配置弃舒,更多使用注解來控制spring框架。而spring的的注解那么多馍忽,可能做java很多年棒坏,都用不上燕差。這里按照類型總結(jié)了這7種最常用的注解。
本號專注Java源碼分析坝冕。喜歡底層源碼的朋友可以來交流探討徒探。交流群:818491202 驗證:88
** 核心注解**
@Required此注解用于bean的setter方法上。表示此屬性是必須的喂窟,必須在配置階段注入测暗,否則會拋出BeanInitializationExcepion。@Autowired此注解用于bean的field磨澡、setter方法以及構(gòu)造方法上碗啄,顯式地聲明依賴。根據(jù)type來autowiring稳摄。當在field上使用此注解稚字,并且使用屬性來傳遞值時,Spring會自動把值賦給此field厦酬。也可以將此注解用于私有屬性(不推薦)胆描,如下。
@Componentpublic class User { @Autowired private Address address;}
最經(jīng)常的用法是將此注解用于settter上仗阅,這樣可以在setter方法中添加自定義代碼昌讲。如下:
@Componentpublic class User { private Address address; @AutoWired public setAddress(Address address) { // custom code this.address=address; }}
當在構(gòu)造方法上使用此注解的時候,需要注意的一點就是一個類中只允許有一個構(gòu)造方法使用此注解减噪。此外短绸,在Spring4.3后,如果一個類僅僅只有一個構(gòu)造方法筹裕,那么即使不使用此注解醋闭,那么Spring也會自動注入相關的bean。如下:
@Componentpublic class User { private Address address; public User(Address address) { this.address=address; }}<bean id="user" class="xx.User"/>
@Qualifier
此注解是和@Autowired一起使用的饶碘。使用此注解可以讓你對注入的過程有更多的控制目尖。@Qualifier可以被用在單個構(gòu)造器或者方法的參數(shù)上。當上下文有幾個相同類型的bean, 使用@Autowired則無法區(qū)分要綁定的bean扎运,此時可以使用@Qualifier來指定名稱。
@Componentpublic class User { @Autowired @Qualifier("address1") private Address address; ...}
<pre style="margin: 0px; padding: 0px; max-width: 100%; box-sizing: border-box !important; word-wrap: break-word !important; color: rgb(51, 51, 51); font-size: 17px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: 0.544px; orphans: 2; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-align: left;">
@Configuration
</pre>
此注解用在class上來定義bean饮戳。其作用和xml配置文件相同豪治,表示此bean是一個Spring配置。此外扯罐,此類可以使用@Bean注解來初始化定義bean负拟。
<pre style="margin: 0px; padding: 0px; max-width: 100%; box-sizing: border-box !important; word-wrap: break-word !important; color: rgb(51, 51, 51); font-size: 17px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: 0.544px; orphans: 2; text-align: justify; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255);">
@Configuartionpublic class SpringCoreConfig { @Bean public AdminUser adminUser() { AdminUser adminUser = new AdminUser(); return adminUser; }}
@ComponentScan</pre>
此注解一般和@Configuration注解一起使用,指定Spring掃描注解的package歹河。如果沒有指定包掩浙,那么默認會掃描此配置類所在的package花吟。@Lazy此注解使用在Spring的組件類上。默認的厨姚,Spring中Bean的依賴一開始就被創(chuàng)建和配置衅澈。如果想要延遲初始化一個bean,那么可以在此類上使用Lazy注解谬墙,表示此bean只有在第一次被使用的時候才會被創(chuàng)建和初始化今布。此注解也可以使用在被@Configuration注解的類上,表示其中所有被@Bean注解的方法都會延遲初始化拭抬。@Value此注解使用在字段部默、構(gòu)造器參數(shù)和方法參數(shù)上。@Value可以指定屬性取值的表達式造虎,支持通過#{}使用SpringEL來取值傅蹂,也支持使用${}來將屬性來源中(Properties文件、本地環(huán)境變量算凿、系統(tǒng)屬性等)的值注入到bean的屬性中贬派。推薦大家看下:Java 必須掌握的 12 種 Spring 常用注解,這篇也是必看了澎媒。
此注解值的注入發(fā)生在AutowiredAnnotationBeanPostProcessor類中搞乏。
** Spring MVC和REST注解**
@Controller此注解使用在class上聲明此類是一個Spring controller,是@Component注解的一種具體形式戒努。
@RequestMapping此注解可以用在class和method上请敦,用來映射web請求到某一個handler類或者handler方法上。當此注解用在Class上時储玫,就創(chuàng)造了一個基礎url侍筛,其所有的方法上的@RequestMapping都是在此url之上的∪銮睿可以使用其method屬性來限制請求匹配的http method匣椰。
@Controller@RequestMapping("/users")public class UserController { @RequestMapping(method = RequestMethod.GET) public String getUserList() { return "users"; }}
<pre style="margin: 0px; padding: 0px; max-width: 100%; box-sizing: border-box !important; word-wrap: break-word !important; color: rgb(51, 51, 51); font-size: 17px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: 0.544px; orphans: 2; text-align: justify; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255);">這篇也推薦大家看下:Spring MVC常用注解。此外端礼,Spring4.3之后引入了一系列@RequestMapping的變種禽笑。如下:</pre>
@GetMapping@PostMapping@PutMapping@PatchMapping@DeleteMapping
分別對應了相應method的RequestMapping配置。
關注微信公眾號:Java技術棧蛤奥,在后臺回復:spring佳镜,可以獲取我整理的 N 篇最新 Spring 教程,都是干貨凡桥。@CookieValue此注解用在@RequestMapping聲明的方法的參數(shù)上蟀伸,可以把HTTP cookie中相應名稱的cookie綁定上去。
@ReuestMapping("/cookieValue") public void getCookieValue(@CookieValue("JSESSIONID") String cookie){}
cookie即http請求中name為JSESSIONID的cookie值。@CrossOrigin此注解用在class和method上用來支持跨域請求啊掏,是Spring 4.2后引入的蠢络。
@CrossOrigin(maxAge = 3600)@RestController@RequestMapping("/users")public class AccountController { @CrossOrigin(origins = "http://xx.com") @RequestMapping("/login") public Result userLogin() { // ... }}
@ExceptionHandler
此注解使用在方法級別,聲明對Exception的處理邏輯迟蜜∩部祝可以指定目標Exception。@InitBinder此注解使用在方法上小泉,聲明對WebDataBinder的初始化(綁定請求參數(shù)到JavaBean上的DataBinder)芦疏。在controller上使用此注解可以自定義請求參數(shù)的綁定。@MatrixVariable此注解使用在請求handler方法的參數(shù)上微姊,Spring可以注入matrix url中相關的值酸茴。這里的矩陣變量可以出現(xiàn)在url中的任何地方兢交,變量之間用;分隔薪捍。如下:
// GET /pets/42;q=11;r=22@RequestMapping(value = "/pets/{petId}")public void findPet(@PathVariable String petId, @MatrixVariable int q) { // petId == 42 // q == 11}
需要注意的是默認Spring mvc是不支持矩陣變量的,需要開啟配喳。
<mvc:annotation-driven enable-matrix-variables="true" />
注解配置則需要如下開啟:
@Configurationpublic class WebConfig extends WebMvcConfigurerAdapter { @Override public void configurePathMatch(PathMatchConfigurer configurer) { UrlPathHelper urlPathHelper = new UrlPathHelper(); urlPathHelper.setRemoveSemicolonContent(false); configurer.setUrlPathHelper(urlPathHelper); }}
@PathVariable
此注解使用在請求handler方法的參數(shù)上酪穿。@RequestMapping可以定義動態(tài)路徑,如:
@RequestMapping("/users/{uid}")
可以使用@PathVariable將路徑中的參數(shù)綁定到請求方法參數(shù)上晴裹。
@RequestMapping("/users/{uid}")public String execute(@PathVariable("uid") String uid){}
關注微信公眾號:Java技術棧被济,在后臺回復:spring,可以獲取我整理的 N 篇最新 Spring 系列程涧团,都是干貨只磷。@RequestAttribute此注解用在請求handler方法的參數(shù)上,用于將web請求中的屬性(request attributes泌绣,是服務器放入的屬性值)綁定到方法參數(shù)上钮追。@RequestBody此注解用在請求handler方法的參數(shù)上,用于將http請求的Body映射綁定到此參數(shù)上阿迈。HttpMessageConverter負責將對象轉(zhuǎn)換為http請求元媚。@RequestHeader此注解用在請求handler方法的參數(shù)上,用于將http請求頭部的值綁定到參數(shù)上苗沧。@RequestParam此注解用在請求handler方法的參數(shù)上刊棕,用于將http請求參數(shù)的值綁定到參數(shù)上。@RequestPart此注解用在請求handler方法的參數(shù)上崎页,用于將文件之類的multipart綁定到參數(shù)上鞠绰。@ResponseBody此注解用在請求handler方法上。和@RequestBody作用類似飒焦,用于將方法的返回對象直接輸出到http響應中。@ResponseStatus此注解用于方法和exception類上,聲明此方法或者異常類返回的http狀態(tài)碼牺荠∥涛。可以在Controller上使用此注解,這樣所有的@RequestMapping都會繼承休雌。@ControllerAdvice此注解用于class上灶壶。前面說過可以對每一個controller聲明一個ExceptionMethod。這里可以使用@ControllerAdvice來聲明一個類來統(tǒng)一對所有@RequestMapping方法來做@ExceptionHandler杈曲、@InitBinder以及@ModelAttribute處理驰凛。@RestController此注解用于class上,聲明此controller返回的不是一個視圖而是一個領域?qū)ο蟮F恕F渫瑫r引入了@Controller和@ResponseBody兩個注解恰响。@RestControllerAdvice此注解用于class上,同時引入了@ControllerAdvice和@ResponseBody兩個注解涌献。@SessionAttribute此注解用于方法的參數(shù)上胚宦,用于將session中的屬性綁定到參數(shù)。@SessionAttributes此注解用于type級別燕垃,用于將JavaBean對象存儲到session中枢劝。一般和@ModelAttribute注解一起使用。如下:
@ModelAttribute("user")public PUser getUser() {}// controller和上面的代碼在同一controller中@Controller@SeesionAttributes(value = "user", types = { User.class})public class UserController {}
Spring Boot注解
@EnableAutoConfiguration此注解通常被用在主應用class上卜壕,告訴Spring Boot自動基于當前包添加Bean您旁、對bean的屬性進行設置等。@SpringBootApplication此注解用在Spring Boot項目的應用主類上(此類需要在base package中)轴捎。使用了此注解的類首先會讓Spring Boot啟動對base package以及其sub-pacakage下的類進行component scan鹤盒。這篇整理的也非常全:Spring Boot 最核心的 25 個注解,建議大家看下轮蜕。此注解同時添加了以下幾個注解:
@Configuration@EnableAutoConfiguration@ComponentScan
** Stereotype注解**
@Component此注解使用在class上來聲明一個Spring組件(Bean), 將其加入到應用上下文中昨悼。@Controller前文已經(jīng)提到過@Service此注解使用在class上,聲明此類是一個服務類跃洛,執(zhí)行業(yè)務邏輯率触、計算、調(diào)用內(nèi)部api等汇竭。是@Component注解的一種具體形式葱蝗。@Repository此類使用在class上聲明此類用于訪問數(shù)據(jù)庫,一般作為DAO的角色细燎。此注解有自動翻譯的特性两曼,例如:當此種component拋出了一個異常,那么會有一個handler來處理此異常玻驻,無需使用try-catch塊悼凑。
數(shù)據(jù)訪問注解
@Transactional此注解使用在接口定義偿枕、接口中的方法、類定義或者類中的public方法上户辫。需要注意的是此注解并不激活事務行為渐夸,它僅僅是一個元數(shù)據(jù),會被一些運行時基礎設施來消費渔欢。
** 任務執(zhí)行墓塌、調(diào)度注解**
@Scheduled此注解使用在方法上,聲明此方法被定時調(diào)度奥额。使用了此注解的方法返回類型需要是Void苫幢,并且不能接受任何參數(shù)。
@Scheduled(fixedDelay=1000)public void schedule() {}@Scheduled(fixedRate=1000)public void schedulg() {}
第二個與第一個不同之處在于其不會等待上一次的任務執(zhí)行結(jié)束垫挨。@Async此注解使用在方法上韩肝,聲明此方法會在一個單獨的線程中執(zhí)行。不同于Scheduled注解棒拂,此注解可以接受參數(shù)伞梯。使用此注解的方法的返回類型可以是Void也可是返回值。但是返回值的類型必須是一個Future帚屉。
測試注解
@ContextConfiguration此注解使用在Class上谜诫,聲明測試使用的配置文件,此外攻旦,也可以指定加載上下文的類喻旷。此注解一般需要搭配SpringJUnit4ClassRunner使用。
@RunWith(SpringJUnit4ClassRunner.class)@ContextConfiguration(classes = SpringCoreConfig.class)public class UserServiceTest {}