XPage系列|是时候抛弃ButterKnife了

ゞ浴缸里的玫瑰 2022-08-29 00:05 159阅读 0赞

## 前言 ##

> 作为 [X-Library系列框架][X-Library] 的灵魂所在，[XPage][] 开源两年以来，一直致力于降低Fragment使用的难度，努力实现一个Activity多Fragment的Android开发模式。

前段时间, 在观望了许久之后, 我终于更新了**Android Studio的最新版本(北极狐)**, 发现项目中使用ButterKnife注解id的代码出现了警告，警告信息如下:

> Resource IDs will be non-final in Android Gradle Plugin version 5.0, avoid using them as annotation attributes

警告信息告诉我们在Gradle 5.0的插件中Resource 的Id值将不会再是final类型，因此应该避免在注解属性中使用Id。这意味着如果我们把Gradle插件升级到5.0版本之后ButterKnife将无法再被使用！而且在ButterKnife的官方文档上也看到了**ButterKnife被标注弃用**的信息：

![3a599f1c9a00372560f459fd8a7d035b.png][]

因为当初设计XPage是为了能够更方便的使用Fragment, 所以就默认集成了ButterKnife. 如果我还想继续使用XPage的话, 就不得不把Gradle插件降到5.0版本以下, 这在ButterKnife被废弃, Viewbinding取而代之的大趋势下, 显然是不合适的.

果不其然, 我的XPage的开源项目很快就被使用者提了[去除ButterKnife的issue][ButterKnife_issue], 具体如下:

![a5b1d4ba1ae73b0a74fff222331ac1de.png][]

这样看来, XPage去除ButterKnife依赖是势在必行的, 于是就有了这次**XPage 3.3.0版本**的升级.

## 升级后有什么变化 ##

> 这次升级主要包含了两个部分: **使用gson代替fastjson** 和 **去除butterknife依赖**, 全方面向Google看齐。

### 使用gson代替fastjson ###

为什么使用gson代替fastjson呢? 我主要是出于以下两点考虑:

*  fastjson之前就经常爆出了好几次比较严重的安全漏洞, 安全性方面存在缺陷.
 *  目前Android项目使用gson的居多, 并且是Google开源维护的,充分相信Google的实力.

### 去除butterknife依赖 ###

去除butterknife依赖, 使用ViewBinding代替是趋势所向. 那么使用ViewBinding代替有哪些好处呢? 下面我简单列举一下:

*  **类型安全**: ViewBinding会基于布局中的View生成类型正确的属性。比如，在布局中放入了一个 TextView ，视图绑定就会暴露出一个 TextView 类型的属性供开发中使用。
 *  **空安全**: ViewBinding会检测某个视图是不是只在一些配置下存在，并依据结果生成带有 @Nullable 注解的属性。所以即使在多种配置下定义的布局文件，视图绑定依然能够保证空安全。
 *  **减少控件变量的定义**: ViewBinding会自动生成一个绑定类, 我们可以直接通过这个绑定对象去访问布局中的控件, 无需再为每个控件的访问去定义一个个的变量.

## 升级3.3.0版本注意事项 ##

### 依赖发生变化 ###

> 3.3.0版本之后无需依赖butterknife.

*  3.3.0及以上版本，只需要在项目中依赖XPage即可.

dependencies {
      ...
      implementation 'com.github.xuexiangjys.XPage:xpage-lib:3.3.0'
      annotationProcessor 'com.github.xuexiangjys.XPage:xpage-compiler:3.3.0'
    }

*  3.2.0及以下版本，除需要在项目中依赖XPage以外, 还需要依赖butterknife.

dependencies {
      ...
      // XPage
      implementation 'com.github.xuexiangjys.XPage:xpage-lib:3.2.0'
      annotationProcessor 'com.github.xuexiangjys.XPage:xpage-compiler:3.2.0'
      // ButterKnife的sdk
      implementation 'com.jakewharton:butterknife:10.1.0'
      annotationProcessor 'com.jakewharton:butterknife-compiler:10.1.0'
    }

### 接口发生变化 ###

> 为了能够让XPage更好地使用上ViewBinding, 我对XPageFragment以及XPageActivity的部分接口做出了调整.

*  删除了**XPageFragment**中的`getLayoutId`抽象方法, 取而代之的是`inflateView`抽象方法.

/**
         * 加载控件
         *
         * @param inflater  inflater
         * @param container 容器
         * @return 根布局
         */
        protected abstract View inflateView(LayoutInflater inflater, ViewGroup container);

*  删除了**XPageActivity**中的`getLayoutId`抽象方法, 取而代之的是`getCustomRootView`方法.

/**
         * 获取自定义根布局
         *
         * @return 自定义根布局
         */
        protected View getCustomRootView() {
            return null;
        }

### 混淆配置发生变化 ###

> 由于此次XPage升级使用gson代替了fastjson, 因此混淆配置需要进行修改.

*  3.2.0及以上版本，使用的是gson进行序列化的，所以配置如下：

# gson
    -keepattributes Signature
    -keepattributes *Annotation*
    -dontwarn sun.misc.**
    -keep class com.google.gson.examples.android.model.** { <fields>; }
    -keep class * extends com.google.gson.TypeAdapter
    -keep class * implements com.google.gson.TypeAdapterFactory
    -keep class * implements com.google.gson.JsonSerializer
    -keep class * implements com.google.gson.JsonDeserializer
    -keepclassmembers,allowobfuscation class * {
      @com.google.gson.annotations.SerializedName <fields>;
    }
    -keep,allowobfuscation,allowshrinking class com.google.gson.reflect.TypeToken
    -keep,allowobfuscation,allowshrinking class * extends com.google.gson.reflect.TypeToken
    
    # xpage
    -keep class com.xuexiang.xpage.annotation.** { *; }
    -keep class com.xuexiang.xpage.config.** { *; }

*  3.1.1及以下版本，使用的是fastjson进行序列化的，所以配置如下：

# fastjson
    -dontwarn com.alibaba.fastjson.**
    -keep class com.alibaba.fastjson.** { *; }
    -keepattributes Signature
    
    # xpage
    -keep class com.xuexiang.xpage.annotation.** { *; }
    -keep class com.xuexiang.xpage.config.** { *; }

## 模板工程 ##

以上的升级内容, 我已在最新的模板工程中做了相应的更新, 想偷懒的同学可以直接拿模板工程使用.

*  [Android应用空壳模板工程][Android]
 *  [简化版Android空壳模板工程][Android 1]

## 相关链接 ##

*  [史上最方便的Android页面框架XPage使用指南][Android_XPage]
 *  [Navigation和XPage框架相比谁更香][Navigation_XPage]
 *  [XPage项目地址：https://github.com/xuexiangjys/XPage][XPage]

## 最后 ##

非常感谢大家对[XPage][] 的支持，喜欢的小伙伴可以到项目的Github主页：[https://github.com/xuexiangjys/XPage][XPage] 点击star支持一下哦！

> 我是xuexiangjys，一枚热爱学习，爱好编程，致力于Android架构研究以及开源项目经验分享的技术up主。获取更多资讯，欢迎微信搜索公众号：**【我的Android开源之旅】**

[X-Library]: https://xuexiangjys.blog.csdn.net/article/details/102639857
[XPage]: https://github.com/xuexiangjys/XPage
[3a599f1c9a00372560f459fd8a7d035b.png]: /images/20220829/49eb5de269114408949849dd7c0ae4d7.png
[ButterKnife_issue]: https://github.com/xuexiangjys/XPage/issues/23
[a5b1d4ba1ae73b0a74fff222331ac1de.png]: /images/20220829/8a7483570d7b45dda2d627161d13c37d.png
[Android]: https://github.com/xuexiangjys/TemplateAppProject
[Android 1]: https://github.com/xuexiangjys/TemplateSimpleProject
[Android_XPage]: https://xuexiangjys.blog.csdn.net/article/details/109085587
[Navigation_XPage]: https://xuexiangjys.blog.csdn.net/article/details/108923027