spring boot 常用注释学习笔记（一）

最新推荐文章于 2023-01-28 13:42:02 发布

momojacky

最新推荐文章于 2023-01-28 13:42:02 发布

阅读量394

点赞数

本文链接：https://blog.csdn.net/weixin_48397688/article/details/125366993

版权

出于个人学习的目的，记录一下基础知识点，防止遗忘

一、Spring Web MVC 与 Spring Bean 注解

一、@RequestMapping
提示：在使用@RequestMapping之前，请求处理类还需要使用@Controller或@RestController进行标记
六个配置属性
1.value :映射的请求URL或者其别名
2.method:兼容HTTP的方法名
3.params:根据HTTP参数的存在、缺省或值对请求进行过滤
4.header:根据HTTP Header的存在、缺省或值对请求进行过滤
5.consume:设定在HTTP请求正文中允许使用的媒体类型
6.product:在HTTP响应体中允许使用的媒体类型

二、@PostMapping与@GetMapping

@PostMapping("/xx/xx") = @RequestMapping (value = "/xx/xx" , method = RequestMethod.POST)

@GetMapping = @RequestMapping (value = "/xx/xx" , method = RequestMethod.GET)

（类似的还有 @PutMapping 、@DeleteMapping、@PatchMapping）

根据HTTP规范:
1. GET 用于信息获取，而且是安全的和幂等的
GET请求是安全的。所谓安全是指不管进行多少次操作，资源的状态都不会改变。该请求就像数据库的select操作一样，只是用来查询一下数据，不会修改、增加数据，不会影响资源的内容，即该请求不会产生副作用。无论进行多少次操作，结果都是一样的。

2. POST 用于创建数据，不是安全和幂等的
POST请求既不是安全的，也不是幂等的，比如常见的POST重复加载问题：当我们多次发出同样的POST请求后，其结果是创建出了若干的资源。

3. PUT 用于创建或完整更新数据，而且是安全和幂等的
PUT请求是向服务器端发送数据的，从而改变信息，该请求就像数据库的update操作一样，用来修改完整的数据内容，但是不会增加数据的种类等，也就是说无论进行多少次PUT操作，其结果并没有不同。

4. DELETE 用于删除数据，而且是安全和幂等的
DELETE请求顾名思义，就是用来删除某一个资源的，该请求就像数据库的delete操作，无论进行多少次DELETE操作，其结果并没有不同。

5. PATCH 用于更新部分数据，不是安全和幂等的
PATCH请求是对PUT请求的补充，一般用来对已知资源部分更新，是后来新出的标准，GitHub Api也开始使用。

@RequestMapping还可以对类进行标记，这样类中的处理方法在映射请求路径时，会自动将类上@RequestMapping设置的value拼接到方法中映射路径之前

三、RequestBody

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

四、@Valid
例: 对象中添加

/**
 * 员工对象
 * 
 * @author sunnyzyq
 * @since 2019/12/13
 */
@Data
public class Employee {
 
    /** 姓名 */
    @NotBlank(message = "请输入名称")
    @Length(message = "名称不能超过个 {max} 字符", max = 10)
    public String name;
 
    /** 年龄 */
    @NotNull(message = "请输入年龄")
    @Range(message = "年龄范围为 {min} 到 {max} 之间", min = 1, max = 100)
    public Integer age;
}

/* BindingResult 用来存放校验报错信息 */
    @PostMapping("/assigns")
    public String assigns(@Valid @RequestBody AssignList assigns, BindingResult bindingResult) {
        if (bindingResult.hasErrors()){
            return bindingResult.getAllErrors().get(0).getDefaultMessage();
        }
        String result = basicInfoService.assigns(assigns);
        return result;
    }

五、@ResponseBody

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

六、@ControllerAdvice
@ControllerAdvice是@Component注解的一个延伸注解，Spring会自动扫描并检测被@ControllerAdvice所标注的类。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用，主要是用来处理控制器所抛出的异常信息。

首先，我们需要定义一个被@ControllerAdvice所标注的类，在该类中，定义一个用于处理具体异常的方法，并使用@ExceptionHandler注解进行标记。

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

1.@ModelAttribute

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

2.@InitBinder

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

3.@ExceptionHandler

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