spring-eolink官网

spring

目录一、前言二、常用注解三、定义分组四、定义需要校验的对象五、在handler 即 Controller中校验六、定义全局异常处理类七、测试效果八、嵌套对象的校验九、自定义注解（自定义校验规则）

一、前言

本章介绍使用spring-boot-starter-validation 校验 SpringMVC 的入参。

org.springframework.boot

spring-boot-starter-parent

2.5.2

org.springframework.boot

spring-boot-starter-validation

二、常用注解

三、定义分组

用于分组校验。使用场景，对同一个对象例如User(username , id) 在不同的接口时需要的校验规则不同。例如，访问一个接口需要 username 不为null且长度大于0 ，id>=0 ；访问另一个接口需要 username 参数的长度在 [1,3]之间。

public class ValidateGroup {

public interface FirstGroup {

}

public interface SecondeGroup {

}

public interface ThirdGroup {

}

四、定义需要校验的对象

import javax.validation.constraints.Min;

import javax.validation.constraints.NotEmpty;

import javax.validation.constraints.Size;

import lombok.Data;

@Data

public class User {

@NotEmpty(message = "用户名不能为空")

@Size(message = "用户名长度 [1-3] ", min = 1, max = 3,groups = ValidateGroup.FirstGroup.class)

private String username;

@Min(message = "id不得小于0", value = 0)

private Integer id;

}

五、在handler 即 Controller中校验

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;

import com.nbpicc.controller.ValidateGroup.FirstGroup;

@RestController

@RequestMapping("/")

public class TestController {

@PostMapping("test3")

public User test3(@RequestBody @Validated({ FirstGroup.class }) User u) {

System.out.println(u);

return u;

}

@PostMapping("test4")

public User test4(@Validated User u) {

System.out.println(u);

return u;

}

校验失败，会直接抛出异常。这样不太友好，可以使用@ControllerAdvice处理全局异常。

六、定义全局异常处理类

import java.util.List;

import org.springframework.validation.BindException;

import org.springframework.validation.BindingResult;

import org.springframework.validation.FieldError;

import org.springframework.web.bind.MethodArgumentNotValidException;

import org.springframework.web.bind.annotation.ExceptionHandler;

import org.springframework.web.bind.annotation.RestControllerAdvice;

import lombok.extern.slf4j.Slf4j;

@Slf4j

@RestControllerAdvice

public class GlobalExceptionHandler {

@ExceptionHandler(value = BindException.class)

public jsonResult exceptionHandle(BindException exception) {

BindingResult result = exception.getBindingResult();

StringBuilder errorMsg = new StringBuilder();

List fieldErrors = result.getFieldErrors();

fieldErrors.forEach(error -> {

log.error("field: " + error.getField() + ", msg:" + error.getDefaultMessage());

errorMsg.append(error.getDefaultMessage()).append("!");

});

return JsonResult.fail(errorMsg.toString());

}

@ExceptionHandler(value = MethodArgumentNotValidException.class)

public JsonResult MyExceptionHandle(MethodArgumentNotValidException exception) {

BindingResult result = exception.getBindingResult();

StringBuilder errorMsg = new StringBuilder();

List fieldErrors = result.getFieldErrors();

fieldErrors.forEach(error -> {

log.error("field: " + error.getField() + ", msg:" + error.getDefaultMessage());

errorMsg.append(error.getDefaultMessage()).append("!");

});

return JsonResult.fail(errorMsg.toString());

}

// 处理运行时异常

@ExceptionHandler(RuntimeException.class)

public JsonResult doHandleRuntimeException(RuntimeException e) {

log.error(e.getMessage(), e);

e.printStackTrace();

return JsonResult.fail(e.getMessage());

}

另外JsonResult.java用于接口返回统一个json格式

import com.fasterxml.jackson.annotation.JsonInclude;

import lombok.AllArgsConstructor;

import lombok.Data;

import lombok.NoArgsConstructor;

import lombok.experimental.Accessors;

/**

*@author wang

*@Date 2020-9-14

**/

@Data

@Accessors(chain = true)

@NoArgsConstructor

@AllArgsConstructor

@JsonInclude(JsonInclude.Include.NON_NULL)

public class JsonResult {

/** 成功 */

public static final int SUCCESS=200;

/**内部服务器错误**/

public static final int FAIL=500;

/** 没有登录 */

public static final int NOT_LOGIN = 400;

/** 发生异常 */

public static final int EXCEPTION = 401;

/** 系统错误 */

public static final int SYS_ERROR = 402;

/** 参数错误 */

public static final int PARAMS_ERROR = 403;

/** 不支持或已经废弃 */

public static final int NOT_SUPPORTED = 410;

/** AuthCode错误 */

public static final int INVALID_AUTHCODE = 444;

/** 太频繁的调用 */

public static final int TOO_FREQUENT = 445;

/** 未知的错误 */

public static final int UNKNOWN_ERROR = 499;

private Integer code;

private String msg;

private T data;

public static JsonResult fail() {

return new JsonResult(FAIL, "请求处理失败",null);

}

public static JsonResult fail(String msg) {

return new JsonResult(FAIL, msg,null);

}

public static JsonResult fail(Integer code,String msg) {

return new JsonResult(code, msg,null);

}

public static JsonResult success() {

return new JsonResult(SUCCESS,"请求处理成功",null);

}

public static JsonResult success(String msg) {

return new JsonResult(SUCCESS,msg,null);

}

public static JsonResult success(T data) {

return new JsonResult (SUCCESS,"请求处理成功",data);

}

public static JsonResult success(String msg,T data) {

return new JsonResult(SUCCESS, msg,data);

}

public static JsonResult err() {

return build(EXCEPTION);

}

public static JsonResult err(String msg) {

return build(EXCEPTION, msg);

}

public JsonResult code(int code) {

this.code = code;

return this;

}

public JsonResult msg(String msg) {

this.msg = msg;

return this;

}

public JsonResult data(T data) {

this.data = data;

return this;

}

public static JsonResult build() {

return new JsonResult();

}

public static JsonResult build(int code) {

return new Jsonhttp://Result().code(code);

}

public static JsonResult build(int code, String msg) {

return new JsonResult().code(code).msg(msg);

}

public static JsonResult build(int code, T data) {

return new JsonResult().code(code).data(data);

}

public static JsonResult build(int code, String msg, T data) {

return new JsonResult().code(code).msg(msg).data(data);

}

当然还有其他异常处理方式可以参考：https://jb51.net/article/244379.htm

七、测试效果

八、嵌套对象的校验

import lombok.Data;

import javax.validation.Valid;

import javax.validation.constraints.*;

@Data

public class User {

@NotEmpty(message = "用户名不能为空")

@Size(message = "长度 [1-3] ", min = 1, max = 3, groups = ValidateGroup.FirstGroup.class)

private String username;

@Min(message = "id不得小于0", value = 0)

private Integer id;

@NotBlank(message = "地址不能为空", groups = {ValidateGroup.ThirdGroup.class, ValidateGroup.SecondeGroup.class})

private String address;

//在内部属性是自定义对象的时候添加 @Valid 注解，即可开启对In对象的校验。

//记得添加@NotNull注解，否则该对象可以为null，并且此时In对象的校验规则也不会抛出异常。

@Valid

@NotNull(message = "In 对象不能为null ", groups = {ValidateGroup.ThirdGroup.class, ValidateGroup.SecondeGroup.class})

private In in;

}

/**

*自定义的对象，User对象中的一个属性。

@Data

public class In {

@NotBlank(message = "str不能为空", groups = {ValidateGroup.ThirdGroup.class, ValidateGroup.SecondeGroup.class})

private String str;

}

九、自定义注解（自定义校验规则）

9.1 实现ConstraintValidator接口

import javax.validation.ConstraintValidator;

import javax.validation.ConstraintValidatorContext;

public class WordConstraintValidator implements ConstraintValidator {

@Override

public boolean isValid(Object value, ConstraintValidatorContext context) {

// 具体的校验规则

return value.toString().length() == 10;

}

9.2 自定义注解

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

import javax.validation.Constraint;

import javax.validation.Payload;

@Target({ ElementType.METHOD, ElementType.FIELD })

@Retention(RetentionPolicy.RUNTIME)

@Constraint(validatedBy = WordConstraintValidator.class)

public @interface CustomValidaor {

String message();

// groups 和 payload 这两个parameter 必须包含,不然会报错

Class>[] groups() default {};

Class extends Payload>[] payload() default {};

}

9.3 使用

@Data

public class Inner {

@NotBlank(message = "str不能为空", groups = { ValidateGroup.ThirdGroup.class, ValidateGroup.SecondeGroup.class })

@CustomValidaor(message = "长度必须为10", groups = { ValidateGroup.ThirdGroup.class, ValidateGroup.SecondeGroup.class })

private String str;

}

9.4测试

访问接口

@PostMapping("test6")

public User test6(@Validated({ValidateGroup.SecondeGroup.class}) @RequestBody User u) {

System.out.println(u);

return u;

}

Java设计模式之外观模式示例详解

268 2022-08-14

spring

Java设计模式之外观模式示例详解

Java设计模式之享元模式示例详解

SpringBoot实现多数据源的切换实践

推荐文章

接口调用是什么意思？几种常用接口调用方式

接口设计原则

8款在线 API 接口文档管理工具

api管理系统是什么？

什么是接口调试？接口调试的步骤有哪些？

api 接口管理系统有哪些？

接口测试有几种测试方法

API文档生成工具有哪些？

微服务和api网关区别

交换机配置步骤

最近发表

热评文章

在线接口文档管理工具推荐，支持在线测试，HTTP接口

开源的在线接口文档wiki工具Mindoc的介绍与使

如何优雅的进行接口设计？接口设计的六大原则是什么？

什么是API测试,api检测公司

软件接口设计怎么做？前后端分离软件接口设计思路

接口管理平台推荐，几大接口管理平台总有一款适合你！