7000 条引用的 Java 源码重构

Question

我需要更改整个代码库中使用的方法的签名。

具体来说，方法 void log(String) 将采用两个附加参数（Class c, String methodName），这两个参数需要由调用者提供，具体取决于所在的方法它被称为。我不能简单地传递 null 或类似的内容。

为了了解范围，Eclipse 发现了 7000 个对该方法的引用，因此如果我更改它，整个项目就会崩溃。我需要几周时间才能手动修复它。

据我所知，Eclipse 的重构插件无法胜任这项任务，但我真的很想自动化它。
那么，我怎样才能完成工作呢？

Answer 1

太好了，我可以复制 我之前的回答，我只需要编辑一点点：

---

我认为你需要做的是使用像 javaparser 来执行此操作。

对于每个java源文件，将其解析为CompilationUnit，创建一个Visitor< /a>，可能使用 ModifierVisitor 作为基类，并覆盖（至少）访问(MethodCallExpr, arg)。然后将更改后的 CompilationUnit 写入新文件，然后进行比较。

我建议不要更改原始源文件，但创建影子文件树可能是个好主意（例如旧文件：src/main/java/com/mycompany/MyClass.java，新文件< code>src/main/refactored/com/mycompany/MyClass.java，这样您就可以比较整个目录）。

Answer 2

Eclipse 能够使用 Refactor -> 来做到这一点。更改方法签名并为新参数提供默认值。

对于类参数，defaultValue 应该是 this.getClass() 但你的评论是对的，我不知道如何处理方法名称参数。

Answer 3

IntelliJ IDEA 应该不会有任何问题。

我不是 Java 专家，但类似的东西可以工作。这不是一个完美的解决方案（甚至可能是一个非常糟糕的解决方案），但它可以帮助您入门：

使用 IntelliJ 的重构工具更改方法签名，并为 2 个新参数指定默认值：

c: self.getClass()
methodName: Thread.currentThread().getStackTrace()[1].getMethodName()

或者更好的是，只需指定 null 作为默认值。

Answer 4

我认为有几个步骤可以解决这个问题，因为这不仅仅是一个技术问题，而是一个“情况”：

1. 由于风险而拒绝在短时间内这样做。
2. 指出不使用标准框架而是重新发明轮子所带来的问题（正如保罗所说）。
3. 如果进行更改，请坚持使用 Log4j 或同等版本。
4. 使用 Eclipse 重构合理的块来进行更改并处理不同的默认值。

我已经使用 Eclipse 重构进行了相当大的更改来修复旧的臭代码 - 如今它相当健壮。

Answer 5

也许我很天真，但为什么不能重载方法名称呢？

void thing(paramA) {
    thing(paramA, THE_DEFAULT_B, THE_DEFAULT_C)
}

void thing(paramA, paramB, paramC) {
    // new method
}

Answer 6

您真的需要更改调用代码和方法签名吗？我的意思是，看起来添加的参数旨在为您提供调用类和方法以添加到日志数据中。如果唯一的要求只是将调用类/方法添加到日志数据中，那么 Thread.currentThread().getStackTrace() 应该可以工作。一旦获得 StackTraceElement[]，您就可以获得调用者的类名和方法名。

Answer 7

如果您需要替换的行属于少数类别，那么您需要的是 Perl：

find -name '*.java' | xargs perl -pi -e 's/log\(([^,)]*?)\)/log(\1, "foo", "bar")/g'

我猜想编写一个将类名（从文件名派生）放入的脚本并不会太难作为第二个参数。将方法名称作为第三个参数作为练习留给读者。

Answer 8

尝试使用 intellij 进行重构。它有一个称为SSR（结构搜索和替换）的功能。您可以引用类、方法名称等来获取上下文。 （seaizer的回答更有希望，我投了赞成票）

Answer 9

我同意Seanizer的回答，你想要一个可以解析Java的工具。这是必要的，但还不够；您真正想要的是一个可以进行可靠的大规模更改的工具。

为此，您需要一个可以解析 Java、可以对解析的代码进行模式匹配、安装替换调用并在不破坏其余源代码的情况下输出答案的工具。

我们的 DMS 软件重新工程工具包 可以为多种语言完成所有这些工作，包括爪哇。它解析完整 java 系统源代码，构建抽象语法树（针对整套代码）。

DMS 可以应用模式导向的源到源转换来实现所需的更改。

为了达到OP的效果，他将应用以下程序转换：

 rule replace_legacy_log(s:STRING): expression -> expression
    " log(\s) " -> " log( \s, \class\(\), \method\(\) ) "

这条规则是什么说的是，找到对具有单个字符串参数的 log 的调用，并将其替换为对 log 的调用，该调用具有由辅助函数确定的另外两个参数 class 和 方法。

这些函数确定规则找到匹配项的 AST 节点根的包含方法名称和包含类名称。

该规则以“源形式”编写，但实际上与 AST 匹配，并用修改后的 AST 替换找到的 AST。

要取回修改后的源代码，您可以要求 DMS 简单地进行漂亮打印（以制作漂亮的布局）或保真打印（如果您希望保留旧代码的布局）。 DMS 保留注释、数字基数等。\

如果现有应用程序对“log”函数有多个定义，则需要添加一个限定符：

... if IsDesiredLog().

其中 IsDesiredLog 使用 DMS 的符号表和继承确定特定日志是否涉及感兴趣的定义的信息。

Answer 10

事实上，您的问题不在于使用允许您替换所有出现的

log("some weird message");

by

log(this.getClass(), new Exception().getStackTrace()[1].getMethodName());

的点击播放引擎，因为它几乎没有机会处理各种情况（例如静态方法）。

我倾向于建议您看一下spoon。该工具允许源代码解析和转换，允许您以（显然是基于代码的）缓慢但受控的操作来实现您的操作。

但是，您还可以考虑通过探索堆栈跟踪来转换您的实际方法以获取信息，或者更好的是，在内部使用 log4j 和显示正确信息的日志格式化程序。

Answer 11

我会搜索并替换 log( 为 log(@class, @methodname,)

然后用任何语言（甚至 java）编写一个小脚本来查找类名和方法名称并替换 @class 和 @method 标记...

祝你好运

Answer 12

如果“这个日志来自哪里？”需要类和方法名称。输入数据，那么另一个选择是在日志方法中打印出堆栈跟踪。例如

public void log(String text)
{
   StringWriter sw = new StringWriter();
   PrintWriter pw = new PrintWriter(sw, true);
   new Throwable.printStackTrace(pw);
   pw.flush();
   sw.flush();
   String stackTraceAsLog = sw.toString();
   //do something with text and stackTraceAsLog
}