springboot 参数验证 简单灵活自由功能强大 validate-springboot-starter 又一个选择

git地址

https://github.com/liangbaika/validate

validate-spring-boot-starter

maven 中央仓库

        <dependency>
            <groupId>com.github.liangbaika</groupId>
            <artifactId>validate-spring-boot-starter</artifactId>
            <version>{latest}</version>
        </dependency>

validate-spring-boot-starter 简介 （desc）

是一个validate-springboot-starter,与springboot框架无缝集成的灵活丰富的验证框架。

versus springboot Framework for seamless integration of verification framework.

注意(attention)

1 如果非法参数将抛出ParamsValidException，您应该捕获这个特殊的异常并解决它。
如果采用的是jsr303型即javax-validation验证并且不是用的@AbcValidate注解,则需要自行处理异常。
对象多级验证时 例如 ‘user.name’ 目前最多支持两级，需求注意。

2 ValidateParam里的express字段使用，一般情况下 可以为空，
当value是Custem时，express=validateBeanName, 有的验证方法需要多个值 逗号分隔即可。
反正注意的是 此express字段和验证的value方法息息相关.

if illegal paramas then will throw ParamsValidException, and you should catch this special exception
and resolve it. Object multilevel authentication such as ‘user.name’ currently supports up to two levels.

优点（advantages）

集成了很多的验证，比如手机号验证，正则验证，邮箱，数字，小数，车牌号，身份证，长度，url等常用验证。
和javax validation 相比,我们的bean可以重复使用，具有更高的灵活性,只要是和验证相关的，可以做到和业务代码完全解耦。

Integrated with a lot of authentication, such as phone number authentication, regular authentication, email,
Numbers, decimals, license plate number, ID card, length, URL, and so on.Our beans are reusable and have more
flexibility than Javax Validation.

（自定义）custom

只需要实现ParamValidator接口就好了，便可以处理复杂的验证，和业务代码完全解耦(你需要让这个实现接口的Bean被Spring容器托管);
All you need to do is implement the ParamValidator interface, which handles complex validation and is completely
decoupled from the business code (you need to have the Bean that implements the interface hosted by the Spring container).

快速开始（quick start）

package com.github.liangbaika.validate.test;

import com.github.liangbaika.validate.annations.ValidateParam;
import com.github.liangbaika.validate.annations.ValidateParams;
import com.github.liangbaika.validate.enums.Check;
import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;

/**
 * @author lq
 * @version 1.0
 * @date 2020/6/16 11:56
 */
@RestController
@RequestMapping("/test")
public class TestController {


    /**
     * 单字段简单验证
     *
     * @param name
     * @return
     */
    @GetMapping("test0")
    @ValidateParam(value = Check.Length, argName = "name", express = "2,6",msg="自定义提示信息")
    public Object test0(String name) {
        return Boolean.TRUE;
    }

    /**
     * 多字段验证
     *
     * @param name
     * @param age
     * @param idcard
     * @return
     */
    @ValidateParams(
            value = {
                    @ValidateParam(value = Check.NotEmpty, argName = "name"),
                    @ValidateParam(value = Check.Number, argName = "age"),
                    @ValidateParam(value = Check.isIDCard, argName = "idcard"),
            }
    )
    @GetMapping("test1")
    public Object test1(String name, Integer age, Integer idcard) {
        return Boolean.TRUE;
    }

    /**
     * 实体验证 javax-validation验证方式
     *
     * @param oneData
     * @return
     */
    @PostMapping("test2")
    public Object test2(@RequestBody @Valid OneData oneData) {
        return oneData;
    }


    /**
     * 对象多级验证，混合验证
     *
     * @param oneData
     * @return
     */
    @PostMapping("test3")
    @ValidateParams(
            value = {
                    @ValidateParam(value = Check.NotEmpty, argName = "oneData.name"),
                    @ValidateParam(value = Check.Number, argName = "oneData.age"),
            }
    )
    public Object test3(@RequestBody @Valid OneData oneData) {
        return oneData;
    }


    /**
     * 自定义验证
     *
     * @param oneData
     * @return
     */
    @PostMapping("test4")
    @ValidateParam(value = Check.Custom, argName = "oneData.name", express = "nameValidater")
    public Object test4(@RequestBody OneData oneData) {
        return oneData;
    }

}


package com.github.liangbaika.validate.test;

import com.github.liangbaika.validate.annations.AbcValidate;
import com.github.liangbaika.validate.enums.Check;

/**
 * @author lq
 * @version 1.0
 * @date 2020/6/16 11:59
 */

public class OneData {


    @AbcValidate(required = true, fun = Check.Custom, express = "nameValidater")
    private String name;
    @AbcValidate(required = true)
    private Integer age;
    @AbcValidate(required = true, fun = Check.le, express = "1")
    private Integer sex;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Integer getSex() {
        return sex;
    }

    public void setSex(Integer sex) {
        this.sex = sex;
    }
}






package com.github.liangbaika.validate.test;

import com.github.liangbaika.validate.core.ParamValidator;
import org.springframework.stereotype.Component;

/**
 * 自定义验证器 模拟复杂逻辑校验
 *
 * @author lq
 * @version 1.0
 * @date 2020/6/16 12:01
 */
@Component
public class NameValidater implements ParamValidator {

    @Override
    public Boolean validate(Object value) {
        String name = (String) value;
        if (name.startsWith("张") && name.length() == 3) {
            return true;
        }
        return false;
    }
}

错误处理( resolve error)

@ControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    @ExceptionHandler({com.github.liangbaika.validate.exception.ParamsValidException .class})
    @ResponseBody
    public Results handleParamsValidException(com.github.liangbaika.validate.exception.ParamsValidException  e) {
        return Results.error(new ErrorCode(ErrorCode.PARAMA_ERROR.getCode(), "参数错误 " + e.getMessage()));
    }
}

感谢与建议 （Thanks and Suggestions）

此项目采用 Apache License协议, 欢迎大家使用或提出建议或贡献代码
如果需要PR，请遵守标准提PR的那套标准原则。
You are welcome to use or suggest or contribute code
If PR is required, please follow the set of standard principles mentioned in the standard.