基于ViewBinding 和 DataBinding的BaseActivity

是什么

三个问题：

  • Viewbinding和 DataBinding 是什么
  • Viewbinding和 DataBinding 能解决什么问题
  • 和传统的使用方式的优缺点是是什么

相信来看这篇文章的同学们，基本上都对Viewbinding和 DataBinding有一定的了解，或者比我知道的更多更清楚，所以关于这些问题，这里就不在赘述了。不清楚的，可以先去了解一下。

如标题，我们的目的是对Viewbinding和 DataBinding进行封装，在封装之前，我们肯定要先了解它们是如何使用的，那么，就先来看一下它们是如何使用的吧。

怎么用

在 app 的 build.gradle 文件中，添加以下配置：

android {
   、、、
    defaultConfig {
     、、、
        buildFeatures{
           // viewBinding 支持，
            viewBinding = true
           // dataBinding 支持
            dataBinding = true
        }
    }
}

ViewBinding


public class TestActivity extends AppCompatActivity {
    
    private ActivityTestBinding activityTestBinding;
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        //1、 通过指定的 ViewBinding (ActivityTestBinding) 的 inflate 方法，来初始化
        activityTestBinding = ActivityTestBinding.inflate(getLayoutInflater());
        //2、通过 其 getRoot() 方法，来获取 view
        setContentView(activityTestBinding.getRoot());
        //3、无需 findViewById(), 可以直接对控件进行 操作
        activityTestBinding.testTextView.setText("");
        
    }
}

DataBinding

1、修改布局文件

与Viewbinding不同的是，DataBinding需要修改布局文件：

<?xml version="1.0" encoding="utf-8"?>
<!--DataBinding 的布局，最外层需要 修改为 <layout> 标签-->
<layout xmlns:android="http://schemas.android.com/apk/res/android">

    <!--  data 是布局需要展示的数据-->
    <data>
        <variable
            name="xxx"
            type="xxxx" />
    </data>

    <!--    这里就是原来的布局-->
    <androidx.constraintlayout.widget.ConstraintLayout                                                      xmlns:app="http://schemas.android.com/apk/res-auto"
        xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:layout_height="match_parent">

        <TextView
            android:id="@+id/test_textView"
            android:layout_width="match_parent"
            android:layout_height="match_parent"
            android:text="这个一个测试界面"
            android:textColor="@android:color/black"
            android:textSize="18sp"
            app:layout_constraintBottom_toBottomOf="parent"
            app:layout_constraintEnd_toEndOf="parent"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="parent"
            tools:ignore="HardcodedText" />
    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

2、Java 代码

public class TestActivity extends AppCompatActivity {

    private ActivityTestDataBindingBinding testDataBinding;
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        //1、 通过指定的 DataBindingUtil  来初始化
        testDataBinding =   
          DataBindingUtil.setContentView(this,R.layout.activity_test_data_binding);
        //2、setContentView
        setContentView(testDataBinding.getRoot());
        //3、设置数据
        testDataBinding.setTestData(new TestValue());

    }
}

通过上面的代码发现，如果我们每写一个界面，都要来一遍 XXX.inflate(getLayoutInflater()); ，或者是来一遍DataBindingUtil.setContentView(this,R.layout.xxxx); ，是不是顿时就感觉了蛋疼？而且从代码的美观方面，这些代码看起来也是很冗余的、臃肿的。如果你不觉得，那可以划走了，如果你觉得是这样的，那就继续往下看，接下来，我们就需要对这些代码进行精简。

如何简化用法？

一般想要简化Activity ，都会抽象一个 BaseActivity ，所以，我们同样也需要抽象个 BaseBindingActivity 。

不知道会不会有人问，为啥要叫 BaseBindingActivity ，不要问，问就是 我想把ViewBinding 和 DataBinding 合在一起使用。

1、泛型

通过上面的示例代码可以发现，如果想要在Activity中使用 ViewBinding和 DataBinding ，就必须拿到一个根据布局文件生成的一个具体的类，比如上面的：ActivityTestBinding 、ActivityTestDataBindingBinding。所以，这个名称必须要调用者传入，就会考虑到使用泛型。

创建基类的雏形是这样的：

public abstract class BaseBindingActivity<Binding> extends AppCompatActivity {
    protected Binding binding;
}

ps: Binding 是泛型名称，不是类

2、反射

现在，我们已经有了一个泛型的声明 binding，接下来就是获取 该声明的实例。通过上面的示例代码可以发现，DataBinding 比较简单一些，直接通过 DataBindingUtil 就可以获取到，那么ViewBinding 要怎么来获取呢，从上面的基类中可以看到，我们使用的时候，具体的类型就是我们传入的泛型，那么，我们的第一目的，就是拿到泛型的类型，这里就需要用到反射。

1、获取ViewBinding 类型

参考DataBindingUtil ，我们创建一个类： BindingUtil，添加以下方法

/**
 * 找到 ViewBinding 的 class
 *
 * @param object obj : activity 
 * @return Class<? extends ViewBinding>
 */
@SuppressWarnings("unchecked")
private static Class<? extends ViewBinding> findViewBinding(Object object) {
  //获取到 BaseBindingActivity
    Type type = object.getClass().getGenericSuperclass();  
    if (type == null) {
        return null;
    }
  // 获取 BaseBindingActivity 的 所包含的泛型参数列表，这里是核心。
    Type[] types = ((ParameterizedType) type).getActualTypeArguments();

    if (types.length == 0) {
        return null;
    }

  //目前泛型只有一个，所以拿第0 个
    return (Class<? extends ViewBinding>) types[0];
}

通过上面的方法，可以获取到 具体的ViewBinding 的 class对象，第一目的已经达到，然后准备获取具体的 ViewBinding 的实例

2、实例化ViewBinding

通过 本身的 inflate()方法来创建的。

/**
 * 得到 Binding 的实例
 *
 * @param viewBindingClass Class<? extends ViewBinding>
 * @param layoutInflater LayoutInflater
 * @param <Binding> Binding
 * @return Binding
 */
@SuppressWarnings("unchecked")
private static <Binding> Binding createViewBinding(Class<? extends ViewBinding> viewBindingClass, LayoutInflater layoutInflater) {

    try {
        Method method = viewBindingClass.getMethod("inflate", LayoutInflater.class);

        ViewBinding viewBinding = (ViewBinding) method.invoke(viewBindingClass,       
                                                              layoutInflater);

        return (Binding) viewBinding;
    } catch (Exception e) {
        e.printStackTrace();
    }
    return null;
}
3、目的实现：

把上面的代码组合起来

class BindingUtil {

    /**
     * activity 的 创建方式
     *
     * @param appCompatActivity AppCompatActivity
     * @param <Binding> Binding
     * @return <Binding> Binding
     */
    public static <Binding> Binding createBinding(@NonNull AppCompatActivity 
                                                  appCompatActivity) {
        LayoutInflater layoutInflater = appCompatActivity.getLayoutInflater();
        Class<? extends ViewBinding> viewBindClass =  
          findViewBinding(appCompatActivity);
      
        return createViewBinding(viewBindClass, layoutInflater);
    }
  
}

目前为止，我们的BaseBindingActivity 就变成了这样：

public abstract class BaseBindingActivity<Binding> extends AppCompatActivity {

    protected Binding binding;
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        binding = BindingUtil.createBinding(this);
        if (binding == null) {
          throw new NullPointerException("binding is null");
        }
      setContentView(((ViewBinding) binding).getRoot());
    }

}

这时候，我们再把自己的 Activity 修改以下，就是下面的样子了。

public class TestActivity extends BaseBindingActivity<ActivityTestBinding> {

}

怎么样，世界是不是一下子就变得清净了。

等等，别高兴太早，还没完呢，我们还有 DataBinding的创建没有实现呢，但是，不要着急。一步一步来嘛！

4、DataBinding 的实现

之前说过，DataBinding 只需要通过DataBindingUtil就可以创建，但是需要获取到布局的id，所以这里添加一个方法getLayoutID()来获取布局资源 ，所以 BaseBindingActivity的最终结果是这样的：

public abstract class BaseBindingActivity<Binding> extends AppCompatActivity {
    protected Binding binding;
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
      
        if (getLayoutID() == 0) {
          // 布局资源不存在，认为是 ViewBinding
            binding = BindingUtil.createBinding(this);
            if (binding == null) {
                throw new NullPointerException("binding is null");
            }
            setContentView(((ViewBinding) binding).getRoot());
        } else {
          //存在则认为是 DataBinding
            binding = (Binding) DataBindingUtil.setContentView(this, getLayoutID());
            setContentView(((ViewDataBinding) binding).getRoot());
        }
    }
  
    
    public int getLayoutID() {
        return 0;
    }
  
}

那么，使用 DataBinding的 Activity 就是这样的了：

public class TestActivity extends BaseBindingActivity<ActivityTestDataBindingBinding> {
    @Override
    public int getLayoutID() { return R.layout.activity_test_data_binding; }
}

从代码上面看，只多了一个 getLayoutID() ,也是相当的干净清爽。

优化和内容丰富

综上所述，对 基于 Viewbinding和 DataBinding的类，进行基类的封装，还是比较简单。

在上面的基础上，我又扩展了一些接口，以方便代码的分层，避免使用者重写 onCreate() 时，造成代码的堆积。

public interface ICreate {

    /**
     * 返回页面 布局的 Layout id
     * @return @LayoutRes id
     */
    @LayoutRes int getLayoutID();

    /**
     * 初始化 view 的状态，例如 显示、 隐藏、等
     */
    void initViewState();

    /**
     * 设置 view 的 监听事件， 例如 点击、长按、选择、输入监听等
     */
    void initViewListener();


    /**
     * 其他的操作，
     * @param savedInstanceState savedInstanceState
     */
    void onProcess(@Nullable Bundle savedInstanceState);


}

到此，功能基本上够用了，同理，对于Fragment 的封装也是一样的，具体代码可以参考AndroidMvvm/mvvm

可以下载使用，当然也支持直接依赖 到项目中：

implementation 'com.github.eson-yunfei:AndroidMvvm:0.0.5' //最新版本是 Kotlin

当然，不要忘记在根目录的build.gradle 中 添加以下内容

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 204,053评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,527评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,779评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,685评论 1赞 276
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,699评论 5赞 366
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,609评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,989评论 3赞 396
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,654评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,890评论 1赞 298
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,634评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,716评论 1赞 330
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,394评论 4赞 319
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,976评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,950评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,191评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 44,849评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,458评论 2赞 342