Databinding使用全面总结

在没有Databinding之前，布局文件通常只负责UI控件的布局工作，我们是在页面中通过id找到控件，接着在页面中通过代码对控件进行操作。为了减轻页面的工作量，google推出Databinding，让布局文件承担了部分原本属于页面的工作，也使页面与布局文件之间的耦合度进一步降低。

Databinding优势：

项目更简洁，可读性更高。部分与UI控件相关的代码可以在布局文件中完成。-
不再需要findViewById()方法。
布局文件可以包含简单的业务逻辑。UI控件能够直接与数据模型中的字段绑定，甚至能响应用户的交互。

1. 配置使用方式：build.gradle文件中配置如下设置即可，配置so easy。

android {
    ...
    dataBinding{
        enabled =true;
    }
    ...

2. 使用方式：

创建一个User实体类来充当数据源类：

public class User {
    private String name;
    private int age;
    private String phone;
    private String imgUrl;
    //0男 1女
    private int gender;

    public User(String name, int age, String phone,String imgUrl) {
        this.name = name;
        this.age = age;
        this.phone = phone;
        this.imgUrl = imgUrl;
    }

    @BindingAdapter({"imgUrl"})
    public static void loadImage(ImageView imageView,String imgUrl){
        //必须为static方法，否则报错
        Glide.with(imageView.getContext()).load(imgUrl).into(imageView);
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }

    public String getImgUrl() {
        return imgUrl;
    }

    public void setImgUrl(String imgUrl) {
        this.imgUrl = imgUrl;
    }

    public int getGender() {
        return gender;
    }

    public void setGender(int gender) {
        this.gender = gender;
    }
}

布局文件写法：

与通常的布局文件不同的是，需要在内容最外层嵌套<layout></layout>标签，然后在其中通过<data></data>节点来设置数据源。<variable/>标签内设置变量，该变量值会通过在代码中传入。type为该变量的类型，需引入完整的包路径加类名，或静态引入路径再加类名。name为该类的一个对象名。

通过@{user.xxx}的方法设置变量的属性值，带有提示，如下图：

image.png

activity_main.xml布局文件写法：

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:app="http://schemas.android.com/apk/res-auto">

    <data>
        <variable
            name="user"
            type="com.example.databindinguse.User"/>

        <variable
            name="listener"
            type="android.view.View.OnClickListener"/>
    </data>

    <LinearLayout
        xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical"
        tools:context="com.example.databindinguse.MainActivity"
        android:gravity="center_horizontal">

        <TextView
            android:id="@+id/tv_name"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:textSize="16sp"
            android:layout_marginTop="15dp"
            android:text="@{`姓名：` + user.name}"/>

        <TextView
            android:id="@+id/tv_age"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:textSize="16sp"
            android:layout_marginTop="15dp"
            android:text="@{`年龄：` + String.valueOf(user.age)}"/>

        <TextView
            android:id="@+id/tv_phone"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:textSize="16sp"
            android:layout_marginTop="15dp"
            android:text="@{`电话：` + user.phone}"/>

        <TextView
            android:id="@+id/tv_gender"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:textSize="16sp"
            android:layout_marginTop="15dp"
            android:text="@{user.gender == 0 ? `性别：男` : `性别：女`}"/>

        <ImageView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            app:imgUrl="@{user.imgUrl}"/>

        <Button
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="提交信息"
            android:onClick="@{listener}"/>

        <Button
            android:id="@+id/btn_cancel"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="长按删除信息"/>

        <Button
            android:id="@+id/btn_recyclerview"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="绑定RecyclerView使用"/>
    </LinearLayout>
</layout>

代码中设置变量值：

通过DataBindingUtil.setContentView获取binding实例，生成一个xxxBinding类对象，类名按照布局文件名有一定的生成规则，找规则输入就有有提示。例如这里的布局文件名为activity_main，规则为下划线法变为驼峰法，activity_main变为ActivityMain，在加上固定的Binding做后缀，即为ActivityMainBinding类，该类为总指挥，功能强大，后面陆续会讲到。

        ActivityMainBinding binding = DataBindingUtil.setContentView(this,R.layout.activity_main);
        User user = new User("小茗同学",8,"1838383883",imgUrl);
        user.setGender(1);
        binding.setUser(user);

bingding.setUser(user)将user对象设置给布局文件中variable的user，并在布局文件中完成值设置。

显示图片

加载图片框架这里用glide。设置图片需要用到DataBinding的自定义属性注解BindingAdapter。

代码在User类中，自定义属性@BindingAdapter({"imageUrl"})，注解的方法必须为static方法，否则报错。传入imageview和imgUrl图片地址。

    @BindingAdapter({"imgUrl"})
    public static void loadImage(ImageView imageView,String imgUrl){
        Glide.with(imageView.getContext()).load(imgUrl).into(imageView);
    }

在ImageView中使用app:imageUrl="@{user.imageUrl}"，如上activity_main.xml中的代码。一旦使用app:imageUrl自定义属性，就会触发注解绑定的方法，通过"@{user.imgUrl}"将图片地址传入loadImage()方法。

        <ImageView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            app:imgUrl="@{user.imgUrl}"/>

其他用法

1. 字符串拼接
如activity_main中如下属性，

android:text="@{`姓名：` + user.name}"
android:text="@{`年龄：` + String.valueOf(user.age)}"

2. 三目运算
如下属性，设置的性别gender值为0为男，1为女的三目运算。

android:text="@{user.gender == 0 ? `性别：男` : `性别：女`}"

3. 使用控件
使用binding对象可获取布局文件中的各个对象，根据控件设置的id来获取。如

        <Button
            android:id="@+id/btn_cancel"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="长按删除信息"/>

使用btnCancel设置长按事件：

        binding.btnCancel.setOnLongClickListener(new View.OnLongClickListener() {
            @Override
            public boolean onLongClick(View v) {
                Toast.makeText(getApplicationContext(),"长按了",Toast.LENGTH_SHORT).show();
                return true;
            }
        });

4. 点击事件写法
传入OnClickListener的变量。

        <variable
            name="listener"
            type="android.view.View.OnClickListener"/>

在Button中给android:onClick设置listener的变量。

        <Button
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="提交信息"
            android:onClick="@{listener}"/>

通过setListener传入点击监听给listener对象。

        binding.setListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Toast.makeText(getApplicationContext(),"点击了",Toast.LENGTH_SHORT).show();
            }
        });

Databinding结合RecyclerView使用：

同样用User类使用。写一个通用的ViewHolder类。对每个item，传入variableId和对象，通过binding.setVariable(variableId,object)绑定值。

    public class ViewHolder extends RecyclerView.ViewHolder{
        private ViewDataBinding binding;

        public ViewHolder(View itemView) {
            super(itemView);

            binding = DataBindingUtil.bind(itemView);
        }

        public ViewHolder setBinding(int variableId,Object object){
            binding.setVariable(variableId,object);
            binding.executePendingBindings();
            return this;
        }
    }

公用Adapter，构造函数需设置布局文件和数据源集合。

public abstract class MyBaseAdapter<T> extends RecyclerView.Adapter<MyBaseAdapter.ViewHolder>{
    protected List<T> mDatas;
    protected int mLayoutId;
    protected int mVariableId;

    public MyBaseAdapter(List<T> mDatas, int mLayoutId, int mVariableId) {
        this.mDatas = mDatas;
        this.mLayoutId = mLayoutId;
        this.mVariableId = mVariableId;
    }

    @Override
    public ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View itemView = LayoutInflater.from(parent.getContext()).inflate(mLayoutId,parent,false);
        return new ViewHolder(itemView);
    }


    @Override
    public void onBindViewHolder(ViewHolder holder, int position) {
        convert(holder,mDatas.get(position));
    }

    @Override
    public int getItemCount() {
        return mDatas.size();
    }

    public abstract void convert(ViewHolder holder, T t);

    public class ViewHolder extends RecyclerView.ViewHolder{
        private ViewDataBinding binding;

        public ViewHolder(View itemView) {
            super(itemView);

            binding = DataBindingUtil.bind(itemView);
        }

        public ViewHolder setBinding(int variableId,Object object){
            binding.setVariable(variableId,object);
            binding.executePendingBindings();
            return this;
        }
    }
}

RecyclerView列表类：

public class BindingRecyclerView extends AppCompatActivity {
    private ArrayList<User> datas = new ArrayList<>();

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        init();
    }

    private void init() {
        //测试用数据
        datas.add(new User("小明",15,"123232232","sdfdd"));
        datas.add(new User("小王",16,"123232232","sdsfsd"));
        datas.add(new User("小红",20,"123232232","jjrjsd"));
        datas.add(new User("小李",13,"123232232","jrtht"));

        final int variableId = BR.user;
        ActivityBindingRecyclerViewBinding binding = DataBindingUtil.setContentView(this,R.layout.activity_binding_recycler_view);
        binding.rv.setLayoutManager(new LinearLayoutManager(getApplicationContext()));
        binding.rv.setAdapter(new MyBaseAdapter<User>(datas,R.layout.item_user,variableId) {
            @Override
            public void convert(ViewHolder holder, User user) {
                holder.setBinding(variableId,user);
            }
        });
    }
}

二级页面绑定

这里写了一个二级页面，需要传入一个user对象，然后将这个二级页面include进入一级页面。

include_user.xml布局文件

<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    xmlns:app="http://schemas.android.com/apk/res-auto">

    <data>
        <variable
            name="usersecond"
            type="com.example.User" />
    </data>
    
     ...
</layout>

在一级页面使用

<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    xmlns:app="http://schemas.android.com/apk/res-auto">

    <data>
          <variable
            name="user"
            type="com.example.User" />
    </data>
<include layout="@layout/include_user"
                    app:usersecond="@{user}"/>
</layout>

在一级页面中，引入二级页面布局，并将该页面的user变量通过app:usersecond属性设置给二级页面。

该文章后续会继续更新，改正其中不足之处，加入更多用法。

最后编辑于：2020.08.19 16:15:06

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