如何为Salesforce APEX代码构建OpenRewrite食谱并提取代码块？

1. 依赖准备 #

确保项目中引入OpenRewrite的Salesforce支持依赖，以Maven为例，在pom.xml中添加：

<dependency>
    <groupId>org.openrewrite.recipe</groupId>
    <artifactId>rewrite-salesforce</artifactId>
    <version>latest.version</version> <!-- 替换为实际最新版本 -->
</dependency>
<dependency>
    <groupId>org.openrewrite</groupId>
    <artifactId>rewrite-apex</artifactId>
    <version>latest.version</version>
</dependency>

2. 自定义食谱实现 #

创建继承自Recipe的自定义类，通过ApexIsoVisitor遍历APEX抽象语法树（AST），识别并提取目标代码块：

import org.openrewrite.ExecutionContext;
import org.openrewrite.Recipe;
import org.openrewrite.apex.ApexIsoVisitor;
import org.openrewrite.apex.tree.ForLoop;
import org.openrewrite.apex.tree.MethodDeclaration;
import org.openrewrite.apex.tree.WhileLoop;

public class ApexCodeBlockExtractor extends Recipe {
    @Override
    public String getDisplayName() {
        return "提取Salesforce APEX代码块（方法、循环）";
    }

    @Override
    public String getDescription() {
        return "从APEX类中提取方法声明、while循环、for循环的信息及代码内容";
    }

    @Override
    protected ApexIsoVisitor<ExecutionContext> getVisitor() {
        return new ApexIsoVisitor<>() {
            // 处理方法声明
            @Override
            public MethodDeclaration visitMethodDeclaration(MethodDeclaration method, ExecutionContext ctx) {
                String methodMeta = String.format("方法名: %s | 返回类型: %s | 参数列表: %s",
                        method.getName().getSimpleName(),
                        method.getReturnType().getType().getSimpleName(),
                        method.getParameters());
                System.out.println(methodMeta);
                // 获取方法体完整代码：method.getBody().print()
                return super.visitMethodDeclaration(method, ctx);
            }

            // 处理while循环
            @Override
            public WhileLoop visitWhileLoop(WhileLoop loop, ExecutionContext ctx) {
                String loopMeta = String.format("While循环 | 条件: %s", loop.getCondition().print());
                System.out.println(loopMeta);
                // 获取循环体代码：loop.getBody().print()
                return super.visitWhileLoop(loop, ctx);
            }

            // 处理for循环
            @Override
            public ForLoop visitForLoop(ForLoop loop, ExecutionContext ctx) {
                String loopMeta = String.format("For循环 | 初始化: %s | 条件: %s | 更新语句: %s",
                        loop.getInitialization().print(),
                        loop.getCondition().print(),
                        loop.getUpdate().print());
                System.out.println(loopMeta);
                // 获取循环体代码：loop.getBody().print()
                return super.visitForLoop(loop, ctx);
            }
        };
    }
}

3. 食谱配置与运行 #

配置rewrite.yml #

在项目根目录创建rewrite.yml文件，注册自定义食谱：

type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ApexCodeBlockExtractor
displayName: 提取APEX代码块
description: 提取APEX类中的方法、while循环、for循环信息
recipeList:
  - com.yourorg.ApexCodeBlockExtractor

运行食谱 #

使用Maven命令执行：

mvn rewrite:run -Drewrite.recipeArtifactCoordinates=com.yourorg:your-recipe-artifact:1.0.0 -Drewrite.activeRecipes=com.yourorg.ApexCodeBlockExtractor

4. 扩展优化 #

• 输出到文件：替换控制台打印逻辑，通过ExecutionContext获取文件输出流，将提取的代码块内容写入指定文件。
• 支持更多节点：可添加DoWhileLoop、IfStatement等其他AST节点的处理逻辑，扩展提取范围。
• 结构化存储：将提取的信息序列化为JSON/XML格式，便于后续分析。

内容的提问来源于stack exchange，提问作者Dora Babu Kotthru