Spring Boot 註解:全家桶快速通

  • 2019 年 10 月 4 日
  • 筆記

作者:譚朝紅

鏈接:https://www.ramostear.com/

1、Spring Web MVC 與Spring Bean 註解

1-1、Spring Web MVC 註解

1-1-1、@RequestMapping

@RequestMapping註解的主要用途是將Web請求與請求處理類中的方法進行映射。Spring MVC和Spring WebFlux都通過RquestMappingHandlerMapping和RequestMappingHndlerAdapter兩個類來提供對@RequestMapping註解的支援。

@RequestMapping註解對請求處理類中的請求處理方法進行標註;@RequestMapping註解擁有以下的六個配置屬性:

  • value:映射的請求URL或者其別名
  • method:兼容HTTP的方法名
  • params:根據HTTP參數的存在、預設或值對請求進行過濾
  • header:根據HTTP Header的存在、預設或值對請求進行過濾
  • consume:設定在HTTP請求正文中允許使用的媒體類型
  • product:在HTTP響應體中允許使用的媒體類型

提示:在使用@RequestMapping之前,請求處理類還需要使用@Controller或@RestController進行標記

下面是使用@RequestMapping的兩個示例:

@RequestMapping還可以對類進行標記,這樣類中的處理方法在映射請求路徑時,會自動將類上@RequestMapping設置的value拼接到方法中映射路徑之前,如下:

1-1-2、@RequestBody

@RequestBody在處理請求方法的參數列表中使用,它可以將請求主體中的參數綁定到一個對象中,請求主體參數是通過HttpMessageConverter傳遞的,根據請求主體中的參數名與對象的屬性名進行匹配並綁定值。此外,還可以通過@Valid註解對請求主體中的參數進行校驗。下面是一個使用@RequestBody的示例:

1-1-3、@GetMapping

@GetMapping註解用於處理HTTP GET請求,並將請求映射到具體的處理方法中。具體來說,@GetMapping是一個組合註解,它相當於是@RequestMapping(method=RequestMethod.GET)的快捷方式。下面是@GetMapping的一個使用示例:

1-1-4、@PostMapping

@PostMapping註解用於處理HTTP POST請求,並將請求映射到具體的處理方法中。@PostMapping與@GetMapping一樣,也是一個組合註解,它相當於是@RequestMapping(method=HttpMethod.POST)的快捷方式。下面是使用@PostMapping的一個示例:

1-1-5、@PutMapping

@PutMapping註解用於處理HTTP PUT請求,並將請求映射到具體的處理方法中,@PutMapping是一個組合註解,相當於是@RequestMapping(method=HttpMethod.PUT)的快捷方式。下面是使用@PutMapping的一個示例:

1-1-6、@DeleteMapping

@DeleteMapping註解用於處理HTTP DELETE請求,並將請求映射到刪除方法中。@DeleteMapping是一個組合註解,它相當於是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。下面是使用@DeleteMapping的一個示例:

1-1-7、@PatchMapping

@PatchMapping註解用於處理HTTP PATCH請求,並將請求映射到對應的處理方法中。@PatchMapping相當於是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。下面是一個簡單的示例:

1-1-8、@ControllerAdvice

@ControllerAdvice是@Component註解的一個延伸註解,Spring會自動掃描並檢測被@ControllerAdvice所標註的類。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute註解搭配使用,主要是用來處理控制器所拋出的異常資訊。首先,我們需要定義一個被@ControllerAdvice所標註的類,在該類中,定義一個用於處理具體異常的方法,並使用@ExceptionHandler註解進行標記。

此外,在有必要的時候,可以使用@InitBinder在類中進行全局的配置,還可以使用@ModelAttribute配置與視圖相關的參數。使用@ControllerAdvice註解,就可以快速的創建統一的,自定義的異常處理類。下面是一個使用@ControllerAdvice的示例程式碼:

1-1-9、@ResponseBody

@ResponseBody會自動將控制器中方法的返回值寫入到HTTP響應中。特別的,@ResponseBody註解只能用在被@Controller註解標記的類中。如果在被@RestController標記的類中,則方法不需要使用@ResponseBody註解進行標註。@RestController相當於是@Controller和@ResponseBody的組合註解。下面是使用該註解的一個示例:

1-1-10、@ExceptionHandler

@ExceptionHander註解用於標註處理特定類型異常類所拋出異常的方法。當控制器中的方法拋出異常時,Spring會自動捕獲異常,並將捕獲的異常資訊傳遞給被@ExceptionHandler標註的方法。下面是使用該註解的一個示例:

1-1-11、@ResponseStatus

@ResponseStatus註解可以標註請求處理方法。使用此註解,可以指定響應所需要的HTTP STATUS。特別地,我們可以使用HttpStauts類對該註解的value屬性進行賦值。下面是使用@ResponseStatus註解的一個示例:

1-1-12、@PathVariable

@PathVariable註解是將方法中的參數綁定到請求URI中的模板變數上。可以通過@RequestMapping註解來指定URI的模板變數,然後使用@PathVariable註解將方法中的參數綁定到模板變數上。特別地,@PathVariable註解允許我們使用value或name屬性來給參數取一個別名。下面是使用此註解的一個示例:

模板變數名需要使用「{ }」進行包裹,如果方法的參數名與URI模板變數名一致,則在@PathVariable中就可以省略別名的定義。下面是一個簡寫的示例:

提示:如果參數是一個非必須的,可選的項,則可以在@PathVariable中設置require = false

1-1-13、@RequestParam

@RequestParam註解用於將方法的參數與Web請求的傳遞的參數進行綁定。使用@RequestParam可以輕鬆的訪問HTTP請求參數的值。下面是使用該註解的程式碼示例:

該註解的其他屬性配置與@PathVariable的配置相同,特別的,如果傳遞的參數為空,還可以通過defaultValue設置一個默認值。示例程式碼如下:

1-1-14、@Controller

@Controller是@Component註解的一個延伸,Spring會自動掃描並配置被該註解標註的類。此註解用於標註Spring MVC的控制器。下面是使用此註解的示例程式碼:

1-1-15、@RestController

@RestController是在Spring 4.0開始引入的,這是一個特定的控制器註解。此註解相當於@Controller和@ResponseBody的快捷方式。當使用此註解時,不需要再在方法上使用@ResponseBody註解。下面是使用此註解的示例程式碼:

1-1-16、@ModelAttribute

通過此註解,可以通過模型索引名稱來訪問已經存在於控制器中的model。下面是使用此註解的一個簡單示例:

與@PathVariable和@RequestParam註解一樣,如果參數名與模型具有相同的名字,則不必指定索引名稱,簡寫示例如下:

特別地,如果使用@ModelAttribute對方法進行標註,Spring會將方法的返回值綁定到具體的Model上。示例如下:

在Spring調用具體的處理方法之前,被@ModelAttribute註解標註的所有方法都將被執行。(希望更加系統的學習springboot,可以在Java知音公眾號內回復「Springboot聚合」,獲取springboot教程)

1-1-17、@CrossOrigin

@CrossOrigin註解將為請求處理類或請求處理方法提供跨域調用支援。如果我們將此註解標註類,那麼類中的所有方法都將獲得支援跨域的能力。使用此註解的好處是可以微調跨域行為。使用此註解的示例如下:

1-1-18、@InitBinder

@InitBinder註解用於標註初始化WebDataBinider的方法,該方法用於對Http請求傳遞的表單數據進行處理,如時間格式化、字元串處理等。下面是使用此註解的示例:

1-2、Spring Bean 註解

在本小節中,主要列舉與Spring Bean相關的4個註解以及它們的使用方式。

1-2-1、@ComponentScan

@ComponentScan註解用於配置Spring需要掃描的被組件註解注釋的類所在的包。可以通過配置其basePackages屬性或者value屬性來配置需要掃描的包路徑。value屬性是basePackages的別名。此註解的用法如下:

1-2-2、@Component

@Component註解用於標註一個普通的組件類,它沒有明確的業務範圍,只是通知Spring被此註解的類需要被納入到Spring Bean容器中並進行管理。此註解的使用示例如下:

1-2-3、@Service

@Service註解是@Component的一個延伸(特例),它用於標註業務邏輯類。與@Component註解一樣,被此註解標註的類,會自動被Spring所管理。下面是使用@Service註解的示例:

1-2-4、@Repository

@Repository註解也是@Component註解的延伸,與@Component註解一樣,被此註解標註的類會被Spring自動管理起來,@Repository註解用於標註DAO層的數據持久化類。此註解的用法如下:


2、Spring Dependency Inject 與 Bean Scops註解

2-1、Spring DI註解

2-1-1、@DependsOn

@DependsOn註解可以配置Spring IoC容器在初始化一個Bean之前,先初始化其他的Bean對象。下面是此註解使用示例程式碼:

2-1-2、@Bean

@Bean註解主要的作用是告知Spring,被此註解所標註的類將需要納入到Bean管理工廠中。@Bean註解的用法很簡單,在這裡,著重介紹@Bean註解中initMethod和destroyMethod的用法。示例如下:

2-2、Scops註解

2-2-1、@Scope

@Scope註解可以用來定義@Component標註的類的作用範圍以及@Bean所標記的類的作用範圍。@Scope所限定的作用範圍有:singleton、prototype、request、session、globalSession或者其他的自定義範圍。(希望更加系統的學習springboot,可以在Java知音公眾號內回復「Springboot聚合」,獲取springboot教程)

這裡以prototype為例子進行講解。當一個Spring Bean被聲明為prototype(原型模式)時,在每次需要使用到該類的時候,Spring IoC容器都會初始化一個新的改類的實例。在定義一個Bean時,可以設置Bean的scope屬性為prototype:scope=「prototype」,也可以使用@Scope註解設置,如下:

@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)

下面將給出兩種不同的方式來使用@Scope註解,示例程式碼如下:

2-2-2、@Scope 單例模式

當@Scope的作用範圍設置成Singleton時,被此註解所標註的類只會被Spring IoC容器初始化一次。在默認情況下,Spring IoC容器所初始化的類實例都為singleton。同樣的原理,此情形也有兩種配置方式,示例程式碼如下:


3、容器配置註解

3-1、@Autowired

@Autowired註解用於標記Spring將要解析和注入的依賴項。此註解可以作用在構造函數、欄位和setter方法上。

3-1-1、作用於構造函數

下面是@Autowired註解標註構造函數的使用示例:

3-1-2、作用於setter方法

下面是@Autowired註解標註setter方法的示例程式碼:

3-1-3、作用於欄位

@Autowired註解標註欄位是最簡單的,只需要在對應的欄位上加入此註解即可,示例程式碼如下:

3-2、@Primary

當系統中需要配置多個具有相同類型的bean時,@Primary可以定義這些Bean的優先順序。下面將給出一個實例程式碼來說明這一特性:

輸出結果:

this is send DingDing method message.

3-3、@PostConstruct與@PreDestroy

值得注意的是,這兩個註解不屬於Spring,它們是源於JSR-250中的兩個註解,位於common-annotations.jar中。@PostConstruct註解用於標註在Bean被Spring初始化之前需要執行的方法。@PreDestroy註解用於標註Bean被銷毀前需要執行的方法。下面是具體的示例程式碼:

3-4、@Qualifier

當系統中存在同一類型的多個Bean時,@Autowired在進行依賴注入的時候就不知道該選擇哪一個實現類進行注入。此時,我們可以使用@Qualifier註解來微調,幫助@Autowired選擇正確的依賴項。下面是一個關於此註解的程式碼示例:


4、Spring Boot註解

4-1、@SpringBootApplication

@SpringBootApplication註解是一個快捷的配置註解,在被它標註的類中,可以定義一個或多個Bean,並自動觸發自動配置Bean和自動掃描組件。此註解相當於@Configuration、@EnableAutoConfiguration和@ComponentScan的組合。在Spring Boot應用程式的主類中,就使用了此註解。示例程式碼如下:

@SpringBootApplication  public class Application{      public static void main(String [] args){          SpringApplication.run(Application.class,args);      }  }

4-2、@EnableAutoConfiguration

@EnableAutoConfiguration註解用於通知Spring,根據當前類路徑下引入的依賴包,自動配置與這些依賴包相關的配置項。

4-3、@ConditionalOnClass與@ConditionalOnMissingClass

這兩個註解屬於類條件註解,它們根據是否存在某個類作為判斷依據來決定是否要執行某些配置。下面是一個簡單的示例程式碼:

@Configuration  @ConditionalOnClass(DataSource.class)  class MySQLAutoConfiguration {      //...  }

4-4、@ConditionalOnBean與@ConditionalOnMissingBean

這兩個註解屬於對象條件註解,根據是否存在某個對象作為依據來決定是否要執行某些配置方法。示例程式碼如下:

@Bean  @ConditionalOnBean(name="dataSource")  LocalContainerEntityManagerFactoryBean entityManagerFactory(){      //...  }  @Bean  @ConditionalOnMissingBean  public MyBean myBean(){      //...  }

4-5、@ConditionalOnProperty

@ConditionalOnProperty註解會根據Spring配置文件中的配置項是否滿足配置要求,從而決定是否要執行被其標註的方法。示例程式碼如下:

@Bean  @ConditionalOnProperty(name="alipay",havingValue="on")  Alipay alipay(){      return new Alipay();  }

4-6、@ConditionalOnResource

此註解用於檢測當某個配置文件存在使,則觸發被其標註的方法,下面是使用此註解的程式碼示例:

@ConditionalOnResource(resources = "classpath:website.properties")  Properties addWebsiteProperties(){      //...  }

4-7、@ConditionalOnWebApplication與@ConditionalOnNotWebApplication

這兩個註解用於判斷當前的應用程式是否是Web應用程式。如果當前應用是Web應用程式,則使用Spring WebApplicationContext,並定義其會話的生命周期。下面是一個簡單的示例:

@ConditionalOnWebApplication  HealthCheckController healthCheckController(){      //...  }

4-8、@ConditionalExpression

此註解可以讓我們控制更細粒度的基於表達式的配置條件限制。當表達式滿足某個條件或者表達式為真的時候,將會執行被此註解標註的方法。

@Bean  @ConditionalException("${localstore} && ${local == 'true'}")  LocalFileStore store(){      //...  }

4-9、@Conditional

@Conditional註解可以控制更為複雜的配置條件。在Spring內置的條件控制註解不滿足應用需求的時候,可以使用此註解定義自定義的控制條件,以達到自定義的要求。下面是使用該註解的簡單示例:

@Conditioanl(CustomConditioanl.class)  CustomProperties addCustomProperties(){      //...  }

總結

本次總結了Spring Boot中常見的各類型註解的使用方式,讓大家能夠統一的對Spring Boot常用註解有一個全面的了解。由於篇幅的原因,關於Spring Boot不常用的一些註解,將在下一次分享中進行補充和說明。