feature: support `native-image` for `seata-client` #5476

wangliang181230 · 2023-03-30T07:41:38Z

I have registered the PR changes.

Ⅰ. Describe what this PR did

feature: First support native-image of the seata-client.
新特性：首次针对 native-image 做兼容性改造。

已支持的功能：

AT
XA
TCC
nacos: 注册中心nacos1.4.4测试通过，2.x测试未通过。配置中心暂未测试。
eureka: 使用seata中定义的版本时，测试通过。

暂未支持的功能：

SAGA
其他可选组件，都未测试。

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)?

Ⅳ. Describe how to verify it

下载此PR的代码，并执行 mvn clean install -DskipTests，将 jar包 install 到本地仓库。
下载我的学习用仓库的 seata-support-aot 分支：https://github.com/wangliang181230/study-spring-boot/tree/seata-support-aot
安装打包native所需环境，参考教程：https://easyj.icu/blog/#/native-image/
用 IDE 单独打开项目中的 test-compatibility-springboot3-seata 小目录，不是 study-spring-boot 大目录。
运行命令 mvn clean package -Pnative -e -DskipTests，开始打包 native-image

注意：打包 native-image 非常消耗内存，内存不足时，容易失败，请尽量关闭不需要的软件，释放内存。
运行完成后，/target/ 目录下，会生成一个 exe 文件，后面环境准备好后。

启动 seata-server
启动 mysql，并创建数据库：seata_study，再运行以下脚本创建表：

CREATE TABLE `tb_order` (
  `id` bigint NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB;

CREATE TABLE `undo_log` (
  `branch_id` bigint NOT NULL COMMENT 'branch transaction id',
  `xid` varchar(128) NOT NULL COMMENT 'global transaction id',
  `context` varchar(128) NOT NULL COMMENT 'undo_log context,such as serialization',
  `rollback_info` longblob NOT NULL COMMENT 'rollback info',
  `log_status` int NOT NULL COMMENT '0:normal status,1:defense status',
  `log_created` datetime(6) NOT NULL COMMENT 'create datetime',
  `log_modified` datetime(6) NOT NULL COMMENT 'modify datetime',
  UNIQUE KEY `ux_undo_log` (`xid`,`branch_id`)
) ENGINE=InnoDB COMMENT='AT transaction mode undo table';

点击目录下的 startup-exe.bat 文件，启动 native-image。
访问站点根地址 http://localhost:8081/，测试成功情况；
另外再访问 http://localhost:8081/?test=1，测试 insert 语句完成后，抛异常的情况，观察表 undo_log 中会有一条数据，等10秒后回滚后被删除。
另外再访问 http://localhost:8081/?test=2，测试 insert 语句和 tcc.prepare 方法完成后，抛异常的情况，观察表 undo_log 中会有一条数据，等10秒后回滚后被删除。同时，控制台会打印类似 test tcc: rollback...... 字样。
关闭 exe 进程，启动 startup-exe-by-XA-mode.bat，重复8、9、10步骤，测试 XA 模式。

以上，AT、XA、TCC三种模式，测试成功。

Ⅴ. Special notes for reviews

seata-spring-framework-fake-for-java8 模块，仅为了使aot相关代码在java8可以编译通过。使 seata 的jar包可以同时兼容高低版本的 java.

…eata/*`.

This reverts commit d21be4c.

…eata/*`, and remove the `aot.factories` of the `SeataServicesRuntimeHints`.

2) Optimize `test.yml` .

# Conflicts: # changes/en-us/develop.md # changes/zh-cn/develop.md # core/src/main/java/io/seata/core/protocol/Version.java # core/src/test/java/io/seata/core/protocol/VersionTest.java

# Conflicts: # .github/workflows/publishes.yml

wangliang181230 · 2023-03-30T07:50:35Z

...c/main/java/io/seata/spring/boot/autoconfigure/provider/SpringBootConfigurationProvider.java

            if (!Map.class.isAssignableFrom(field.getType())) {
                field.setAccessible(true);
                return field.get(propertyObj);
            }
+        } catch (NoSuchFieldException e) {


字段未找到时，就用方法获取。
因为在native-image中，有可能未注册fields，但注册了methods，可以通过method获取到配置值。

wangliang181230 · 2023-03-31T09:26:47Z

@slievrly PTAL

slievrly

LGTM

xingfudeshi

LGTM

linghengqian · 2024-02-19T15:32:00Z

config/seata-config-core/src/main/java/io/seata/config/ConfigurationCache.java

+        return (Configuration)Proxy.newProxyInstance(this.getClass().getClassLoader(), new Class[]{Configuration.class}
+            , (proxy, method, args) -> {


@funky-eyes

As a solution to No classes have been predefined during the image build to load from bytecodes at runtime raphw/byte-buddy#1588 , can we port the handling of ConfigurationCache.java back to the 2.x branch?

Reference https://github.com/apache/incubator-seata/blob/2.x/config/seata-config-core/src/main/java/org/apache/seata/config/ConfigurationCache.java .

@funky-eyes

As a solution to No classes have been predefined during the image build to load from bytecodes at runtime raphw/byte-buddy#1588 , can we port the handling of ConfigurationCache.java back to the 2.x branch?

Reference https://github.com/apache/incubator-seata/blob/2.x/config/seata-config-core/src/main/java/org/apache/seata/config/ConfigurationCache.java .

针对configuration cache代理这块可以修改为接口的方式使用jdk代理来解决，但是2.0中重构了事务api相关的模块，针对用户发起事务的实例使用了bytebuddy进行了代理，所以我不知道单纯改动configuration cache这个代理为jdk代理是否能解决该问题。
The configuration cache proxy can be modified to use a JDK proxy to address this issue. However, in 2.0, the transaction API-related modules were refactored, and ByteBuddy was used for proxying instances that initiate user transactions. Therefore, I am unsure whether simply changing the configuration cache proxy to a JDK proxy will resolve the issue.

@funky-eyes

As a solution to No classes have been predefined during the image build to load from bytecodes at runtime raphw/byte-buddy#1588 , can we port the handling of ConfigurationCache.java back to the 2.x branch?

Reference https://github.com/apache/incubator-seata/blob/2.x/config/seata-config-core/src/main/java/org/apache/seata/config/ConfigurationCache.java .

#6386 configurationcache will remove bytebuddy proxy in this pr

@funky-eyes

As a solution to No classes have been predefined during the image build to load from bytecodes at runtime raphw/byte-buddy#1588 , can we port the handling of ConfigurationCache.java back to the 2.x branch?

Reference https://github.com/apache/incubator-seata/blob/2.x/config/seata-config-core/src/main/java/org/apache/seata/config/ConfigurationCache.java .

#6386 configurationcache will remove bytebuddy proxy in this pr

@funky-eyes Late reply, I have verified that the relevant PR is enough to make the AT mode of Seata Client 2.1.0-SNAPSHOT work under GraalVM Native Image. I opened Provide built-in GraalVM Reachability Metadata on Seata Client 2.1.0+ #6686 to ask for further comments.

wangliang181230 and others added 30 commits February 16, 2023 09:50

add module spring-framework-fake-for-java8

3528b03

Version to 1.7.0-native-SNAPSHOT, upgrade shade-plugin to 3.2.4

8041cef

add some functions for native-image

f3e38d0

Change proxy byte-buddy to JDK-Proxy.

da2f61d

Add support for spring-boot-maven-plugin:process-aot.

f1f8374

Add reachability-metadata for /META-INF/services/* and `/META-INF/s…

f9f1248

…eata/*`.

Add reachability-metadata for Configuration

eb065bf

Add reachability-metadata for seata-core

aec3f80

Add reachability-metadata for AT mode

cd7ea26

Add reachability-metadata for XA mode

d21be4c

Add reachability-metadata for TCC mode

7382e0f

Revert "Add reachability-metadata for XA mode"

4a4f162

This reverts commit d21be4c.

Add reachability-metadata for XA mode

154f9e9

Add reachability-metadata for /META-INF/services/* and `/META-INF/s…

4935939

…eata/*`, and remove the `aot.factories` of the `SeataServicesRuntimeHints`.

Fix the wrong reachability-metadata.

8dfe448

Remove duplicate resource-config.json

4d24be8

Optimize log

56e2cd1

release: release for 1.7.0-native-rc1

7e6b913

change the version to 1.7.0-NATIVE-RC2-SNAPSHOT

4714e9d

Add reachability-metadata for seata-server

d1d345f

1) Fix license;

73ad983

2) Optimize `test.yml` .

Merge remote-tracking branch 'upstream/develop' into native

135f5ae

add VersionTest.java

58dc6aa

add VersionTest.java

c93a5c0

release: release for 1.7.0-native-rc2

bade349

optimize publishes.yml

fdf5451

release 1.7.0-native-rc2 (apache#5379)

4903f02

change the version to 1.7.0-native-rc3-SNAPSHOT

c7a392e

Merge remote-tracking branch 'upstream/develop' into native

911c74d

# Conflicts: # changes/en-us/develop.md # changes/zh-cn/develop.md # core/src/main/java/io/seata/core/protocol/Version.java # core/src/test/java/io/seata/core/protocol/VersionTest.java

Merge remote-tracking branch 'upstream/develop' into native

71a645f

# Conflicts: # .github/workflows/publishes.yml

wangliang181230 added 4 commits March 8, 2023 15:19

optimize actions

c8b225f

Merge remote-tracking branch 'upstream/develop' into native

8674671

optimize style

f94dffa

optimize style

9a14df3

wangliang181230 changed the base branch from 2.x to develop March 30, 2023 07:41

wangliang181230 closed this Mar 30, 2023

wangliang181230 reopened this Mar 30, 2023

wangliang181230 commented Mar 30, 2023

View reviewed changes

wangliang181230 changed the title ~~feature: First support native-image for seata-client~~ feature: First support native-image for seata-client Mar 31, 2023

wangliang181230 added 2 commits March 31, 2023 17:08

恢复spring fake模块下的所有类的许可内容及作者。

803267c

style

dfffb5b

wangliang181230 requested a review from slievrly March 31, 2023 09:26

slievrly approved these changes Apr 21, 2023

View reviewed changes

slievrly changed the title ~~feature: First support native-image for seata-client~~ feature: support native-image for seata-client Apr 21, 2023

xingfudeshi approved these changes Apr 21, 2023

View reviewed changes

Merge branch 'develop' into support-graalvm-native-image

d90ef1c

slievrly added this to the 1.7.0 milestone Jun 14, 2023

wangliang181230 and others added 2 commits June 20, 2023 13:58

Merge branch 'develop' into support-graalvm-native-image

94bd0b6

Merge branch 'develop' into support-graalvm-native-image

a47d560

slievrly merged commit 23244cf into apache:develop Jul 2, 2023

open-digger-bot bot mentioned this pull request Jul 3, 2023

[WeeklyReport] Weekly report for seata 6/26/2023 to 7/3/2023 #5697

Closed

wangliang181230 deleted the support-graalvm-native-image branch July 4, 2023 08:28

slievrly mentioned this pull request Feb 16, 2024

Add GraalVM Reachability Metadata and corresponding nativeTest for Seata integration apache/shardingsphere#30138

Merged

6 tasks

linghengqian reviewed Feb 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: support `native-image` for `seata-client` #5476

feature: support `native-image` for `seata-client` #5476

wangliang181230 commented Mar 30, 2023

wangliang181230 Mar 30, 2023

wangliang181230 commented Mar 31, 2023

slievrly left a comment

xingfudeshi left a comment

linghengqian Feb 19, 2024

funky-eyes Feb 20, 2024

funky-eyes Mar 1, 2024

linghengqian Jul 19, 2024

		return (Configuration)Proxy.newProxyInstance(this.getClass().getClassLoader(), new Class[]{Configuration.class}
		, (proxy, method, args) -> {

feature: support native-image for seata-client #5476

feature: support native-image for seata-client #5476

Conversation

wangliang181230 commented Mar 30, 2023

Ⅰ. Describe what this PR did

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)?

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

wangliang181230 Mar 30, 2023

Choose a reason for hiding this comment

wangliang181230 commented Mar 31, 2023

slievrly left a comment

Choose a reason for hiding this comment

xingfudeshi left a comment

Choose a reason for hiding this comment

linghengqian Feb 19, 2024

Choose a reason for hiding this comment

funky-eyes Feb 20, 2024

Choose a reason for hiding this comment

funky-eyes Mar 1, 2024

Choose a reason for hiding this comment

linghengqian Jul 19, 2024

Choose a reason for hiding this comment

feature: support `native-image` for `seata-client` #5476

feature: support `native-image` for `seata-client` #5476