This is an automated email from the ASF dual-hosted git repository.
wangjian pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/incubator-seata.git
The following commit(s) were added to refs/heads/2.x by this push:
new b1e5538cd0 optimize: refactor method and class names in the saga
module (#7894)
b1e5538cd0 is described below
commit b1e5538cd0ec2893e7d6fe7d797a52108190f232
Author: MaoMaoandSnail <[email protected]>
AuthorDate: Sun Dec 28 12:14:36 2025 +0800
optimize: refactor method and class names in the saga module (#7894)
* optimize: optimize method and class names in the saga module.
* optimize: make comments consistent with method names.
* optimize: add register pr information and author information
---------
Co-authored-by: funkye <[email protected]>
Co-authored-by: Eric Wang <[email protected]>
---
changes/en-us/2.x.md | 2 ++
changes/zh-cn/2.x.md | 2 ++
.../io/seata/saga/engine/impl/DefaultStateMachineConfig.java | 8 ++++----
.../java/io/seata/saga/engine/repo/StateMachineRepository.java | 6 +++---
.../io/seata/saga/engine/impl/DefaultStateMachineConfigTest.java | 4 ++--
.../java/org/apache/seata/saga/engine/StateMachineEngine.java | 9 +++++----
.../seata/saga/engine/config/AbstractStateMachineConfig.java | 2 +-
.../seata/saga/engine/pcext/InterceptableStateHandler.java | 2 +-
.../org/apache/seata/saga/engine/pcext/utils/ParameterUtils.java | 1 -
.../apache/seata/saga/engine/repo/StateMachineRepository.java | 6 +++---
.../seata/saga/engine/repo/impl/StateMachineRepositoryImpl.java | 6 +++---
.../apache/seata/saga/engine/impl/DefaultStateMachineConfig.java | 2 +-
.../java/org/apache/seata/saga/statelang/parser/JsonParser.java | 2 +-
.../saga/statelang/parser/impl/AbstractTaskStateParser.java | 2 +-
.../parser/impl/{BaseStatePaser.java => BaseStateParser.java} | 4 ++--
.../seata/saga/statelang/parser/impl/ChoiceStateParser.java | 2 +-
.../statelang/parser/impl/CompensationTriggerStateParser.java | 2 +-
.../seata/saga/statelang/parser/impl/FailEndStateParser.java | 2 +-
.../seata/saga/statelang/parser/impl/SucceedEndStateParser.java | 2 +-
19 files changed, 35 insertions(+), 31 deletions(-)
diff --git a/changes/en-us/2.x.md b/changes/en-us/2.x.md
index ec61b85f88..c8ac84e67c 100644
--- a/changes/en-us/2.x.md
+++ b/changes/en-us/2.x.md
@@ -105,6 +105,7 @@ Add changes here for all PR submitted to the 2.x branch.
- [[#7873](https://github.com/apache/incubator-seata/pull/7873)] upgrade
jacoco plugin version from 0.8.7 to 0.8.14 in order to adapt JDK25
- [[#7885](https://github.com/apache/incubator-seata/pull/7885)] replace fury
with fory
- [[#7884](https://github.com/apache/incubator-seata/pull/7884)] upgrade
tomcat-embed-core version to 11.0.10
+- [[#7894](https://github.com/apache/incubator-seata/pull/7894)] optimize
method and class names in the saga module
### security:
@@ -208,6 +209,7 @@ Thanks to these contributors for their code commits. Please
report an unintended
- [xingfudeshi](https://github.com/xingfudeshi)
- [diguage](https://github.com/diguage)
- [aias00](https://github.com/aias00)
+- [MaoMaoandSnail](https://github.com/MaoMaoandSnail)
Also, we receive many valuable issues, questions and advices from our
community. Thanks for you all.
diff --git a/changes/zh-cn/2.x.md b/changes/zh-cn/2.x.md
index 71ec918f1b..af12825d48 100644
--- a/changes/zh-cn/2.x.md
+++ b/changes/zh-cn/2.x.md
@@ -104,6 +104,7 @@
- [[#7873](https://github.com/apache/incubator-seata/pull/7873)]
将Jacoco插件版本从0.8.7升级到0.8.14以适配JDK25
- [[#7885](https://github.com/apache/incubator-seata/pull/7885)] 替换 fury 至 fory
- [[#7884](https://github.com/apache/incubator-seata/pull/7884)] 将
tomcat-embed-core 版本升级到 11.0.10
+- [[#7894](https://github.com/apache/incubator-seata/pull/7894)]
优化saga模块中的方法名和类名
### security:
@@ -207,6 +208,7 @@
- [xingfudeshi](https://github.com/xingfudeshi)
- [diguage](https://github.com/diguage)
- [aias00](https://github.com/aias00)
+- [MaoMaoandSnail](https://github.com/MaoMaoandSnail)
同时，我们收到了社区反馈的很多有价值的issue和建议，非常感谢大家。
diff --git
a/compatible/src/main/java/io/seata/saga/engine/impl/DefaultStateMachineConfig.java
b/compatible/src/main/java/io/seata/saga/engine/impl/DefaultStateMachineConfig.java
index 80a35c31c8..3f0bdb3c26 100644
---
a/compatible/src/main/java/io/seata/saga/engine/impl/DefaultStateMachineConfig.java
+++
b/compatible/src/main/java/io/seata/saga/engine/impl/DefaultStateMachineConfig.java
@@ -183,15 +183,15 @@ public class DefaultStateMachineConfig implements
StateMachineConfig, Applicatio
}
@Override
- public StateMachine registryStateMachine(StateMachine
stateMachine) {
+ public StateMachine registerStateMachine(StateMachine
stateMachine) {
org.apache.seata.saga.statelang.domain.StateMachine unwrap =
((StateMachineImpl) stateMachine).unwrap();
- repository.registryStateMachine(unwrap);
+ repository.registerStateMachine(unwrap);
return stateMachine;
}
@Override
- public void registryByResources(InputStream[]
resourceAsStreamArray, String tenantId) throws IOException {
- repository.registryByResources(resourceAsStreamArray,
tenantId);
+ public void registerByResources(InputStream[]
resourceAsStreamArray, String tenantId) throws IOException {
+ repository.registerByResources(resourceAsStreamArray,
tenantId);
}
};
}
diff --git
a/compatible/src/main/java/io/seata/saga/engine/repo/StateMachineRepository.java
b/compatible/src/main/java/io/seata/saga/engine/repo/StateMachineRepository.java
index 1b0e704a25..93263b934a 100644
---
a/compatible/src/main/java/io/seata/saga/engine/repo/StateMachineRepository.java
+++
b/compatible/src/main/java/io/seata/saga/engine/repo/StateMachineRepository.java
@@ -60,14 +60,14 @@ public interface StateMachineRepository {
* @param stateMachine stateMachine
* @return the state machine
*/
- StateMachine registryStateMachine(StateMachine stateMachine);
+ StateMachine registerStateMachine(StateMachine stateMachine);
/**
- * Registry by resources.
+ * Register state machines by resources.
*
* @param resourceAsStreamArray the resource as stream array
* @param tenantId the tenant id
* @throws IOException the io exception
*/
- void registryByResources(InputStream[] resourceAsStreamArray, String
tenantId) throws IOException;
+ void registerByResources(InputStream[] resourceAsStreamArray, String
tenantId) throws IOException;
}
diff --git
a/compatible/src/test/java/io/seata/saga/engine/impl/DefaultStateMachineConfigTest.java
b/compatible/src/test/java/io/seata/saga/engine/impl/DefaultStateMachineConfigTest.java
index d748a5cd20..7d70cac931 100644
---
a/compatible/src/test/java/io/seata/saga/engine/impl/DefaultStateMachineConfigTest.java
+++
b/compatible/src/test/java/io/seata/saga/engine/impl/DefaultStateMachineConfigTest.java
@@ -138,13 +138,13 @@ public class DefaultStateMachineConfigTest {
}
@Override
- public org.apache.seata.saga.statelang.domain.StateMachine
registryStateMachine(
+ public org.apache.seata.saga.statelang.domain.StateMachine
registerStateMachine(
org.apache.seata.saga.statelang.domain.StateMachine stateMachine) {
return stateMachine;
}
@Override
- public void registryByResources(java.io.InputStream[]
resources, String tenantId) {}
+ public void registerByResources(java.io.InputStream[]
resources, String tenantId) {}
};
defaultStateMachineConfig.setStateMachineRepository(stateMachineRepository);
diff --git
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/StateMachineEngine.java
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/StateMachineEngine.java
index f8d279ed18..b25c5ccf8a 100644
---
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/StateMachineEngine.java
+++
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/StateMachineEngine.java
@@ -91,7 +91,7 @@ public interface StateMachineEngine {
* forward restart a failed state machine instance
*
* @param stateMachineInstId the state machine instance id
- * @param replaceParams the replace params
+ * @param replaceParams the replacement params
* @return the state machine instance
* @throws ForwardInvalidException forward invalid exception
*/
@@ -102,7 +102,7 @@ public interface StateMachineEngine {
* forward restart a failed state machine instance asynchronously
*
* @param stateMachineInstId the state machine instance id
- * @param replaceParams the replace params
+ * @param replaceParams the replacement params
* @param callback callback after forward restart a failed state machine
* @return the state machine instance
* @throws ForwardInvalidException the forward invalid exception
@@ -115,7 +115,7 @@ public interface StateMachineEngine {
* compensate a state machine instance
*
* @param stateMachineInstId the state machine id
- * @param replaceParams the replace params
+ * @param replaceParams the replacement params
* @return the state machine instance
* @throws EngineExecutionException the engin execution exception
*/
@@ -126,7 +126,7 @@ public interface StateMachineEngine {
* compensate a state machine instance asynchronously
*
* @param stateMachineInstId the state machine instance id
- * @param replaceParams the replace params
+ * @param replaceParams the replacement params
* @param callback callback after compensate a failed state machine
* @return the state machine instance
* @throws EngineExecutionException the engine execution exception
@@ -139,6 +139,7 @@ public interface StateMachineEngine {
* skip current failed state instance and forward restart state machine
instance
*
* @param stateMachineInstId the state machine instance id
+ * @param replaceParams the replacement params
* @return the state machine instance
* @throws EngineExecutionException the engine execution exception
*/
diff --git
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/config/AbstractStateMachineConfig.java
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/config/AbstractStateMachineConfig.java
index b3cb19f9c4..8c6e2efcec 100644
---
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/config/AbstractStateMachineConfig.java
+++
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/config/AbstractStateMachineConfig.java
@@ -168,7 +168,7 @@ public abstract class AbstractStateMachineConfig implements
StateMachineConfig {
// auto register resources
if (autoRegisterResources && stateMachineDefInputStreamArray != null) {
-
stateMachineRepository.registryByResources(stateMachineDefInputStreamArray,
defaultTenantId);
+
stateMachineRepository.registerByResources(stateMachineDefInputStreamArray,
defaultTenantId);
}
if (statusDecisionStrategy == null) {
diff --git
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/pcext/InterceptableStateHandler.java
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/pcext/InterceptableStateHandler.java
index 2d7b3d5855..8685a46a61 100644
---
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/pcext/InterceptableStateHandler.java
+++
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/pcext/InterceptableStateHandler.java
@@ -19,7 +19,7 @@ package org.apache.seata.saga.engine.pcext;
import java.util.List;
/**
- * Interceptible State Handler
+ * Interceptable State Handler
*
*/
public interface InterceptableStateHandler extends StateHandler {
diff --git
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/pcext/utils/ParameterUtils.java
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/pcext/utils/ParameterUtils.java
index 1e6bcef4ca..38f8204466 100644
---
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/pcext/utils/ParameterUtils.java
+++
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/pcext/utils/ParameterUtils.java
@@ -31,7 +31,6 @@ import java.util.List;
import java.util.Map;
/**
- *
* ParameterUtils
*
*/
diff --git
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/repo/StateMachineRepository.java
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/repo/StateMachineRepository.java
index 7eeaeca3e1..ccc1e0ba5a 100644
---
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/repo/StateMachineRepository.java
+++
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/repo/StateMachineRepository.java
@@ -60,14 +60,14 @@ public interface StateMachineRepository {
* @param stateMachine stateMachine
* @return the state machine
*/
- StateMachine registryStateMachine(StateMachine stateMachine);
+ StateMachine registerStateMachine(StateMachine stateMachine);
/**
- * Registry by resources.
+ * Register state machines by resources.
*
* @param resourceAsStreamArray the resource as stream array
* @param tenantId the tenant id
* @throws IOException the io exception
*/
- void registryByResources(InputStream[] resourceAsStreamArray, String
tenantId) throws IOException;
+ void registerByResources(InputStream[] resourceAsStreamArray, String
tenantId) throws IOException;
}
diff --git
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/repo/impl/StateMachineRepositoryImpl.java
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/repo/impl/StateMachineRepositoryImpl.java
index b88adc8c4e..6ffdd9b83e 100644
---
a/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/repo/impl/StateMachineRepositoryImpl.java
+++
b/saga/seata-saga-engine/src/main/java/org/apache/seata/saga/engine/repo/impl/StateMachineRepositoryImpl.java
@@ -119,7 +119,7 @@ public class StateMachineRepositoryImpl implements
StateMachineRepository {
}
@Override
- public StateMachine registryStateMachine(StateMachine stateMachine) {
+ public StateMachine registerStateMachine(StateMachine stateMachine) {
String stateMachineName = stateMachine.getName();
String tenantId = stateMachine.getTenantId();
@@ -169,7 +169,7 @@ public class StateMachineRepositoryImpl implements
StateMachineRepository {
}
@Override
- public void registryByResources(InputStream[] resourceAsStreamArray,
String tenantId) throws IOException {
+ public void registerByResources(InputStream[] resourceAsStreamArray,
String tenantId) throws IOException {
for (InputStream resource : resourceAsStreamArray) {
String json;
try (InputStream is = resource) {
@@ -182,7 +182,7 @@ public class StateMachineRepositoryImpl implements
StateMachineRepository {
if (StringUtils.isBlank(stateMachine.getTenantId())) {
stateMachine.setTenantId(tenantId);
}
- registryStateMachine(stateMachine);
+ registerStateMachine(stateMachine);
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("===== StateMachine Loaded: \n{}", json);
}
diff --git
a/saga/seata-saga-spring/src/main/java/org/apache/seata/saga/engine/impl/DefaultStateMachineConfig.java
b/saga/seata-saga-spring/src/main/java/org/apache/seata/saga/engine/impl/DefaultStateMachineConfig.java
index f73683d4aa..7d53b8bfe3 100644
---
a/saga/seata-saga-spring/src/main/java/org/apache/seata/saga/engine/impl/DefaultStateMachineConfig.java
+++
b/saga/seata-saga-spring/src/main/java/org/apache/seata/saga/engine/impl/DefaultStateMachineConfig.java
@@ -64,7 +64,7 @@ public class DefaultStateMachineConfig extends
AbstractStateMachineConfig
for (int i = 0; i < registerResources.length; i++) {
resourceAsStreamArray[i] = registerResources[i].getInputStream();
}
- getStateMachineRepository().registryByResources(resourceAsStreamArray,
getDefaultTenantId());
+ getStateMachineRepository().registerByResources(resourceAsStreamArray,
getDefaultTenantId());
}
private void registerSpringElExpressionFactoryManager() {
diff --git
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/JsonParser.java
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/JsonParser.java
index cab3de2e43..388d2c22f9 100644
---
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/JsonParser.java
+++
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/JsonParser.java
@@ -17,7 +17,6 @@
package org.apache.seata.saga.statelang.parser;
/**
- *
* Json Parser
*
*/
@@ -61,6 +60,7 @@ public interface JsonParser {
*
* @param json the parse input json
* @param type the class type
+ * @param ignoreAutoType is ignore auto type
* @param <T> the object type
* @return the parse result
*/
diff --git
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/AbstractTaskStateParser.java
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/AbstractTaskStateParser.java
index 3b36c2e68b..65fa85be93 100644
---
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/AbstractTaskStateParser.java
+++
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/AbstractTaskStateParser.java
@@ -33,7 +33,7 @@ import java.util.Map;
* AbstractTaskStateParser
*
*/
-public abstract class AbstractTaskStateParser extends BaseStatePaser {
+public abstract class AbstractTaskStateParser extends BaseStateParser {
protected void parseTaskAttributes(AbstractTaskState state, Object node) {
diff --git
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/BaseStatePaser.java
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/BaseStateParser.java
similarity index 95%
rename from
saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/BaseStatePaser.java
rename to
saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/BaseStateParser.java
index 035e4d8434..404d413558 100644
---
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/BaseStatePaser.java
+++
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/BaseStateParser.java
@@ -21,10 +21,10 @@ import
org.apache.seata.saga.statelang.domain.impl.BaseState;
import java.util.Map;
/**
- * BaseStatePaser
+ * BaseStateParser
*
*/
-public abstract class BaseStatePaser {
+public abstract class BaseStateParser {
protected void parseBaseAttributes(BaseState state, Object node) {
diff --git
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/ChoiceStateParser.java
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/ChoiceStateParser.java
index 5d8ccd5502..75f8e03e1e 100644
---
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/ChoiceStateParser.java
+++
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/ChoiceStateParser.java
@@ -30,7 +30,7 @@ import java.util.Map;
* Single item selection state parser
*
*/
-public class ChoiceStateParser extends BaseStatePaser implements
StateParser<ChoiceState> {
+public class ChoiceStateParser extends BaseStateParser implements
StateParser<ChoiceState> {
@Override
public ChoiceState parse(Object node) {
diff --git
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/CompensationTriggerStateParser.java
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/CompensationTriggerStateParser.java
index 88046d887a..c44acdcbca 100644
---
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/CompensationTriggerStateParser.java
+++
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/CompensationTriggerStateParser.java
@@ -24,7 +24,7 @@ import org.apache.seata.saga.statelang.parser.StateParser;
* 'trigger compensation process' state parser
*
*/
-public class CompensationTriggerStateParser extends BaseStatePaser implements
StateParser<CompensationTriggerState> {
+public class CompensationTriggerStateParser extends BaseStateParser implements
StateParser<CompensationTriggerState> {
@Override
public CompensationTriggerState parse(Object node) {
diff --git
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/FailEndStateParser.java
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/FailEndStateParser.java
index 4ae7044598..86e0a1f9ab 100644
---
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/FailEndStateParser.java
+++
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/FailEndStateParser.java
@@ -26,7 +26,7 @@ import java.util.Map;
* Failed end state parser
*
*/
-public class FailEndStateParser extends BaseStatePaser implements
StateParser<FailEndState> {
+public class FailEndStateParser extends BaseStateParser implements
StateParser<FailEndState> {
@Override
public FailEndState parse(Object node) {
diff --git
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/SucceedEndStateParser.java
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/SucceedEndStateParser.java
index 184c959542..302990f554 100644
---
a/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/SucceedEndStateParser.java
+++
b/saga/seata-saga-statelang/src/main/java/org/apache/seata/saga/statelang/parser/impl/SucceedEndStateParser.java
@@ -24,7 +24,7 @@ import org.apache.seata.saga.statelang.parser.StateParser;
* Succeed end state parser
*
*/
-public class SucceedEndStateParser extends BaseStatePaser implements
StateParser<SucceedEndState> {
+public class SucceedEndStateParser extends BaseStateParser implements
StateParser<SucceedEndState> {
@Override
public SucceedEndState parse(Object node) {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
