如何将 checkstyle 添加到 libGDX 项目？

Question

我有以下 libGDX 项目：https://github.com/Glusk2/sprouts

我尝试将 checkstyle 添加到根 build.gradle 文件中的整个项目，如下所示：

// ...
allprojects {
    apply plugin: "eclipse"
    apply plugin: "idea"
    apply plugin: "checkstyle"
    // ...
}
// ...

并将 config/checkstyle/checkstyle.xml 添加到根项目。

但是没用。我在运行 ./gradlew build connectedCheck:

之后收到此错误

:android:compileJava                 
<path-to-project>\sprouts\android\src\com\github\glusk2\sprouts\AndroidLauncher.java:3: error: package android.os does not exist
import android.os.Bundle;            
                    ^
<path-to-project>\sprouts\android\src\com\github\glusk2\sprouts\AndroidLauncher.java:9: error: cannot access Activity
public class AndroidLauncher extends AndroidApplication {
        ^
    class file for android.app.Activity not found
<path-to-project>\sprouts\android\src\com\github\glusk2\sprouts\AndroidLauncher.java:11: error: cannot find symbol
        protected void onCreate (Bundle savedInstanceState) {
                                    ^
    symbol:   class Bundle
    location: class AndroidLauncher
<path-to-project>\sprouts\android\src\com\github\glusk2\sprouts\AndroidLauncher.java:10: error: method does not override or implement a method from a supertype
        @Override
        ^
<path-to-project>\sprouts\android\src\com\github\glusk2\sprouts\AndroidLauncher.java:12: error: cannot find symbol
                super.onCreate(savedInstanceState);
                ^
    symbol:   variable super
    location: class AndroidLauncher
<path-to-project>\sprouts\android\src\com\github\glusk2\sprouts\AndroidLauncher.java:15: error: cannot find symbol
                initialize(new Sprouts(), config);
                ^
    symbol:   method initialize(Sprouts,AndroidApplicationConfiguration)
    location: class AndroidLauncher
6 errors
:android:compileJava FAILED

Answer 1

默认情况下，将 checkstyle 插件应用于 Android gradle 项目不会执行任何操作（它不会添加检查样式任务），因为：

Note that the Android plugin uses its own implementation of source sets.

Android Gradle plugin; sourceSets{}

The Android plugin has its own sourceSet concept and does not populate the sourceSet collection of the java-base plugin.
So applying a plugin like checkstyle will do nothing by default.

https://issuetracker.google.com/issues/36972352#comment21

但在我的例子中，包含字符串“checkstyle”的任务列表如下所示：

$ ./gradlew tasks --all | grep checkstyle
android:checkstyleMain - Run Checkstyle analysis for main classes //<-- this should not be here :)
core:checkstyleMain - Run Checkstyle analysis for main classes
desktop:checkstyleMain - Run Checkstyle analysis for main classes
html:checkstyleMain - Run Checkstyle analysis for main classes
ios:checkstyleMain - Run Checkstyle analysis for main classes
core:checkstyleTest - Run Checkstyle analysis for test classes
desktop:checkstyleTest - Run Checkstyle analysis for test classes
html:checkstyleTest - Run Checkstyle analysis for test classes
ios:checkstyleTest - Run Checkstyle analysis for test classes

为什么任务 android:checkstyleMain 被添加到列表中？

原来是这个原因（android项目build.gradle文件）：

// ...
eclipse {
    // ...
    sourceSets {
        main {
            java.srcDirs "src", 'gen'
        }
    }
    // ...
}
// ...

它设置了sourceSets，checkstyle插件可以检测到，但是配置显然不完整，因为任务构建失败：android:checkstyleMain。
上面的 eclipse 块为 Eclipse ADT 插件添加了配置，现在已经有一段时间不受支持了，所以我决定完全删除该块。

$ ./gradlew tasks --all | grep checkstyle
core:checkstyleMain - Run Checkstyle analysis for main classes
desktop:checkstyleMain - Run Checkstyle analysis for main classes
html:checkstyleMain - Run Checkstyle analysis for main classes
ios:checkstyleMain - Run Checkstyle analysis for main classes
core:checkstyleTest - Run Checkstyle analysis for test classes
desktop:checkstyleTest - Run Checkstyle analysis for test classes
html:checkstyleTest - Run Checkstyle analysis for test classes
ios:checkstyleTest - Run Checkstyle analysis for test classes

成功！但是我仍然没有设法让 checkstyle 与 android 项目一起工作。

阅读许多关于 android 项目未显示的检查样式任务的类似问题后...

Get Android gradle plugin & checkstyle working together / command line usage
Checkstyle Plugin does not add gradle tasks

...我想出了解决办法

解决方案

根目录 build.gradle:

// ...
allprojects {
     apply plugin: "eclipse"
     apply plugin: "idea"
+    apply plugin: "checkstyle"

+    checkstyle {
+        configFile file("${project.rootDir}/config/checkstyle/checkstyle.xml")
+    }
// ...
}
// ...

Android build.gradle:

+task checkstyle(type: Checkstyle) {
+    source 'src'
+    include '**/*.java'
+    exclude '**/gen/**'
+    exclude '**/R.java'
+    exclude '**/BuildConfig.java'
+    classpath = files()
+}
+check.dependsOn "checkstyle"

// ...

-// sets up the Android Eclipse project, using the old Ant based build.
-eclipse {
-    // need to specify Java source sets explicitly, SpringSource Gradle Eclipse -plugin
-    // ignores any nodes added in classpath.file.withXml
-    sourceSets {
-        main {
-            java.srcDirs "src", 'gen'
-        }
-    }
-
-    jdt {
-        sourceCompatibility = 1.6
-        targetCompatibility = 1.6
-    }
-
-    classpath {
-        plusConfigurations += [ project.configurations.compile ]        
-        containers 'com.android.ide.eclipse.adt.ANDROID_FRAMEWORK', 'com.android.ide.eclipse.adt.LIBRARIES'       
-    }
-
-    project {
-        name = appName + "-android"
-        natures 'com.android.ide.eclipse.adt.AndroidNature'
-        buildCommands.clear();
-        buildCommand "com.android.ide.eclipse.adt.ResourceManagerBuilder"
-        buildCommand "com.android.ide.eclipse.adt.PreCompilerBuilder"
-        buildCommand "org.eclipse.jdt.core.javabuilder"
-        buildCommand "com.android.ide.eclipse.adt.ApkBuilder"
-    }
-}

如何将 checkstyle 添加到 libGDX 项目？

How to add checkstyle to a libGDX project?

gradle

libgdx

android-gradle-plugin

解决方案