ButterKnife 是如何通過 Gradle Plugin 來生成 R2 類的原理分析

一、學(xué)習(xí)目標(biāo)

本節(jié)的學(xué)習(xí)目標(biāo)是分析 butterknife 利用 Gradle Plugin 生成 R2.java 文件的過程。

  • 新建工程，引入 butterknife ，并在 library 中使用 butterknife。

  • 分析為何需要生成 R2.java 文件。

  • R2.java 文件的生成。

  • 分析 R.java 和 R2.java 的區(qū)別。

  • library 工程出現(xiàn)資源 id 沖突。

二、在 library 使用 butterknife

  • 新建一個(gè) AS 工程，并創(chuàng)建一個(gè) Library 類型的 module。
新建工程
  • 依賴 butterknife

在工程根目錄下/build.gradle

dependencies {
    classpath 'com.android.tools.build:gradle:3.0.0'
    //引入 butterknife 插件
    classpath 'com.jakewharton:butterknife-gradle-plugin:8.2.0'
}

在 library/build.gradle

implementation 'com.jakewharton:butterknife:8.2.0'
annotationProcessor 'com.jakewharton:butterknife-compiler:8.2.0'
  • 在 library 引入插件
apply plugin: 'com.android.library'
apply plugin: 'com.jakewharton.butterknife'
  • 在 library module 使用 butterknife
public class MainActivity extends AppCompatActivity {

    @BindView(R2.id.textview)
    TextView textview;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.bind(this);
    }
}

好了，經(jīng)過上面的幾個(gè)步驟，我們就就可以將 butterknife 引入到我們的 library module 中是用了，根據(jù)官方文檔的指示，我們在使用 @BindView(R2.id.textview) 中時(shí)，需要指定 R2 而不是 R 哦。

三、為何需要 R2.java 文件

當(dāng)我們在 library 工程中這樣使用 BindView(R.id.textview) 是會報(bào)錯(cuò)的，提示如下圖所示，表示注解中的值需要接收的是一個(gè)常量。

library 中是用 R.id.xxx

我們來看看在 library 工程中生成的 R.java 文件，可以看出，R.java 類內(nèi)部都是變量，而不像是 application 工程生成的 R.java 類的變量會被 final 修飾?，F(xiàn)在我們就明白了為什么在 library 中這樣使用 @BindView(R.id.textview) 會報(bào)錯(cuò)。

R 文件

下面是 Android 官方對這個(gè)問題的解釋，有興趣的可以點(diǎn)擊進(jìn)去看看。

Non-constant Fields in Case Labels

早期的 butterknife 版本是不支持在 library 使用的，不過現(xiàn)在都是在搞組件化了，所以在 butterknife:8.2.0 版本之后開始支持，本文使用的源代碼也是基于 8.2.0 版本。

實(shí)現(xiàn)的原理就是將 R.java 文件拷貝一份到 R2.java 中，并且將每一個(gè)屬性變成常量，這樣最終就變成 @BindView(R2.id.textview) 了。

四、R2.java 文件的生成

我們在前面為我們的工程中引入了 butterknife-gradle-plugin:8.2.0 插件，這個(gè)東西就是用來負(fù)責(zé)生成 R2.java 的。

接下來，我們進(jìn)入源代碼分析一下，它內(nèi)部是如何去生成的：

4.1 ButterKnifePlugin 源碼

ButterKnifePlugin 中主要做了以下幾件事：

  • 1、判斷該 plugin 只能用于 android 工程。

  • 2、在 processResources task 中獲取需要生成 R2 文件所在的目錄和 R 文件。

  • 4、調(diào)用 FinalRClassBuilder.brewJava 生成 R2 文件。

public class ButterKnifePlugin implements Plugin<Project> {

  @Override
  void apply(Project project) {
  
    //1.判斷該plugin 只能用于 android 工程
    if (!(project.plugins.hasPlugin(LibraryPlugin) || project.plugins.hasPlugin(AppPlugin))) {
      throw new IllegalStateException('Butterknife plugin can only be applied to android projects')
    }
    
    def variants
    if (project.plugins.hasPlugin(LibraryPlugin)) {
      variants = project.android.libraryVariants
    } else {
      variants = project.android.applicationVariants
    }
    //核心代碼
    project.afterEvaluate {
      variants.all { BaseVariant variant ->
        variant.outputs.each { BaseVariantOutput output ->
        
          //處理 processResources 這個(gè) task 
          //例如 :library:process${FlavorName}ReleaseResources
          output.processResources.doLast {
            //2.確定需要生成 R2.java 文件所在的目錄和R.java 文件。
            //packageForR就是表示當(dāng)前的包名
            //將 R.java 所在的包中的.替換為/,相當(dāng)于 com.example.xxx —> com/example/xxx
            File rDir = new File(sourceOutputDir, packageForR.replaceAll('\\.',
                    StringEscapeUtils.escapeJava(File.separator)))
            File R = new File(rDir, 'R.java')
            //3.生成 R2.java 文件
            FinalRClassBuilder.brewJava(R, sourceOutputDir, packageForR, 'R2')
          }
        }
      }
    }
  }
}

4.2、生成 R2 文件

下面摘取了核心的代碼，下面這段代碼主要是將對應(yīng)的 R 文件的變量寫入到 R2 文件中，并使用 public static final 標(biāo)識為常量。

private static void addResourceField(TypeSpec.Builder resourceType, VariableDeclarator variable,
    ClassName annotation) {
  String fieldName = variable.getId().getName();
  String fieldValue = variable.getInit().toString();
  FieldSpec.Builder fieldSpecBuilder = FieldSpec.builder(int.class, fieldName)
      .addModifiers(PUBLIC, STATIC, FINAL)
      .initializer(fieldValue);
  if (annotation != null) {
    fieldSpecBuilder.addAnnotation(annotation);
  }
  resourceType.addField(fieldSpecBuilder.build());
}

最終生成的 R2 文件如下：

R2文件

現(xiàn)在 R2 文件的屬性都是常量了，其實(shí)也就是欺騙編譯器吧。

@BindView(R2.id.textview)
TextView textview;

4.3 R 和 R2 的區(qū)別？

  • 1、存放在 build/generated/source/r/debug/包名/ 目錄下。

  • 2、R2文件的屬性變成了 public static final 常量，并且是使用對應(yīng)的@XxRes 注解標(biāo)識

  • 3、兩個(gè)類的屬性資源 id 都是一樣的。

//R 文件
public static final class id {
      public static int textview = 0x7f0c0086;
}
//R2文件
public static final class id {
      @IdRes
      public static final int textview = 0x7f0c0086;
}

4.4 library 工程出現(xiàn)資源 id 沖突

在多 library 庫合并時(shí)，有可能出現(xiàn)資源 id 沖突的現(xiàn)象，那么這時(shí) R2 類每一個(gè)屬性的資源 id 還是舊 R 類的資源 id，這樣會不會有問題呢？

我們來看看下面的代碼，這是 butterknife 通過 APT 幫我們自動(dòng)生成的一個(gè)類 MainActivity_ViewBinding，MainActivity_ViewBinding構(gòu)造是在 Butterknife.bind(this)時(shí)調(diào)用。這里會給 MainActivity 的 textview 屬性賦值。在這里已經(jīng)指定了 id 為 R.id.textview ，因此即使資源 id 沖突，那也是在合并編譯期間的事了。
在運(yùn)行期間還是通過 R 類引用的。R2 類只是做一個(gè)標(biāo)識，告訴 APT 怎么去生成這個(gè)對應(yīng)的 java 代碼 ，看 findOptionalView 方法，實(shí)際最終還是 findViewById(R.id.textview) 而不是 findViewById(R2.id.textview)。

public class MainActivity_ViewBinding<T extends MainActivity> implements Unbinder {
  //MainActivity
  protected T target;

  public MainActivity_ViewBinding(T target, Finder finder, Object source) {
    this.target = target;
    //這里會給 MainActivity 的 textview 屬性賦值。
    //在這里已經(jīng)指定了 id 為 R.id.textview ，因此即使資源id 沖突，這里還是通過 R 文件引用的。
    //R2類只是做一個(gè)標(biāo)識，標(biāo)識怎么去查找這個(gè) id ，但是實(shí)際還是 findViewById(R.id.textview) 而不是 findViewById(R2.id.textview)。
    target.textview = finder.findRequiredViewAsType(source, R.id.textview, "field 'textview'", TextView.class);
  }
  ...
}

//Finder
public enum Finder {
    ACTIVITY {
      @Override public View findOptionalView(Object source, @IdRes int id) {
        return ((Activity) source).findViewById(id);
      }
      @Override public Context getContext(Object source) {
        return (Activity) source;
      }
    }
 }

五、總結(jié)

本文簡單地分析了 ButterKnife 是如何通過 Gradle Plugin 來生成 R2.java 類，文章所描述的內(nèi)容只是本人學(xué)習(xí)的總結(jié)，有錯(cuò)誤的地方望請指正。

記錄于 2019年2月21日

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容