feature: support native-image for seata-client

.github/workflows/test.yml

@@ -79,7 +79,7 @@ jobs:
       # step 4
       - name: "Test with Maven"
         run: |
-          ./mvnw -T 4C clean test -Dspring-boot.version=${{ matrix.springboot }} -Dcheckstyle.skip=false -Dlicense.skip=false -e -B -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn;
+          ./mvnw -T 4C clean test -Dspring-boot.version=${{ matrix.springboot }} -Dcheckstyle.skip=true -Dlicense.skip=true -e -B -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn;
 
   # job 3
   arm64-test:

.licenserc.yaml

@@ -75,6 +75,7 @@ header:
     - 'ext/apm-seata-skywalking-plugin/config/agent.config'
     - 'server/src/main/resources/lua/redislocker/redislock.lua'
     - 'server/src/main/resources/banner.txt'
+    - '**/org/springframework/**'
 
 
   comment: on-failure

all/pom.xml

@@ -212,6 +212,16 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>io.seata</groupId>
+            <artifactId>seata-spring-aot-core</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.seata</groupId>
+            <artifactId>seata-spring-aot-client</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>io.seata</groupId>
             <artifactId>seata-tcc</artifactId>
@@ -421,10 +431,6 @@
             <artifactId>edas-sdk</artifactId>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>net.bytebuddy</groupId>
-            <artifactId>byte-buddy</artifactId>
-        </dependency>
         <dependency>
             <groupId>aopalliance</groupId>
             <artifactId>aopalliance</artifactId>
@@ -623,6 +629,13 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
+                <dependencies>
+                    <dependency>
+                        <groupId>org.springframework.boot</groupId>
+                        <artifactId>spring-boot-maven-plugin</artifactId>
+                        <version>${spring-boot.version}</version>
+                    </dependency>
+                </dependencies>
                 <executions>
                     <execution>
                         <phase>package</phase>
@@ -641,17 +654,17 @@
                             </artifactSet>
                             <transformers>
                                 <!-- META-INF/services -->
-                                <transformer
-                                        implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
+                                <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                                 <!-- spring相关 -->
-                                <transformer
-                                        implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
+                                <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                                     <resource>META-INF/spring.handlers</resource>
                                 </transformer>
-                                <transformer
-                                        implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
+                                <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                                     <resource>META-INF/spring.schemas</resource>
                                 </transformer>
+                                <transformer implementation="org.springframework.boot.maven.PropertiesMergingResourceTransformer">
+                                    <resource>META-INF/spring/aot.factories</resource>
+                                </transformer>
                             </transformers>
                             <filters>
                                 <filter>

build/pom.xml

@@ -103,7 +103,7 @@
         <maven-source-plugin.version>2.2.1</maven-source-plugin.version>
         <maven-resources-plugin.version>3.2.0</maven-resources-plugin.version>
         <maven-jar-plugin.version>3.2.2</maven-jar-plugin.version>
-        <maven-shade-plugin.version>2.4.3</maven-shade-plugin.version>
+        <maven-shade-plugin.version>3.2.4</maven-shade-plugin.version>
         <maven-dependency-plugin.version>3.0.2</maven-dependency-plugin.version>
         <maven-assembly-plugin.version>3.0.0</maven-assembly-plugin.version>
         <jib-maven-plugin.version>3.2.0</jib-maven-plugin.version>

changes/en-us/develop.md

@@ -3,7 +3,7 @@ Add changes here for all PR submitted to the develop branch.
 <!-- Please add the `changes` to the following location(feature/bugfix/optimize/test) based on the type of PR -->
 
 ### feature:
-- [[#xxx](https://github.com/seata/seata/pull/xxx)] support xxx
+- [[#5476](https://github.com/seata/seata/pull/5476)] First support `native-image` for `seata-client`
 
 ### bugfix:
 - [[#5682](https://github.com/seata/seata/pull/5682)]  fix saga mode replay context lost startParams

changes/zh-cn/develop.md

@@ -3,7 +3,7 @@
 <!-- 请根据PR的类型添加 `变更记录` 到以下对应位置(feature/bugfix/optimize/test) 下 -->
 
 ### feature:
-- [[#xxx](https://github.com/seata/seata/pull/xxx)] 支持 xxx
+- [[#5476](https://github.com/seata/seata/pull/5476)] seata客户端，首次支持 `native-image`
 
 ### bugfix:
 - [[#5682](https://github.com/seata/seata/pull/5682)] 修复saga模式下replay context丢失startParams问题

common/src/main/java/io/seata/common/aot/NativeUtils.java

@@ -0,0 +1,63 @@
+/*
+ *  Copyright 1999-2019 Seata.io Group.
+ *
+ *  Licensed 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 io.seata.common.aot;
+
+/**
+ * The native utils
+ *
+ * @author wang.liang
+ */
+public class NativeUtils {
+
+    /**
+     * The native-image code
+     *
+     * @see <a href="https://github.com/oracle/graal/blob/master/sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/ImageInfo.java">ImageInfo.java</a>
+     */
+    private static final String NATIVE_IMAGE_CODE = System.getProperty("org.graalvm.nativeimage.imagecode");
+
+
+    public static final String SPRING_AOT_PROCESSING = "spring.aot.processing";
+
+
+    /**
+     * Whether Spring-AOT processing
+     *
+     * @return the boolean
+     */
+    public static boolean isSpringAotProcessing() {
+        return "true".equalsIgnoreCase(System.getProperty(SPRING_AOT_PROCESSING));
+    }
+
+    /**
+     * Gets the native-image code.
+     *
+     * @return the native-image code
+     */
+    public static String getNativeImageCode() {
+        return NATIVE_IMAGE_CODE;
+    }
+
+    /**
+     * Whether run in native-image
+     *
+     * @return the boolean
+     * @see org.springframework.core.NativeDetector#inNativeImage()
+     */
+    public static boolean inNativeImage() {
+        return NATIVE_IMAGE_CODE != null;
+    }
+}

common/src/main/java/io/seata/common/loader/EnhancedServiceLoader.java

@@ -44,6 +44,9 @@
  */
 public class EnhancedServiceLoader {
 
+    public static final String SERVICES_DIRECTORY = "META-INF/services/";
+    public static final String SEATA_DIRECTORY = "META-INF/seata/";
+
     /**
      * Class->InnerEnhancedServiceLoader map
      */
@@ -245,8 +248,6 @@ private static ClassLoader findClassLoader() {
 
     private static class InnerEnhancedServiceLoader<S> {
         private static final Logger LOGGER = LoggerFactory.getLogger(InnerEnhancedServiceLoader.class);
-        private static final String SERVICES_DIRECTORY = "META-INF/services/";
-        private static final String SEATA_DIRECTORY = "META-INF/seata/";
 
         private final Class<S> type;
         private final Holder<List<ExtensionDefinition<S>>> definitionsHolder = new Holder<>();
@@ -555,7 +556,9 @@ private void loadFile(String dir, ClassLoader loader, List<ExtensionDefinition<S
 
                 if (LOGGER.isDebugEnabled()) {
                     if (!hasServiceFile) {
-                        LOGGER.warn("Load [{}] class fail: no service files found in '{}'.", type.getName(), dir);
+                        if (!SEATA_DIRECTORY.equals(dir)) {
+                            LOGGER.warn("Load [{}] class fail: no service files found in '{}'.", type.getName(), dir);
+                        }
                     } else if (!hasClasses) {
                         LOGGER.warn("Load [{}] class fail: the service files in '{}' is all empty.", type.getName(), dir);
                     }

common/src/main/java/io/seata/common/util/ReflectionUtil.java

@@ -130,6 +130,25 @@ public static Class<?> getWrappedClass(Class<?> clazz) {
         return clazz;
     }
 
+    public static boolean isJavaClass(Class<?> clazz) {
+        return clazz != null && clazz.getClassLoader() == null;
+    }
+
+    /**
+     * Whether the class exists
+     *
+     * @param className the class name
+     * @return the boolean
+     */
+    public static boolean existsClass(String className) {
+        try {
+            getClassByName(className);
+            return true;
+        } catch (ClassNotFoundException e) {
+            return false;
+        }
+    }
+
     //endregion
 
 

common/src/main/resources/META-INF/native-image/io.seata/seata-common/resource-config.json

@@ -0,0 +1,66 @@
+{
+  "resources": {
+    "includes": [
+      {
+        "condition": {
+          "typeReachable": "io.seata.common.loader.EnhancedServiceLoader"
+        },
+        "pattern": "\\QMETA-INF\/services\/io.seata.\\E.*"
+      },
+      {
+        "condition": {
+          "typeReachable": "io.seata.common.loader.EnhancedServiceLoader"
+        },
+        "pattern": "\\QMETA-INF\/seata\/io.seata.\\E.*"
+      },
+      {
+        "condition": {
+          "typeReachable": "io.seata.common.loader.EnhancedServiceLoader"
+        },
+        "pattern": "\\QMETA-INF\/services\/com.alibaba.dubbo.rpc.Filter\\E"
+      },
+      {
+        "condition": {
+          "typeReachable": "io.seata.common.loader.EnhancedServiceLoader"
+        },
+        "pattern": "\\QMETA-INF\/seata\/com.alibaba.dubbo.rpc.Filter\\E"
+      },
+      {
+        "condition": {
+          "typeReachable": "io.seata.common.loader.EnhancedServiceLoader"
+        },
+        "pattern": "\\QMETA-INF\/services\/com.alipay.sofa.rpc.filter.Filter\\E"
+      },
+      {
+        "condition": {
+          "typeReachable": "io.seata.common.loader.EnhancedServiceLoader"
+        },
+        "pattern": "\\QMETA-INF\/seata\/com.alipay.sofa.rpc.filter.Filter\\E"
+      },
+      {
+        "condition": {
+          "typeReachable": "io.seata.common.loader.EnhancedServiceLoader"
+        },
+        "pattern": "\\QMETA-INF\/services\/com.taobao.hsf.invocation.filter.RPCFilter\\E"
+      },
+      {
+        "condition": {
+          "typeReachable": "io.seata.common.loader.EnhancedServiceLoader"
+        },
+        "pattern": "\\QMETA-INF\/seata\/com.taobao.hsf.invocation.filter.RPCFilter\\E"
+      },
+      {
+        "condition": {
+          "typeReachable": "io.seata.common.loader.EnhancedServiceLoader"
+        },
+        "pattern": "\\QMETA-INF\/services\/com.weibo.api.motan.filter.Filter\\E"
+      },
+      {
+        "condition": {
+          "typeReachable": "io.seata.common.loader.EnhancedServiceLoader"
+        },
+        "pattern": "\\QMETA-INF\/seata\/com.weibo.api.motan.filter.Filter\\E"
+      }
+    ]
+  }
+}

common/src/test/resources/META-INF/native-image/io.seata/seata-common/reflect-config.json

@@ -0,0 +1,14 @@
+[
+  {
+    "condition": {
+      "typeReachable": "io.seata.common.loader.Hello"
+    },
+    "name": "io.seata.common.loader.ChineseHello",
+    "methods": [
+      {
+        "name": "<init>",
+        "parameterTypes": []
+      }
+    ]
+  }
+]

compressor/seata-compressor-7z/src/main/resources/META-INF/native-image/io.seata/seata-compressor-7z/reflect-config.json

@@ -0,0 +1,14 @@
+[
+  {
+    "condition": {
+      "typeReachable": "io.seata.core.compressor.Compressor"
+    },
+    "name": "io.seata.compressor.sevenz.SevenZCompressor",
+    "methods": [
+      {
+        "name": "<init>",
+        "parameterTypes": []
+      }
+    ]
+  }
+]

compressor/seata-compressor-bzip2/src/main/resources/META-INF/native-image/io.seata/seata-compressor-bzip2/reflect-config.json

@@ -0,0 +1,14 @@
+[
+  {
+    "condition": {
+      "typeReachable": "io.seata.core.compressor.Compressor"
+    },
+    "name": "io.seata.compressor.bzip2.BZip2Compressor",
+    "methods": [
+      {
+        "name": "<init>",
+        "parameterTypes": []
+      }
+    ]
+  }
+]

compressor/seata-compressor-deflater/src/main/resources/META-INF/native-image/io.seata/seata-compressor-deflater/reflect-config.json

@@ -0,0 +1,14 @@
+[
+  {
+    "condition": {
+      "typeReachable": "io.seata.core.compressor.Compressor"
+    },
+    "name": "io.seata.compressor.deflater.DeflaterCompressor",
+    "methods": [
+      {
+        "name": "<init>",
+        "parameterTypes": []
+      }
+    ]
+  }
+]

compressor/seata-compressor-gzip/src/main/resources/META-INF/native-image/io.seata/seata-compressor-gzip/reflect-config.json

@@ -0,0 +1,14 @@
+[
+  {
+    "condition": {
+      "typeReachable": "io.seata.core.compressor.Compressor"
+    },
+    "name": "io.seata.compressor.gzip.GzipCompressor",
+    "methods": [
+      {
+        "name": "<init>",
+        "parameterTypes": []
+      }
+    ]
+  }
+]

compressor/seata-compressor-lz4/src/main/resources/META-INF/native-image/io.seata/seata-compressor-lz4/reflect-config.json

@@ -0,0 +1,14 @@
+[
+  {
+    "condition": {
+      "typeReachable": "io.seata.core.compressor.Compressor"
+    },
+    "name": "io.seata.compressor.lz4.Lz4Compressor",
+    "methods": [
+      {
+        "name": "<init>",
+        "parameterTypes": []
+      }
+    ]
+  }
+]