1、Spring Web MVC 與 Spring Bean 注解
1-1、Spring Web MVC 注解
1-1-1、@RequestMapping
@RequestMapping 注解的主要用途是將 Web 請(qǐng)求與請(qǐng)求處理類中的方法進(jìn)行映射。Spring MVC 和 Spring WebFlux 都通過 RquestMappingHandlerMapping 和 RequestMappingHndlerAdapter 兩個(gè)類來提供對(duì) @RequestMapping 注解的支持。
@RequestMapping 注解對(duì)請(qǐng)求處理類中的請(qǐng)求處理方法進(jìn)行標(biāo)注；@RequestMapping 注解擁有以下的六個(gè)配置屬性：
value: 映射的請(qǐng)求 URL 或者其別名
method: 兼容 HTTP 的方法名
params: 根據(jù) HTTP 參數(shù)的存在、缺省或值對(duì)請(qǐng)求進(jìn)行過濾
header: 根據(jù) HTTP Header 的存在、缺省或值對(duì)請(qǐng)求進(jìn)行過濾
consume: 設(shè)定在 HTTP 請(qǐng)求正文中允許使用的媒體類型
product: 在 HTTP 響應(yīng)體中允許使用的媒體類型
提示：在使用 @RequestMapping 之前，請(qǐng)求處理類還需要使用 @Controller 或 @RestController 進(jìn)行標(biāo)記
下面是使用 @RequestMapping 的兩個(gè)示例：
@RequestMapping 還可以對(duì)類進(jìn)行標(biāo)記，這樣類中的處理方法在映射請(qǐng)求路徑時(shí)，會(huì)自動(dòng)將類上 @RequestMapping 設(shè)置的 value 拼接到方法中映射路徑之前，如下：
1-1-2、@RequestBody
@RequestBody 在處理請(qǐng)求方法的參數(shù)列表中使用，它可以將請(qǐng)求主體中的參數(shù)綁定到一個(gè)對(duì)象中，請(qǐng)求主體參數(shù)是通過 HttpMessageConverter 傳遞的，根據(jù)請(qǐng)求主體中的參數(shù)名與對(duì)象的屬性名進(jìn)行匹配并綁定值。此外，還可以通過 @Valid 注解對(duì)請(qǐng)求主體中的參數(shù)進(jìn)行校驗(yàn)。下面是一個(gè)使用 @RequestBody 的示例：
1-1-3、@GetMapping
@GetMapping 注解用于處理 HTTP GET 請(qǐng)求，并將請(qǐng)求映射到具體的處理方法中。具體來說，@GetMapping 是一個(gè)組合注解，它相當(dāng)于是 @RequestMapping(method=RequestMethod.GET) 的快捷方式。下面是 @GetMapping 的一個(gè)使用示例：
1-1-4、@PostMapping
@PostMapping 注解用于處理 HTTP POST 請(qǐng)求，并將請(qǐng)求映射到具體的處理方法中。@PostMapping 與 @GetMapping 一樣，也是一個(gè)組合注解，它相當(dāng)于是 @RequestMapping(method=HttpMethod.POST) 的快捷方式。下面是使用 @PostMapping 的一個(gè)示例：
1-1-5、@PutMapping
@PutMapping 注解用于處理 HTTP PUT 請(qǐng)求，并將請(qǐng)求映射到具體的處理方法中，@PutMapping 是一個(gè)組合注解，相當(dāng)于是 @RequestMapping(method=HttpMethod.PUT) 的快捷方式。下面是使用 @PutMapping 的一個(gè)示例：
1-1-6、@DeleteMapping
@DeleteMapping 注解用于處理 HTTP DELETE 請(qǐng)求，并將請(qǐng)求映射到刪除方法中。@DeleteMapping 是一個(gè)組合注解，它相當(dāng)于是 @RequestMapping(method=HttpMethod.DELETE) 的快捷方式。下面是使用 @DeleteMapping 的一個(gè)示例：
1-1-7、@PatchMapping
@PatchMapping 注解用于處理 HTTP PATCH 請(qǐng)求，并將請(qǐng)求映射到對(duì)應(yīng)的處理方法中。@PatchMapping 相當(dāng)于是 @RequestMapping(method=HttpMethod.PATCH) 的快捷方式。下面是一個(gè)簡單的示例：
1-1-8、@ControllerAdvice
@ControllerAdvice 是 @Component 注解的一個(gè)延伸注解，Spring 會(huì)自動(dòng)掃描并檢測(cè)被 @ControllerAdvice 所標(biāo)注的類。@ControllerAdvice 需要和 @ExceptionHandler、@InitBinder 以及 @ModelAttribute 注解搭配使用，主要是用來處理控制器所拋出的異常信息。首先，我們需要定義一個(gè)被 @ControllerAdvice 所標(biāo)注的類，在該類中，定義一個(gè)用于處理具體異常的方法，并使用 @ExceptionHandler 注解進(jìn)行標(biāo)記。
此外，在有必要的時(shí)候，可以使用 @InitBinder 在類中進(jìn)行全局的配置，還可以使用 @ModelAttribute 配置與視圖相關(guān)的參數(shù)。使用 @ControllerAdvice 注解，就可以快速的創(chuàng)建統(tǒng)一的，自定義的異常處理類。下面是一個(gè)使用 @ControllerAdvice 的示例代碼：
1-1-9、@ResponseBody
@ResponseBody 會(huì)自動(dòng)將控制器中方法的返回值寫入到 HTTP 響應(yīng)中。特別的，@ResponseBody 注解只能用在被 @Controller 注解標(biāo)記的類中。如果在被 @RestController 標(biāo)記的類中，則方法不需要使用 @ResponseBody 注解進(jìn)行標(biāo)注。@RestController 相當(dāng)于是 @Controller 和 @ResponseBody 的組合注解。下面是使用該注解的一個(gè)示例：
1-1-10、@ExceptionHandler
@ExceptionHander 注解用于標(biāo)注處理特定類型異常類所拋出異常的方法。當(dāng)控制器中的方法拋出異常時(shí)，Spring 會(huì)自動(dòng)捕獲異常，并將捕獲的異常信息傳遞給被 @ExceptionHandler 標(biāo)注的方法。下面是使用該注解的一個(gè)示例：
1-1-11、@ResponseStatus
@ResponseStatus 注解可以標(biāo)注請(qǐng)求處理方法。使用此注解，可以指定響應(yīng)所需要的 HTTP STATUS。特別地，我們可以使用 HttpStauts 類對(duì)該注解的 value 屬性進(jìn)行賦值。下面是使用 @ResponseStatus 注解的一個(gè)示例：
1-1-12、@PathVariable
@PathVariable 注解是將方法中的參數(shù)綁定到請(qǐng)求 URI 中的模板變量上?？梢酝ㄟ^ @RequestMapping 注解來指定 URI 的模板變量，然后使用 @PathVariable 注解將方法中的參數(shù)綁定到模板變量上。特別地，@PathVariable 注解允許我們使用 value 或 name 屬性來給參數(shù)取一個(gè)別名。下面是使用此注解的一個(gè)示例：
模板變量名需要使用 “{}” 進(jìn)行包裹，如果方法的參數(shù)名與 URI 模板變量名一致，則在 @PathVariable 中就可以省略別名的定義。下面是一個(gè)簡寫的示例：
提示：如果參數(shù)是一個(gè)非必須的，可選的項(xiàng)，則可以在 @PathVariable 中設(shè)置 require = false
1-1-13、@RequestParam
@RequestParam 注解用于將方法的參數(shù)與 Web 請(qǐng)求的傳遞的參數(shù)進(jìn)行綁定。使用 @RequestParam 可以輕松的訪問 HTTP 請(qǐng)求參數(shù)的值。下面是使用該注解的代碼示例：
該注解的其他屬性配置與 @PathVariable 的配置相同，特別的，如果傳遞的參數(shù)為空，還可以通過 defaultValue 設(shè)置一個(gè)默認(rèn)值。示例代碼如下：
1-1-14、@Controller
@Controller 是 @Component 注解的一個(gè)延伸，Spring 會(huì)自動(dòng)掃描并配置被該注解標(biāo)注的類。此注解用于標(biāo)注 Spring MVC 的控制器。下面是使用此注解的示例代碼：
1-1-15、@RestController
@RestController 是在 Spring 4.0 開始引入的，這是一個(gè)特定的控制器注解。此注解相當(dāng)于 @Controller 和 @ResponseBody 的快捷方式。當(dāng)使用此注解時(shí)，不需要再在方法上使用 @ResponseBody 注解。下面是使用此注解的示例代碼：
1-1-16、@ModelAttribute
通過此注解，可以通過模型索引名稱來訪問已經(jīng)存在于控制器中的 model。下面是使用此注解的一個(gè)簡單示例：
與 @PathVariable 和 @RequestParam 注解一樣，如果參數(shù)名與模型具有相同的名字，則不必指定索引名稱，簡寫示例如下：
特別地，如果使用 @ModelAttribute 對(duì)方法進(jìn)行標(biāo)注，Spring 會(huì)將方法的返回值綁定到具體的 Model 上。示例如下：
在 Spring 調(diào)用具體的處理方法之前，被 @ModelAttribute 注解標(biāo)注的所有方法都將被執(zhí)行。（希望更加系統(tǒng)的學(xué)習(xí) springboot，可以在 Java 知音公眾號(hào)內(nèi)回復(fù) “Springboot 聚合”，獲取 springboot 教程）
1-1-17、@CrossOrigin
@CrossOrigin 注解將為請(qǐng)求處理類或請(qǐng)求處理方法提供跨域調(diào)用支持。如果我們將此注解標(biāo)注類，那么類中的所有方法都將獲得支持跨域的能力。使用此注解的好處是可以微調(diào)跨域行為。使用此注解的示例如下：
1-1-18、@InitBinder
@InitBinder 注解用于標(biāo)注初始化 WebDataBinider 的方法，該方法用于對(duì) Http 請(qǐng)求傳遞的表單數(shù)據(jù)進(jìn)行處理，如時(shí)間格式化、字符串處理等。下面是使用此注解的示例：
1-2、Spring Bean 注解
在本小節(jié)中，主要列舉與 Spring Bean 相關(guān)的 4 個(gè)注解以及它們的使用方式。
1-2-1、@ComponentScan
@ComponentScan 注解用于配置 Spring 需要掃描的被組件注解注釋的類所在的包?？梢酝ㄟ^配置其 basePackages 屬性或者 value 屬性來配置需要掃描的包路徑。value 屬性是 basePackages 的別名。此注解的用法如下：
1-2-2、@Component
@Component 注解用于標(biāo)注一個(gè)普通的組件類，它沒有明確的業(yè)務(wù)范圍，只是通知 Spring 被此注解的類需要被納入到 Spring Bean 容器中并進(jìn)行管理。此注解的使用示例如下：
1-2-3、@Service
@Service 注解是 @Component 的一個(gè)延伸（特例），它用于標(biāo)注業(yè)務(wù)邏輯類。與 @Component 注解一樣，被此注解標(biāo)注的類，會(huì)自動(dòng)被 Spring 所管理。下面是使用 @Service 注解的示例：
1-2-4、@Repository
@Repository 注解也是 @Component 注解的延伸，與 @Component 注解一樣，被此注解標(biāo)注的類會(huì)被 Spring 自動(dòng)管理起來，@Repository 注解用于標(biāo)注 DAO 層的數(shù)據(jù)持久化類。此注解的用法如下：
2、Spring Dependency Inject 與 Bean Scops 注解
2-1、Spring DI 注解
2-1-1、@DependsOn
@DependsOn 注解可以配置 Spring IoC 容器在初始化一個(gè) Bean 之前，先初始化其他的 Bean 對(duì)象。下面是此注解使用示例代碼：
2-1-2、@Bean
@Bean 注解主要的作用是告知 Spring，被此注解所標(biāo)注的類將需要納入到 Bean 管理工廠中。@Bean 注解的用法很簡單，在這里，著重介紹 @Bean 注解中 initMethod 和 destroyMethod 的用法。示例如下：
2-2、Scops 注解
2-2-1、@Scope
@Scope 注解可以用來定義 @Component 標(biāo)注的類的作用范圍以及 @Bean 所標(biāo)記的類的作用范圍。@Scope 所限定的作用范圍有：singleton、prototype、request、session、globalSession 或者其他的自定義范圍。（希望更加系統(tǒng)的學(xué)習(xí) springboot，可以在 Java 知音公眾號(hào)內(nèi)回復(fù) “Springboot 聚合”，獲取 springboot 教程）
這里以 prototype 為例子進(jìn)行講解。當(dāng)一個(gè) Spring Bean 被聲明為 prototype（原型模式）時(shí)，在每次需要使用到該類的時(shí)候，Spring IoC 容器都會(huì)初始化一個(gè)新的改類的實(shí)例。在定義一個(gè) Bean 時(shí)，可以設(shè)置 Bean 的 scope 屬性為 prototype：scope=“prototype”, 也可以使用 @Scope 注解設(shè)置，如下：
@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)
下面將給出兩種不同的方式來使用 @Scope 注解，示例代碼如下：
2-2-2、@Scope 單例模式
當(dāng) @Scope 的作用范圍設(shè)置成 Singleton 時(shí)，被此注解所標(biāo)注的類只會(huì)被 Spring IoC 容器初始化一次。在默認(rèn)情況下，Spring IoC 容器所初始化的類實(shí)例都為 singleton。同樣的原理，此情形也有兩種配置方式，示例代碼如下：
3、容器配置注解
3-1、@Autowired
@Autowired 注解用于標(biāo)記 Spring 將要解析和注入的依賴項(xiàng)。此注解可以作用在構(gòu)造函數(shù)、字段和 setter 方法上。
3-1-1、作用于構(gòu)造函數(shù)
下面是 @Autowired 注解標(biāo)注構(gòu)造函數(shù)的使用示例：
3-1-2、作用于 setter 方法
下面是 @Autowired 注解標(biāo)注 setter 方法的示例代碼：
3-1-3、作用于字段
@Autowired 注解標(biāo)注字段是最簡單的，只需要在對(duì)應(yīng)的字段上加入此注解即可，示例代碼如下：
3-2、@Primary
當(dāng)系統(tǒng)中需要配置多個(gè)具有相同類型的 bean 時(shí)，@Primary 可以定義這些 Bean 的優(yōu)先級(jí)。下面將給出一個(gè)實(shí)例代碼來說明這一特性：
輸出結(jié)果：
this is send DingDing method message.
3-3、@PostConstruct 與 @PreDestroy
值得注意的是，這兩個(gè)注解不屬于 Spring, 它們是源于 JSR-250 中的兩個(gè)注解，位于 common-annotations.jar 中。@PostConstruct 注解用于標(biāo)注在 Bean 被 Spring 初始化之前需要執(zhí)行的方法。@PreDestroy 注解用于標(biāo)注 Bean 被銷毀前需要執(zhí)行的方法。下面是具體的示例代碼：
3-4、@Qualifier
當(dāng)系統(tǒng)中存在同一類型的多個(gè) Bean 時(shí)，@Autowired 在進(jìn)行依賴注入的時(shí)候就不知道該選擇哪一個(gè)實(shí)現(xiàn)類進(jìn)行注入。此時(shí)，我們可以使用 @Qualifier 注解來微調(diào)，幫助 @Autowired 選擇正確的依賴項(xiàng)。下面是一個(gè)關(guān)于此注解的代碼示例：
4、Spring Boot 注解
4-1、@SpringBootApplication
@SpringBootApplication 注解是一個(gè)快捷的配置注解，在被它標(biāo)注的類中，可以定義一個(gè)或多個(gè) Bean，并自動(dòng)觸發(fā)自動(dòng)配置 Bean 和自動(dòng)掃描組件。此注解相當(dāng)于 @Configuration、@EnableAutoConfiguration 和 @ComponentScan 的組合。在 Spring Boot 應(yīng)用程序的主類中，就使用了此注解。示例代碼如下：
@SpringBootApplication
public class Application{
public static void main(String [] args){
SpringApplication.run(Application.class,args);
}
}
4-2、@EnableAutoConfiguration
@EnableAutoConfiguration 注解用于通知 Spring，根據(jù)當(dāng)前類路徑下引入的依賴包，自動(dòng)配置與這些依賴包相關(guān)的配置項(xiàng)。
4-3、@ConditionalOnClass 與 @ConditionalOnMissingClass
這兩個(gè)注解屬于類條件注解，它們根據(jù)是否存在某個(gè)類作為判斷依據(jù)來決定是否要執(zhí)行某些配置。下面是一個(gè)簡單的示例代碼：
@Configuration
@ConditionalOnClass(DataSource.class)
class MySQLAutoConfiguration {
//...
}
4-4、@ConditionalOnBean 與 @ConditionalOnMissingBean
這兩個(gè)注解屬于對(duì)象條件注解，根據(jù)是否存在某個(gè)對(duì)象作為依據(jù)來決定是否要執(zhí)行某些配置方法。示例代碼如下：
@Bean
@ConditionalOnBean(name="dataSource")
LocalContainerEntityManagerFactoryBean entityManagerFactory(){
//...
}
@Bean
@ConditionalOnMissingBean
public MyBean myBean(){
//...
}
4-5、@ConditionalOnProperty
@ConditionalOnProperty 注解會(huì)根據(jù) Spring 配置文件中的配置項(xiàng)是否滿足配置要求，從而決定是否要執(zhí)行被其標(biāo)注的方法。示例代碼如下：
@Bean
@ConditionalOnProperty(name="alipay",havingValue="on")
Alipay alipay(){
return new Alipay();
}
4-6、@ConditionalOnResource
此注解用于檢測(cè)當(dāng)某個(gè)配置文件存在使，則觸發(fā)被其標(biāo)注的方法，下面是使用此注解的代碼示例：
@ConditionalOnResource(resources = "classpath:website.properties")
Properties addWebsiteProperties(){
//...
}
4-7、@ConditionalOnWebApplication 與 @ConditionalOnNotWebApplication
這兩個(gè)注解用于判斷當(dāng)前的應(yīng)用程序是否是 Web 應(yīng)用程序。如果當(dāng)前應(yīng)用是 Web 應(yīng)用程序，則使用 Spring WebApplicationContext, 并定義其會(huì)話的生命周期。下面是一個(gè)簡單的示例：
@ConditionalOnWebApplication
HealthCheckController healthCheckController(){
//...
}
4-8、@ConditionalExpression
此注解可以讓我們控制更細(xì)粒度的基于表達(dá)式的配置條件限制。當(dāng)表達(dá)式滿足某個(gè)條件或者表達(dá)式為真的時(shí)候，將會(huì)執(zhí)行被此注解標(biāo)注的方法。
@Bean
@ConditionalException("${localstore} && ${local == 'true'}")
LocalFileStore store(){
//...
}
4-9、@Conditional
@Conditional 注解可以控制更為復(fù)雜的配置條件。在 Spring 內(nèi)置的條件控制注解不滿足應(yīng)用需求的時(shí)候，可以使用此注解定義自定義的控制條件，以達(dá)到自定義的要求。下面是使用該注解的簡單示例：
@Conditioanl(CustomConditioanl.class)
CustomProperties addCustomProperties(){
//...
}
總結(jié)
本次總結(jié)了 Spring Boot 中常見的各類型注解的使用方式，讓大家能夠統(tǒng)一的對(duì) Spring Boot 常用注解有一個(gè)全面的了解。由于篇幅的原因，關(guān)于 Spring Boot 不常用的一些注解，將在下一次分享中進(jìn)行補(bǔ)充和說明。
