com.github.codingsoldier.paramsvalidate.ValidateInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of params-validate Show documentation

params-validate

There is a newer version: 1.8-RELEASE

package com.github.codingsoldier.paramsvalidate;

import com.github.codingsoldier.paramsvalidate.bean.Parser;
import com.github.codingsoldier.paramsvalidate.bean.ResultValidate;
import com.github.codingsoldier.paramsvalidate.bean.ValidateConfig;

import java.util.Map;

/**
 * author chenpiqian
 */
public interface ValidateInterface {
    /**
     * 返回json文件基础路径。init.json文件必须放在此目录下
     * @return json文件基础路径
     */
    String basePath();

    /**
     * 参数校验未通过
     * @param resultValidate
     * @return 返回给客户端的数据
     */
    Object validateNotPass(ResultValidate resultValidate);

    /**
     * json解析器
     * 1、使用默认解析器jackson，直接返回null即可。
     * 2、使用gson，请返回 new Parser(Gson.class)。
     * 3、使用fastjson，请返回new Parser(JSON.class, Feature[].class)。
     * 为了支持fastjson，搞得好坑爹。
     */
    Parser getParser();

    /**
     * 获取缓存中的校验规则
     * @param validateConfig
     * @return  校验规则
     */
    Map getCache(ValidateConfig validateConfig);

    /**
     * 设置校验规则到缓存中
     * @param validateConfig
     * @param json 校验规则
     */
    void setCache(ValidateConfig validateConfig, Map json);

}