40 個 SpringBoot 常用注解
閱讀本文大概需要 8.5 分鐘。
來自：https://ramostear.com/
一、Spring Web MVC 與 Spring Bean 注解
Spring Web MVC 注解
RquestMappingHandlerMapping和RequestMappingHndlerAdapter兩個類來提供對@RequestMapping注解的支持。@RequestMapping注解對請求處理類中的請求處理方法進行標注；@RequestMapping注解擁有以下的六個配置屬性：value:映射的請求URL或者其別名method:兼容HTTP的方法名params:根據(jù)HTTP參數(shù)的存在、缺省或值對請求進行過濾header:根據(jù)HTTP Header的存在、缺省或值對請求進行過濾consume:設定在HTTP請求正文中允許使用的媒體類型product:在HTTP響應體中允許使用的媒體類型
HttpMessageConverter傳遞的，根據(jù)請求主體中的參數(shù)名與對象的屬性名進行匹配并綁定值。此外，還可以通過@Valid注解對請求主體中的參數(shù)進行校驗。@RequestBody的示例：
@GetMapping注解用于處理HTTP GET請求，并將請求映射到具體的處理方法中。具體來說，@GetMapping是一個組合注解，它相當于是@RequestMapping(method=RequestMethod.GET)的快捷方式。@GetMapping的一個使用示例：
@PostMapping注解用于處理HTTP POST請求，并將請求映射到具體的處理方法中。@PostMapping與@GetMapping一樣，也是一個組合注解，它相當于是@RequestMapping(method=HttpMethod.POST)的快捷方式。@PostMapping的一個示例：@PutMapping注解用于處理HTTP PUT請求，并將請求映射到具體的處理方法中，@PutMapping是一個組合注解，相當于是@RequestMapping(method=HttpMethod.PUT)的快捷方式。@PutMapping的一個示例：
@DeleteMapping注解用于處理HTTP DELETE請求，并將請求映射到刪除方法中。@DeleteMapping是一個組合注解，它相當于是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。@DeleteMapping的一個示例：
@PatchMapping注解用于處理HTTP PATCH請求，并將請求映射到對應的處理方法中。@PatchMapping相當于是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。
@ControllerAdvice是@Component注解的一個延伸注解，Spring會自動掃描并檢測被@ControllerAdvice所標注的類。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用，主要是用來處理控制器所拋出的異常信息。@ControllerAdvice所標注的類，在該類中，定義一個用于處理具體異常的方法，并使用@ExceptionHandler注解進行標記。@InitBinder在類中進行全局的配置，還可以使用@ModelAttribute配置與視圖相關的參數(shù)。使用@ControllerAdvice注解，就可以快速的創(chuàng)建統(tǒng)一的，自定義的異常處理類。@ControllerAdvice的示例代碼：
@ResponseBody會自動將控制器中方法的返回值寫入到HTTP響應中。特別的，@ResponseBody注解只能用在被@Controller注解標記的類中。如果在被@RestController標記的類中，則方法不需要使用@ResponseBody注解進行標注。@RestController相當于是@Controller和@ResponseBody的組合注解。
@ExceptionHander注解用于標注處理特定類型異常類所拋出異常的方法。當控制器中的方法拋出異常時，Spring會自動捕獲異常，并將捕獲的異常信息傳遞給被@ExceptionHandler標注的方法。
@ResponseStatus注解可以標注請求處理方法。使用此注解，可以指定響應所需要的HTTP STATUS。特別地，我們可以使用HttpStauts類對該注解的value屬性進行賦值。@ResponseStatus注解的一個示例：
@PathVariable注解是將方法中的參數(shù)綁定到請求URI中的模板變量上。可以通過@RequestMapping注解來指定URI的模板變量，然后使用@PathVariable注解將方法中的參數(shù)綁定到模板變量上。@PathVariable注解允許我們使用value或name屬性來給參數(shù)取一個別名。下面是使用此注解的一個示例：
{ }進行包裹，如果方法的參數(shù)名與URI模板變量名一致，則在@PathVariable中就可以省略別名的定義。
@PathVariable中設置require = false@RequestParam注解用于將方法的參數(shù)與Web請求的傳遞的參數(shù)進行綁定。使用@RequestParam可以輕松的訪問HTTP請求參數(shù)的值。
@PathVariable的配置相同，特別的，如果傳遞的參數(shù)為空，還可以通過defaultValue設置一個默認值。示例代碼如下：
@Controller是@Component注解的一個延伸，
@RestController是在Spring 4.0開始引入的，這是一個特定的控制器注解。此注解相當于@Controller和@ResponseBody的快捷方式。當使用此注解時，不需要再在方法上使用@ResponseBody注解。
@PathVariable和@RequestParam注解一樣，如果參數(shù)名與模型具有相同的名字，則不必指定索引名稱，簡寫示例如下：
@ModelAttribute對方法進行標注，Spring會將方法的返回值綁定到具體的Model上。示例如下：
@ModelAttribute注解標注的所有方法都將被執(zhí)行。@CrossOrigin注解將為請求處理類或請求處理方法提供跨域調用支持。如果我們將此注解標注類，那么類中的所有方法都將獲得支持跨域的能力。使用此注解的好處是可以微調跨域行為。使用此注解的示例如下：
@InitBinder注解用于標注初始化WebDataBinider的方法，該方法用于對Http請求傳遞的表單數(shù)據(jù)進行處理，如時間格式化、字符串處理等。下面是使用此注解的示例：
二、Spring Bean 注解
@ComponentScan注解用于配置Spring需要掃描的被組件注解注釋的類所在的包。可以通過配置其basePackages屬性或者value屬性來配置需要掃描的包路徑。value屬性是basePackages的別名。此注解的用法如下：
@Service注解是@Component的一個延伸（特例），它用于標注業(yè)務邏輯類。與@Component注解一樣，被此注解標注的類，會自動被Spring所管理。下面是使用@Service注解的示例：
@Repository注解也是@Component注解的延伸，與@Component注解一樣，被此注解標注的類會被Spring自動管理起來，@Repository注解用于標注DAO層的數(shù)據(jù)持久化類。此注解的用法如下：
三、Spring Dependency Inject 與 Bean Scops注解
Spring DI注解
@DependsOn注解可以配置Spring IoC容器在初始化一個Bean之前，先初始化其他的Bean對象。下面是此注解使用示例代碼：
initMethod和destroyMethod的用法。示例如下：
Scops注解
singleton、prototype、request、session、globalSession或者其他的自定義范圍。這里以prototype為例子進行講解。prototype：scope=“prototype”,也可以使用@Scope注解設置，如下：@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)
四、容器配置注解
@Autowired
@Primary
this is send DingDing method message.
@PostConstruct與@PreDestroy
common-annotations.jar中。@PostConstruct注解用于標注在Bean被Spring初始化之前需要執(zhí)行的方法。@PreDestroy注解用于標注Bean被銷毀前需要執(zhí)行的方法。下面是具體的示例代碼：
@Qualifier
五、Spring Boot注解
@SpringBootApplication注解是一個快捷的配置注解，在被它標注的類中，可以定義一個或多個Bean，并自動觸發(fā)自動配置Bean和自動掃描組件。此注解相當于@Configuration、@EnableAutoConfiguration和@ComponentScan的組合。@SpringBootApplication
public class Application{
public static void main(String [] args){
SpringApplication.run(Application.class,args);
}
}
@Configuration
@ConditionalOnClass(DataSource.class)
class MySQLAutoConfiguration {
//...
}
@Bean
@ConditionalOnBean(name="dataSource")
LocalContainerEntityManagerFactoryBean entityManagerFactory(){
//...
}
@Bean
@ConditionalOnMissingBean
public MyBean myBean(){
//...
}
@Bean
@ConditionalOnProperty(name="alipay",havingValue="on")
Alipay alipay(){
return new Alipay();
}
@ConditionalOnResource(resources = "classpath:website.properties")
Properties addWebsiteProperties(){
//...
}
@ConditionalOnWebApplication
HealthCheckController healthCheckController(){
//...
}
@Bean
@ConditionalException("${localstore} && ${local == 'true'}")
LocalFileStore store(){
//...
}
@Conditioanl(CustomConditioanl.class)
CustomProperties addCustomProperties(){
//...
}
總結
推薦閱讀：
最近面試BAT，整理一份面試資料《Java面試BATJ通關手冊》，覆蓋了Java核心技術、JVM、Java并發(fā)、SSM、微服務、數(shù)據(jù)庫、數(shù)據(jù)結構等等。
朕已閱 
評論
圖片
表情