Skip to content

一个强大的 Java 参数校验包,基于 SpEL 实现,扩展自 jakarta.validation-api 包,用于简化参数校验,几乎支持所有场景下的参数校验。

License

Notifications You must be signed in to change notification settings

stick-i/spel-validator

Repository files navigation

SpEL Validator

Coverage Status Maven Central license

一个强大的 Java 参数校验包,基于 SpEL 实现,扩展自 jakarta.validation-api 包,用于简化参数校验,几乎支持所有场景下的参数校验。

项目地址

特点

  • 简单易用,使用方式几乎与 jakarta.validation-api 一致,学习成本低,上手快。
  • 强大的参数校验功能,几乎支持所有场景下的参数校验。
  • 扩展自 jakarta.validation-api 包,只新增不修改,无缝集成到项目中。
  • 基于 SpEL(Spring Expression Language) 表达式,支持复杂的校验逻辑。
  • 支持调用 Spring Bean,可在表达式中使用注入过的 Spring Bean。
  • 校验时基于整个对象,支持对象内字段间的校验逻辑。
  • 支持自定义校验注解,可根据业务需求自定义校验逻辑。
  • 无需额外的异常处理,校验失败时会上报到 jakarta.validation-api 的异常体系中。

支持的环境

JDK8+

交流群

请添加微信号 sticki6,备注 SpEL,我拉你入群。

它解决了什么问题?

  • 枚举值字段校验:

    @SpelAssert(assertTrue = " T(cn.sticki.enums.UserStatusEnum).getByCode(#this.userStatus) != null ", message = "用户状态不合法")
    private Integer userStatus;
  • 多字段联合校验:

    @NotNull
    private Integer contentType;
    
    @SpelNotNull(condition = "#this.contentType == 1", message = "语音内容不能为空")
    private Object audioContent;
    
    @SpelNotNull(condition = "#this.contentType == 2", message = "视频内容不能为空")
    private Object videoContent;
  • 复杂逻辑校验,调用静态方法:

    // 中文算两个字符,英文算一个字符,要求总长度不超过 10
    // 调用外部静态方法进行校验
    @SpelAssert(assertTrue = "T(cn.sticki.util.StringUtil).getLength(#this.userName) <= 10", message = "用户名长度不能超过10")
    private String userName;
  • 调用 Spring Bean(需要使用 @EnableSpelValidatorBeanRegistrar 开启Spring Bean支持):

    // 这里只是简单举例,实际开发中不建议这样判断用户是否存在
    @SpelAssert(assertTrue = "@userService.getById(#this.userId) != null", message = "用户不存在")
    private Long userId;
  • 更多使用场景,欢迎探索和补充!

📦 快速开始

在线文档:https://spel-validator.sticki.cn/guide/getting-started.html

📦 示例项目

🤝 贡献指南

非常欢迎您来参与项目贡献,但希望您可以先在 issue 中提出您的想法,我们可以一起讨论,然后再进行代码编写。

分支说明

  • main:主分支,已发布的最新版本代码将合入此分支。
  • vX.Y.Z:版本分支,用于汇总及验证新版本的功能,已经发布的版本会将分支删除。
  • dev-num-desc:开发分支,用于开发新功能,每个dev分支都应当对应一个issue,功能开发完成后通过PR合入 vX.Y.Z 分支,并删除当前分支。
  • docs:文档分支,修改文档的内容将提交到这里。

License

Apache-2.0

📧 联系作者

💰 捐赠支持

微信赞赏 支付宝赞赏
微信 支付宝

About

一个强大的 Java 参数校验包,基于 SpEL 实现,扩展自 jakarta.validation-api 包,用于简化参数校验,几乎支持所有场景下的参数校验。

Topics

Resources

License

Stars

Watchers

Forks