我们的目标是简化将Error Prone检查添加到现有的Java编译中。请注意,Error Prone必须在JDK 8或更高版本上运行。你可以通过设置适当的-source / -target / -bootclasspath
标记来构建Java 6或7代码。
Error Prone与Bazel开箱即用。
java_library(
name = "hello",
srcs = ["Hello.java"],
)
$ bazel build :hello
ERROR: example/myproject/BUILD:29:1: Java compilation in rule '//example/myproject:hello'
examples/maven/error_prone_should_flag/src/main/java/Main.java:20: error: [DeadException] Exception created but not thrown
new Exception();
^
(see http://errorprone.info/bugpattern/DeadException)
Did you mean 'throw new Exception();'?
1 error
BazelJavaBuilder threw exception: java compilation returned status ERROR
INFO: Elapsed time: 1.989s, Critical Path: 1.69s
编辑您的pom.xml
文件以将设置添加到maven-compiler-plugin
中:
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.3</version>
<configuration>
<compilerId>javac-with-errorprone</compilerId>
<forceJavacCompilerUse>true</forceJavacCompilerUse>
<!-- maven-compiler-plugin defaults to targeting Java 5, but our javac
only supports >=6 -->
<source>7</source>
<target>7</target>
</configuration>
<dependencies>
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-compiler-javac-errorprone</artifactId>
<version>2.8</version>
</dependency>
<!-- override plexus-compiler-javac-errorprone's dependency on
Error Prone with the latest version -->
<dependency>
<groupId>com.google.errorprone</groupId>
<artifactId>error_prone_core</artifactId>
<version>2.0.19</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
有关一个工作示例,请参阅examples/maven目录:
../examples/maven/error_prone_should_flag$ mvn compile
[INFO] Compiling 1 source file to .../examples/maven/error_prone_should_flag/target/classes
.../examples/maven/error_prone_should_flag/src/main/java/Main.java:20: error: [DeadException] Exception created but not thrown
new Exception();
^
(see http://errorprone.info/bugpattern/DeadException)
Did you mean 'throw new Exception();'?
1 error
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
Gradle插件是外部贡献。文档和代码在tbroyer/gradle-errorprone-plugin。
有关一个工作示例,请参阅examples/gradle目录:
$ gradle compileJava
.../examples/gradle/src/main/java/Main.java:20: error: [DeadException] Exception created but not thrown
new Exception();
^
(see http://errorprone.info/bugpattern/DeadException)
Did you mean 'throw new Exception();'?
1 error
:compileJava FAILED
FAILURE: Build failed with an exception.
从maven下载最新版本的Error Prone,并将以下javac任务添加到项目的build.xml
文件中。
<javac destdir="build"
compiler="com.google.errorprone.ErrorProneAntCompilerAdapter"
encoding="UTF-8" debug="true"
includeantruntime="false">
<src path="src"/>
<compilerclasspath>
<pathelement location="./path/to/error_prone_ant.jar"/>
</compilerclasspath>
</javac>
请参阅examples/ant目录去了解ant配置。
examples/ant/compilerclasspath$ ant
Buildfile: .../examples/ant/compilerclasspath/build.xml
compile:
[javac] Compiling 1 source file to .../examples/ant/compilerclasspath/build
[javac] .../examples/ant/compilerclasspath/src/Main.java:20: error: [DeadException] Exception created but not thrown
[javac] new IllegalArgumentException("Missing required argument");
[javac] ^
[javac] (see http://errorprone.info/bugpattern/DeadException)
[javac] Did you mean 'throw new IllegalArgumentException("Missing required argument");'?
[javac] 1 error
BUILD FAILED
要添加插件,启动IDE并找到Plugins
对话框。浏览Repositories
,选择Category:Build
,并找到Error-prone插件。
右键单击并选择Download and install
。然后退出这些对话框后,重新启动IDE。
要启用Error-prone,请选择Settings | Compiler | Java Compiler | Use compiler: Javac with error-prone
并确保Settings | Compiler | Use external build
未被选中。
理想情况下,由于ECJ提供(eclipse编译器for Java)的连续编译,你可以在eclipse代码中找到失败的Error Prone检查。但是这是一个架构的挑战,因为Error Prone目前很大程度上依赖于com.sun.*
API来访问AST和符号表。
现在,Eclipse用户可以使用Findbugs eclipse插件替代,因为它也可以捕获许多相同的问题。
要在命令行中使用Error Prone作为javac的替换:
wget https://repo1.maven.org/maven2/com/google/errorprone/error_prone_ant/2.0.19/error_prone_ant-2.0.19.jar
java -Xbootclasspath/p:error_prone_ant-2.0.19.jar com.google.errorprone.ErrorProneCompiler Test.java
Test.java:1: error: [InfiniteRecursion] This method always recurses, and will cause a StackOverflowError
class Test { void f() { f(); } }
^
(see http://errorprone.info/bugpattern/InfiniteRecursion)
如果您是构建系统的最终用户,您可以提出一个bug来请求集成。
如果您开发构建系统,您应该为您的用户创建一个集成!以下是一些让您开始的基础知识:
Error-prone被实现为编译器钩子,使用javac中的内部机制。要安装我们的钩子,我们覆盖com.sun.tools.javac.main.Main
中的main()
方法。
找到构建系统中调用javac主方法的位置。这是假设您在进程中调用javac,而不是将其移植到机器上的javac可执行文件(由于很难知道位于何处),因此这将非常跛脚。
首先,将Error Prone的核心库添加到正确的类路径。它将需要对当前查找javac Main
类的类加载器可见。然后用Error Prone编译器替换javac.main.Main.main()
的调用:
return new ErrorProneCompiler.Builder().build().compile(args) == 0
参考链接: installation & bugpatterns