Merge pull request #875 from linwumingshi/feature/json-view

feat: ✨ Add support for `@JsonView`

Author: shalousun

src/main/java/com/ly/doc/builder/IBaseDocBuilderTemplate.java

@@ -68,13 +68,16 @@ public interface IBaseDocBuilderTemplate<T extends IDoc> {
 
 	/**
 	 * get all doc api data
+	 * @param isAsciidoc is Asciidoc
+	 * @param showJavaType show java type
+	 * @param paramsDataToTree params data to tree
 	 * @param config ApiConfig
 	 * @param javaProjectBuilder JavaProjectBuilder
 	 * @return ApiAllData
 	 */
-	default List<T> getApiDoc(boolean adoc, boolean showJavaType, boolean paramsDataToTree, ApiConfig config,
+	default List<T> getApiDoc(boolean isAsciidoc, boolean showJavaType, boolean paramsDataToTree, ApiConfig config,
 			JavaProjectBuilder javaProjectBuilder) {
-		config.setAdoc(adoc);
+		config.setAdoc(isAsciidoc);
 		config.setShowJavaType(showJavaType);
 		config.setParamsDataToTree(paramsDataToTree);
 		this.checkAndInit(config, Boolean.TRUE);

src/main/java/com/ly/doc/builder/websocket/WebSocketDocBuilderTemplate.java

@@ -54,14 +54,14 @@ public class WebSocketDocBuilderTemplate implements IBaseDocBuilderTemplate<WebS
 
 	/**
 	 * get all websocket api data.
-	 * @param adoc is adoc
+	 * @param isAsciidoc is Asciidoc
 	 * @param config ApiConfig
 	 * @param javaProjectBuilder JavaProjectBuilder
 	 * @return ApiAllData
 	 */
-	public List<WebSocketDoc> getWebSocketApiDoc(boolean adoc, ApiConfig config,
+	public List<WebSocketDoc> getWebSocketApiDoc(boolean isAsciidoc, ApiConfig config,
 			JavaProjectBuilder javaProjectBuilder) {
-		config.setAdoc(adoc);
+		config.setAdoc(isAsciidoc);
 		this.checkAndInit(config, Boolean.TRUE);
 		config.setParamsDataToTree(false);
 		config
@@ -89,6 +89,7 @@ public List<WebSocketDoc> getWebSocketApiDoc(ApiConfig config, JavaProjectBuilde
 	 * Merge all websocket api doc into one document.
 	 * @param webSocketDocList list data of Api doc
 	 * @param config api config
+	 * @param javaProjectBuilder JavaProjectBuilder
 	 * @param template template
 	 * @param outPutFileName output file
 	 */

src/main/java/com/ly/doc/constants/DocAnnotationConstants.java

@@ -38,6 +38,11 @@ public interface DocAnnotationConstants {
 	 */
 	String SHORT_JSON_IGNORE_PROPERTIES = "JsonIgnoreProperties";
 
+	/**
+	 * jackson JsonView annotation {@code com.fasterxml.jackson.annotation.JsonView}
+	 */
+	String SHORT_JSON_VIEW = "JsonView";
+
 	/**
 	 * jackson JsonProperty annotation
 	 * {@code com.fasterxml.jackson.annotation.JsonProperty}

src/main/java/com/ly/doc/helper/JsonBuildHelper.java

@@ -27,6 +27,7 @@
 import com.power.common.util.CollectionUtil;
 import com.power.common.util.StringUtil;
 import com.thoughtworks.qdox.model.*;
+import com.thoughtworks.qdox.model.expression.AnnotationValue;
 
 import java.util.*;
 
@@ -95,8 +96,8 @@ public static String buildReturnJson(DocJavaMethod docJavaMethod, ProjectDocConf
 			return StringUtil.removeQuotes(DocUtil.jsonValueByType(typeName));
 		}
 
-		return JsonUtil.toPrettyFormat(
-				buildJson(typeName, returnType, Boolean.TRUE, 0, new HashMap<>(16), new HashSet<>(0), builder));
+		return JsonUtil.toPrettyFormat(buildJson(typeName, returnType, Boolean.TRUE, 0, new HashMap<>(16),
+				Collections.emptySet(), docJavaMethod.getJsonViewClasses(), builder));
 	}
 
 	/**
@@ -107,11 +108,14 @@ public static String buildReturnJson(DocJavaMethod docJavaMethod, ProjectDocConf
 	 * @param counter The recursion counter.
 	 * @param registryClasses A map to keep track of processed classes.
 	 * @param groupClasses A set of valid group classes.
+	 * @param methodJsonViewClasses A set of valid `@JsonView` classes on controller
+	 * method.
 	 * @param builder The project config builder.
 	 * @return The JSON string representation of the type.
 	 */
 	public static String buildJson(String typeName, String genericCanonicalName, boolean isResp, int counter,
-			Map<String, String> registryClasses, Set<String> groupClasses, ProjectDocConfigBuilder builder) {
+			Map<String, String> registryClasses, Set<String> groupClasses, Set<String> methodJsonViewClasses,
+			ProjectDocConfigBuilder builder) {
 
 		Map<String, String> genericMap = new HashMap<>(10);
 		JavaClass javaClass = builder.getJavaProjectBuilder().getClassByName(typeName);
@@ -187,14 +191,16 @@ else if (JavaClassValidateUtil.isPrimitive(gName)) {
 			}
 			else if (gName.contains("<")) {
 				String simple = DocClassUtil.getSimpleName(gName);
-				String json = buildJson(simple, gName, isResp, nextLevel, registryClasses, groupClasses, builder);
+				String json = buildJson(simple, gName, isResp, nextLevel, registryClasses, groupClasses,
+						methodJsonViewClasses, builder);
 				data.append(json);
 			}
 			else if (JavaClassValidateUtil.isCollection(gName)) {
 				data.append("\"any object\"");
 			}
 			else {
-				String json = buildJson(gName, gName, isResp, nextLevel, registryClasses, groupClasses, builder);
+				String json = buildJson(gName, gName, isResp, nextLevel, registryClasses, groupClasses,
+						methodJsonViewClasses, builder);
 				data.append(json);
 			}
 			data.append("]");
@@ -228,7 +234,8 @@ else if (JavaClassValidateUtil.isPrimitive(gicName)) {
 			}
 			else if (gicName.contains("<")) {
 				String simple = DocClassUtil.getSimpleName(gicName);
-				String json = buildJson(simple, gicName, isResp, nextLevel, registryClasses, groupClasses, builder);
+				String json = buildJson(simple, gicName, isResp, nextLevel, registryClasses, groupClasses,
+						methodJsonViewClasses, builder);
 				data.append("{").append("\"mapKey\":").append(json).append("}");
 			}
 			else {
@@ -239,7 +246,7 @@ else if (gicName.contains("<")) {
 							.append(field.getName())
 							.append("\":")
 							.append(buildJson(gicName, genericCanonicalName, isResp, counter + 1, registryClasses,
-									groupClasses, builder))
+									groupClasses, methodJsonViewClasses, builder))
 							.append(",");
 					}
 					// Remove the trailing comma
@@ -252,7 +259,7 @@ else if (gicName.contains("<")) {
 					data.append("{")
 						.append("\"mapKey\":")
 						.append(buildJson(gicName, genericCanonicalName, isResp, counter + 1, registryClasses,
-								groupClasses, builder))
+								groupClasses, methodJsonViewClasses, builder))
 						.append("}");
 				}
 			}
@@ -266,7 +273,8 @@ else if (JavaTypeConstants.JAVA_OBJECT_FULLY.equals(typeName)) {
 		}
 		// Handle Reactor types
 		else if (JavaClassValidateUtil.isReactor(typeName)) {
-			data.append(buildJson(globGicName[0], typeName, isResp, nextLevel, registryClasses, groupClasses, builder));
+			data.append(buildJson(globGicName[0], typeName, isResp, nextLevel, registryClasses, groupClasses,
+					methodJsonViewClasses, builder));
 			return data.toString();
 		}
 		// Process fields of the class
@@ -306,8 +314,19 @@ else if (JavaClassValidateUtil.isReactor(typeName)) {
 				String jsonFormatString = null;
 				// has Annotation @JsonSerialize And using ToStringSerializer
 				boolean toStringSerializer = false;
+				// Handle @JsonView; if the field is not annotated with @JsonView, skip
+				// it.
+				if (!methodJsonViewClasses.isEmpty() && isResp && annotations.isEmpty()) {
+					continue;
+				}
 				// Handle annotations on the field
 				for (JavaAnnotation annotation : annotations) {
+					// Handle @JsonView
+					if (JavaClassUtil.shouldExcludeFieldFromJsonView(annotation, methodJsonViewClasses, isResp,
+							builder)) {
+						continue out;
+					}
+
 					String annotationName = annotation.getType().getValue();
 					// if the field is annotated with @JsonSerialize
 					if (DocAnnotationConstants.SHORT_JSON_SERIALIZE.equals(annotationName)
@@ -316,7 +335,7 @@ else if (JavaClassValidateUtil.isReactor(typeName)) {
 						toStringSerializer = true;
 						continue;
 					}
-
+					// if the field is annotated with @Null And isResp is false
 					if (JSRAnnotationConstants.NULL.equals(annotationName) && !isResp) {
 						if (CollectionUtil.isEmpty(groupClasses)) {
 							continue out;
@@ -346,16 +365,17 @@ else if (JavaClassValidateUtil.isReactor(typeName)) {
 					// Handle @JsonProperty
 					else if (DocAnnotationConstants.SHORT_JSON_PROPERTY.equals(annotationName)
 							|| DocAnnotationConstants.GSON_ALIAS_NAME.equals(annotationName)) {
-						if (null != annotation.getProperty(DocAnnotationConstants.VALUE_PROP)) {
-							fieldName = StringUtil
-								.removeQuotes(annotation.getProperty(DocAnnotationConstants.VALUE_PROP).toString());
+						AnnotationValue annotationValue = annotation.getProperty(DocAnnotationConstants.VALUE_PROP);
+						if (null != annotationValue) {
+							fieldName = StringUtil.removeQuotes(annotationValue.toString());
 						}
 					}
 					// Handle @JsonFormat
 					else if (DocAnnotationConstants.JSON_FORMAT.equals(annotationName)) {
 						jsonFormatString = DocUtil.getJsonFormatString(field, annotation);
 					}
 				}
+
 				String typeSimpleName = docField.getTypeSimpleName();
 				String fieldGicName = docField.getTypeGenericCanonicalName();
 				CustomField.Key key = CustomField.Key.create(docField.getDeclaringClassName(), fieldName);
@@ -450,7 +470,8 @@ else if (gicName.length() == 1) {
 								if (!typeName.equals(gicName1)) {
 									data0.append("[")
 										.append(buildJson(DocClassUtil.getSimpleName(gicName1), gicName1, isResp,
-												nextLevel, registryClasses, groupClasses, builder))
+												nextLevel, registryClasses, groupClasses, methodJsonViewClasses,
+												builder))
 										.append("]")
 										.append(",");
 								}
@@ -475,7 +496,7 @@ else if (gicName.length() == 1) {
 								fieldGicName = DocUtil.formatFieldTypeGicName(genericMap, fieldGicName);
 								data0.append("[")
 									.append(buildJson(gicName, fieldGicName, isResp, nextLevel, registryClasses,
-											groupClasses, builder))
+											groupClasses, methodJsonViewClasses, builder))
 									.append("]")
 									.append(",");
 							}
@@ -517,7 +538,8 @@ else if (JavaClassValidateUtil.isMap(subTypeName)) {
 									data0.append("{")
 										.append("\"mapKey\":")
 										.append(buildJson(DocClassUtil.getSimpleName(gicName1), gicName1, isResp,
-												nextLevel, registryClasses, groupClasses, builder))
+												nextLevel, registryClasses, groupClasses, methodJsonViewClasses,
+												builder))
 										.append("},");
 								}
 								else {
@@ -529,7 +551,7 @@ else if (JavaClassValidateUtil.isMap(subTypeName)) {
 							data0.append("{")
 								.append("\"mapKey\":")
 								.append(buildJson(gicName, fieldGicName, isResp, nextLevel, registryClasses,
-										groupClasses, builder))
+										groupClasses, methodJsonViewClasses, builder))
 								.append("},");
 						}
 					}
@@ -544,7 +566,7 @@ else if (fieldGicName.length() == 1) {
 								String simple = DocClassUtil.getSimpleName(gicName);
 								data0
 									.append(buildJson(simple, gicName, isResp, nextLevel, registryClasses, groupClasses,
-											builder))
+											methodJsonViewClasses, builder))
 									.append(",");
 							}
 						}
@@ -601,7 +623,7 @@ else if (StringUtil.isNotEmpty(jsonFormatString)) {
 								fieldGicName = DocUtil.formatFieldTypeGicName(genericMap, fieldGicName);
 								data0
 									.append(buildJson(subTypeName, fieldGicName, isResp, nextLevel, registryClasses,
-											groupClasses, builder))
+											groupClasses, methodJsonViewClasses, builder))
 									.append(",");
 							}
 						}