springboot+dubbo+validation 进行rpc参数校验的实现方法

注意：本文dubbo 版本 2.8.4 springboot 版本 2.0.4.RELEASE

项目结构

• test-rest （前端消费着，controller 层，springboot+maven项目）
• test-api （dubbo服务 的 api ，只记录 service 接口和 model ,maven 项目）
• test-provider（dubbo 服务提供者，实际的数据库操作及业务层， springboot+maven项目 ）

背景：

使用springmvc做restful，使用dubbo做rpc，restful中调用大量的rpc，数据验证会在这两个地方，一个是restful层面，一个是rpc层面，restful层面使用springmvc默认的集成hibernate-validator来实现，参数开启验证只需要加入@Validated param。dubbo 使用 rpc 的校验

dubbo rpc层面采用的是JSR303标准注解验证，通过hibernate-validator实现，dubbo中开启validation也有两个方式，一个是在consumer端，一个是在provider`端。

开启dubbo 的服务端校验时，调用dubbo 的服务时会在服务端进行参数校验，如果在consumer 端也开启了校验则调用服务时也会在 consumer 端进行校验

dubbo 的rpc 校验 （服务端开启）

首先配置dobbo 的rpc 层校验

1.引入依赖,

 <dependency>
      <groupId>javax.validation</groupId>
      <artifactId>validation-api</artifactId>
    </dependency>
    <dependency>
      <groupId>org.hibernate.validator</groupId>
      <artifactId>hibernate-validator</artifactId>
    </dependency>

2.在api 的model 上添加注解

import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.Pattern;
import java.io.Serializable;

public class UserSaveArgs implements Serializable {

  private static final long serialVersionUID = -5457103531947646047L;
  @NotEmpty(
      message = "用户名不能为空")
  @Pattern(regexp = Constants.USERNAME_PATTERN, message = "用户名格式有误")
  private String userName;
  @NotEmpty(
      message = "手机号不能为空")
  @Pattern(regexp = Constants.PHONTE_NUMBER_PATTERN, message = "手机号编码格式有误")
  private String phoneNumber;
  @NotNull(
      message = "年龄不能为空")
  @Min(value = 0, message = "年龄不能小于0")
  private Integer age;

  //get set 省略

在dubbo 配置文件 provider.xml 中开启验证 validation=“true”

  <dubbo:provider delay="-1" timeout="5000" threads="600" threadpool="fixed" loadbalance="roundrobin" accesslog="true"
          retries="0" validation="true"/>

消费端开启

由于消费端引入了服务端的api 所以在消费端开启校验时只需在consumer.xml 中开启验证即可 validation=“true”

consumer 端开启了校验则在调用服务时会在 consumer 端进行参数校验，不使用provider的资源进行校验

<dubbo:consumer check="false" timeout="60000" retries="0" validation="true"/>

配置自定义异常处理解析 rpc 校验异常

@ControllerAdvice
public class DefaultExceptionHandler {

 @ExceptionHandler({RpcException.class})
  @ResponseBody
  @ResponseStatus(HttpStatus.OK)
  public ResponseEntity RpcException(Exception ex, Model model) {
    logger.error("rpc接口参数校验异常。{}", ex.getMessage());
    String errMsg = ((ConstraintViolationException) ex.getCause()).getConstraintViolations()
        .iterator().next().getMessage();
    //ResponseEntity 为自定义的返回类，非springframework.http.ResponseEntity，当然此处可以自己定义返回类，只需将 异常信息 errMsg 返回即可
    return ResponseEntity.error(ARG_ERROR_CODE, errMsg);
  }
}

Controller 验证

也就是 test-rest 项目 由于是dubbo的消费者项目，也是springboot 项目。由于前端传递的参数需要在 此层包装后进行调用服务。所以验证前端传递的参数时 可以选择使用 Springboot + validation 进行校验

Spring3支持JSR-303验证框架，JSR-303 是Java EE 6 中的一项子规范，叫做BeanValidation，官方参考实现是hibernate Validator（与Hibernate ORM 没有关系），JSR 303 用于对Java Bean 中的字段的值进行验证。

具体配置参照博客：springboot 使用校验框架validation校验

小问题

test-rest 和 test-provider 都引用了test-api 。如果test-rest 层的入参恰好与 test-provider的服务调用入参相同，则此时仍需在 test-rest 项目中 新建 入参的 Java bean。

虽然 test-rest 的java bean 和 test-api 的Java bean 相同。但是Spring3 在解析的时候不能获取到 test-api 的Java bean 校验注解。所以需要校验的时候仍然需要在 test-rest 项目中创建一个 和 test-api 的Java bean 相同 的java bean

附录： 检验注解及含义

//(1)空检查
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
//(2)Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false
//(3)长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=) 验证字符串的长度在min和max范围之内.
//(4)日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期
@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期
@Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。
//(5)数值检查
建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为""时无法转换为int，但可以转换为Stirng为"",Integer为null
@Min 验证 Number 和 String 对象是否大等于指定的值
@Max 验证 Number 和 String 对象是否小等于指定的值
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
@Range(min=, max=) 被指定的元素必须在合适的范围内
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=

当然也可以自定义校验注解：

此处本文不做展示，如需自定义校验注解可查阅参考文档

参考文档：

https://www.jb51.net/article/170692.htm

https://www.jb51.net/article/155033.htm

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。