开发的工作主要是写代码, 有考虑过使用代码写代码, 使用代码分析和改进代码吗? JavaParser 就可以帮你用来处理Java 代码的这些功能。
Java Parser 的介绍
Java Parser是一个用于解析和分析Java源代码的开源工具。它提供了一个API接口,使开发人员能够读取和修改Java源代码的结构。
Java Parser可以帮助开发人员进行一些有用的任务,其主要的作用包括三个方面:
-
解析Java源代码:它可以将Java源代码转换为一个抽象语法树(Abstract Syntax Tree, AST),每个节点代表源代码中的一个结构,例如类、方法、变量等。
-
遍历和修改AST:开发人员可以使用Java Parser遍历AST,并对AST节点进行修改。这使得开发人员能够进行一些自动化的任务,如重命名变量、删除无用的代码等。
-
生成Java源代码:Java Parser还可以将AST转换回Java源代码。这对于生成代码片段或自动生成代码非常有用。
关于 AST
1. 树形数据结构
AST(Abstract Syntax Tree,抽象语法树)是一种表示代码结构的树形数据结构。它可以用来表示源代码的抽象语法结构,其中每个节点代表一个语法结构的元素,如表达式、语句、函数等。
AST的图形表示通常采用树状结构,其中每个节点表示一个语法结构的元素,节点之间通过边连接起来以表示它们之间的关系。
以下是一个简单的示例,展示了一个包含数学运算的表达式的AST的图形表示:
+
/ \
* 8
/ \
2 3
在这个例子中,AST表示了一个数学表达式 "2 * 3 + 8"。根节点是一个加法操作,左子节点是一个乘法操作,右子节点是一个字面量 "8"。乘法操作的左子节点是数字 "2",右子节点是数字 "3"。
通过这种图形表示,可以直观地理解代码的结构,并且可以在树上进行遍历和操作,以进行各种代码分析和转换的操作。
2. 代码的内部表示
AST (Abstract Syntax Tree) 是指抽象语法树,它是源代码在编译过程中的一种内部表示形式。AST 是编译器常用的数据结构,用于表示代码的语法结构。
下面是一个 Java 类的 AST 示例代码:
CompilationUnit [packageDeclaration: null, importDeclarations: [], types: [
TypeDeclaration [modifiers: [], name: "Person", superClass: null, superInterfaces: [], members: [
FieldDeclaration [modifiers: [private], type: "String", variables: [
VariableDeclaration [name: "name", initializer: null]
]],
FieldDeclaration [modifiers: [private], type: "int", variables: [
VariableDeclaration [name: "age", initializer: null]
]],
MethodDeclaration [modifiers: [public], returnType: "String", name: "getName", parameters: [], body: [
ReturnStatement [expression: MethodInvocation [name: "name", arguments: []]]
]],
MethodDeclaration [modifiers: [public], returnType: "void", name: "setName", parameters: [
Parameter [type: "String", name: "name"]
], body: [
ExpressionStatement [expression: Assignment [leftHandSide: FieldAccess [expression: This, name: "name"], operator: "=", rightHandSide: SimpleName [name: "name"]]]
]],
MethodDeclaration [modifiers: [public], returnType: "int", name: "getAge", parameters: [], body: [
ReturnStatement [expression: MethodInvocation [name: "age", arguments: []]]
]],
MethodDeclaration [modifiers: [public], returnType: "void", name: "setAge", parameters: [
Parameter [type: "int", name: "age"]
], body: [
ExpressionStatement [expression: Assignment [leftHandSide: FieldAccess [expression: This, name: "age"], operator: "=", rightHandSide: SimpleName [name: "age"]]]
]],
]]
]]
这个示例表示一个名为 "Person" 的类,它有两个私有字段(name 和 age),以及四个方法(getName、setName、getAge 和 setAge)。每个方法的修饰符、返回类型、名称、参数和方法体都在 AST 中表示出来。
Java Parser的优点
Java Parser的优点包括:
-
易于使用:Java Parser提供了一个简单而直观的API,使得开发人员能够轻松地读取、修改和生成Java源代码。
-
强大的功能:Java Parser支持大多数Java语法的解析和分析,包括类、方法、变量、注释等。它还提供了一些高级功能,如类型推断、泛型、Lambda表达式等。
-
开放源代码:Java Parser是一个开源项目,可以自由地访问和修改源代码。这使得开发人员可以根据自己的需求进行定制和扩展。
总之,Java Parser是一个功能强大且易于使用的工具,可以帮助开发人员解析、修改和生成Java源代码。它非常适合用于编写代码分析工具、自动化重构工具、代码生成器等。
JavaParser的使用示例
使用 JavaParser 之前, 首先需要导入 JavaParser 的依赖。
使用Maven导入依赖的配置如下:
<dependency>
<groupId>com.github.javaparser</groupId>
<artifactId>javaparser-symbol-solver-core</artifactId>
<version>3.25.9</version>
</dependency>
1. 创建代表代码的Java 对象
CompilationUnit compilationUnit = StaticJavaParser.parse("class MyClass{}");
Optional<ClassOrInterfaceDeclaration> myClass = compilationUnit.getClassByName("MyClass");
上面的代码的作用是解析一个Java源代码字符串,并找到其中名为"MyClass"的类或接口声明。首先,使用StaticJavaParser类的parse()方法将字符串解析为一个CompilationUnit对象。然后,使用CompilationUnit对象的getClassByName()方法来查找名为"MyClass"的类或接口声明。返回的结果是一个Optional对象,表示找到的类或接口声明,或者如果找不到则为空。
如何获取 ClassOrInterfaceDeclaration
类型的对象呢?
可以使用如下代码:
if (myClass.isPresent()) {
ClassOrInterfaceDeclaration classOrInterfaceDeclaration = myClass.get();
// 使用 classOrInterfaceDeclaration 进行后续操作
} else {
// myClass 是空的,处理空值的情况
}
使用Lambda 表达式的方式更为简洁:
myClass.ifPresent(classOrInterfaceDeclaration -> {
// 使用 classOrInterfaceDeclaration 进行后续操作
});
CompilationUnit 代表什么?
JavaParser 中的 CompilationUnit 是一个表示整个 Java 文件的抽象语法树 (AST)。它包含了 Java 文件中所有的类、接口、枚举等结构的信息,可以通过遍历 CompilationUnit 来获取文件中的各种声明和表达式。 CompilationUnit 还提供了一些方法,用于对文件进行修改、添加或删除元素,并可以将修改后的 AST 转换回 Java 源代码。
2. 使用JavaParser 解析源代码之"查找public而且不是 static的属性"
从compilationUnit 对象可以获取源码的各种声明和表达式。
compilationUnit.findAll(FieldDeclaration.class).stream().filter(f -> f.isPublic() && !f.isStatic())
.forEach(f -> System.out.println("属性的行数" + f.getRange().map(r -> r.begin.line).orElse(-1)));
3. 使用JavaParser 转换代码 - "将所有的抽象类的名字改成以 Abstract 开头"
示例代码如下:
compilationUnit.findAll(ClassOrInterfaceDeclaration.class).stream()
.filter(c -> !c.isInterface() && c.isAbstract() && !c.getNameAsString().startWith("Abstract"))
.forEach(c -> {
String from = c.getNameAsString();
String to = "Abstract" + from;
System.out.println("重命名类" + from + " into " + to);
c.setName(to);
});
4. 使用JavaParser 创建代码
示例代码如下:
@Test
public void generate() {
CompilationUnit compilationUnit = new CompilationUnit();
ClassOrInterfaceDeclaration myClass = compilationUnit.addClass("MyClass").setPublic(true);
myClass.addField(int.class, "A_CONSTANT", com.github.javaparser.ast.Modifier.Keyword.PUBLIC, com.github.javaparser.ast.Modifier.Keyword.STATIC);
myClass.addField(String.class, "name", com.github.javaparser.ast.Modifier.Keyword.PRIVATE);
String Code = myClass.toString();
System.out.println(Code);
}
上面代码的作用是生成一个Java源代码字符串,包含了一个名为"MyClass"的类定义,其中包含了两个成员变量:"A_CONSTANT"和"name"。其中,"A_CONSTANT"是一个公共的静态整型常量,"name"是一个私有的字符串类型成员变量。最后,通过调用myClass.toString(),将生成的代码字符串保存在Code变量中。
产生出来的代码如下:
参考
- 官方站点: https://javaparser.org/