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: 根據(jù) HTTP 參數(shù)的存在小槐、缺省或值對請求進行過濾

• header: 根據(jù) HTTP Header 的存在拇派、缺省或值對請求進行過濾

• consume: 設(shè)定在 HTTP 請求正文中允許使用的媒體類型

• product: 在 HTTP 響應體中允許使用的媒體類型

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

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

@RequestMapping 還可以對類進行標記，這樣類中的處理方法在映射請求路徑時件豌，會自動將類上 @RequestMapping 設(shè)置的 value 拼接到方法中映射路徑之前疮方，如下：

1-1-2、@RequestBody

@RequestBody 在處理請求方法的參數(shù)列表中使用茧彤，它可以將請求主體中的參數(shù)綁定到一個對象中骡显，請求主體參數(shù)是通過 HttpMessageConverter 傳遞的，根據(jù)請求主體中的參數(shù)名與對象的屬性名進行匹配并綁定值曾掂。此外惫谤，還可以通過 @Valid 注解對請求主體中的參數(shù)進行校驗。下面是一個使用 @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 配置與視圖相關(guān)的參數(shù)建钥。使用 @ControllerAdvice 注解，就可以快速的創(chuàng)建統(tǒng)一的虐沥，自定義的異常處理類熊经。下面是一個使用 @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 注解是將方法中的參數(shù)綁定到請求 URI 中的模板變量上檩互√蒯＃可以通過 @RequestMapping 注解來指定 URI 的模板變量，然后使用 @PathVariable 注解將方法中的參數(shù)綁定到模板變量上闸昨。特別地蚯斯，@PathVariable 注解允許我們使用 value 或 name 屬性來給參數(shù)取一個別名薄风。下面是使用此注解的一個示例：

模板變量名需要使用 “{}” 進行包裹，如果方法的參數(shù)名與 URI 模板變量名一致拍嵌，則在 @PathVariable 中就可以省略別名的定義遭赂。下面是一個簡寫的示例：

提示：如果參數(shù)是一個非必須的，可選的項横辆，則可以在 @PathVariable 中設(shè)置 require = false

1-1-13撇他、@RequestParam

@RequestParam 注解用于將方法的參數(shù)與 Web 請求的傳遞的參數(shù)進行綁定。使用 @RequestParam 可以輕松的訪問 HTTP 請求參數(shù)的值狈蚤。下面是使用該注解的代碼示例：

該注解的其他屬性配置與 @PathVariable 的配置相同困肩，特別的，如果傳遞的參數(shù)為空脆侮，還可以通過 defaultValue 設(shè)置一個默認值锌畸。示例代碼如下：

1-1-14、@Controller

@Controller 是 @Component 注解的一個延伸靖避，Spring 會自動掃描并配置被該注解標注的類潭枣。此注解用于標注 Spring MVC 的控制器。下面是使用此注解的示例代碼：

1-1-15幻捏、@RestController

@RestController 是在 Spring 4.0 開始引入的卸耘，這是一個特定的控制器注解。此注解相當于 @Controller 和 @ResponseBody 的快捷方式粘咖。當使用此注解時，不需要再在方法上使用 @ResponseBody 注解侈百。下面是使用此注解的示例代碼：

1-1-16瓮下、@ModelAttribute

通過此注解，可以通過模型索引名稱來訪問已經(jīng)存在于控制器中的 model钝域。下面是使用此注解的一個簡單示例：

與 @PathVariable 和 @RequestParam 注解一樣讽坏，如果參數(shù)名與模型具有相同的名字，則不必指定索引名稱例证，簡寫示例如下：

特別地路呜，如果使用 @ModelAttribute 對方法進行標注，Spring 會將方法的返回值綁定到具體的 Model 上织咧。示例如下：

在 Spring 調(diào)用具體的處理方法之前胀葱，被 @ModelAttribute 注解標注的所有方法都將被執(zhí)行。（希望更加系統(tǒng)的學習 springboot笙蒙，可以在 Java 知音公眾號內(nèi)回復 “Springboot 聚合”抵屿，獲取 springboot 教程）

1-1-17、@CrossOrigin

@CrossOrigin 注解將為請求處理類或請求處理方法提供跨域調(diào)用支持捅位。如果我們將此注解標注類轧葛，那么類中的所有方法都將獲得支持跨域的能力搂抒。使用此注解的好處是可以微調(diào)跨域行為。使用此注解的示例如下：

1-1-18尿扯、@InitBinder

@InitBinder 注解用于標注初始化 WebDataBinider 的方法求晶，該方法用于對 Http 請求傳遞的表單數(shù)據(jù)進行處理，如時間格式化衷笋、字符串處理等芳杏。下面是使用此注解的示例：

1-2、Spring Bean 注解

在本小節(jié)中右莱，主要列舉與 Spring Bean 相關(guān)的 4 個注解以及它們的使用方式蚜锨。

1-2-1、@ComponentScan

@ComponentScan 注解用于配置 Spring 需要掃描的被組件注解注釋的類所在的包慢蜓⊙窃伲可以通過配置其 basePackages 屬性或者 value 屬性來配置需要掃描的包路徑。value 屬性是 basePackages 的別名晨抡。此注解的用法如下：

1-2-2氛悬、@Component

@Component 注解用于標注一個普通的組件類，它沒有明確的業(yè)務(wù)范圍耘柱，只是通知 Spring 被此注解的類需要被納入到 Spring Bean 容器中并進行管理如捅。此注解的使用示例如下：

1-2-3、@Service

@Service 注解是 @Component 的一個延伸（特例）调煎，它用于標注業(yè)務(wù)邏輯類镜遣。與 @Component 注解一樣，被此注解標注的類士袄，會自動被 Spring 所管理悲关。下面是使用 @Service 注解的示例：

1-2-4、@Repository

@Repository 注解也是 @Component 注解的延伸娄柳，與 @Component 注解一樣寓辱，被此注解標注的類會被 Spring 自動管理起來，@Repository 注解用于標注 DAO 層的數(shù)據(jù)持久化類赤拒。此注解的用法如下：

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 或者其他的自定義范圍吮廉。（希望更加系統(tǒng)的學習 springboot苞尝，可以在 Java 知音公眾號內(nèi)回復 “Springboot 聚合”，獲取 springboot 教程）

這里以 prototype 為例子進行講解宦芦。當一個 Spring Bean 被聲明為 prototype（原型模式）時宙址，在每次需要使用到該類的時候，Spring IoC 容器都會初始化一個新的改類的實例调卑。在定義一個 Bean 時抡砂，可以設(shè)置 Bean 的 scope 屬性為 prototype：scope=“prototype”, 也可以使用 @Scope 注解設(shè)置，如下：

@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)

下面將給出兩種不同的方式來使用 @Scope 注解恬涧，示例代碼如下：

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

當 @Scope 的作用范圍設(shè)置成 Singleton 時，被此注解所標注的類只會被 Spring IoC 容器初始化一次溯捆。在默認情況下丑搔，Spring IoC 容器所初始化的類實例都為 singleton。同樣的原理提揍，此情形也有兩種配置方式啤月，示例代碼如下：

3、容器配置注解

3-1碳锈、@Autowired

@Autowired 注解用于標記 Spring 將要解析和注入的依賴項。此注解可以作用在構(gòu)造函數(shù)欺抗、字段和 setter 方法上售碳。

3-1-1、作用于構(gòu)造函數(shù)

下面是 @Autowired 注解標注構(gòu)造函數(shù)的使用示例：

3-1-2绞呈、作用于 setter 方法

下面是 @Autowired 注解標注 setter 方法的示例代碼：

3-1-3贸人、作用于字段

@Autowired 注解標注字段是最簡單的，只需要在對應的字段上加入此注解即可佃声，示例代碼如下：

3-2艺智、@Primary

當系統(tǒng)中需要配置多個具有相同類型的 bean 時，@Primary 可以定義這些 Bean 的優(yōu)先級圾亏。下面將給出一個實例代碼來說明這一特性：

輸出結(jié)果：

this is send DingDing method message.

3-3十拣、@PostConstruct 與 @PreDestroy

值得注意的是封拧，這兩個注解不屬于 Spring, 它們是源于 JSR-250 中的兩個注解，位于 common-annotations.jar 中夭问。@PostConstruct 注解用于標注在 Bean 被 Spring 初始化之前需要執(zhí)行的方法泽西。@PreDestroy 注解用于標注 Bean 被銷毀前需要執(zhí)行的方法。下面是具體的示例代碼：

3-4缰趋、@Qualifier

當系統(tǒng)中存在同一類型的多個 Bean 時捧杉，@Autowired 在進行依賴注入的時候就不知道該選擇哪一個實現(xiàn)類進行注入。此時秘血，我們可以使用 @Qualifier 注解來微調(diào)味抖，幫助 @Autowired 選擇正確的依賴項。下面是一個關(guān)于此注解的代碼示例：

4灰粮、Spring Boot 注解

4-1仔涩、@SpringBootApplication

@SpringBootApplication 注解是一個快捷的配置注解，在被它標注的類中谋竖，可以定義一個或多個 Bean红柱，并自動觸發(fā)自動配置 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，根據(jù)當前類路徑下引入的依賴包些侍，自動配置與這些依賴包相關(guān)的配置項隶症。

4-3、@ConditionalOnClass 與 @ConditionalOnMissingClass

這兩個注解屬于類條件注解岗宣，它們根據(jù)是否存在某個類作為判斷依據(jù)來決定是否要執(zhí)行某些配置蚂会。下面是一個簡單的示例代碼：

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

4-4、@ConditionalOnBean 與 @ConditionalOnMissingBean

這兩個注解屬于對象條件注解耗式，根據(jù)是否存在某個對象作為依據(jù)來決定是否要執(zhí)行某些配置方法胁住。示例代碼如下：

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

4-5、@ConditionalOnProperty

@ConditionalOnProperty 注解會根據(jù) Spring 配置文件中的配置項是否滿足配置要求刊咳，從而決定是否要執(zhí)行被其標注的方法彪见。示例代碼如下：

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

4-6、@ConditionalOnResource

此注解用于檢測當某個配置文件存在使娱挨，則觸發(fā)被其標注的方法余指，下面是使用此注解的代碼示例：

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

4-7、@ConditionalOnWebApplication 與 @ConditionalOnNotWebApplication

這兩個注解用于判斷當前的應用程序是否是 Web 應用程序跷坝。如果當前應用是 Web 應用程序酵镜，則使用 Spring WebApplicationContext, 并定義其會話的生命周期碉碉。下面是一個簡單的示例：

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

4-8、@ConditionalExpression

此注解可以讓我們控制更細粒度的基于表達式的配置條件限制笋婿。當表達式滿足某個條件或者表達式為真的時候誉裆，將會執(zhí)行被此注解標注的方法。

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

4-9缸濒、@Conditional

@Conditional 注解可以控制更為復雜的配置條件足丢。在 Spring 內(nèi)置的條件控制注解不滿足應用需求的時候，可以使用此注解定義自定義的控制條件庇配，以達到自定義的要求斩跌。下面是使用該注解的簡單示例：

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

總結(jié)

本次總結(jié)了 Spring Boot 中常見的各類型注解的使用方式，讓大家能夠統(tǒng)一的對 Spring Boot 常用注解有一個全面的了解捞慌。由于篇幅的原因耀鸦，關(guān)于 Spring Boot 不常用的一些注解，將在下一次分享中進行補充和說明啸澡。