1. 不想看2中具體代碼實現(xiàn)的總結(jié)

• json-schema本身也是json咽袜，但是可以用來描述另一個json應該符合的格式規(guī)范雏掠；
• json-schema只是表示出規(guī)范下愈，校驗一個json是否符合這個json-schema的規(guī)范矫钓，需要代碼實現(xiàn)毡琉；
• 有很多開源的工具铁瞒，可以用來校驗，例如https://github.com/everit-org/json-schema和https://github.com/java-json-tools/json-schema-validator桅滋；
• 本文的目的是將這個工具包裝成一個注解慧耍，用來校驗使用Spring的web工程中接口接收到的json參數(shù)身辨。

2. 使用示例

接口接收的json參數(shù)（這里只是舉個例子）：

{
  "param1": 37.69437890136598,
  "param2": "enum1",
  "param3": true
}
其中，param1是0~100的數(shù)字芍碧，必填煌珊，默認值為0；param2是枚舉類型泌豆，有三個值enum1定庵、enum2、enum3踪危，默認值為enum1蔬浙，必填；param3是布爾類型贞远，默認值為true畴博，非必填。

用來校驗上面這個json的json-schema（我這里和前端交互蓝仲，接口信息是寫在yapi上俱病，可以直接從yapi里面拷，是yapi根據(jù)接口描述自動生成的）：

{
  "type": "object",
  "title": "empty object",
  "properties": {
    "param1": {
      "type": "number",
      "minimum": 0,
      "maximum": 100,
      "default": "0"
    },
    "param2": {
      "type": "string",
      "default": "enum1",
      "enum": [
        "enum1",
        "enum2",
        "enum3"
      ],
      "enumDesc": "枚舉類型杂曲，只有三個值enum1庶艾、enum2袁余、enum3"
    },
    "param3": {
      "type": "boolean",
      "default": true
    }
  },
  "required": [
    "param1",
    "param2"
  ]
}

自定義注解：

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Documented
@Target(ElementType.PARAMETER)
@Constraint(validatedBy = JsonConstraintValidated.class)
public @interface JsonValid {

    String value();

    String message() default "Json數(shù)據(jù)校驗失敗";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

實現(xiàn)注解具體功能的類：

import com.alibaba.fastjson.JSONObject;
import com.chinatelecom.ctyun.xlive.common.exception.DataErrorException;
import com.fasterxml.jackson.databind.JsonNode;
import com.github.fge.jackson.JsonLoader;
import com.github.fge.jsonschema.core.exceptions.ProcessingException;
import com.github.fge.jsonschema.core.report.LogLevel;
import com.github.fge.jsonschema.core.report.ProcessingReport;
import com.github.fge.jsonschema.main.JsonSchema;
import com.github.fge.jsonschema.main.JsonSchemaFactory;
import org.springframework.util.StringUtils;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.io.IOException;
import java.util.Optional;

public class JsonConstraintValidated implements ConstraintValidator<JsonValid, JSONObject> {

    /**
     * 校驗規(guī)則
     */
    private String jsonSchemaString;

  /**
   * 初始化方法擎勘，使用注解的地方，需要提供接口中定義好的參數(shù)颖榜，這里可以獲得這些參數(shù)
   */
    @Override
    public void initialize(JsonValid constraintAnnotation) {
        jsonSchemaString = constraintAnnotation.value();
    }

    /**
     * 校驗方法
     *
     * @param value   待校驗的json
     * @param context 將失敗消息帶出到Spring的參數(shù)校驗異常類ConstraintViolationException
     * @return true：校驗成功棚饵，無感知；false：校驗失敗掩完，框架會拋出異常ConstraintViolationException
     */
    @Override
    public boolean isValid(JSONObject value, ConstraintValidatorContext context) {
        try {
            String message = Optional.ofNullable(validJson(value, jsonSchemaString)).orElse("");
            if (StringUtils.isEmpty(message)) {
                return true;
            } else {
                //禁用默認的message的值噪漾，重新添加錯誤提示語句
        //默認的message無法體現(xiàn)具體是哪個json參數(shù)有問題
                context.disableDefaultConstraintViolation();
                context.buildConstraintViolationWithTemplate(message).addConstraintViolation();
                return false;
            }
        } catch (Exception e) {
            throw new DataErrorException("json校驗數(shù)據(jù)異常，請聯(lián)系管理員");
        }
    }

    /**
     * 使用開源工具https://github.com/java-json-tools/json-schema-validator校驗json
     *
     * @param object     被校驗對象
     * @param validParam 校驗規(guī)則
     * @return 返回失敗消息且蓬，為空則校驗成功
     * @throws Exception
     */
    public String validJson(JSONObject object, String validParam) throws IOException, ProcessingException {
        JsonNode schema = JsonLoader.fromString(validParam);
        JsonNode data = JsonLoader.fromString(object.toJSONString());
        final JsonSchema jsonSchema = JsonSchemaFactory.byDefault().getJsonSchema(schema);
        ProcessingReport report = jsonSchema.validate(data);
        StringBuilder sBuilder = new StringBuilder();
        report.forEach(pm -> {
            if (LogLevel.ERROR.equals(pm.getLogLevel())) {
                JsonNode jsonNode = pm.asJson();
                JsonNode key = Optional.ofNullable(jsonNode)
                        .map(o -> o.get("instance"))
                        .map(r -> r.get("pointer"))
                        .orElse(null);
                sBuilder.append("errorKey:")
                        .append(key == null ? "" : key.asText())
                        .append("; errorMessage:")
                        .append(pm.getMessage());
            }
        });
        return sBuilder.toString();
    }
}