apache / apache/servicecomb-java-chassis

Java-Chassis生成的契约无法反映hibernate参数校验注解

未关闭
#3,232 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
Proposal
主要语言
Java
星标
1.9k
派生
814
平均合并
8 天 23 小时
30 天内合并 PR
1

描述

## 框架版本

Java-Chassis 1.3.7

## 复现demo

REST 接口方法如下:
```java
@Path("/test")
@POST
public Person test(@QueryParam("query") String query, @Valid Person person) {
person.setName(person.getName() + query);
return person;
}
```

body参数类型定义如下:
```java
public class Person {
@Length(min = 4,max = 5) // org.hibernate.validator.constraints.Length
private String name;

@Range(min = 20,max=30 ) // org.hibernate.validator.constraints.Range
private int age;

// 省略后面的 getter setter 方法
}
```

启动服务后调用 `test` 接口方法, 确认参数校验的逻辑是生效的.
但是契约中显示的 `Person` 类型字段信息不会包含参数限制信息.

Swagger 2.0 本身的数据模型是有对参数校验字段的表达的支持的, 参考[Swagger 2.0 文档](https://swagger.io/specification/v2/), 包含 `maximum`/`exclusiveMaximum`/`minimum`/`exclusiveMinimum`/`maxLength`/`minLength`/`pattern` 等元素.

Swagger 本身的工具类已经支持了 `javax.validation` 包中的注解. 但对于 hibernate 的注解则不支持:
![image](https://user-images.githubusercontent.com/22049770/181217637-d17e2890-b4b8-44c7-b20c-27274e364477.png)

相关代码逻辑在 `io.swagger.jackson.ModelResolver#applyBeanValidatorAnnotations` 方法中.

请问 Java-Chassis 能否扩展一下, 增加对 hibernate 注解的支持?

贡献指南

这个仓库没有索引到贡献指南

调研方向

从 io.swagger.jackson.ModelResolver#applyBeanValidatorAnnotations 开始,检查 REST 测试方法的 Person body 所生成的契约。将现有的 javax.validation 处理与 Hibernate @Length 和 @Range 进行比较,然后验证该契约公开了相应的长度和范围约束。

由索引模型根据 Issue 内容生成。

评估

技术栈
java
领域
api
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。