鑽石舞台

隨着技術的更新迭代，Java5.0開始支持註解。而作為java中的領軍框架spring，自從更新了2.5版本之後也開始慢慢捨棄xml配置，更多使用註解來控制spring框架。

而spring的的註解那麼多，可能做java很多年，都用不上。這裡按照類型總結了這7種最常用的註解。

一. 核心註解

@Required此註解用於bean的setter方法上。表示此屬性是必須的，必須在配置階段注入，否則會拋出BeanInitializationExcepion。

@Autowired此註解用於bean的field、setter方法以及構造方法上，顯式地聲明依賴。根據type來autowiring。

當在field上使用此註解，並且使用屬性來傳遞值時，Spring會自動把值賦給此field。也可以將此註解用於私有屬性(不推薦)，如下。

@Component

public class User {

@Autowired

private Address address;

}

最經常的用法是將此註解用於settter上，這樣可以在setter方法中添加自定義代碼。如下：

@Component

public class User {

private Address address;

@AutoWired

public setAddress(Address address) {

// custom code

this.address=address;

}

}

當在構造方法上使用此註解的時候，需要注意的一點就是一個類中只允許有一個構造方法使用此註解。此外，在Spring4.3後，如果一個類僅僅只有一個構造方法，那麼即使不使用此註解，那麼Spring也會自動注入相關的bean。如下：

@Component

public class User {

private Address address;

public User(Address address) {

this.address=address;

}

}

<bean id="user" class="xx.User"/>

@Qualifier此註解是和@Autowired一起使用的。使用此註解可以讓你對注入的過程有更多的控制。

@Qualifier可以被用在單個構造器或者方法的參數上。當上下文有幾個相同類型的bean, 使用@Autowired則無法區分要綁定的bean，此時可以使用@Qualifier來指定名稱。

@Component

public class User {

@Autowired

@Qualifier("address1")

private Address address;

...

}

@Configuration此註解用在class上來定義bean。其作用和xml配置文件相同，表示此bean是一個Spring配置。此外，此類可以使用@Bean註解來初始化定義bean。

@Configuartion

public class SpringCoreConfig {

@Bean

public AdminUser adminUser() {

AdminUser adminUser = new AdminUser();

return adminUser;

}

}

@ComponentScan此註解一般和@Configuration註解一起使用，指定Spring掃描註解的package。如果沒有指定包，那麼默認會掃描此配置類所在的package。

@Lazy此註解使用在Spring的組件類上。默認的，Spring中Bean的依賴一開始就被創建和配置。如果想要延遲初始化一個bean，那麼可以在此類上使用Lazy註解，表示此bean只有在第一次被使用的時候才會被創建和初始化。此註解也可以使用在被@Configuration註解的類上，表示其中所有被@Bean註解的方法都會延遲初始化。

@Value此註解使用在字段、構造器參數和方法參數上。@Value可以指定屬性取值的表達式，支持通過#{}使用SpringEL來取值，也支持使用${}來將屬性來源中(Properties文件、本地環境變量、系統屬性等)的值注入到bean的屬性中。此註解值的注入發生在AutowiredAnnotationBeanPostProcessor類中。

二. Spring MVC和REST註解

@Controller此註解使用在class上聲明此類是一個Spring controller，是@Component註解的一種具體形式。

@RequestMapping此註解可以用在class和method上，用來映射web請求到某一個handler類或者handler方法上。當此註解用在Class上時，就創造了一個基礎url，其所有的方法上的@RequestMapping都是在此url之上的。

可以使用其method屬性來限制請求匹配的http method。

@Controller

@RequestMapping("/users")

public class UserController {

@RequestMapping(method = RequestMethod.GET)

public String getUserList() {

return "users";

}

}

此外，Spring4.3之後引入了一系列@RequestMapping的變種。如下：

@GetMapping

@PostMapping

@PutMapping

@PatchMapping

@DeleteMapping

分別對應了相應method的RequestMapping配置。

@CookieValue此註解用在@RequestMapping聲明的方法的參數上，可以把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的初始化(綁定請求參數到JavaBean上的DataBinder)。在controller上使用此註解可以自定義請求參數的綁定。

@MatrixVariable此註解使用在請求handler方法的參數上，Spring可以注入matrix url中相關的值。這裡的矩陣變量可以出現在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" />

註解配置則需要如下開啟：

@Configuration

public class WebConfig extends WebMvcConfigurerAdapter {

@Override

public void configurePathMatch(PathMatchConfigurer configurer) {

UrlPathHelper urlPathHelper = new UrlPathHelper();

urlPathHelper.setRemoveSemicolonContent(false);

configurer.setUrlPathHelper(urlPathHelper);

}

}

@PathVariable此註解使用在請求handler方法的參數上。@RequestMapping可以定義動態路徑，如:

@RequestMapping("/users/{uid}")

可以使用@PathVariable將路徑中的參數綁定到請求方法參數上。

@RequestMapping("/users/{uid}")

public String execute(@PathVariable("uid") String uid){

}

@RequestAttribute

此註解用在請求handler方法的參數上，用於將web請求中的屬性(request attributes，是服務器放入的屬性值)綁定到方法參數上。

@RequestBody此註解用在請求handler方法的參數上，用於將http請求的Body映射綁定到此參數上。HttpMessageConverter負責將對象轉換為http請求。

@RequestHeader此註解用在請求handler方法的參數上，用於將http請求頭部的值綁定到參數上。

@RequestParam此註解用在請求handler方法的參數上，用於將http請求參數的值綁定到參數上。

@RequestPart此註解用在請求handler方法的參數上，用於將文件之類的multipart綁定到參數上。

@ResponseBody此註解用在請求handler方法上。和@RequestBody作用類似，用於將方法的返回對象直接輸出到http響應中。

@ResponseStatus此註解用於方法和exception類上，聲明此方法或者異常類返回的http狀態碼。可以在Controller上使用此註解，這樣所有的@RequestMapping都會繼承。

@ControllerAdvice此註解用於class上。前面說過可以對每一個controller聲明一個ExceptionMethod。這裡可以使用@ControllerAdvice來聲明一個類來統一對所有@RequestMapping方法來做@ExceptionHandler、@InitBinder以及@ModelAttribute處理。

@RestController此註解用於class上，聲明此controller返回的不是一個視圖而是一個領域對象。其同時引入了@Controller和@ResponseBody兩個註解。

@RestControllerAdvice此註解用於class上，同時引入了@ControllerAdvice和@ResponseBody兩個註解。

@SessionAttribute此註解用於方法的參數上，用於將session中的屬性綁定到參數。

@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。

此註解同時添加了以下幾個註解：

@Configuration

@EnableAutoConfiguration

@ComponentScan

四. Stereotype註解

@Component此註解使用在class上來聲明一個Spring組件(Bean), 將其加入到應用上下文中。

@Controller前文已經提到過

@Service此註解使用在class上，聲明此類是一個服務類，執行業務邏輯、計算、調用內部api等。是@Component註解的一種具體形式。

@Repository此類使用在class上聲明此類用於訪問數據庫，一般作為DAO的角色。

此註解有自動翻譯的特性，例如：當此種component拋出了一個異常，那麼會有一個handler來處理此異常，無需使用try-catch塊。

五. 數據訪問註解

@Transactional此註解使用在接口定義、接口中的方法、類定義或者類中的public方法上。需要注意的是此註解並不激活事務行為，它僅僅是一個元數據，會被一些運行時基礎設施來消費。

六. 任務執行、調度註解

@Scheduled此註解使用在方法上，聲明此方法被定時調度。使用了此註解的方法返回類型需要是Void，並且不能接受任何參數。

@Scheduled(fixedDelay=1000)

public void schedule() {

}

@Scheduled(fixedRate=1000)

public void schedulg() {

}

第二個與第一個不同之處在於其不會等待上一次的任務執行結束。

@Async此註解使用在方法上，聲明此方法會在一個單獨的線程中執行。不同於Scheduled註解，此註解可以接受參數。

使用此註解的方法的返回類型可以是Void也可是返回值。但是返回值的類型必須是一個Future。

七. 測試註解

@ContextConfiguration此註解使用在Class上，聲明測試使用的配置文件，此外，也可以指定加載上下文的類。

此註解一般需要搭配SpringJUnit4ClassRunner使用。

@RunWith(SpringJUnit4ClassRunner.class)

@ContextConfiguration(classes = SpringCoreConfig.class)

public class UserServiceTest {

}

來源：blog.csdn.net/Lubanjava/article/details/100579554

掃二維碼，加我微信，回覆：40

注意，不要亂回復

沒錯，不是機器人

記得一定要等待，等待才有好東西