Spring常用Annotation簡介

tinyking發表於2018-03-15
Spring

Annotation介紹

Spring專案開發常用Annotation

Java

@Resource

Resource 註釋標記應用程式所需的資源。此註釋可以應用於應用程式元件類，或者該元件類的欄位或方法。如果將該註釋應用於一個欄位或方法，那麼初始化應用程式元件時容器將把所請求資源的一個例項注入其中。如果將該註釋應用於元件類，則該註釋將宣告一個應用程式在執行時將查詢的資源。

即使此註釋沒有被標記為Inherited，部署工具仍然需要檢查任意元件類的所有超類，以發現這些超類中所有使用此註釋的地方。所有此類註釋例項都指定了應用程式元件所需的資源。注意，此註釋可能出現在超類的 private 欄位和方法上；在這種情況下容器也需要執行注入操作。

在Spring中使用該註解，表示按name注入。

Spring

@Required

此註解用於JavaBean的setter方法上，表示此屬性是必須的，必須在配置階段注入，否則會丟擲BeanInitializationException。

@Autowired

此註解用於構造方法、欄位、setter方法和註解型別。顯示宣告依賴，根據type來autowiring, 預設注入是必須的。

@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Autowired {

    /**
     * Declares whether the annotated dependency is required.
     * <p>Defaults to {@code true}.
     */
    boolean required() default true;

}

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

@Componentpublic class User {
    private Address address;
    public User(Address address) {
        this.address=address;     
    }
    
}

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

@Qualifier

此註解是和@Autowired一起使用的。使用此註解可以讓你對注入的過程有更多的控制，用@Qulifier指定要繫結的bean的名稱。當一個type有多個bean時，使用@Autowired的時候需要配合上@Qulifier才能正常。

@Componentpublic class User {
    @Autowired    
    @Qualifier("address1")    
    private Address address;    
    
    ...
    
}

@Configuration

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

@Configuartion
public class SpringCoreConfig {
    @Bean    
    public AdminUser adminUser() {
        AdminUser adminUser = new AdminUser();
        return adminUser;    
        
    }
    
}

@Lazy

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

@Value

此註解使用在欄位、構造器引數和方法引數上。@Value可以指定屬性取值的表示式，支援通過#{}使用SpringEL來取值，也支援使用${}來將屬性來源中(Properties檔案呢、本地環境變數、系統屬性等)的值注入到bean的屬性中。此註解的注入時發生在AutowiredAnnotationBeanPostProcessor中。

Stereotype註解

@Component

此註解使用在class上來宣告一個Spring元件(Bean), 將其加入到應用上下文中。

@Controller

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

@Service

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

@Repository

此類使用在class上宣告此類用於訪問資料庫，一般作為DAO的角色。
此註解有自動翻譯的特性，例如：當此種component丟擲了一個異常，那麼會有一個handler來處理此異常，無需使用try-catch塊。

Spring Boot註解

@EnableAutoConfiguration

此註解通常被用在主應用class上，告訴Spring Boot 自動基於當前包新增Bean、對bean的屬性進行設定等。

@SpringBootApplication

此註解用在Spring Boot專案的應用主類上（此類需要在base package中）。使用了此註解的類首先會讓Spring Boot啟動對base package下以及其sub-pacakages的類進行component scan。

此註解同時新增了以下幾個註解：

  • @Configuration
  • @EnableAutoConfiguration
  • @ComponentScan

Spring MVC和REST註解

@Controller

上述已經提到過此註解。

@RequestMapping

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

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

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

  • @GetMapping
  • @PostMapping
  • @PutMapping
  • @PatchMapping
  • @DeleteMapping

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

@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" />

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

@Configurationpublic 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}")
public String execute(@PathVariable("uid") String uid){
}

@RequestAttribute

此註解用在請求handler方法的引數上，用於將web請求中的屬性(requst 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, and @ModelAttribute處理。

@RestController

此註解用於class上，宣告此controller返回的不是一個檢視而是一個領域物件。其同時引入了@Controller and @ResponseBody兩個註解。

@RestControllerAdvice

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

@SessionAttribute

此註解用於方法的引數上，用於將session中的屬性繫結到引數。

@SessionAttributes

此註解用於type級別，用於將JavaBean物件儲存到session中。一般和@ModelAttribute註解一起使用。如下：

@ModelAttribute("user")
public PUser getUser() {}

// controller和上面的程式碼在同一controller中
@Controller
@SessionAttributes(value = "user", types = {
    User.class
})
public class UserController {}

資料訪問註解

@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 {}

相關文章