DataCheck

DataCheck是一个基于SpringBoot的数据校验框架。

普通校验方式

在entity中声明@Check注解

public class Normal {

    @Check(test = "required")
    private String id;
    @Check(test = { "required", "maxLength" }, length = 10)
    private String name;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

使用DataCheckUtil的相关方法，即可对数据项进行校验。

/**
 * 这是一个普通使用的例子
 * 
 * @author XuDL(Wisea)
 *
 *         2018年1月18日 下午4:45:46
 */
public class UseInClassDemo {
    public static void main(String[] args) {
        // 普通的校验 非空和长度
        System.out.println("普通的校验  非空和长度---------");
        Normal n = new Normal();
        System.out.println(DataCheckUtil.checkResultMsg(n).stream().collect(Collectors.joining(";")));
        n.setId("1");
        System.out.println(DataCheckUtil.checkResultMsg(n).stream().collect(Collectors.joining(";")));
        n.setName("qwertyujiasdfghj");
        System.out.println(DataCheckUtil.checkResultMsg(n).stream().collect(Collectors.joining(";")));
        n.setName("qwertyu");
        System.out.println("校验是否通过:" + DataCheckUtil.check(n));

        System.out.println();
        System.out.println();

        // 长度区间校验
        System.out.println("长度区间校验---------");
        LengthRange lr = new LengthRange();
        lr.setName("qwertyuioasdfghjk");
        System.out.println(DataCheckUtil.checkResultMsg(lr).stream().collect(Collectors.joining(";")));

        System.out.println();
        System.out.println();

        // 中英文混合长度区间校验
        System.out.println("中英文混合长度区间校验---------");
        ChineseRange cr = new ChineseRange();
        cr.setName1("12345678901");
        cr.setName2("一二三54654");
        cr.setName3("一二三1234");
        System.out.println(DataCheckUtil.checkResultMsg(cr).stream().collect(Collectors.joining(";")));
        
        System.out.println();
        System.out.println();
        
        // 数据有效性
        System.out.println("数据有效性校验---------");
        DataLiveable dl = new DataLiveable();
        dl.setName1("3");
        dl.setName2("bbb");
        System.out.println(DataCheckUtil.checkResultMsg(dl).stream().collect(Collectors.joining(";")));

        System.out.println();
        System.out.println();
        
        // 正则表达式
        System.out.println("正则表达式校验---------");
        RegexData rd = new RegexData();
        rd.setName1("正则表达式校验");
        rd.setName2("bbb");
        System.out.println(DataCheckUtil.checkResultMsg(rd).stream().collect(Collectors.joining(";")));
        
        System.out.println();
        System.out.println();
        
        // 逻辑表达式
        System.out.println("逻辑表达式校验---------");
        TestPo t = new TestPo();
        t.setCode("1");
        // t.setName("2");
        // t.setNum(0);
        TestPo2 t2 = new TestPo2();
        // t.setCode("1");
        // t.setName("2");
        TestPo3 t3 = new TestPo3();
        t2.setLop(t3);
        t.setTest(t2);
        List<String> msg = DataCheckUtil.checkResultMsg(t);
        String str = "校验通过";
        if (ConverterUtil.isNotEmpty(msg)) {
            str = msg.stream().collect(Collectors.joining(";"));
        }
        System.out.println(str);
    }
}

以下是输出结果

  普通的校验  非空和长度---------
  id不能为空;name不能为空
  name不能为空
  name最大长度为10
  校验是否通过:true

  长度区间校验---------
  name最大长度为10

  中英文混合长度区间校验---------
  name1最大长度为10;name2最大长度为10

  数据有效性校验---------
  name1数据无效

  正则表达式校验---------
  name2格式不正确

  逻辑表达式校验---------
  name条件不正确;test.code不能为空;test.name条件不正确;test.lop.mem条件不正确

Spring Boot方式

在boot工程的@SpringBootApplication或@Configuration的class中加入@EnableDataCheck即可。

使用Demo

在PO中声明@Check注解

public class RegisterUserPo {
    @Check(test = "required")
    private String loginName;

    @Check(test = "required")
    private String password;
}

在任意方法前加入@DataCheck注解，都会进行校验,例如在controller中可以这样写

@RestController
public class RegisterController {
    @Autowired
    private UserService userService;

    /**
     * 注册用户
     * 
     * @return
     */
    @RequestMapping(value = "/register", method = RequestMethod.POST)
    @DataCheck
    public ResultPoJo<User> register(@RequestBody RegisterUserPo registerUser) {
        return userService.insert(registerUser);
    }
}

如果参数为基本类型，也可以直接把@Check加在Parameter上，例如:`

/**
 * 批量删除用户信息
 * 
 * @param ids
 * @return
 */
@RequestMapping(value = "batDelete", method = RequestMethod.POST)
@DataCheck
public ResultPoJo<Object> batDelete(@Check(test = "required") @RequestBody String ids) {
    return userService.batDelete(ids);
}

如果参数为List或Map类型，那么会进行遍历校验，例如:`

/**
 * 批量修改用户有效期
 * 
 * @param effeBatUpdateList
 * @return
 */
@RequestMapping(value = "effe/batUpdate", method = RequestMethod.POST)
@DataCheck
public ResultPoJo<Object> effeBatUpdate(@RequestBody List<EffeBatUpdatePo> effeBatUpdateList) {
    return userService.effeBatUpdate(effeBatUpdateList);
}

/**
 * 修改用户有效期PO
 */
public class EffeBatUpdatePo {
    @ApiModelProperty(value = "用户.id 非空", required = true)
    @Check(test = "required")
    private Long id;

    @JsonSerialize(using = OffsetDateTimeSerializer.class)
    @JsonDeserialize(using = OffsetDateTimeDeserializer.class)
    @ApiModelProperty(value = "有效期 若为空则代表长期有效", required = true)
    private OffsetDateTime availableDate;
    // ...
}

如果这样标准的校验方式不能满足要求，也可以在service中实现校验逻辑 5. 也可以在Service中，如果基层了BaseService，可以对Po进行校验并设置ResultPojo的错误信息

@Service
public class UserService extends BaseService {
    @Transactional(readOnly = false)
    public ResultPoJo<Object> loginBatUpdate(LoginBatUpdatePo loginBatUpdate) {
        ResultPoJo<Object> result = new ResultPoJo<Object>();
        // 进行数据校验
        if (!dataCheck(result, loginBatUpdate)) {
            return result;
        }
        // ...
       return result;
    }
}

也可以直接使用DataCheckUtil的方法进行校验

public boolean dataCheck(Object entity) {
    List<String> checkList = DataCheckUtil.checkResultMsg(entity);
    if (ConverterUtil.isNotEmpty(checkList)) {
               // ...
        return false;
    }
    return true;
}

这里的DataCheckUtil.checkResultMsg只是例子，如果不需要返回错误消息，可以直接使用DataCheckUtil.check函数

也可以使用非注解的方式，用Map进行校验格式的声明,Map(DataCheck)的方式，不支持logic校验，因为可以使用logic的方式实现，因而不再使用Map的校验方式

public static final Map<String, DataCheck> USER_PASSWORD_CHECK_MAP = new HashMap<String, DataCheck>() {
        private static final long serialVersionUID = 8136871463161977654L;
        {
            put("id", new DataCheck(new String[] { "required" }));
            put("password", new DataCheck(new String[] { "required" }));
            put("newPassword", new DataCheck(new String[] { "required" }));
        }
    };
public boolean dataCheck(Object entity) {
    List<String> checkList = DataCheckUtil.checkResultMsg(entity,  USER_PASSWORD_CHECK_MAP);
    if (ConverterUtil.isNotEmpty(checkList)) {
               // ...
        return false;
    }
    return true;
}

若被校验的属性为一个bean对象，那么需要声明cascade=true，这样的校验被称为级联校验;

public class TestPo {
    @Check(test = "required")
    private String code;

    @Check(test = "required", cascade = true)
    private TestPo2 test;
    // ...
}

public class TestPo2 {
    @Check(test = "required")
    private String name;
    // ...
}

若遇到需要更为复杂的校验逻辑，必须要手动进行check时，可以选择logic:逻辑表达式的方式进行校验，若需要使用父节点的属性，则需要使用parent[xxx]，若级联的层次较深，表达式的中二级以上的parent需要写为[parent]。

public class TestPo {
    @Check(test = "required")
    private String code;

    @Check(test = "logic", logic = "#isNotEmpty(#code, #name)")
    private String name;

    @Check(test = "required", cascade = true)
    private TestPo2 test;
    // ...
}

public class TestPo2 {
    //@Check(test = {"required", "logic"}, logic = "'1'.equals(#parent[code])") // 必填且parent.code=1
    @Check(test = "logic", logic = "'1'.equals(#parent[code])?#isNotEmpty(#code):true") // parent.code=1时则该项必填
    private String code;
    @Check(test = "logic", logic = "'1'.equals(#parent[code])?#isNotEmpty(#name):true")
    private String name;
    
    @Check(test = "required", cascade = true)
    private TestPo3 lop;
    // ...
}

public class TestPo3 {
    @Check(test = "logic", logic = "'1'.equals(#parent[parent][code])?#isNotEmpty(#mem):true")
    private String mem;
    
    // ...
}

若需要使用自定义的校验函数，则可以将方法声明成static,使用T(AllPackage).xxx的方式进行调用。

public final class ConverterUtil {
    public static boolean isNotEmpty(Object str) {
        //...
        return !isEmpty(str);
    }
}

public class TestPo3 {
    @Check(test = "logic", logic = "T(com.wisea.cloud.common.util.ConverterUtil).isNotEmpty(#asa)")
    private String asa;
    // ...
}

若希望某些通用的校验函数直接能够在logic中使用，则可以通过设置注解@CheckModel和@CheckApi进行设置，这样就可以使用了

@CheckModel
public final class ConverterUtil {
    @CheckApi
    public static boolean isNumeric(Object... strs) {
        boolean result = true;
        for (Object obj : strs) {
            result = (result && StringUtils.isNumeric(toString(obj, "")));
        }
        return result;
    }
}

public class TestPo4 {
    @Check(test = "logic", logic = "#isNumeric(#num)")
    private Integer num;
    // ...
}

DataCheck支持以下八种常用的校验格式，更具体的说明请参考@Check注解

required:非空,length标准长度,mixLength中英文长度,minLength:最小长度,maxLength:最大长度,liveable:有效性,regex:正则表达式,logic:逻辑表达式。logic:逻辑表达式的语法请参考官方文档，除此之外还增加了isEmpty和isNotEmpty两个常用的判断函数。Map(DataCheck)的方式，不支持logic校验，因为可以使用logic的方式实现，因而不再使用Map的校验方式

Spring Expression Language 官方文档

Name		Name	Last commit message	Last commit date
Latest commit History 6 Commits
src/main/java/com/wisea/cloud/common		src/main/java/com/wisea/cloud/common
.gitignore		.gitignore
README.md		README.md
pom.xml		pom.xml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

DataCheck

普通校验方式

Spring Boot方式

使用Demo

About

Releases

Packages

Languages

xudl33/DataCheck

Folders and files

Latest commit

History

Repository files navigation

DataCheck

普通校验方式

Spring Boot方式

使用Demo

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages