ButterKnife最新版本使用的深坑

2019-03-23 本文已影响198人 JamFF

ButterKnife现在最新10.1.0版本，先说下我现在的环境。
AS版本：3.3.2，Gradle版本：4.10.1，buildToolsVersion版本：28.0.3。

我们先来看看官方文档，分别介绍了在 application 中和 library 中的使用。

github 上 ButterKnife官方文档

ButterKnife10.1.0版本

按照上面的步骤写好，报错：

Manifest merger failed : Attribute application@appComponentFactory value=(android.support.v4.app.CoreComponentFactory) from [com.android.support:support-compat:28.0.0] AndroidManifest.xml:22:18-91
    is also present at [androidx.core:core:1.0.0] AndroidManifest.xml:22:18-86 value=(androidx.core.app.CoreComponentFactory).
    Suggestion: add 'tools:replace="android:appComponentFactory"' to <application> element at AndroidManifest.xml:5:5-20:19 to override.

还好已经有人踩过这坑，直接参考这篇文章。
修改好运行，还是报错：

Error: Static interface methods are only supported starting with Android N (--min-api 24): void butterknife.Unbinder.lambda$static$0()

这个是因为 butterknife 使用了 lambda，依然有据可查，需要使用 Java8。

android {
    ...
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

继续报错：

Error: Program type already present: androidx.versionedparcelable.CustomVersionedParcelable

很快又找到了解决办法，使用implementation 'androidx.appcompat:appcompat:1.0.2'代替implementation 'com.android.support:appcompat-v7:28.0.0'。

依然报错：Compilation failed; see the compiler error output for details.

org.gradle.execution.MultipleBuildFailures: Build completed with 1 failures.
    at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
    at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
    at org.gradle.internal.concurrent.ThreadFactoryImpl$ManagedThreadRunnable.run(ThreadFactoryImpl.java:55)
    at java.lang.Thread.run(Thread.java:745)
Caused by: org.gradle.api.tasks.TaskExecutionException: Execution failed for task ':moduleb:compileDebugJavaWithJavac'.
    ... 6 more
Caused by: org.gradle.api.internal.tasks.compile.CompilationFailedException: Compilation failed; see the compiler error output for details.
    at com.android.build.gradle.tasks.AndroidJavaCompile.compile(AndroidJavaCompile.kt:233)
    ... 34 more

ButterKnife8.8.1版本

到这里实在是改不动了，考虑换个版本，按照这篇文章操作一下。不过这篇博客有点老，我尝试使用ButterKnife 8.8.1 的版本搞一下。

使用classpath 'com.jakewharton:butterknife-gradle-plugin:8.8.1'，继续报错：

ERROR: Unable to find method 'com.android.build.gradle.api.BaseVariant.getOutputs()Ljava/util/List;'.
Possible causes for this unexpected error include:
Gradle's dependency cache may be corrupt (this sometimes occurs after a network connection timeout.)
Re-download dependencies and sync project (requires network)

The state of a Gradle build process (daemon) may be corrupt. Stopping all Gradle daemons may solve this problem.
Stop Gradle build processes (requires restart)

Your project may be using a third-party plugin which is not compatible with the other plugins in the project or the version of Gradle requested by the project.

In the case of corrupt Gradle processes, you can also try closing the IDE and then killing all Java processes.

找到原因，是因为butterknife的gradle插件还未支持gradle3.0，只能降级到8.4.0，或者升级到9.0.0。

先试着降级到8.4.0，报错：

The Android Gradle plugin supports only Butterknife Gradle plugin version 9.0.0-rc2 and higher.
The following dependencies do not satisfy the required version:
root project 'AndroidModuleDemo' -> com.jakewharton:butterknife-gradle-plugin:8.4.0

提示只能在 9.0.0-rc2 以上版本，那么再使用 9.0.0 的稳定版本看下效果。
classpath 'com.jakewharton:butterknife-gradle-plugin:9.0.0'

ButterKnife 9.0.0 版本

运行成功，最终结论是，在 AS 3.3.2 版本上，使用 ButterKnife 9.0.0 版本

项目的 build.gradle 中的配置：

buildscript {
  repositories {
    mavenCentral()
    google()
   }
  dependencies {
    classpath 'com.jakewharton:butterknife-gradle-plugin:9.0.0'
  }
}

module 中的 build.gradle 中的配置，不要忘记使用 Java 8：

android {
    ....
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}
dependencies {
  implementation 'com.jakewharton:butterknife:9.0.0'
  annotationProcessor 'com.jakewharton:butterknife-compiler:9.0.0'
}

Library 中的注意事项

如果 library 中如果需要使用 butterknife 寻找控件，一定要添加 plugin，目的是为了生成R2文件。

apply plugin: 'com.jakewharton.butterknife'

还要在 module 下的 build.gradle 中添加 annotationProcessor，目的是为了自动生成java文件。

dependencies {
    annotationProcessor 'com.jakewharton:butterknife-compiler:9.0.0'
}

不要尝试在 Library 中引入 ButterKnife，然后在 application 中通过依赖 Library 的方式引入，因为上条注意事项重的两项，必须添加在使用的 ButterKnife 的自己 module 中才能生效。
Library 中需要使用 R2.id.* 才能找到控件，原因是 ButterKnife 的注解必须是常量，在Library 中的 R.id.* 并不是常量，生成的 R2 才是 final 修饰的常量。

@BindView(R2.id.tv_light)
TextView tvLight;

switch 不能使用，同样是因为不是常量的原因，需要使用 if 替代，但是里面的判断还是要用 R.id.*。

@OnClick(R2.id.ll_scan)
void onClick(View v) {
    if (v.getId() == R.id.ll_scan) {
        getRuntimePermission();
    }
}

如果使用 androidx 需要使用 10.1.0 版本，否则使用 9.0.0 版本。前提是，你可以正确的使用androidx。

DONE

可以看下这个Android组件化的项目，里面有具体的在 Library 使用 ButterKnife 的配置。
github项目地址

参考资料

解决组件化开发butterknife 在 library中使用的坑
 ERROR: The Android Gradle plugin supports only Butterknife Gradle plugin version 9.0.0-rc2 and higher