Skip to content

fix:openapi #15806

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
redoom wants to merge 1 commit into
base: 3.3
Choose a base branch
from
+168 −8
Open

fix:openapi #15806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
172 changes: 166 additions & 6 deletions ...-openapi/src/main/java/org/apache/dubbo/rpc/protocol/tri/rest/openapi/SchemaResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import org.apache.dubbo.rpc.protocol.tri.rest.util.RestToolKit;
import org.apache.dubbo.rpc.protocol.tri.rest.util.TypeUtils;

import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.GenericArrayType;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
Expand Down Expand Up @@ -112,7 +113,14 @@ private Schema doResolveType(Type type, ParameterMeta parameter) {
.setAdditionalPropertiesSchema(doResolveNestedType(argTypes[1], parameter));
}

return doResolveClass(clazz, parameter);
Schema classSchema = doResolveClass(clazz, parameter, pType);
for (Type argType : argTypes) {
Type actualArgType = TypeUtils.getActualGenericType(argType);
if (actualArgType != null) {
doResolveNestedType(actualArgType, parameter);
}
}
return classSchema;
}
}
if (type instanceof TypeVariable) {
Expand All @@ -130,6 +138,10 @@ private Schema doResolveType(Type type, ParameterMeta parameter) {
}

private Schema doResolveClass(Class<?> clazz, ParameterMeta parameter) {
return doResolveClass(clazz, parameter, null);
}

private Schema doResolveClass(Class<?> clazz, ParameterMeta parameter, ParameterizedType parameterizedType) {
Schema schema = PrimitiveSchema.newSchemaOf(clazz);
if (schema != null) {
return schema;
Expand All @@ -154,7 +166,7 @@ private Schema doResolveClass(Class<?> clazz, ParameterMeta parameter) {
return schema;
}

TypeParameterMeta typeParameter = new TypeParameterMeta(clazz);
TypeParameterMeta typeParameter = new TypeParameterMeta(parameter.getToolKit(), clazz);
for (OpenAPISchemaPredicate predicate : predicates) {
Boolean accepted = predicate.acceptClass(clazz, typeParameter);
if (accepted == null) {
Expand Down Expand Up @@ -184,13 +196,32 @@ private Schema doResolveClass(Class<?> clazz, ParameterMeta parameter) {
flatten = anno != null && anno.getBoolean("flatten");
}

return new Schema().setTargetSchema(doResolveBeanClass(parameter.getToolKit(), clazz, flatten));
return new Schema()
.setTargetSchema(doResolveBeanClass(parameter.getToolKit(), clazz, flatten, parameterizedType));
}

private Schema doResolveBeanClass(RestToolKit toolKit, Class<?> clazz, boolean flatten) {
return doResolveBeanClass(toolKit, clazz, flatten, null);
}

private Schema doResolveBeanClass(
RestToolKit toolKit, Class<?> clazz, boolean flatten, ParameterizedType parameterizedType) {
Schema beanSchema = OBJECT.newSchema().setJavaType(clazz);
schemaMap.put(clazz, beanSchema);
BeanMeta beanMeta = new BeanMeta(toolKit, clazz, flatten);

Map<String, Type> typeVarMap = null;
if (parameterizedType != null) {
TypeVariable<?>[] typeParams = clazz.getTypeParameters();
Type[] actualArgs = parameterizedType.getActualTypeArguments();
if (typeParams.length == actualArgs.length && typeParams.length > 0) {
typeVarMap = CollectionUtils.newHashMap(typeParams.length);
for (int i = 0; i < typeParams.length; i++) {
typeVarMap.put(typeParams[i].getName(), actualArgs[i]);
}
}
}

out:
for (PropertyMeta property : beanMeta.getProperties()) {
boolean fallback = true;
Expand All @@ -200,10 +231,10 @@ private Schema doResolveBeanClass(RestToolKit toolKit, Class<?> clazz, boolean f
continue;
}
if (accepted) {
continue out;
} else {
fallback = false;
break;
} else {
continue out;
}
}

Expand All @@ -213,7 +244,21 @@ private Schema doResolveBeanClass(RestToolKit toolKit, Class<?> clazz, boolean f
continue;
}
}
beanSchema.addProperty(property.getName(), resolve(property));

Type originalType = property.getGenericType();
Type substitutedType = originalType;
if (typeVarMap != null) {
substitutedType = substituteTypeVariables(originalType, typeVarMap);
}

Schema propertySchema;
if (substitutedType != originalType) {
ParameterMeta substitutedParam = new SubstitutedPropertyMeta(property, substitutedType);
propertySchema = resolve(substitutedParam);
} else {
propertySchema = resolve(property);
}
beanSchema.addProperty(property.getName(), propertySchema);
}

if (flatten) {
Expand Down Expand Up @@ -258,6 +303,30 @@ private boolean isClassExcluded(Class<?> clazz) {
return matches.get(0).getValue();
}

private Type substituteTypeVariables(Type type, Map<String, Type> typeVarMap) {
if (type instanceof TypeVariable) {
TypeVariable<?> typeVar = (TypeVariable<?>) type;
Type actualType = typeVarMap.get(typeVar.getName());
return actualType != null ? actualType : type;
}
if (type instanceof ParameterizedType) {
ParameterizedType pType = (ParameterizedType) type;
Type[] actualArgs = pType.getActualTypeArguments();
Type[] substitutedArgs = new Type[actualArgs.length];
boolean changed = false;
for (int i = 0; i < actualArgs.length; i++) {
substitutedArgs[i] = substituteTypeVariables(actualArgs[i], typeVarMap);
if (substitutedArgs[i] != actualArgs[i]) {
changed = true;
}
}
if (changed) {
return new ParameterizedTypeImpl(pType.getRawType(), substitutedArgs, pType.getOwnerType());
}
}
return type;
}

public static void addPath(RadixTree<Boolean> tree, String path) {
if (path == null) {
return;
Expand Down Expand Up @@ -315,4 +384,95 @@ public Schema resolve(Type type) {
return SchemaResolver.this.resolve(type);
}
}

private static final class SubstitutedPropertyMeta extends ParameterMeta {
private final PropertyMeta originalProperty;
private final Type substitutedType;
private final Class<?> substitutedClass;

SubstitutedPropertyMeta(PropertyMeta originalProperty, Type substitutedType) {
super(originalProperty.getToolKit(), originalProperty.getPrefix(), originalProperty.getName());
this.originalProperty = originalProperty;
this.substitutedType = substitutedType;
this.substitutedClass = TypeUtils.getActualType(substitutedType);
}

@Override
public Class<?> getType() {
return substitutedClass;
}

@Override
public Type getGenericType() {
return substitutedType;
}

@Override
protected AnnotatedElement getAnnotatedElement() {
// Return the first annotated element from the list
List<? extends AnnotatedElement> elements = originalProperty.getAnnotatedElements();
return (elements != null && !elements.isEmpty()) ? elements.get(0) : null;
}

@Override
public List<? extends AnnotatedElement> getAnnotatedElements() {
// Delegate to original property to preserve all annotation sources
return originalProperty.getAnnotatedElements();
}

@Override
public String getDescription() {
return originalProperty.getDescription();
}

@Override
public int getIndex() {
return originalProperty.getIndex();
}
}

private static final class ParameterizedTypeImpl implements ParameterizedType {
private final Type rawType;
private final Type[] typeArguments;
private final Type ownerType;

ParameterizedTypeImpl(Type rawType, Type[] typeArguments, Type ownerType) {
this.rawType = rawType;
this.typeArguments = typeArguments;
this.ownerType = ownerType;
}

@Override
public Type[] getActualTypeArguments() {
return typeArguments.clone();
}

@Override
public Type getRawType() {
return rawType;
}

@Override
public Type getOwnerType() {
return ownerType;
}

@Override
public String toString() {
StringBuilder sb = new StringBuilder();
if (ownerType != null) {
sb.append(ownerType).append(".");
}
sb.append(rawType);
if (typeArguments.length > 0) {
sb.append("<");
for (int i = 0; i < typeArguments.length; i++) {
if (i > 0) sb.append(", ");
sb.append(typeArguments[i]);
}
sb.append(">");
}
return sb.toString();
}
}
}
2 changes: 1 addition & 1 deletion .../org/apache/dubbo/rpc/protocol/tri/rest/support/basic/BasicOpenAPIDefinitionResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ public Schema resolve(ParameterMeta parameter, SchemaContext context, SchemaChai
setBoolValue(annoMeta, "deprecated", schema::setDeprecated);
schema.setExtensions(Helper.toProperties(annoMeta.getStringArray("extensions")));

return chain.resolve(parameter, context);
return schema;
}

@Override
Expand Down
2 changes: 1 addition & 1 deletion .../apache/dubbo/rpc/protocol/tri/rest/support/swagger/SwaggerOpenAPIDefinitionResolver.java
View file
Open in desktop
Copy link
Contributor Author

@redoom redoom Nov 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because it has already been called once here, if it is called again, it will be called twice. So I directly returned the schema. I believe the schema annotation is failing because it's being called an extra time at the end, which prevents the preceding set methods from taking effect.
@oxsean

Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ public Schema resolve(ParameterMeta parameter, SchemaContext context, SchemaChai
schema.setNullable(anno.nullable() ? Boolean.TRUE : null);
schema.setDeprecated(anno.deprecated() ? Boolean.TRUE : null);

return chain.resolve(parameter, context);
return schema;
Copy link
Contributor

@oxsean oxsean Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove it?

}

@Override
Expand Down
Loading