Databinding使用全面总结

我们在平时项目开发中,通常需要些大量的findViewById()、setXxx()、setOnXxxxListener()等无实际意义的代码,不必要地加大工作量,大家代码的复杂度。而Databinding正是来解放我们双手的得力工具,性能高,功能全面,谁用谁知道。

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);
            }
        });
    }
}

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

推荐阅读更多精彩内容