選單

40 個 Spring Boot 常用註解,你知道幾個?

40 個 Spring Boot 常用註解,你知道幾個?

一、Spring Web MVC 與 Spring Bean 註解

Spring Web MVC 註解

@RequestMapping

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

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

:對映的請求URL或者其別名

:相容HTTP的方法名

:根據HTTP引數的存在、預設或值對請求進行過濾

:根據HTTP Header的存在、預設或值對請求進行過濾

:設定在HTTP請求正文中允許使用的媒體型別

:在HTTP響應體中允許使用的媒體型別

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

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

40 個 Spring Boot 常用註解,你知道幾個?

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

40 個 Spring Boot 常用註解,你知道幾個?

@RequestBody

@RequestBody在處理請求方法的引數列表中使用,它可以將請求主體中的引數繫結到一個物件中,請求主體引數是透過傳遞的,根據請求主體中的引數名與物件的屬性名進行匹配並繫結值。此外,還可以透過@Valid註解對請求主體中的引數進行校驗。

下面是一個使用的示例:

40 個 Spring Boot 常用註解,你知道幾個?

@GetMapping

註解用於處理HTTP GET請求,並將請求對映到具體的處理方法中。具體來說,@GetMapping是一個組合註解,它相當於是的快捷方式。

下面是的一個使用示例:

40 個 Spring Boot 常用註解,你知道幾個?

@PostMapping

註解用於處理HTTP POST請求,並將請求對映到具體的處理方法中。@PostMapping與@GetMapping一樣,也是一個組合註解,它相當於是的快捷方式。

下面是使用的一個示例:

40 個 Spring Boot 常用註解,你知道幾個?

@PutMapping

註解用於處理HTTP PUT請求,並將請求對映到具體的處理方法中,@PutMapping是一個組合註解,相當於是的快捷方式。

下面是使用的一個示例:

40 個 Spring Boot 常用註解,你知道幾個?

@DeleteMapping

註解用於處理HTTP DELETE請求,並將請求對映到刪除方法中。@DeleteMapping是一個組合註解,它相當於是的快捷方式。

下面是使用的一個示例:

40 個 Spring Boot 常用註解,你知道幾個?

@PatchMapping

註解用於處理HTTP PATCH請求,並將請求對映到對應的處理方法中。@PatchMapping相當於是的快捷方式。

下面是一個簡單的示例:

@ControllerAdvice

是@Component註解的一個延伸註解,Spring會自動掃描並檢測被@ControllerAdvice所標註的類。需要和、以及註解搭配使用,主要是用來處理控制器所丟擲的異常資訊。

首先,我們需要定義一個被所標註的類,在該類中,定義一個用於處理具體異常的方法,並使用@ExceptionHandler註解進行標記。

此外,在有必要的時候,可以使用在類中進行全域性的配置,還可以使用@ModelAttribute配置與檢視相關的引數。使用註解,就可以快速的建立統一的,自定義的異常處理類。

下面是一個使用的示例程式碼:

40 個 Spring Boot 常用註解,你知道幾個?

@ResponseBody

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

下面是使用該註解的一個示例

@ExceptionHandler

註解用於標註處理特定型別異常類所丟擲異常的方法。當控制器中的方法丟擲異常時,Spring會自動捕獲異常,並將捕獲的異常資訊傳遞給被標註的方法。

下面是使用該註解的一個示例:

@ResponseStatus

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

下面是使用註解的一個示例:

40 個 Spring Boot 常用註解,你知道幾個?

@PathVariable

註解是將方法中的引數繫結到請求URI中的模板變數上。可以透過註解來指定URI的模板變數,然後使用註解將方法中的引數繫結到模板變數上。

特別地,註解允許我們使用value或name屬性來給引數取一個別名。下面是使用此註解的一個示例:

模板變數名需要使用進行包裹,如果方法的引數名與URI模板變數名一致,則在中就可以省略別名的定義。

下面是一個簡寫的示例:

提示:如果引數是一個非必須的,可選的項,則可以在中設定

@RequestParam

註解用於將方法的引數與Web請求的傳遞的引數進行繫結。使用可以輕鬆的訪問HTTP請求引數的值。

下面是使用該註解的程式碼示例:

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

40 個 Spring Boot 常用註解,你知道幾個?

@Controller

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

40 個 Spring Boot 常用註解,你知道幾個?

@RestController

是在Spring 4。0開始引入的,這是一個特定的控制器註解。此註解相當於和的快捷方式。當使用此註解時,不需要再在方法上使用註解。

下面是使用此註解的示例程式碼:

40 個 Spring Boot 常用註解,你知道幾個?

@ModelAttribute

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

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

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

40 個 Spring Boot 常用註解,你知道幾個?

在Spring呼叫具體的處理方法之前,被註解標註的所有方法都將被執行。

@CrossOrigin

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

@InitBinder

註解用於標註初始化

WebDataBinider

的方法,該方法用於對Http請求傳遞的表單資料進行處理,如時間格式化、字串處理等。下面是使用此註解的示例:

二、Spring Bean 註解

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

@ComponentScan

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

@Component

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

40 個 Spring Boot 常用註解,你知道幾個?

@Service

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

40 個 Spring Boot 常用註解,你知道幾個?

@Repository

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

40 個 Spring Boot 常用註解,你知道幾個?

三、Spring Dependency Inject 與 Bean Scops註解

Spring DI註解

@DependsOn

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

40 個 Spring Boot 常用註解,你知道幾個?

@Bean

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

40 個 Spring Boot 常用註解,你知道幾個?

Scops註解

@Scope

@Scope註解可以用來定義@Component標註的類的作用範圍以及@Bean所標記的類的作用範圍。@Scope所限定的作用範圍有:、、、、或者其他的自定義範圍。這裡以prototype為例子進行講解。

當一個Spring Bean被宣告為prototype(原型模式)時,在每次需要使用到該類的時候,Spring IoC容器都會初始化一個新的改類的例項。在定義一個Bean時,可以設定Bean的scope屬性為,也可以使用@Scope註解設定,如下:

@Scope(value=ConfigurableBeanFactory。SCOPE_PROPTOTYPE)

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

40 個 Spring Boot 常用註解,你知道幾個?

@Scope 單例模式

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

40 個 Spring Boot 常用註解,你知道幾個?

四、容器配置註解

@Autowired

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

作用於建構函式

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

40 個 Spring Boot 常用註解,你知道幾個?

作用於setter方法

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

40 個 Spring Boot 常用註解,你知道幾個?

作用於欄位

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

40 個 Spring Boot 常用註解,你知道幾個?

@Primary

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

40 個 Spring Boot 常用註解,你知道幾個?

輸出結果:

this is send DingDing method message。

@PostConstruct與@PreDestroy

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

40 個 Spring Boot 常用註解,你知道幾個?

@Qualifier

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

40 個 Spring Boot 常用註解,你知道幾個?

五、Spring Boot註解

@SpringBootApplication

註解是一個快捷的配置註解,在被它標註的類中,可以定義一個或多個Bean,並自動觸發自動配置Bean和自動掃描元件。此註解相當於、和的組合。

在Spring Boot應用程式的主類中,就使用了此註解。示例程式碼如下:

@SpringBootApplication

public class Application{

public static void main(String [] args){

SpringApplication。run(Application。class,args);

}

}

@EnableAutoConfiguration

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

@ConditionalOnClass與@ConditionalOnMissingClass

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

@Configuration

@ConditionalOnClass(DataSource。class)

class MySQLAutoConfiguration {

//。。。

}

@ConditionalOnBean與@ConditionalOnMissingBean

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

@Bean

@ConditionalOnBean(name=“dataSource”)

LocalContainerEntityManagerFactoryBean entityManagerFactory(){

//。。。

}

@Bean

@ConditionalOnMissingBean

public MyBean myBean(){

//。。。

}

@ConditionalOnProperty

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

@Bean

@ConditionalOnProperty(name=“alipay”,havingValue=“on”)

Alipay alipay(){

return new Alipay();

}

@ConditionalOnResource

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

@ConditionalOnResource(resources = “classpath:website。properties”)

Properties addWebsiteProperties(){

//。。。

}

@ConditionalOnWebApplication與@ConditionalOnNotWebApplication

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

@ConditionalOnWebApplication

HealthCheckController healthCheckController(){

//。。。

}

@ConditionalExpression

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

@Bean

@ConditionalException(“$ && $”)

LocalFileStore store(){

//。。。

}

@Conditional

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

@Conditioanl(CustomConditioanl。class)

CustomProperties addCustomProperties(){

//。。。

}

總結

本次課程總結了Spring Boot中常見的各型別註解的使用方式,讓大家能夠統一的對Spring Boot常用註解有一個全面的瞭解。

最近面試BAT,整理一份面試資料《

Java面試BATJ通關手冊

》,覆蓋了Java核心技術、JVM、Java併發、SSM、微服務、資料庫、資料結構等等。

文章有幫助的話,在看,轉發吧。

謝謝支援喲 (*^__^*)