在 spring boot 中创建用于验证的自定义注释
1. 概述
虽然 spring 标准注释（@notblank、@notnull、@min、@size 等）涵盖了验证用户输入时的许多用例，但有时我们需要为更具体的输入类型创建自定义验证逻辑。在本文中，我将演示如何创建自定义注释以进行验证。
2. 设置
我们需要将 spring-boot-starter-validation 依赖项添加到我们的 pom.xml 文件中。
org.springframework.boot spring-boot-starter-validation
3. 自定义字段级别验证
3.1 创建注释
让我们创建自定义注释来验证文件属性，例如文件扩展名、文件大小和 mime 类型。
有效文件扩展名
@target({elementtype.field})@retention(retentionpolicy.runtime)@documented@constraint( validatedby = {fileextensionvalidator.class})public @interface validfileextension { string[] extensions() default {}; string message() default "{constraints.validfileextension.message}"; class[] groups() default {}; class[] payload() default {};}
有效文件最大大小
@target({elementtype.field})@retention(retentionpolicy.runtime)@documented@constraint( validatedby = {filemaxsizevalidator.class})public @interface validfilemaxsize { long maxsize() default long.max_value; // mb string message() default "{constraints.validfilemaxsize.message}"; class[] groups() default {}; class[] payload() default {};}
文件mime类型验证器
@target({elementtype.field})@retention(retentionpolicy.runtime)@documented@constraint( validatedby = {filemimetypevalidator.class})public @interface validfilemimetype { string[] mimetypes() default {}; string message() default "{constraints.validfilemimetype.message}"; class[] groups() default {}; class[] payload() default {};}
让我们分解一下这些注释的组成部分：
@constraint：指定负责验证逻辑的验证器类。@target({elementtype.field})：表示该注解只能应用于字段。message(): 验证失败时默认的错误消息。
3.2 创建验证器
文件扩展名验证器
public class fileextensionvalidator implements constraintvalidator { private list extensions; @override public void initialize(validfileextension constraintannotation) { extensions = list.of(constraintannotation.extensions()); } @override public boolean isvalid(multipartfile file, constraintvalidatorcontext constraintvalidatorcontext) { if (file == null || file.isempty()) { return true; } var extension = filenameutils.getextension(file.getoriginalfilename()); return stringutils.isnotblank(extension) && extensions.contains(extension.tolowercase()); }}
文件最大大小验证器
public class filemaxsizevalidator implements constraintvalidator { private long maxsizeinbytes; @override public void initialize(validfilemaxsize constraintannotation) { maxsizeinbytes = constraintannotation.maxsize() * 1024 * 1024; } @override public boolean isvalid(multipartfile file, constraintvalidatorcontext constraintvalidatorcontext) { return file == null || file.isempty() || file.getsize() <= maxsizeinbytes; }}
文件mime类型验证器
@requiredargsconstructorpublic class filemimetypevalidator implements constraintvalidator { private final tika tika; private list mimetypes; @override public void initialize(validfilemimetype constraintannotation) { mimetypes = list.of(constraintannotation.mimetypes()); } @sneakythrows @override public boolean isvalid(multipartfile file, constraintvalidatorcontext constraintvalidatorcontext) { if (file == null || file.isempty()) { return true; } var detect = tika.detect(tikainputstream.get(file.getinputstream())); return mimetypes.contains(detect); }}
这些类是 constraintvalidator 接口的实现，包含实际的验证逻辑。
对于 filemimetypevalidator，我们将使用 apache tika（一个旨在从多种类型的文档中提取元数据和内容的工具包）。
3.3 应用注释
让我们创建一个 testuploadrequest 类，用于处理文件上传，特别是 pdf 文件。
百度文心百中
百度大模型语义搜索体验中心
22 查看详情
@datapublic class testuploadrequest { @notnull @validfilemaxsize(maxsize = 10) @validfileextension(extensions = {"pdf"}) @validfilemimetype(mimetypes = {"application/pdf"}) private multipartfile pdffile;}
@restcontroller@validated@requestmapping("/test")public class testcontroller { @postmapping(value = "/upload", consumes = {mediatype.multipart_form_data_value}) public responseentity testupload(@valid @modelattribute testuploadrequest request) { return responseentity.ok("test upload"); }}
@target({elementtype.type})：表示该注解的目标是类型声明。
4. 自定义类级别验证
还可以在类级别定义自定义验证注释来验证类内的字段组合。
4.1 创建注释
让我们创建 @passwordmatches 注解来确保类中的两个密码字段匹配。
@target({elementtype.type})@retention(retentionpolicy.runtime)@documented@constraint( validatedby = {passwordmatchesvalidator.class})public @interface passwordmatches { string message() default "{constraints.passwordmatches.message}"; class[] groups() default {}; class[] payload() default {};}
4.2 创建验证器
密码dto
public interface passworddto { string getpassword(); string getconfirmpassword();}
密码匹配验证器
public class passwordmatchesvalidator implements constraintvalidator { @override public boolean isvalid(passworddto password, constraintvalidatorcontext constraintvalidatorcontext) { return stringutils.equals(password.getpassword(), password.getconfirmpassword()); }}
passworddto 接口是包含密码和确认密码字段的对象的接口。
passwordmatchesvalidator 类实现 constraintvalidator 接口，并包含验证密码和确认密码字段是否匹配的逻辑。
4.3 应用注释
让我们创建一个 registeraccountrequest 类，用于处理用户注册数据。
@passwordmatches@datapublic class registeraccountrequest implements passworddto { @notblank private string username; @notblank @email private string email; @notblank @tostring.exclude private string password; @notblank @tostring.exclude private string confirmpassword;}
@RestController@Validated@RequestMapping("/auth")public class AuthController { @PostMapping("/register") public ResponseEntity register(@RequestBody @Valid RegisterAccountRequest request) { return ResponseEntity.ok("register success"); }}
5. 总结
在这篇短文中，我们发现创建自定义注释来验证字段或类是多么容易。本文中的代码可以在我的 github 上找到。
spring-boot-微服务用户服务
6. 参考文献
拜尔东。 （日期不详）。 spring mvc 自定义验证器。已检索来自 https://www.baeldung.com/spring-mvc-custom-validator
以上就是在 Spring Boot 中创建用于验证的自定义注释的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/509728.html
微信扫一扫 
支付宝扫一扫 
