项目搭建-统一参数校验

2024-01-30

搭建属于自己的类属性(VO,DTO,PO,Entity等)校验

本思路使用如果会使用了，你可以在各个项目中整体处理对象，校验对象的属性

内容

采用 springboot 的 Validation，导入依赖

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

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

如果你学习过 springboot 的 Validation，相信你知道，所谓的校验只是在类的属性上添加一个注解。但是当你真正使用的时候发现无从下手，虽然我们在实体(后续类的属性统称为实体)中添加了对应的注解，但是接下里该做什么。启动项目，然后调用接口创建实体对象，然后发现报错了。而且报错是异常处理报错 MethodArgumentNotValidException，这个报错是到了 java 异常中的。

本章接下里内容包括如果把这些java异常统一处理，使我们调用接口创建实体对象，如果没有满足校验规则，返回校验规则的 msg。

统一结果返回

在开始之前，我说一下。在接口调用中我们需要定义一个返回的 VO。这里总共创建了两个类和一个枚举，分别是通用的响应对象VO类，统一的成功和失败的处理方法的类，接口响应状态码的枚举。

通用的响应对象VO类:

@Data
@NoArgsConstructor  
@AllArgsConstructor
public class EntityResult<T> implements Serializable {  
    private static final long serialVersionUID = -3021643689165802865L;  
    private String result = "1";  
    private String msg;  
    private String extInfo;  
    private T rows;  
}

统一的成功和失败的处理方法的类:

/**  
 * 封装响应  
 */
 public class ResultHandler { 
    /**  
     * 操作成功  
     *  
     * @return  
     */  
    public static <T> EntityResult<T> operOk() {  
        EntityResult<T> optResult = new EntityResult<T>();  
        optResult.setResult(SuccessEnum.SUCCESS.getResult());  
        optResult.setMsg(SuccessEnum.SUCCESS.getMsg());  
        return optResult;  
    }  
  
    /**  
     * 操作成功  
     *  
     * @return  
     */  
    public static <T> EntityResult<T> operOk(String msg) {  
        EntityResult<T> optResult = new EntityResult<T>();  
        optResult.setResult(SuccessEnum.SUCCESS.getResult());  
        optResult.setMsg(msg);  
        return optResult;  
    }  
  
    /**  
     * 操作失败  
     *  
     * @return  
     */  
    public static <T> EntityResult<T> operError(String msg) {  
        EntityResult<T> optResult = new EntityResult<T>();  
        optResult.setResult(SuccessEnum.Error.getResult());  
        optResult.setMsg(msg);  
        return optResult;  
    }  
  
    /**  
     * 操作失败  
     *  
     * @return  
     */  
    public static <T> EntityResult<T> operError(String msg, String extText) {  
        EntityResult<T> optResult = new EntityResult<T>();  
        optResult.setResult(SuccessEnum.Error.getResult());  
        optResult.setMsg(msg);  
        optResult.setExtInfo(extText);  
        return optResult;  
    } 
}

接口响应状态码的枚举：

@Getter  
public enum StatusEnum {  
    SUCCESS(200 ,"请求处理成功"),  
    UNAUTHORIZED(401 ,"用户认证失败"),  
    FORBIDDEN(403 ,"权限不足"),  
    SERVICE_ERROR(500, "服务器去旅行了，请稍后重试"),  
    PARAM_INVALID(1000, "无效的参数"),  
    ;  
    public final Integer code;  
  
    public final String message;  
  
    StatusEnum(Integer code, String message) {  
        this.code = code;  
        this.message = message;  
    }  
}

### 统一异常处理

统一异常处理的必要性体现在保持代码的一致性、提供更清晰的错误信息、以及更容易排查问题。通过定义统一的异常处理方式，确保在整个应用中对异常的处理保持一致，减少了重复编写相似异常处理逻辑的工作，同时提供友好的错误信息帮助开发者和维护人员更快地定位和解决问题，最终提高了应用的可维护性和可读性。

定义统一的异常类

我们需要定义服务中可能抛出的自定义异常类。这些异常类可以继承自RuntimeException，并携带有关异常的相关信息。即可理解为局部异常，用于特定的业务处理中异常。手动埋点抛出。

/**  
 * 捕获Vo,po,entity中Validation校验异常  
 */  
@Data  
public class MethodArgumentNotValidException extends RuntimeException{  
    private static final long serialVersionUID = -3303518302920463234L;  
    private StatusEnum status;  
  
    public MethodArgumentNotValidException(StatusEnum status, String message) {  
        super(message); this.status = status;  
    }  
  
    public MethodArgumentNotValidException(StatusEnum status) {  
        this(status, status.message);  
    }  
}

2.异常处理器

@Slf4j  
@ControllerAdvice  
public class ExceptionAdvice {  
  
    /**  
     * 处理MethodArgumentNotValidException  
     * @param methodArgumentNotValidException MethodArgumentNotValidException  
     * @param request 请求参数  
     * @return 接口响应  
     */  
    @ExceptionHandler(MethodArgumentNotValidException.class)  
    @ResponseBody  
    public EntityResult<Void> handleServiceException(MethodArgumentNotValidException methodArgumentNotValidException, HttpServletRequest request) {  
        log.warn("request {} throw ServiceException \n", request, methodArgumentNotValidException);  
        return ResultHandler.operError(methodArgumentNotValidException.getMessage(),String.valueOf(methodArgumentNotValidException.getStatus()));  
    }  
  
    /**  
     * 其他异常拦截  
     * @param ex 异常  
     * @param request 请求参数  
     * @return 接口响应  
     */  
    @ExceptionHandler(Exception.class)  
    @ResponseBody  
    public EntityResult<Void> handleException(Exception ex, HttpServletRequest request) {  
        log.error("request {} throw unExpectException \n", request, ex);  
        return ResultHandler.operError(String.valueOf(StatusEnum.SERVICE_ERROR));  
    }  
}

统一属性注解校验

这里采用Vo类 UserCreateRequestVO 举例，本节有两个类，一个为Vo类，一个是controller接口调用类。

Vo类：

/**  
 * @version 1.0  
 * @description: <p></p >  
 * @author: 码农Academy  
 * @create: 2024/1/8 16:46  
 */@Data  
public class UserCreateRequestVO {  
  
    @NotBlank(message = "请输入用户名")  
    @Size(max = 128, message = "用户名长度最大为128个字符")  
    private String userName;  
  
    @Email(message = "请填写正确的邮箱地址")  
    private String email;  
  
    @Min(value = 18, message = "用户年龄必须大于18岁")  
    @Max(value = 60, message = "用户年龄必须小于60岁")  
    private Integer age;  
  
    @NotEmpty(message = "请输入你的兴趣爱好")  
    @Size(max = 5, message = "兴趣爱好最多可以输入5个")  
    private List<String> hobbies;  
  
    @DecimalMin(value = "50", inclusive = false, message = "体重必须大于50KG")  
    private BigDecimal weight;  
  
    @NotNull(message = "请输入地址信息")  
    private UserAddressRequestVO address;  
}

controller接口调用类：

@RestController  
@RequestMapping("user")
@Validated
@Slf4j
public class UserController {  
  
    /**  
     * 创建用户  
     * @param requestVO  
     * @return  
     */  
    @PostMapping("create")  
    public EntityResult<Void> createUser(@Validated @RequestBody UserCreateRequestVO requestVO){  
        return ResultHandler.operOk(null);  
    }  
  
    /**  
     * 校验用户邮箱是否合法  
     * @param email  
     * @return  
     */  
    @GetMapping("email")  
    public EntityResult<Void> validUserEmail(@Email(message = "邮箱格式不正确") String email){  
        return ResultHandler.operOk(null);  
    }  
}

测试及结果

调用方法

POST http://{{host}}/user/create
Accept: application/json, text/plain, */*  
Content-Type: application/json; charset=UTF-8  

{  
  "userName": "",  "hobbies": ["打乒乓球"],  
  "weight": 76.02,  "address": {}
}

返回结果:

{
  "result": "0",
  "msg": "请输入用户名",
  "extInfo": null,
  "rows": null,
  "rowcount": null,
  "pageindex": null,
  "pagecount": null,
  "row": null
}

看到这个结果表示我们的类校验生效了

如果想要项目统一校验前端返回过来的VO，我们可以采用这种方法来处理