springboot：统一参数校验（JSR303校验）

        业务需求：在controller中对必填参数和参数类型做合法性校验

1、在项目父工程添加spring-boot-starter-validation的依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2、在引入的validation依赖包下有很多这样的校验注解，直接使用注解定义校验规则即可。

3、现在对下面业务中的文章发布功能做参数校验

package com.heima.wemedia.controller.v1;

import com.heima.model.common.dtos.ResponseResult;
import com.heima.model.common.wemedia.model.po.WmNewsMaterial;
import com.heima.wemedia.service.WmNewsService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api/v1/news")
public class WmNewsController {

    @Autowired
    WmNewsService wmNewsService;
    
    
    /*文章发布*/
    @PostMapping("/submit")
    public ResponseResult addNews(@RequestBody WmNewsDto dto){
        return wmNewsService.addNews(dto);
    }

}

4、可以看到上面接口使用WmNewsDto模型对象接收参数，所以进入WmNewsDto类，在属性上添加校验规则。

        下面我使用了NotEmpty注解验证非空

package com.heima.model.common.wemedia.model.dto;

import lombok.Data;

import javax.validation.constraints.NotEmpty;
import java.util.Date;
import java.util.List;

@Data
public class WmNewsDto {

    private Integer id;
     /**
     * 标题
     */
    @NotEmpty(message = "文章标题不能为空")
    private String title;
     /**
     * 频道id
     */
    private Integer channelId;
     /**
     * 标签
     */
    @NotEmpty(message = "标签不能为空")
    private String labels;
     /**
     * 发布时间
     */
    private Date publishTime;
     /**
     * 文章内容
     */
    @NotEmpty(message = "文章内容不能为空")
    private String content;
     /**
     * 文章封面类型  0 无图 1 单图 3 多图 -1 自动
     */
    private Short type;
     /**
     * 提交时间
     */
    private Date submitedTime; 
     /**
     * 状态 提交为1  草稿为0
     */
    private Short status;
     
     /**
     * 封面图片列表 多张图以逗号隔开
     */
    private List<String> images;
}

5、还需要再controller中添加@Validated 注解开启参数校验

    /*文章发布*/
    @PostMapping("/submit")
    public ResponseResult addNews(@RequestBody @Validated WmNewsDto dto){
        return wmNewsService.addNews(dto);
    }

6、如果校验出错Spring会抛出MethodArgumentNotValidException异常，我们需要在统一异常处理器中捕获异常，解析出异常信息。

        代码如下

@ResponseBody
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public RestErrorResponse methodArgumentNotValidException(MethodArgumentNotValidException e) {
    BindingResult bindingResult = e.getBindingResult();
    List<String> msgList = new ArrayList<>();
    //将错误信息放在msgList
    bindingResult.getFieldErrors().stream().forEach(item->msgList.add(item.getDefaultMessage()));
    //拼接错误信息
    String msg = StringUtils.join(msgList, ",");
    log.error("【系统异常】{}",msg);
    return new RestErrorResponse(msg);
}