apache / apache/servicecomb-java-chassis

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

Đang mở
#3,232 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Proposal
Ngôn ngữ chính
Java
Star
1.9k
Fork
814
Merge trung bình
8 ngày 23 giờ
Pull request đã merge (30 ngày)
1

Mô tả

## 框架版本

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 注解的支持?

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Bắt đầu từ io.swagger.jackson.ModelResolver#applyBeanValidatorAnnotations và kiểm tra contract được tạo cho body Person của phương thức kiểm thử REST. So sánh cách xử lý javax.validation hiện có với Hibernate @Length và @Range, sau đó xác minh rằng contract cung cấp các ràng buộc về độ dài và phạm vi tương ứng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
java
Lĩnh vực
api
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
38/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.