SpringBoot 常用注解
@RequestMapping注解的主要用途是将Web請求與請求處理類中的方法進行映射。
@RequestMapping注解對請求處理類中的請求處理方法進行标注;@RequestMapping注解擁有以下的六個配置屬性:
- value:映射的請求URL或者其别名
- method:相容HTTP的方法名
- params:根據HTTP參數的存在、預設或值對請求進行過濾
- header:根據HTTP Header的存在、預設或值對請求進行過濾
- consume:設定在HTTP請求正文中允許使用的媒體類型
- product:在HTTP響應體中允許使用的媒體類型
提示:在使用@RequestMapping之前,請求處理類還需要使用@Controller或@RestController進行标記。
@RequestMapping可以對類和方法進行标記,這樣類中的處理方法在映射請求路徑時,會自動将類上@RequestMapping設定的value拼接到方法中映射路徑之前。
@RequestBody在處理請求方法的參數清單中使用,它可以将請求主體中的參數綁定到一個對象中,請求主體參數是通過HttpMessageConverter傳遞的,根據請求主體中的參數名與對象的屬性名進行比對并綁定值。此外,還可以通過@Valid注解對請求主體中的參數進行校驗。
@GetMapping注解用于處理HTTP GET請求,并将請求映射到具體的處理方法中。具體來說,@GetMapping是一個組合注解,它相當于是@RequestMapping(method=RequestMethod.GET)的快捷方式。
@PostMapping注解用于處理HTTP POST請求,并将請求映射到具體的處理方法中。@PostMapping與@GetMapping一樣,也是一個組合注解,它相當于是@RequestMapping(method=HttpMethod.POST)的快捷方式。
@DeleteMapping注解用于處理HTTP DELETE請求,并将請求映射到删除方法中。@DeleteMapping是一個組合注解,它相當于是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。
@PatchMapping注解用于處理HTTP PATCH請求,并将請求映射到對應的處理方法中。@PatchMapping相當于是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。
@ControllerAdvice是@Component注解的一個延伸注解,Spring會自動掃描并檢測被@ControllerAdvice所标注的類。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用,主要是用來處理控制器所抛出的異常資訊。
首先,我們需要定義一個被@ControllerAdvice所标注的類,在該類中,定義一個用于處理具體異常的方法,并使用@ExceptionHandler注解進行标記。
此外,在有必要的時候,可以使用@InitBinder在類中進行全局的配置,還可以使用@ModelAttribute配置與視圖相關的參數。使用@ControllerAdvice注解,就可以快速的建立統一的,自定義的異常處理類。
@ResponseBody會自動将控制器中方法的傳回值寫入到HTTP響應中。特别的,@ResponseBody注解隻能用在被@Controller注解标記的類中。如果在被@RestController标記的類中,則方法不需要使用@ResponseBody注解進行标注。@RestController相當于是@Controller和@ResponseBody的組合注解。
@ExceptionHander注解用于标注處理特定類型異常類所抛出異常的方法。當控制器中的方法抛出異常時,Spring會自動捕獲異常,并将捕獲的異常資訊傳遞給被@ExceptionHandler标注的方法。
@ResponseStatus注解可以标注請求處理方法。使用此注解,可以指定響應所需要的HTTP STATUS。特别地,我們可以使用HttpStauts類對該注解的value屬性進行指派。
@PathVariable注解是将方法中的參數綁定到請求URI中的模闆變量上。可以通過@RequestMapping注解來指定URI的模闆變量,然後使用@PathVariable注解将方法中的參數綁定到模闆變量上。
特别地,@PathVariable注解允許我們使用value或name屬性來給參數取一個别名。模闆變量名需要使用{ }進行包裹,如果方法的參數名與URI模闆變量名一緻,則在@PathVariable中就可以省略别名的定義。
@RequestParam注解用于将方法的參數與Web請求的傳遞的參數進行綁定。使用@RequestParam可以輕松的通路HTTP請求參數的值。
該注解的其他屬性配置與@PathVariable的配置相同,特别的,如果傳遞的參數為空,還可以通過defaultValue設定一個預設值。
@Controller是@Component注解的一個延伸。
@RestController是在Spring 4.0開始引入的,這是一個特定的控制器注解。此注解相當于@Controller和@ResponseBody的快捷方式。當使用此注解時,不需要再在方法上使用@ResponseBody注解。
通過此注解,可以通過模型索引名稱來通路已經存在于控制器中的model。與@PathVariable和@RequestParam注解一樣,如果參數名與模型具有相同的名字,則不必指定索引名稱。
特别地,如果使用@ModelAttribute對方法進行标注,Spring會将方法的傳回值綁定到具體的Model上。
在Spring調用具體的處理方法之前,被@ModelAttribute注解标注的所有方法都将被執行。
@CrossOrigin注解将為請求處理類或請求處理方法提供跨域調用支援。如果我們将此注解标注類,那麼類中的所有方法都将獲得支援跨域的能力。使用此注解的好處是可以微調跨域行為。
@InitBinder注解用于标注初始化WebDataBinider的方法,該方法用于對Http請求傳遞的表單資料進行處理,如時間格式化、字元串處理等。
@ComponentScan注解用于配置Spring需要掃描的被元件注解注釋的類所在的包。可以通過配置其basePackages屬性或者value屬性來配置需要掃描的包路徑。value屬性是basePackages的别名。
@Component注解用于标注一個普通的元件類,它沒有明确的業務範圍,隻是通知Spring被此注解的類需要被納入到Spring Bean容器中并進行管理。
@Servic
@Service注解是@Component的一個延伸(特例),它用于标注業務邏輯類。與@Component注解一樣,被此注解标注的類,會自動被Spring所管理。
@Repository注解也是@Component注解的延伸,與@Component注解一樣,被此注解标注的類會被Spring自動管理起來,@Repository注解用于标注DAO層的資料持久化類。
@DependsOn注解可以配置Spring IoC容器在初始化一個Bean之前,先初始化其他的Bean對象。
@Bean注解主要的作用是告知Spring,被此注解所标注的類将需要納入到Bean管理工廠中。
@Scope注解可以用來定義@Component标注的類的作用範圍以及@Bean所标記的類的作用範圍。@Scope所限定的作用範圍有:singleton、prototype、request、session、globalSession或者其他的自定義範圍。這裡以prototype為例子進行講解。
當一個Spring Bean被聲明為prototype(原型模式)時,在每次需要使用到該類的時候,Spring IoC容器都會初始化一個新的改類的執行個體。在定義一個Bean時,可以設定Bean的scope屬性為prototype:scope=“prototype”,也可以使用@Scope注解設定。
當@Scope的作用範圍設定成Singleton時,被此注解所标注的類隻會被Spring IoC容器初始化一次。在預設情況下,Spring IoC容器所初始化的類執行個體都為singleton。
@Autowired注解用于标記Spring将要解析和注入的依賴項。此注解可以作用在構造函數、字段和setter方法上。
當系統中需要配置多個具有相同類型的bean時,@Primary可以定義這些Bean的優先級。
這兩個注解不屬于Spring,它們是源于JSR-250中的兩個注解,位于common-annotations.jar中。@PostConstruct注解用于标注在Bean被Spring初始化之前需要執行的方法。@PreDestroy注解用于标注Bean被銷毀前需要執行的方法。
當系統中存在同一類型的多個Bean時,@Autowired在進行依賴注入的時候就不知道該選擇哪一個實作類進行注入。此時,我們可以使用@Qualifier注解來微調,幫助@Autowired選擇正确的依賴項。
@SpringBootApplication注解是一個快捷的配置注解,在被它标注的類中,可以定義一個或多個Bean,并自動觸發自動配置Bean和自動掃描元件。此注解相當于@Configuration、@EnableAutoConfiguration和@ComponentScan的組合。
@EnableAutoConfiguration注解用于通知Spring,根據目前類路徑下引入的依賴包,自動配置與這些依賴包相關的配置項。
這兩個注解屬于類條件注解,它們根據是否存在某個類作為判斷依據來決定是否要執行某些配置。
這兩個注解屬于對象條件注解,根據是否存在某個對象作為依據來決定是否要執行某些配置方法。
@ConditionalOnProperty注解會根據Spring配置檔案中的配置項是否滿足配置要求,進而決定是否要執行被其标注的方法。
此注解用于檢測當某個配置檔案存在時,則觸發被其标注的方法。
這兩個注解用于判斷目前的應用程式是否是Web應用程式。如果目前應用是Web應用程式,則使用Spring WebApplicationContext,并定義其會話的生命周期。
此注解可以讓我們控制更細粒度的基于表達式的配置條件限制。當表達式滿足某個條件或者表達式為真的時候,将會執行被此注解标注的方法。
@Conditional注解可以控制更為複雜的配置條件。在Spring内置的條件控制注解不滿足應用需求的時候,可以使用此注解定義自定義的控制條件,以達到自定義的要求。