简单好用的springboot springmvc springcloud dubbo 参数验证

最新推荐文章于 2024-07-06 23:23:08 发布
置顶 最新推荐文章于 2024-07-06 23:23:08 发布
阅读量854 收藏
点赞数
分类专栏： springboot springmvc 文章标签： springboot参数验证 springmvc 参数验证
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fashionbrot/article/details/100189992
版权

mars-validated

简单好用的参数验证，支持spring 、springboot 、springcloud、dubbo
validated 是 控制 springmvc springboot 的验证框架。
只对 Controller层接口参数验证。此框架基于spring 开发。开发环境 jdk1.8 spring4.0开始，可以直接在service实现上添加注解，也可以在Controller 层直接使用

mars-validated springmvc springboot springcloud dubbo 参数校验

简单好用的 springmvc springboot springcloud dubbo 参数校验

版本新增功能
1.0.01、参数验证基本功能上线
1.0.11、新增验证注解
2、Validated 注解增加validClass方法，可以选择性验证自己想要的参数。
3、新增Default 注解
1.0.21、代码逻辑优化。
2、新增groups 功能，可以根据groups 选择性验证
1.0.31、Constraint 接口增加  validatedByBean 方法，用来自定义注解实现
2、新增国际化支持 EnableValidatedConfig 中增加了 language方法、localeParamName方法用来实现消息内容国际化支持，目前支持中英文两种。其他语言请自行添加
3、增加1.0.3 的validated-springboot-starter 支持
2.0.01、Constraint 接口删除 validatedByBean 方法
2、删除ConstraintValidatorBean 接口
3、ConstraintValidator 新增 modify 方法、validObject 方法
4、Validated 注解增加 failFast快速失败方法、增加validReturnValue 方法（验证返回值）
5、重构了以前的逻辑，相比hibernate valid 速度快1倍左右

hibernate valid 和 mars validated 比较 调用1000次接口时间比较,验证参数10个

hibernate

http://localhost:8080/compare/demo5?method=hibernate&count=1000

4213,4269,4221,4183,4187

mars

http://localhost:8080/compare/demo5?method=/compare/mars&count=1000

2158,2128,2174,2256,2150

通过测试可以看出，mars 比 hibernate 速度提升接近1倍

validated 参数验证

使用环境

spring4.0 及以上
jdk1.8 及以上

AnnotationSupported data types作用
NotBlankString验证String 字符串是否为空
NotNullString,Object,Integer,Long,Double,Short,Float,BigDecimal, BigInteger验证对象是否为空
NotEmptyString验证字符串不能为空
AssertFalseBoolean,boolean,String只能为false
AssertTrueBoolean,boolean,String只能为true
BankCardString验证银行卡
CreditCardString验证信用卡
DefaultInteger,Double,Long,Short,Float,BigDecimal,String设置默认值
DigitsString验证是否是数字
EmailString验证是否是邮箱
IdCardString验证是否是身份证，验证18岁
Lengthint,long,short,double,Integer,Long,Float,Double,Short,String验证长度
PatternString正则表达式验证
PhoneString验证手机号是否正确
Sizeobject[],boolean[],byte[],char[],double[],float[],int[],long[],short[],String length,Collection,Map验证大小值
NotEqualLengthString验证长度

使用4步配置

1、导入jar

        <!-- springmvc 依赖-->
        <dependency>
            <groupId>com.github.fashionbrot</groupId>
            <artifactId>mars-validated</artifactId>
            <version>2.0.0</version>
        </dependency>
        <!-- springboot 依赖-->
        <dependency>
               <groupId>com.github.fashionbrot</groupId>
               <artifactId>validated-springboot-starter</artifactId>
               <version>2.0.0</version>
        </dependency>

1、validated springboot 的使用方式 1 (application.properties 直接添加)

mars.validated.file-name=valid
mars.validated.language=zh_CN
mars.validated.locale-param-name=lang

1、validated springboot 的使用方式 2 （fileName 如果不填默认jar 包自带提示，如果需要批量自定义请按照jar 包下的valid_zh_CN.properties 修改提示语内容）

@SpringBootApplication
@EnableValidatedConfig(fileName = "valid",language="zh_CN",localeParamName="lang")    // fileName 默认中文jar包自带 如需要批量自定义请自己创建 valid_zh_CN.properties  放在自己项目中的resources 下
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

3、spring适配方式

@Component
@Configuration
@EnableValidatedConfig(fileName = "valid",language="zh_CN",localeParamName="lang") 
public class ValidConfig {
}

自定义实现全局异常处理

拦截 ValidatedException异常类

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ValidatedException.class)
    @ResponseStatus(HttpStatus.OK)
    public Object ValidatedException(ValidatedException e) {
        List<MarsViolation> violations = e.getViolations();
        return String.join(",",violations.stream().map(m-> m.getMsg()).collect(Collectors.toList()));
    }

}

@Validated 注解支持功能

方法作用
Class<?>[] validClass() default {}需要校验的 class
Class<?>[] groups() default { }校验组
boolean failFast() default truetrue 快速失败
boolean validReturnValue() default false验证返回值 默认false

使用参数验证方式（1）通过aop 自定义拦截

@Component
@Aspect
public class ValidAspect {

    @Pointcut("execution(* com.github.fashion.test.service.*.*(..))")
    private void pointcut() {}

    @Autowired
    private MarsValidator marsValidator;

    @Around(value = "pointcut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        //打印方法的信息
        Object[] args = joinPoint.getArgs();
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature)signature;
        //自定义参数验证
        marsValidator.parameterAnnotationValid(methodSignature.getMethod(),args);

        return joinPoint.proceed();
    }

}

使用参数验证方式（2） @Validated 开启接口验证 @Email验证邮箱格式

@Controller
public class DemoController {

    @Autowired
    private TestService testService;
    
    @RequestMapping("/emailCheck")
    @ResponseBody
    @Validated //注意此处
    public String demo(@Email String abc,){
        return testService.test(abc);
    }
}   
@Controller
public class DemoController {

    @Autowired
    private TestService testService;
    
    @RequestMapping("/idcardCheck")
    @ResponseBody
    @Validated //注意此处
    public String demo(IdCardModel idCardModel){
        return testService.test("ac");
    }
}


**此处支持多继承验证*** 

public class IdCardModel extends BaseModel{

    @IdCard
    private String idCardModel;

    public String getIdCardModel() {
        return idCardModel;
    }

    public void setIdCardModel(String idCardModel) {
        this.idCardModel = idCardModel;
    }
}

@Service
public class TestService{
    @Validated
    public void test2(@IdCard String abc){

    }
}

按照 @Validated(groups = {EditGroup.class}) valid 校验

@Controller
public class DemoController {
     @RequestMapping("/test1")
     @ResponseBody
     @Validated(groups = {EditGroup.class})
     public String test1( @Custom(min = 1,groups = {EditGroup.class,AddGroup.class}) String abc1){
         return abc1;
     }
 
 
     @RequestMapping("/test2")
     @ResponseBody
     @Validated(groups = AddGroup.class)
     public String test2(GroupModel groupModel){
         return groupModel.getAbc();
     } 
}

支持 默认值设置 hibernate默认不支持

import com.github.fashionbrot.validated.annotation.Default;
@Data
public class BaseModel {

    @Default("1")
    private Integer pageNo;

    @Default("20")
    private Integer pageSize;
}

支持对 bean 对象的直接验证

@RequestMapping("/valid/bean")
@Controller
public class ValidBeanController {


    @RequestMapping("/test")
    @ResponseBody
    @Validated
    public String test(@CustomBean ValidBeanModel validBeanModel){
        return validBeanModel.getA1()+validBeanModel.getA2();
    }
}
@Documented
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {CustomBeanConstraintValidatorBean.class})
public @interface CustomBean {
    //没有任何参数

}

public class CustomBeanConstraintValidatorBean implements ConstraintValidator<CustomBean, Object> {

    @Override
    public boolean isValid(CustomBean annotation, Object value, Class<?> valueType) {
        return true;
    }


    @Override
    public String validObject(CustomBean custom, Object var,Class<?> valueType) {

        if (var instanceof ValidBeanModel){
            ValidBeanModel beanModel= (ValidBeanModel) var;
            if (beanModel!=null && (beanModel.getA1()==null || beanModel.getA2()==null)){
                return "a1 或者 a2 为空";
            }
        }
        /**
         * return null 则验证成功 其他验证失败
          */
        return null;
    }
    @Override
    public Object modify(CustomBean annotation, Object var,Class<?> valueType) {
        System.out.println("CustomConstraintValidator:"+var);
        if (var instanceof ValidBeanModel){
            ValidBeanModel beanModel= (ValidBeanModel) var;
            beanModel.setA1("1");
            beanModel.setA2("2");
            return beanModel;
        }
        return var;
    }
}

支持 国际化消息提示（现支持中英文两种）

请求：http://localhost:8080/l18n/test?lang=en_us
提示：must not be empty
请求:http://localhost:8080/l18n/test?lang=zh_CN
提示：不能为空


@RequestMapping("/l18n")
@Controller
public class I18nController {

    @RequestMapping("/test")
    @ResponseBody
    @Validated
    public String test(@NotEmpty() String abc){
        return abc;
    }

}

支持 dubbo 接口、实现类上方法上添加 @Validated ,设置 dubbo DubboProviderFilter 拦截器做统一处理


public class DubboProviderFilter implements Filter {

    @Override
    public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
        Result result =  invoker.invoke(invocation);
        if(result.hasException() && result.getException() instanceof com.sgr.common.valid.exception.ValidationException){
            throw new CustomException(result.getException()); //自定义异常，全局拦截控制,或抛出 RpcException 自行拦截
        }
        return result;
    }
}

ConstraintValidator 接口新增方法

package com.github.fashionbrot.validated.constraint;
import java.lang.annotation.Annotation;
public  interface ConstraintValidator<A extends Annotation, T> {

        boolean isValid(A annotation, T var1);
    
        //实现类可实现可不实现,使用场景如 ajax传入 base64字符,可以在自己逻辑中实现自定义逻辑
        /**
         * 修改 value 值
         * @param annotation
         * @param value
         * @param valueType
         * @return
         */
        default T modify(A annotation,T value,Class<?> valueType){
            return value;
        }
        /**
         * return value==null?验证通过:验证不通过
         * 验证不过 throw Exception value
         * @param annotation
         * @param value
         * @param valueType
         * @return
         */
        default String validObject(A annotation, T value,Class<?> valueType){
            return null;
        }

}

支持自定义注解 如下：

1、实现 ConstraintValidator 此接口
2、自定义注解如下： CustomConstraintValidator.class,CustomConstraintValidator2.class 实现类可多个，至少有一个

    @Documented
    @Target({ElementType.FIELD,  ElementType.PARAMETER})
    @Retention(RetentionPolicy.RUNTIME)
    @Constraint(validatedBy = {CustomConstraintValidator.class,CustomConstraintValidator2.class})
    public @interface Custom {
    
        String msg() default "com.mars.valid.Custom.msg";
    
        int min();
    }

3、代码实现

public class CustomConstraintValidator implements ConstraintValidator<Custom,String> {

    @Override
    public boolean isValid(Custom custom,String var1,Class<?> valueType) {
        /**
         * 自定义方法
         */
        int min=custom.min();
        /**
         * value
         */
        System.out.println(var1);
        /**
         * return true 则验证成功 false 验证失败
          */
        return true;
    }
}

6、可通过 test项目中的 https://github.com/fashionbrot/mars-validated/tree/master/test/springboot-test 参考使用demo

7、如有问题请通过 https://github.com/fashionbrot/mars-validated/issues 提出 告诉我们。我们非常认真地对待错误和缺陷，在产品面前没有不重要的问题。不过在创建错误报告之前，请检查是否存在报告相同问题的issues。

如有问题请联系官方qq群：52842583

fashionbrot
关注
专栏目录
mars-validated:简单好用的 springmvc springboot springcloud dubbo 参数校验
05-21
mars-validated springmvc springboot springcloud dubbo 参数校验简单好用的 springmvc springboot springcloud dubbo 参数校验validated 是 控制 springmvc springboot 的验证框架。此框架基于spring 开发。版本...
【全网最全】JSR303参数校验与全局异常处理（从理论到实践别用if判断参数了）
小王博客基地
03-02 1569
文章目录一、前言二、JSR303简介三、导入依赖四、常用注解五、@Validated、@Valid区别六、常用使用测试1. 实体类添加校验2. 统一返回类型3. 测试类4. 普通测试结果5. 我们把异常返回给页面6. 异常处理结果七、抽离全局异常处理1. 心得体会2. 书写ExceptionControllerAdvice3. 测试结果八、分组校验1. 需求2. 创建分组接口（不需写任何内容）3. 在需要二义性的字段上添加分组4. 不同Controller添加校验规则5. 测试九、自定义校验1.定义自定义
springBoot注解的复习
qx020814的博客
10-24 164
这就很有趣，都忘光了。
jwt token太长了?自己实现序列化并缩短token长度
最新发布
fashionbrot的专栏
07-06 939
jwt token 太长了？ 可以试一下自定义实现的数据+签名的 token秘钥
springboot+dubbo+validation 进行 rpc 参数校验
哎幽的成长
09-22 9958
注意：本文dubbo 版本 2.8.4 springboot 版本 2.0.4.RELEASE 项目结构 test-rest （前端消费着，controller 层，springboot+maven项目） test-api （dubbo服务 的 api ，只记录 service 接口和 model ,maven 项目） test-provider（dubbo 服务提供者，实际的数据库操作及业务层...
JSR303校验与统一异常处理
qq_35419179的博客
05-11 613
JSR303校验的使用 1.给bean的属性添加校验注解并自定义校验提示信息 更多校验注解参考javax.validation.constraints包; BrandEntity.java @NotBlank(message = "不能为空") private String name; // 品牌logo地址 @URL(message = "logo必须是一个合法的url地址") private String logo; //自定义校验规则 @Pattern(regexp = "/^[a-zA
2022-05-02 三.表单校验
不爱吃奶昔（zsl0）的博客
05-02 485
表单校验图解练习 图解 个人整理Xind图片导出： 练习 导入依赖： <dependencies> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> <dependency> <groupId
尚硅谷SpringCloud视频 + 源码 百度网盘
11-06
根据给定文件的信息，我们...通过对Dubbo和SpringCloud的对比，可以让学习者更清楚地了解到两种技术栈的特点及其适用场景。最后，通过实战案例的学习，可以更好地将理论知识应用于实际工作中，从而提高自己的技术水平。
springboot整合dubbo实例
05-21
8. **扩展性**：SpringBoot整合Dubbo后，可以轻松地接入其他Spring生态组件，如SpringCloud、MyBatis等，进一步提升系统的灵活性和可扩展性。 这个实例项目提供了一个快速上手的模板，帮助开发者理解SpringBoot和...
2020年SpringCloud分布式面试题整理.pdf
11-03
SpringCloud 基于 SpringBoot，提供了一套完整的微服务解决方案，它依赖于 SpringBoot 的 web 组件（如 SpringMVC），并利用其快速开发特性来实现微服务架构中的各种组件。 Spring Cloud 的核心组件包括： 1. **...
苏宁数据中台基于Spring Cloud微服务架构实践.docx
10-24
在选型过程中，苏宁对比了Dubbo和Spring Cloud。Dubbo以其四个主要模块（Monitor、Registry、Provider、Consumer）提供了服务治理能力，但其基于RPC而非HTTP REST接口。而Spring Cloud使用Eureka作为注册中心，提供...
Spring 中@Validated 分组校验使用
u012102536的博客
02-09 1万+
说白了：分组的作用就是精准验证，解耦 Spring 中@Validated 分组校验使用 转载：Spring 中@Validated 分组校验使用_wangxuelei036的博客-CSDN博客_spring valid 分组 通过本文你能学习到@Validated 的基本使用，以及如何再spring-boot 中进行数据异常的统一处理 Spring Validation验证框架对参数的验证机制提供了@Validated（Spring’s JSR-303规范，是标准JSR-303的一个变种），j
【优雅的参数验证@Validated】@Validated参数校验的使用及注解详解——你还在用if做条件验证？
热门推荐
A-Itfuture的博客
11-15 3万+
你还在用if做条件验证？【优雅的参数验证@Validated】--@Validated参数校验的使用及注解详解
String中@NotNull、@NotBlank、@NotEmpty使用
weixin_45326523的博客
07-31 716
NotEmpty：适用于String、Collection集合、Map、数组等；@NotNull：适用于基本数据类型Integer、Long、Double等；@NotBlank：适用于String类型；
@NotBlank(groups = {CreateGroup.class,ModifyGroup.class})中groups的作用，如何自定义并使用校验组
qq_35350487的博客
10-25 1998
@NotBlank(groups = {CreateGroup.class,ModifyGroup.class})中groups的作用，如何自定义并使用校验组
使用 @Validated groups分组实现一个dto校验不同的属性字段
weixin_42156018的博客
03-10 1732
1.当一个实体类需要多种验证方式时，例：对于一个实体类的id来说，新增的时候是不需要的，对于更新时是必须的。 可以通过groups对验证进行分组. 分组接口类： public interface Add { } public interface Edit { } 2.DTO内使用groups: public class CompanyDTO implements Serializable { @NotBlank(message = "ID不能为空！", groups = { Edit
Java开发-参数校验@NotEmpty、@NotBlank、@NotNull
zzy7075的专栏
10-12 601
NotNull适用于基本数据类型(Integer，Long，Double等等)，当 @NotNull 注解被使用在 String 类型的数据上，则表示该数据不能为 Null（但是可以为 Empty）源码包注释源码注释翻译：被注释的元素不能为空。接受任何类型。注：被其标注的字段可以使用 @size、@Max、@Min 对字段数值进行大小的控制@NotBlank。
【SpringBoot+shiro】数据格式的校验
qq_37634156的博客
04-06 1793
前言 Spring Boot整合shiro时，在前端传输数据给后端的时候，后端一般要进行数据格式的校验和数据业务的校验； 数据格式的校验：比如手机号11位，如果传输的是12位，而数据库中设置的字段是11位，从而导致无法插入到数据库，报SQL相关的异常，这时候就需要对格式进行校验； 数据业务的校验：比如查询手机号是否重复 我们知道在前端可以进行数据格式的校验，比如【el-form】组件提供了表单验证的功能，只需要通过【rules】属性传入约定的验证规则等实现数据格式的校验，但那是前端做的，在后端中一
springmvc和springboot和springcloud关系
07-27
- *3* [Spring、SpringMVC、SpringBoot、SpringCloud 之间的关系？](https://blog.csdn.net/WXF_Sir/article/details/122940584)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值