[incubator-servicecomb-java-chassis] 07/10: SCB-266 x-java-class change to canonical to support generic

[li...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

liubao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-java-chassis.git

commit c1a5b28a0747fe4f27b48fb599930db2b7b2fb51
Author: wujimin <wu...@huawei.com>
AuthorDate: Sat Jan 20 03:41:16 2018 +0800

    SCB-266 x-java-class change to canonical to support generic
---
 .../swagger/converter/AbstractConverter.java       | 44 ++++++++----
 .../swagger/extend/ModelResolverExt.java           |  6 +-
 .../swagger/converter/TestAbstractConverter.java   | 83 ++++++++++++++++++++++
 .../swagger/extend/TestModelResolverExt.java       | 42 +++++++++++
 4 files changed, 161 insertions(+), 14 deletions(-)

diff --git a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/converter/AbstractConverter.java b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/converter/AbstractConverter.java
index c6d549b..94e1b88 100644
--- a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/converter/AbstractConverter.java
+++ b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/converter/AbstractConverter.java
@@ -21,6 +21,9 @@ import java.util.Map;
 
 import org.apache.servicecomb.swagger.generator.core.SwaggerConst;
 import org.apache.servicecomb.swagger.generator.core.utils.ClassUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.util.StringUtils;
 
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.type.TypeFactory;
@@ -28,6 +31,7 @@ import com.fasterxml.jackson.databind.type.TypeFactory;
 import io.swagger.models.Swagger;
 
 public abstract class AbstractConverter implements Converter {
+  private static final Logger LOGGER = LoggerFactory.getLogger(AbstractConverter.class);
 
   protected abstract Map<String, Object> findVendorExtensions(Object def);
 
@@ -35,23 +39,39 @@ public abstract class AbstractConverter implements Converter {
 
   @Override
   public JavaType convert(ClassLoader classLoader, String packageName, Swagger swagger, Object def) {
+    TypeFactory typeFactory = TypeFactory
+        .defaultInstance()
+        .withClassLoader(classLoader);
+
     Map<String, Object> vendorExtensions = findVendorExtensions(def);
-    JavaType javaType = getJavaTypeByVendorExtensions(classLoader, vendorExtensions);
-    if (javaType != null) {
-      return javaType;
+    String canonical = ClassUtils.getVendorExtension(vendorExtensions, SwaggerConst.EXT_JAVA_CLASS);
+    if (!StringUtils.isEmpty(canonical)) {
+      Class<?> clsResult = ClassUtils.getClassByName(classLoader, canonical);
+      if (clsResult != null) {
+        return typeFactory.constructType(clsResult);
+      }
     }
 
-    return doConvert(classLoader, packageName, swagger, def);
-  }
+    // ensure all depend model exist
+    // maybe create dynamic class by canonical
+    JavaType result = doConvert(classLoader, packageName, swagger, def);
 
-  private JavaType getJavaTypeByVendorExtensions(ClassLoader classLoader,
-      Map<String, Object> vendorExtensions) {
-    Class<?> cls =
-        ClassUtils.getClassByVendorExtensions(classLoader, vendorExtensions, SwaggerConst.EXT_JAVA_CLASS);
-    if (cls == null) {
-      return null;
+    String rawClassName = ClassUtils.getRawClassName(canonical);
+    if (StringUtils.isEmpty(rawClassName)) {
+      return result;
     }
 
-    return TypeFactory.defaultInstance().constructType(cls);
+    try {
+      JavaType rawType = typeFactory.constructFromCanonical(rawClassName);
+
+      if (rawType.getRawClass().getTypeParameters().length > 0) {
+        return typeFactory.constructFromCanonical(canonical);
+      }
+
+      return result;
+    } catch (IllegalArgumentException e) {
+      LOGGER.info("failed to load generic class, use {}.", result.getGenericSignature(), e);
+      return result;
+    }
   }
 }
diff --git a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/extend/ModelResolverExt.java b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/extend/ModelResolverExt.java
index 7f028ae..6b7d876 100644
--- a/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/extend/ModelResolverExt.java
+++ b/swagger/swagger-generator/generator-core/src/main/java/org/apache/servicecomb/swagger/extend/ModelResolverExt.java
@@ -35,6 +35,7 @@ import org.apache.servicecomb.swagger.extend.property.creator.ShortPropertyCreat
 import org.springframework.util.StringUtils;
 
 import com.fasterxml.jackson.databind.JavaType;
+import com.google.common.annotations.VisibleForTesting;
 
 import io.swagger.converter.ModelConverter;
 import io.swagger.converter.ModelConverterContext;
@@ -70,8 +71,9 @@ public class ModelResolverExt extends ModelResolver {
         .forEach(this::addPropertyCreator);
   }
 
-  private void setType(JavaType type, Map<String, Object> vendorExtensions) {
-    vendorExtensions.put(ExtendConst.EXT_JAVA_CLASS, type.getRawClass().getName());
+  @VisibleForTesting
+  protected void setType(JavaType type, Map<String, Object> vendorExtensions) {
+    vendorExtensions.put(ExtendConst.EXT_JAVA_CLASS, type.toCanonical());
   }
 
   private void checkType(JavaType type) {
diff --git a/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/converter/TestAbstractConverter.java b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/converter/TestAbstractConverter.java
new file mode 100644
index 0000000..98ac8eb
--- /dev/null
+++ b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/converter/TestAbstractConverter.java
@@ -0,0 +1,83 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.servicecomb.swagger.converter;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Optional;
+
+import org.apache.servicecomb.swagger.generator.core.SwaggerConst;
+import org.junit.Assert;
+import org.junit.Test;
+
+import com.fasterxml.jackson.databind.JavaType;
+import com.fasterxml.jackson.databind.type.TypeFactory;
+
+import io.swagger.models.Swagger;
+import mockit.Mocked;
+
+public class TestAbstractConverter {
+  Map<String, Object> vendorExtensions = new HashMap<>();
+
+  JavaType doConvertResult;
+
+  ClassLoader classLoader = new ClassLoader() {
+  };
+
+  AbstractConverter converter = new AbstractConverter() {
+    @Override
+    protected Map<String, Object> findVendorExtensions(Object def) {
+      return vendorExtensions;
+    }
+
+    @Override
+    protected JavaType doConvert(ClassLoader classLoader, String packageName, Swagger swagger, Object def) {
+      return doConvertResult;
+    }
+  };
+
+  @Test
+  public void convert_canonical_normal() {
+    doConvertResult = TypeFactory.defaultInstance().constructType(String.class);
+    vendorExtensions.put(SwaggerConst.EXT_JAVA_CLASS, "java.lang.String");
+
+    Assert.assertSame(doConvertResult, converter.convert(classLoader, null, null, null));
+  }
+
+  @Test
+  public void convert_noCanonical(@Mocked JavaType type) {
+    doConvertResult = type;
+
+    Assert.assertSame(type, converter.convert(classLoader, null, null, null));
+  }
+
+  @Test
+  public void convert_canonical_generic() {
+    doConvertResult = TypeFactory.defaultInstance().constructParametricType(Optional.class, String.class);
+    vendorExtensions.put(SwaggerConst.EXT_JAVA_CLASS, "java.util.Optional<java.lang.String>");
+
+    Assert.assertSame(doConvertResult, converter.convert(classLoader, null, null, null));
+  }
+
+  @Test
+  public void convert_canonical_rawNotExist() {
+    doConvertResult = TypeFactory.defaultInstance().constructType(String.class);
+    vendorExtensions.put(SwaggerConst.EXT_JAVA_CLASS, "xxx<java.lang.String>");
+
+    Assert.assertSame(doConvertResult, converter.convert(classLoader, null, null, null));
+  }
+}
diff --git a/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/extend/TestModelResolverExt.java b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/extend/TestModelResolverExt.java
new file mode 100644
index 0000000..9cc4abb
--- /dev/null
+++ b/swagger/swagger-generator/generator-core/src/test/java/org/apache/servicecomb/swagger/extend/TestModelResolverExt.java
@@ -0,0 +1,42 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.servicecomb.swagger.extend;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.servicecomb.swagger.generator.core.SwaggerConst;
+import org.junit.Assert;
+import org.junit.Test;
+
+import com.fasterxml.jackson.databind.JavaType;
+import com.fasterxml.jackson.databind.type.TypeFactory;
+
+public class TestModelResolverExt {
+  static ModelResolverExt resolver = new ModelResolverExt();
+
+  Map<String, Object> vendorExtensions = new HashMap<>();
+
+  @Test
+  public void setType() {
+    JavaType type = TypeFactory.defaultInstance().constructCollectionType(List.class, String.class);
+    resolver.setType(type, vendorExtensions);
+
+    Assert.assertEquals("java.util.List<java.lang.String>", vendorExtensions.get(SwaggerConst.EXT_JAVA_CLASS));
+  }
+}

-- 
To stop receiving notification emails like this one, please contact
"commits@servicecomb.apache.org" <co...@servicecomb.apache.org>.