liubao68 closed pull request #983: [SCB-979] add reminder log on the selection
of SwaggerGeneratorContext
URL: https://github.com/apache/incubator-servicecomb-java-chassis/pull/983
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git
a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/CompositeSwaggerGeneratorContext.java
b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/CompositeSwaggerGeneratorContext.java
index ef3979353..70adc13ec 100644
---
a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/CompositeSwaggerGeneratorContext.java
+++
b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/core/CompositeSwaggerGeneratorContext.java
@@ -18,16 +18,25 @@
package org.apache.servicecomb.swagger.generator.core;
import java.util.List;
+import java.util.Map;
+import org.apache.servicecomb.foundation.common.concurrent.ConcurrentHashMapEx;
import org.apache.servicecomb.foundation.common.utils.SPIServiceUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import org.springframework.context.EmbeddedValueResolverAware;
import org.springframework.stereotype.Component;
import org.springframework.util.StringValueResolver;
@Component
public class CompositeSwaggerGeneratorContext implements
EmbeddedValueResolverAware {
+
+ private static final Logger LOGGER =
LoggerFactory.getLogger(CompositeSwaggerGeneratorContext.class);
+
private List<SwaggerGeneratorContext> contextList;
+ private Map<Class<?>, SwaggerGeneratorContext>
producerClassSwaggerContextCacheMap = new ConcurrentHashMapEx<>();
+
public CompositeSwaggerGeneratorContext() {
contextList =
SPIServiceUtils.getSortedService(SwaggerGeneratorContext.class);
}
@@ -46,12 +55,14 @@ public void setEmbeddedValueResolver(StringValueResolver
resolver) {
}
public SwaggerGeneratorContext selectContext(Class<?> cls) {
- for (SwaggerGeneratorContext context : contextList) {
- if (context.canProcess(cls)) {
- return context;
+ return producerClassSwaggerContextCacheMap.computeIfAbsent(cls,
producerClass -> {
+ for (SwaggerGeneratorContext context : contextList) {
+ if (context.canProcess(cls)) {
+ LOGGER.info("select [{}] for [{}] to generate schema.",
context.getClass().getName(), cls.getName());
+ return context;
+ }
}
- }
-
- throw new Error("impossible, must be bug.");
+ throw new Error("impossible, must be bug.");
+ });
}
}
diff --git
a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/pojo/PojoSwaggerGeneratorContext.java
b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/pojo/PojoSwaggerGeneratorContext.java
index 816ad6c1a..eb8ecc8a9 100644
---
a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/pojo/PojoSwaggerGeneratorContext.java
+++
b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/generator/pojo/PojoSwaggerGeneratorContext.java
@@ -16,6 +16,7 @@
*/
package org.apache.servicecomb.swagger.generator.pojo;
+import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
@@ -31,11 +32,16 @@
import
org.apache.servicecomb.swagger.generator.pojo.converter.parameter.PendingBodyParameterConverter;
import
org.apache.servicecomb.swagger.generator.pojo.extend.parameter.PendingBodyParameter;
import
org.apache.servicecomb.swagger.generator.pojo.processor.parameter.PojoDefaultParameterProcessor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import io.swagger.models.parameters.BodyParameter;
import io.swagger.models.parameters.Parameter;
public class PojoSwaggerGeneratorContext extends
AbstractSwaggerGeneratorContext {
+
+ private static final Logger LOGGER =
LoggerFactory.getLogger(PojoSwaggerGeneratorContext.class);
+
static {
ConverterMgr.addConverter(PendingBodyParameter.class, new
PendingBodyParameterConverter());
}
@@ -47,6 +53,16 @@ public int getOrder() {
@Override
public boolean canProcess(Class<?> cls) {
+ for (Annotation annotation : cls.getAnnotations()) {
+ // we check the annotations by class name to avoid importing extra
dependencies in this module
+ if
("javax.ws.rs.Path".equals(annotation.annotationType().getCanonicalName())
+ || "org.springframework.web.bind.annotation.RequestMapping"
+ .equals(annotation.annotationType().getCanonicalName())) {
+ LOGGER.info(
+ "There is @RequestMapping or @Path annotation on the REST
interface class, but POJO swagger context is chosen. "
+ + "If this is unexpected, maybe you should check your
dependency jar files.");
+ }
+ }
return true;
}
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services