美文网首页
四、校验响应数据的字段正确性

四、校验响应数据的字段正确性

作者: 木沐__ | 来源:发表于2018-02-04 12:01 被阅读0次

一般接口响应结果是json格式,所以可使用JSON Schema进行返回值字段的校验。
主要涉及的校验包括:

  • 字段类型(type)
  • 是否必须存在(required)
  • 数值类型大小(minimum、maximum)
  • 取值(const)
  • array类型item个数(minItems、maxItems)
  • ……

JSON Schema的简单例子

json数据如下:

{
  "resultCode": "0",
  "resultData": {
    "access_token": "42ae7d01",
    "token_type": "bearer",
    "refresh_token": "f59dfdcf",
    "expires_in": 81737,
    "scope": "test"
  },
  "resultDesc": "success"
}

与此对应JSON Schema如下:

{
  "type":"object",
  "properties":{
    "resultCode":{
      "type":"string"
    },
    "resultData":{
      "type":"object",
      "properties":{
        "access_token":{
          "type":"string"
        },
        "token_type":{
          "type":"string"
        },
        "refresh_token":{
          "type":"string"
        },
        "expires_in":{
          "type":"number"
        },
        "scope":{
          "type":"string"
        }
      }
    },
    "resultDesc":{
      "type":"string"
    }
  },
  "required":["resultCode","resultData"]
}

注:推荐使用可自动生成JSON Schema的在线工具

如何通过代码进行校验呢?

在使用前,需在pom文件中添加依赖包

        <dependency>
            <groupId>com.github.fge</groupId>
            <artifactId>json-schema-validator</artifactId>
            <version>2.2.6</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.8.8</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.8.8</version>
        </dependency>

测试一下JsonSchemaFactory的功能,代码如下:

public static void main(String[] args){
        String jsonStr="{\"resultCode\":\"0\",\"resultData\":{\"access_token\":\"42ae7d01\",\"token_type\":\"bearer\",\"refresh_token\":\"f59dfdcf\",\"expires_in\":81737,\"scope\":\"test\"},\"resultDesc\":\"success\"}";
        String jsonSchema = "{\"type\":\"object\",\"properties\":{\"resultCode\":{\"type\":\"string\"},\"resultData\":{\"type\":\"object\",\"properties\":{\"access_token\":{\"type\":\"string\"},\"token_type\":{\"type\":\"string\"},\"refresh_token\":{\"type\":\"string\"},\"expires_in\":{\"type\":\"number\"},\"scope\":{\"type\":\"string\"}}},\"resultDesc\":{\"type\":\"string\"}},\"required\":[\"resultCode\",\"resultData\"]}";

        JsonNode jsonStrNode = null;
        JsonNode jsonSchemaNode = null;
        try{
            jsonStrNode = JsonLoader.fromString(jsonStr);
            jsonSchemaNode = JsonLoader.fromString(jsonSchema);
        }catch (IOException e){
            e.printStackTrace();
        }

        ProcessingReport report = JsonSchemaFactory.byDefault().getValidator().validateUnchecked(jsonSchemaNode,jsonStrNode);

        if(report.isSuccess()){
            System.out.print("校验成功!");
        }else{
            System.out.print("校验失败!");
        }

    }

最后

为了可复用,我们可以编写校验的工具类,详见JSON数据格式校验

可在测试用例中添加以下校验代码:

String jsonStr = String.valueOf(response);
JsonSchema jsonSchema = new JsonSchema();
Boolean checkResult = jsonSchema.jsonSchemaCheck(jsonStr,System.getProperty("user.dir") + "\\json"+"\\tushengLogin.json");
Assert.assertTrue(checkResult);

参考文章:
https://www.cnblogs.com/x113773/p/8135398.html

相关文章

  • 四、校验响应数据的字段正确性

    一般接口响应结果是json格式,所以可使用JSON Schema进行返回值字段的校验。主要涉及的校验包括: 字段类...

  • 项目中用到的策略模式

    所在项目:产品中心功能点:数据校验接口该接口用于校验产品中心的数据的正确性,根据数据类型校验,如果是数字类型的数据...

  • java实现传输Model字段属性校验

    需求:对传入的数据DTO的属性字段进行校验,类似于hibernate validator需要校验的具体字段属性从数...

  • Hibernate Validator实战篇

    在写程序的时候经常需要进行数据校验,比如服务端对http请求参数校验,数据入库时对字段长度进行校验,接口参数校验,...

  • CRC

    校验原理 循环校验码(CRC 码):是数据通信领域中最常用的一种差错校验码,其特征是信息字段和校验字段的长度可以任...

  • JSR303后台数据校验的相关使用

    1)、标注校验注解想要使用JSR303帮我们做数据校验,可以给Bean里面需要验证的字段加数据校验注解。java为...

  • structs2校验器无法运行

    structs2 校验器 分为字段校验器和非字段校验器字段校验器具体格式如下

  • “跨境电商进口统一版功能”与用户界面

    功能结构图 登录界面 企业报文校验(企业校验数据报文的正确性,以保证报文数据能正常被海关系统接收。) 导入电子订单...

  • springboot统一表单数据校验

    统一表单数据校验 在开发中经常需要写一些字段校验的代码,比如字段非空,字段长度限制,邮箱格式验证等等,写这些与业务...

  • CRC校验

    CRC校验 是数据通信领域中最常用的一种查错校验码,其特征是信息字段和校验字段的长度可以任意选定。循环冗余检查(C...

网友评论

      本文标题:四、校验响应数据的字段正确性

      本文链接:https://www.haomeiwen.com/subject/aqxqzxtx.html