Micronaut中自定义@CustomPattern注解如何让Swagger生成pattern schema
Micronaut 框架下自定义校验注解匹配 Swagger 生成 Pattern 字段的实现方案
核心原因
Micronaut 集成的 OpenAPI(Swagger)生成逻辑,默认仅识别javax.validation.constraints/jakarta.validation.constraints包下的内置标准校验注解,会自动提取这些注解的属性值映射为符合 OpenAPI 规范的 Schema 字段。自定义的@CustomPattern不在默认扫描白名单范围内,因此不会自动生成对应的pattern配置项。
实现步骤
- 确认自定义注解的属性定义
保证@CustomPattern注解中存储正则规则的属性(如regexp)是可被反射读取的公开方法,参考基础注解结构:@Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface CustomPattern { // 存储正则表达式的核心属性 String regexp() default ""; String message() default "参数格式校验不通过"; } - 配置自定义注解与 Schema 字段的映射规则
在项目的application.yml中添加 OpenAPI 映射配置,将自定义注解的属性和 OpenAPI Schema 的标准字段做绑定:
注意:映射配置左侧必须严格使用 OpenAPI 规范定义的 Schema 字段名(如micronaut: openapi: schema: mappings: # 替换为自定义注解的全限定类名 com.yourpackage.annotation.CustomPattern: # 键为OpenAPI Schema的固定字段名,值为自定义注解中对应的属性名 pattern: regexppattern/maxLength/minLength),右侧需要和自定义注解的属性名完全一致,否则会出现值提取失败的问题。
特殊场景说明
如果@CustomPattern是通过元注解直接组合了原生@Pattern(即注解定义上直接标注@Pattern(regexp = "{}")),无需额外配置,Micronaut 的注解处理器会自动递归识别组合注解上的原生校验注解,直接生成对应的pattern字段。
配置完成后重启项目,生成的swagger配置文件中,被@CustomPattern标注的参数会自动在对应Schema节点下生成pattern字段,和原生@Pattern的输出效果完全一致。
内容的提问来源于stack exchange,提问作者Faraz
相关产品推荐
相关产品推荐

