40 個(gè) SpringBoot 常用注解:讓生產(chǎn)力爆表!
往期熱門文章:
2、為什么不建議使用ON DUPLICATE KEY UPDATE?
一、Spring Web MVC 與 Spring Bean 注解 Spring Web MVC 注解 二、Spring Bean 注解 三、Spring Dependency Inject 與 Bean Scops注解 Spring DI注解 Scops注解 四、容器配置注解 @Autowired @Primary @PostConstruct與@PreDestroy @Qualifier 五、Spring Boot注解 總結(jié)
企業(yè)開發(fā)項(xiàng)目SpringBoot已經(jīng)是必備框架了,其中注解是開發(fā)中的小工具(誰(shuí)處可見(jiàn)哦),用好了開發(fā)效率大大提升,當(dāng)然用錯(cuò)了也會(huì)引入缺陷。
一、Spring Web MVC 與 Spring Bean 注解
Spring Web MVC 注解
RquestMappingHandlerMapping和RequestMappingHndlerAdapter兩個(gè)類來(lái)提供對(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)行過(guò)濾header:根據(jù)HTTP Header的存在、缺省或值對(duì)請(qǐng)求進(jìn)行過(guò)濾consume:設(shè)定在HTTP請(qǐng)求正文中允許使用的媒體類型product:在HTTP響應(yīng)體中允許使用的媒體類型
HttpMessageConverter傳遞的,根據(jù)請(qǐng)求主體中的參數(shù)名與對(duì)象的屬性名進(jìn)行匹配并綁定值。此外,還可以通過(guò)@Valid注解對(duì)請(qǐng)求主體中的參數(shù)進(jìn)行校驗(yàn)。@RequestBody的示例:@GetMapping
@GetMapping注解用于處理HTTP GET請(qǐng)求,并將請(qǐng)求映射到具體的處理方法中。具體來(lái)說(shuō),@GetMapping是一個(gè)組合注解,它相當(dāng)于是@RequestMapping(method=RequestMethod.GET)的快捷方式。@GetMapping的一個(gè)使用示例:@PostMapping注解用于處理HTTP POST請(qǐng)求,并將請(qǐng)求映射到具體的處理方法中。@PostMapping與@GetMapping一樣,也是一個(gè)組合注解,它相當(dāng)于是@RequestMapping(method=HttpMethod.POST)的快捷方式。@PostMapping的一個(gè)示例:@PutMapping注解用于處理HTTP PUT請(qǐng)求,并將請(qǐng)求映射到具體的處理方法中,@PutMapping是一個(gè)組合注解,相當(dāng)于是@RequestMapping(method=HttpMethod.PUT)的快捷方式。@PutMapping的一個(gè)示例:@DeleteMapping注解用于處理HTTP DELETE請(qǐng)求,并將請(qǐng)求映射到刪除方法中。@DeleteMapping是一個(gè)組合注解,它相當(dāng)于是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。@DeleteMapping的一個(gè)示例:@PatchMapping注解用于處理HTTP PATCH請(qǐng)求,并將請(qǐng)求映射到對(duì)應(yīng)的處理方法中。@PatchMapping相當(dāng)于是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。@ControllerAdvice是@Component注解的一個(gè)延伸注解,Spring會(huì)自動(dòng)掃描并檢測(cè)被@ControllerAdvice所標(biāo)注的類。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用,主要是用來(lái)處理控制器所拋出的異常信息。@ControllerAdvice所標(biāo)注的類,在該類中,定義一個(gè)用于處理具體異常的方法,并使用@ExceptionHandler注解進(jìn)行標(biāo)記。@InitBinder在類中進(jìn)行全局的配置,還可以使用@ModelAttribute配置與視圖相關(guān)的參數(shù)。使用@ControllerAdvice注解,就可以快速的創(chuàng)建統(tǒng)一的,自定義的異常處理類。@ControllerAdvice的示例代碼:@ResponseBody會(huì)自動(dòng)將控制器中方法的返回值寫入到HTTP響應(yīng)中。特別的,@ResponseBody注解只能用在被@Controller注解標(biāo)記的類中。如果在被@RestController標(biāo)記的類中,則方法不需要使用@ResponseBody注解進(jìn)行標(biāo)注。@RestController相當(dāng)于是@Controller和@ResponseBody的組合注解。@ExceptionHander注解用于標(biāo)注處理特定類型異常類所拋出異常的方法。當(dāng)控制器中的方法拋出異常時(shí),Spring會(huì)自動(dòng)捕獲異常,并將捕獲的異常信息傳遞給被@ExceptionHandler標(biāo)注的方法。@ResponseStatus注解可以標(biāo)注請(qǐng)求處理方法。使用此注解,可以指定響應(yīng)所需要的HTTP STATUS。特別地,我們可以使用HttpStauts類對(duì)該注解的value屬性進(jìn)行賦值。@ResponseStatus注解的一個(gè)示例:@PathVariable注解是將方法中的參數(shù)綁定到請(qǐng)求URI中的模板變量上。可以通過(guò)@RequestMapping注解來(lái)指定URI的模板變量,然后使用@PathVariable注解將方法中的參數(shù)綁定到模板變量上。@PathVariable注解允許我們使用value或name屬性來(lái)給參數(shù)取一個(gè)別名。下面是使用此注解的一個(gè)示例:{ }進(jìn)行包裹,如果方法的參數(shù)名與URI模板變量名一致,則在@PathVariable中就可以省略別名的定義。@PathVariable中設(shè)置require = false@RequestParam注解用于將方法的參數(shù)與Web請(qǐng)求的傳遞的參數(shù)進(jìn)行綁定。使用@RequestParam可以輕松的訪問(wèn)HTTP請(qǐng)求參數(shù)的值。@PathVariable的配置相同,特別的,如果傳遞的參數(shù)為空,還可以通過(guò)defaultValue設(shè)置一個(gè)默認(rèn)值。示例代碼如下:@Controller是@Component注解的一個(gè)延伸,Spring 會(huì)自動(dòng)掃描并配置被該注解標(biāo)注的類。此注解用于標(biāo)注Spring MVC的控制器。下面是使用此注解的示例代碼:@RestController是在Spring 4.0開始引入的,這是一個(gè)特定的控制器注解。此注解相當(dāng)于@Controller和@ResponseBody的快捷方式。當(dāng)使用此注解時(shí),不需要再在方法上使用@ResponseBody注解。@PathVariable和@RequestParam注解一樣,如果參數(shù)名與模型具有相同的名字,則不必指定索引名稱,簡(jiǎn)寫示例如下:@ModelAttribute對(duì)方法進(jìn)行標(biāo)注,Spring會(huì)將方法的返回值綁定到具體的Model上。示例如下:@ModelAttribute注解標(biāo)注的所有方法都將被執(zhí)行。@CrossOrigin注解將為請(qǐng)求處理類或請(qǐng)求處理方法提供跨域調(diào)用支持。如果我們將此注解標(biāo)注類,那么類中的所有方法都將獲得支持跨域的能力。使用此注解的好處是可以微調(diào)跨域行為。使用此注解的示例如下:@InitBinder注解用于標(biāo)注初始化WebDataBinider 的方法,該方法用于對(duì)Http請(qǐng)求傳遞的表單數(shù)據(jù)進(jìn)行處理,如時(shí)間格式化、字符串處理等。下面是使用此注解的示例:二、Spring Bean 注解
@ComponentScan注解用于配置Spring需要掃描的被組件注解注釋的類所在的包??梢酝ㄟ^(guò)配置其basePackages屬性或者value屬性來(lái)配置需要掃描的包路徑。value屬性是basePackages的別名。此注解的用法如下:@Service注解是@Component的一個(gè)延伸(特例),它用于標(biāo)注業(yè)務(wù)邏輯類。與@Component注解一樣,被此注解標(biāo)注的類,會(huì)自動(dòng)被Spring所管理。下面是使用@Service注解的示例:@Repository注解也是@Component注解的延伸,與@Component注解一樣,被此注解標(biāo)注的類會(huì)被Spring自動(dòng)管理起來(lái),@Repository注解用于標(biāo)注DAO層的數(shù)據(jù)持久化類。此注解的用法如下:三、Spring Dependency Inject 與 Bean Scops注解
Spring DI注解
@DependsOn注解可以配置Spring IoC容器在初始化一個(gè)Bean之前,先初始化其他的Bean對(duì)象。下面是此注解使用示例代碼:initMethod和destroyMethod的用法。示例如下:Scops注解
singleton、prototype、request、session、globalSession或者其他的自定義范圍。這里以prototype為例子進(jìn)行講解。prototype:scope=“prototype”,也可以使用@Scope注解設(shè)置,如下:@Scope(value=ConfigurableBeanFactory.SCOPE_PROPTOTYPE)
四、容器配置注解
@Autowired
@Primary
輸出結(jié)果:
this is send DingDing method message.
@PostConstruct與@PreDestroy
common-annotations.jar中。@PostConstruct注解用于標(biāo)注在Bean被Spring初始化之前需要執(zhí)行的方法。@PreDestroy注解用于標(biāo)注Bean被銷毀前需要執(zhí)行的方法。下面是具體的示例代碼:@Qualifier
五、Spring Boot注解
@SpringBootApplication注解是一個(gè)快捷的配置注解,在被它標(biāo)注的類中,可以定義一個(gè)或多個(gè)Bean,并自動(dòng)觸發(fā)自動(dòng)配置Bean和自動(dòng)掃描組件。此注解相當(dāng)于@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(){
//...
}
總結(jié)
往期熱門文章:
1、MySQL 暴跌! 2、超越 Xshell!號(hào)稱下一代 Terminal 終端神器,用完愛(ài)不釋手! 3、IDEA 官宣全新默認(rèn) UI,太震撼了?。?/span> 4、讓你直呼「臥槽」的 GitHub 項(xiàng)目! 5、Kafka又笨又重,為啥不選Redis? 6、50多個(gè)高頻免費(fèi) API 接口分享 7、IDEA公司再發(fā)新神器!超越 VS Code 騷操作! 8、我懷疑這是 IDEA 的 BUG,但是我翻遍全網(wǎng)沒(méi)找到證據(jù)! 9、Spring MVC 中的 Controller 是線程安全的嗎? 10、Gitee 倒下了???
評(píng)論
圖片
表情
