springboot注解学习

1-1、Spring Web MVC 注解

1、@RequestMaping注解

它的主要用途是将Web请求与请求处理类中的方法进行映射。SpringMvc和SpringWebFlux都通过RequestMappingHandlerMapping和RequestMappingHandlerAdapter两个类提供对@RequestMapping注解的支持

它有一下六个配置属性：

value：映射请求的URL请求或者其别名

method：兼容HTTP的方法名

params：根据HTTP参数的存在、缺省或值对请求进行过滤

header：根据HTTP Header的存在，缺省或值对请求进行过滤

consume：设定在HTTP请求正文中允许使用的媒体类型

product：在HTTP响应体中允许使用的媒体类型

注：在使用@RequestingMapping中签，请求处理类还需要使用@Controller或者@RestController进行标记

 

2、@RequestBody注解

@RequestBody在处理请求方法的参数列表中使用，它可以将请求主题中的参数绑定到一个对象中，请求主题参数是通过HttpMessageConvert传递的，根据请求主题中的参数名与对象的属性名进行匹配并绑定值。此外，还可以通过@Value注解对请求主体中的参数进行校验。

 

3、@GetMapping注解

@GetMapping注解用于处理HTTP Get请求，并将请求映射到具体的处理方法中。具体来说，@GetMapping是一个组合注解，它相当于是一个@RequestMapping(method=RequestMethod.Get)的快捷方式。

 

4、@PostMapping

@PostMapping注解用于处理HTTP POST请求，并将请求映射到具体的处理方法中，他是一个组合注解，它相当于@RequestMapping(method=HttpMethod.POST)的快捷方式

 

5、@PutMapping

@PutMapping注解用于处理HTTP PUT请求，并将请求映射到具体的处理方法中，他是一个组合注解，它相当于@PutMapping(method=HttpMethod.PUT)的快捷方式

 

6、@DeleteMapping

@DeleteMapping注解用于处理HTTP DELETE请求，并将请求映射到具体的处理方法中，他是一个组合注解，它相当于@DeleteMapping(method=HttpMethod.DELETE)的快捷方式

 

7、@PatchMapping

@PatchMapping注解用于处理HTTP PATCH请求，并将请求映射到具体的处理方法中，他是一个组合注解，它相当于@PatchMapping(method=HttpMethod.PATCH)的快捷方式

 

8、@ControllerAdvice

它是@Component注解的一个延伸注解，Spring会自动扫描并检测被ControllerAdvice所标注的类。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribbute注解搭配使用，主要是用来处理控制器所抛出的异常信息。首先，我们需要定义一个被@ControllerAdvice所标注的类，在该类中，定义一个用于处理异常的方法，并使用@ExceptionHandler进行标记。

此外，在有必要的时候吗可以使用@InitBinder在类中进行全局的皮质，还可以使用@ModelAttribute配置与视图相关的参数，使用@ControllerAdvice注解，就可以快速的创建统一的，自定义的异常处理类。

 

9、ResponseBody

@ResponseBody注解会自动将控制器中的方法的返回值写入到HTTP响应中，特别的，@ResponseBody注解只能用在被@Controller注解标记的类中。如果在被@RequestController标记的类中，则方法不需要使用@RequestBody注解进行标注。@RestController相当于是@Controller和@ResponseBody的组合注解。

 

10、@ExceptionHander

@ExceptionHander注解用于标注处理特定类型异常类所抛出的方法。当控制器中的方法抛出异常时，Spring会自动捕获异常，并将捕获的异常信息传递给被逼@ExceptionHandler标注的方法。

 

11、@ResponseStatus

@ResponseStatus注解可以标注请求处理方法。使用此注解，可以指定响应所需要的HTTP STASUS。特别的，我们可以使用HttpStatus类对该注解的value属性进行赋值。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDqELaIlMjw3Pd7dOHfkjebNLhHRt8DBjX0OZy8aF0crXPWsBXPa7AOiaQ/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

 

12、@PathVariable

@PathVariable注解是将方法中的参数绑定到请求URL中的模板变量上。可通过@RequestMapping注解来指定URL模板变量，然后使用@PathVariable注解允许我们使用value或name属性来给参数取一个别名。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDq9md9MXvGvRDdakVTFHPyCP1BbJvCr3Wh9eK0ibMviaxfZmWwbmvKvy1A/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

模板变量名需要使用{}进行包裹，如果方法的参数名与URL中模板变量名一致，则在@PathVariable中就可以省略别名的定义。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDqYMpic6UALnMJMVssXIhB0zgZBEyTJAtovvfBicrnTYU9xaREaEulvZiaA/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

如果参数是一个非必须的，可以在@PathVariable中设置require=false

 

13、@RequestParam

@RequestParam注解用于将方法的参数与Web请求的传递的参数进行绑定。使用@RequestParam可以轻松的访问HTTP请求参数的值。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDq3874lfeGFYEAMVIndqtD1uOYyKTfBS0n0vzzqtKnFkFDQsZOTJw0QQ/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

该注解的其他属性配置与@PathVariable的配置相同，如果传递的参数唯恐，还可以通过defaultValue设置一个默认值。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDqr4PjCFOR2JOV31yiaxYr2Z2odaSyItG8emNvOkzRFWReSqoiajE1dt7Q/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

 

14、@Controller

@Controller值@Conponent注解的一个延伸，Spring会自动扫描并配置被该注解标注的类。此注解用于标注springmvc的控制器。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDqGvaKx68nGAYFibvQnKMDWha9LHuHGwpN56GXkolIicy6Aojso5iaeS1fg/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

 

15、@RestController

@RestController是在spring4.0开始引入的，这是一个特定的控制器注解。此注解相当于@Controller和@ResponseBody的快捷方式。使用此注解，不需要在@ResponseBody注解

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDqR7pzRg9sHfqWaMibheW1VK67I3zhIgHHgsgJVQYNu32CXSIz8ESdCcA/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

16、@ModelAttribute

通过此注解，可以通过模型索引名称来访问已经存在于控制器其中的model。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDqUTSkDOibMb9HicBcNkXVfjZaTWKNvTIajR8FHWxiaLFIStXVx7pZQaiaWg/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

与@PathVariable和@RequestParam注解一样，如果参数名与模型具有相同的名字，就不需要指定索引名称

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDqvpCbibCKsorr5YCJyFl74oboIRQYv9yrVibHFVRYcL2lauB0Olu3QtcA/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

如果使用@ModelAttribute对方法进行标注，spring会将方法的返回值绑定到具体的model上

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDqS4gvWPQvCoiblh18Ptuj880JQNMJJbia1v4bp25DTvNHXvW3icUplD5UA/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

在spring调用具体的处理方法之前，被@ModelAttribute注解标注的所有方法将被执行。

 

17、@CrossOrigin

@CrossOrigin注解将为请求处理类或请求处理方法提供跨域调用支持。如果我们将此注解标注类，那么类中的所有方法都将获得支持跨域的请求能力。使用此注解的好处就是可以支持微调跨域行为。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDq0YfTJhHhA4JhnaBT2Od39yta4zIIUaDyQhiayAFciac1de4MtNias4A3w/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

 

18、@InitBinder

@InitBinder注解用于标注初始化WebDataBinder的方法，该方法用于对Http请求传递的表单数据进行处理，如时间格式化、字符串处理等。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDq9OjzLe1OXxFQKrqMV1p1nLOKQmg6HZQdZ8ve2dyXvgDYAqaicLSSwlQ/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

 

1-2、Spring Bean 注解

1、@ComponentScan

@ComponentScan注解用于配置Spring需要扫描的被组建注解注释的类所在的包。可以通过basePackages属性或者value属性来配置需要扫描的抱抱路径。value属性是babsePackages的别名

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDqqpjHsRHdOGfKAc9jHS6ictAcoxRxQHMZDKCXOfib8b8yyVN5cEDKFfZQ/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

2、@Component

@Component注解用于标注一个普通的组建类，他没有明确的业务范围，只是同志被此注解的类需要被纳入到Spring Bean容器中并进行管理。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDq39Ou2oVMj5TibBKGVxIt6QichuEibiaoSPwAGBgYlpyp7jTovaOiar4AvkA/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

3、@Service

@Service注解是@Component的一个延伸，它用于标注业务逻辑类。与@Component注解一样，被此注解的类，会自动被Spring所管理。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDqSat4kibFUMvnTvxzqru4DMyFaZR1BonVFcicUbN5OEgjNOCd7XfJ4xyA/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1

4、@Repository

@Repository注解也是@Component注解的延伸，与@Component注解一样，被刺注解标注的类会被Spring自动管理起来，@Repository注解用于标注DAO曾的数据持久化类。

https://mmbiz.qpic.cn/mmbiz_png/JfTPiahTHJhouLowuEibXAbxvEeuIb9yDqJXNeGQtIMxBwS7VKxmbUsFruSgLhtYP5GbxII2KL0Tn4NWZicLNiaNlQ/640?wx_fmt=png&wxfrom=5&wx_lazy=1&wx_co=1