validator4cj:

Branch1Tags0

validator4cj

validator4cj 提供了客户端和服务器端数据验证的基础构建模块。它可以独立使用,也可以配合框架使用。

特性:

  • 🚀 多种格式数据验证功能

项目结构

├── doc
│   ├── readme-image
│   └── feature_api.md
└── src
│   ├── *.cj              // 校验框架核心类
│   ├── routines          // 具体数据校验器
│   └── xml_ffi           // libxml2 FFI 封装
└── test
    ├── HLT
    └── LLT
├── CHANGELOG
├── cjpm.toml
├── LICENSE
├── README.md
├── README.OpenSource
  • doc 文档目录,用于存API接口文档
  • src 是库源码目录,根包提供校验流程、资源配置、表单和字段模型
  • src/routines 提供 Email、Domain、URL、CreditCard、ISBN、ISSN、ISIN、IBAN、InetAddress 等校验器和校验位算法
  • src/xml_ffi 封装 libxml2 C API,用于解析 XML 校验配置
  • test 存放 HLT 测试用例、LLT 自测用例

接口说明

主要核心类和全局函数说明,详情见 API

3 使用说明

编译

两种编译方式

  1. 使用脚本编译
    1. 下载配置编译脚本
    2. ciTest.py build
  2. 使用包管理器编译
    1. 该三方库依赖stdx,请参考stdx文档配置CANGJIE_STDX_PATH路径
    2. cjpm build

功能示例

信用卡数据验证功能

import std.io.ByteBuffer
import std.time.MonoTime
import std.unittest.*
import std.unittest.testmacro.*
import validator4cj.routines.CreditCardRangeValidator
import validator4cj.routines.CreditCardValidator
import validator4cj.routines.*

main(): Unit {

    // 定义有效的信用卡号常量
    private static let VALID_VISA: String = "4417123456789113"
    private static let VALID_SHORT_VISA: String = "4222222222222"
    private static let VALID_AMEX: String = "378282246310005"
    private static let VALID_MASTERCARD: String = "5105105105105100"
    private static let VALID_DISCOVER: String = "6011000990139424"
    private static let VALID_DINERS: String = "30569309025904"

    // 测试默认构造函数 - 应该允许所有默认卡类型
    var validator: CreditCardValidator = CreditCardValidator.genericCreditCardValidator()
    
    // 测试有效的卡号应该通过验证
    @Assert(validator.isValid(VALID_VISA), true)
    @Assert(validator.isValid(VALID_SHORT_VISA), true)
    @Assert(validator.isValid(VALID_AMEX), true)
    @Assert(validator.isValid(VALID_MASTERCARD), true)
    @Assert(validator.isValid(VALID_DISCOVER), true)
}

自定义校验框架功能


import validator4cj.xml_ffi.*
import validator4cj.routines.*
import validator4cj.*
import std.unittest.*
import std.unittest.testmacro.*
import std.reflect.*
import std.convert.*
import std.collection.*
import std.io.*
import std.fs.*

@Test
public class xml_test {
let pathStr = """
<!DOCTYPE form-validation PUBLIC
        "-//Apache Software Foundation//DTD Commons Validator Rules Configuration 1.4.0//EN"
        "http://commons.apache.org/dtds/validator_1_4_0.dtd">
<form-validation>
   <global>

      <validator
              name="required"
              classname="default.GenericValidatorImpl"
              method="validateRequired"
              methodParams="std.core.Any,validator4cj.Field"
              msg="errors.required"/>

   </global>
   <formset>

      <form name="userForm">

         <field
                 property="username"
                 depends="required"/>

      </form>

   </formset>

</form-validation>
"""
    
    @TestCase
    public func t1(): Unit {
         let allBytes: Array<Byte> = pathStr.toArray()
         var resources: ValidatorResources = ValidatorResources(ByteBuffer(allBytes))
         var validator: Validator = Validator(resources, "userForm")

        var form: User = User()
        form.setUsername("")

        validator.setParameter(Validator.BEAN_PARAM, form)
        var results: ValidatorResults = validator.validate()

        for(fieldName in results.getPropertyNames()){
            var vr: ValidatorResult = results.getValidatorResult(fieldName).getOrThrow()
            var iterator: Iterator<String> = vr.getActions()

            while (true) { /* 使用迭代器进行遍历 */
                match (iterator.next()) {
                    case Some(action) => 
                        var passed: Bool = vr.isValid(action)
                        @Assert(passed, true)
                    case None => break
                }
            }
        }

    }

}

public class User {

    public var username: String = "zz"

    public init () {
        
    }
    public func getUsername(): String {
        return username
    }

    public func setUsername(username: String): Unit {
        this.username = username
    }
}

public class GenericValidatorImpl {
    public func validateRequired(bean: Any, field: Field): Bool {
        let ty: ClassTypeInfo = ClassTypeInfo.of(bean)
        var property = ty.getInstanceVariable(field.getProperty().getOrThrow())
        var value = (property.getValue(bean) as String).getOrThrow()
        return value == ""
    }
}

约束与限制

在下述版本验证通过:

编号 依赖构建工具 版本号
1 cjc v1.2.0

开源协议

本项目基于 Apache License 2.0,请自由的享受和参与开源。

4 参与贡献

本项目基于 Apache License 2.0,欢迎给我们提交PR,欢迎参与任何形式的贡献。