场景描述

用户在provider端使用参数效验，可以对相应的参数输入要求预先进行设置，在接口实际调用前进行效验处理，达到控制参数输入标准的效果。

配置说明

  • 添加swagger-invocation-validator的pom依赖：
  1. <dependency>
  2.     <groupId>org.apache.servicecomb</groupId>
  3.     <artifactId>swagger-invocation-validator</artifactId>
  4. </dependency>
  • 在需要验证的代码上按照JSR 349规范添加验证器注解，如@NotNull，@Min，@Max等。

示例代码

  • 接口参数验证
  1. @RestSchema(schemaId = "validator")
  2. @Path("/validator")
  3. @Produces(MediaType.APPLICATION_JSON)
  4. public class Validator {
  6.   @Path("/add")
  7.   @POST
  8.   public int add(@FormParam("a") int a, @Min(20) @FormParam("b") int b) {
  9.     return a + b;
  10.   }
  12.   @Path("/sayhi/{name}")
  13.   @PUT
  14.   public String sayHi(@Length(min = 3) @PathParam("name") String name) {
  15.     ContextUtils.getInvocationContext().setStatus(202);
  16.     return name + " sayhi";
  17.   }
  19.   @Path("/sayhello")
  20.   @POST
  21.   public Student sayHello(@Valid Student student) {
  22.     student.setName("hello " + student.getName());
  23.     student.setAge(student.getAge());
  24.     return student;
  25.   }
  26. }
  • bean类验证
    需要在传入的Student对象前加@Valid，如上图sayHello(@Valid Student student)方法。
  1. public class Student {
  2.   @NotNull
  3.   private String name;
  5.   @Max(20)
  6.   private int age;
  8.   public void setName(String name) {
  9.     this.name = name;
  10.   }
  12.   public String getName() {
  13.     return this.name;
  14.   }
  16.   public void setAge(int age) {
  17.     this.age = age;
  18.   }
  20.   public int getAge() {
  21.     return age;
  22.   }
  23. }

自定义返回异常

  • 默认的参数效验器ParameterValidator已经实现了接口ProducerInvokeExtension，按照JSR 349规范处理所需的参数验证。

如果任何参数验证失败，缺省错误是BAD_REQUEST(400, "Bad Request")。

返回错误支持自定义扩展，使用SPI机制。

  • 可以通过实现接口ExceptionToProducerResponseConverter来自定义返回的错误信息，以ConstraintViolationExceptionToProducerResponseConverter为例。

    • 实现ExceptionToProducerResponseConverter接口，重写方法，其中getOrder方法的返回结果表示该验证器的优先级，值越小优先级越高。
  1. public class ConstraintViolationExceptionToProducerResponseConverter
  2.     implements ExceptionToProducerResponseConverter<ConstraintViolationException> {
  3.   @Override
  4.   public Class<ConstraintViolationException> getExceptionClass() {
  5.     return ConstraintViolationException.class;
  6.   }
  8.   @Override
  9.   public Response convert(SwaggerInvocation swaggerInvocation, ConstraintViolationException e) {
  10.     return Response.createFail(new InvocationException(Status.BAD_REQUEST, e.getConstraintViolations().toString()));
  11.   }
  13.   @Override
  14.   public int getOrder() {
  15.     return -100;
  16.   }
  17. }
  • 在META-INF下的services文件夹增加一个文件，以所实现接口x.x.x.ExceptionToProducerResponseConverter(带包名)为名，以具体实现类x.x.x.ConstraintViolationExceptionToProducerResponseConverter(带包名)为内容。