Java source refactoring of 7000 references

Question

I need to change the signature of a method used all over the codebase.

Specifically, the method void log(String) will take two additional arguments (

Answer 1

Great, I can copy a previous answer of mine and I just need to edit a tiny little bit:

---

I think what you need to do is use a source code parser like javaparser to do this.

For every java source file, parse it to a CompilationUnit, create a Visitor, probably using ModifierVisitorAdapter as base class, and override (at least) visit(MethodCallExpr, arg). Then write the changed CompilationUnit to a new File and do a diff afterwards.

I would advise against changing the original source file, but creating a shadow file tree may me a good idea (e.g. old file: src/main/java/com/mycompany/MyClass.java, new file src/main/refactored/com/mycompany/MyClass.java, that way you can diff the entire directories).

Answer 2

Eclipse is able to do that using Refactor -> Change Method signature and provide default values for the new parameters.

For the class parameter the defaultValue should be this.getClass() but you are right in your comment I don't know how to do for the method name parameter.

Answer 3

Il fact your problem is not to use a click'n'play engine that will allow you to replace all occurences of

log("some weird message");

by

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

As it has few chances to work on various cases (like static methods, as an example).

I would tend to suggest you to take a look at spoon. This tool allows source code parsing and transformation, allowing you to achieve your operation in a -obviously code based- slow, but controlled operation.

However, you could alos consider transforming your actual method with one exploring stack trace to get information or, even better, internally use log4j and a log formatter that displays the correct information.

Answer 4

If the lines you need replaced fall into a small number of categories, then what you need is Perl:

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

I'm guessing that it wouldn't be too hard to hack together a script which would put the classname (derived from the filename) in as the second argument. Getting the method name in as the third argument is left as an exercise to the reader.

Answer 5

Maybe I'm being naive, but why can't you just overload the method name?

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

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

Answer 6

IntelliJ IDEA shouldn't have any trouble with this.

I'm not a Java expert, but something like this could work. It's not a perfect solution (it may even be a very bad solution), but it could get you started:

Change the method signature with IntelliJ's refactoring tools, and specify default values for the 2 new parameters:

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

or better yet, simply specify null as the default values.