Android View Binding概述及基本使用

前言

使用kotlin语言进行Android开发的朋友们肯定对Kotlin-android-extensions插件不陌生,这个插件可以帮助我们节省findviewbyid()的书写。在不需要添加其他的代码的情况下,我们就可以直接在kotlin代码中直接使用xml定义的控件id来直接调用控件,其余的工作都由插件自动完成。

这个插件在Android开发中可以说是非常方便了,尤其是复杂的页面中包含大量的View的情况下,可以为我们省略的大量的琐碎代码的书写。但是自Android Studio4.1之后,每当我们再次新建的工程时,编译器已经不会帮助我们自动引入此控件了。

在发现了这个问题之后,我感到非常奇怪,尤其是之前的编译器曾经在新创建工程中引入过此插件。于是我去查询了google官方说明,得到了如下结果:

Google提示我们Kotlin-android-extensions此插件已经被废弃掉了,在之后的版本建议使用View Binding来进行视图绑定,来替代extensions插件的功能。

那么本文就对于View Binding的使用做一个简单说明。

一、配置

在使用View Binding之前,首先需要确定你当前使用的Android Studio版本,只有在3.6之后的Android Studio才能够支持View Binding。

官方文档上指出:

视图绑定视图绑定在Android Studio 3.6 Canary 11及更高版本中可用。

在确定完编译器版本可用之后,我们就可以使用View Binding了,首先是需要在build.gradle文件中配置开启viewbinding,配置代码如下:

android {
        ...
        viewBinding {
            enabled = true
        }
    }

二、文件生成说明

在进行上述配置之后,当前module就启动了viewBinding功能,Android Studio会自动为我们所编写的每一个布局文件都生成对应的Binding类,

其命名规则是对xml文件名称的驼峰重命名+Binding

其位置在build/generated/data_binding_base_class_sorce_out/debug/out/com....../databinding/文件夹里面。

举例如下:

如果我们定义一个activity_single_main.xml的布局,则其对应的文件名为ActivitySingleMainBinding,其位置如下图:

viewbinding文件位置图.jpg

在启用了ViewBinding功能之后,Android Studio会为我们所编写的每一个布局文件都生成一个对应的Binding类。如果不需要布局生成Binding文件,可以将tools:viewBindingIgnore="true"属性添加到相应的布局文件的根视图中,如下:

<LinearLayout
            ...
            tools:viewBindingIgnore="true" >
        ...
</LinearLayout>

接下来对Viewbinding在Activity和Fragment中的使用进行简单说明。

三、基本使用

1. Activity中的使用

在Activity中使用比较简单,我们在onCreate()方法中执行如下代码:

    private ActivityMainLibJavaBinding binding;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        binding = ActivityMainLibJavaBinding.inflate(getLayoutInflater());
        View view = binding.getRoot();
        setContentView(view);
    }

即如下步骤:

  1. 调用绑定类中包含的静态inflate()方法
  2. 调用getRoot()方法获取View
  3. 将View传递到setContentView()中,使其成为屏幕上的活动视图。

kotlin代码类似(两种语言处理基本相同,后续以Java代码进行说明)

    private lateinit var viewBinding: ActivitySingleMainBinding

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        viewBinding = ActivitySingleMainBinding.inflate(layoutInflater)
        setContentView(viewBinding.root)
    }

经过如上步骤,我们就能够使用绑定类的实例binding.XX来引用视图了,如下:

        getSupportFragmentManager().beginTransaction().replace(binding.content.getId(),new Test1Fragment()).commitAllowingStateLoss();

在BaseActivity中做简单封装方便使用,如下:

public abstract class BaseActivity<VB extends ViewBinding> extends AppCompatActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        VB binding = getBinding();
        setContentView(binding.getRoot());
    }

     abstract protected VB getBinding();
}

在Activity中实现getBinding()方法,之后就可以使用getBinding().XX引用布局控件了:

public class MainLibJavaActivity extends BaseActivity<ActivityMainLibJavaBinding> {

    @Override
    protected ActivityMainLibJavaBinding getBinding() {
        return ActivityMainLibJavaBinding.inflate(getLayoutInflater());
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        getSupportFragmentManager().beginTransaction().replace(getBinding().content.getId(),new Test1Fragment()).commitAllowingStateLoss();
    }
}

2. Fragment中的使用

在Fragment中使用,需要在Fragment的onCreateView()方法中执行如下绑定,在视图销毁时移除绑定,代码如下:

public class Test1Fragment extends BaseFragment {

    private FragmentTest1Binding binding;

    public Test1Fragment() {
        // Required empty public constructor
    }

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        // Inflate the layout for this fragment
        binding = FragmentTest1Binding.inflate(inflater, container, false);
        View view = binding.getRoot();
        return view;
    }

    @Override
    public void onDestroyView() {
        super.onDestroyView();
        binding = null;
    }

}
  1. 调用生成的绑定类中包含的静态inflate()方法,此操作会创建该绑定类的实例以供Fragment使用。
  2. 通过调用getRoot()方法获取对跟实图的引用
  3. onCreateView()返回值设置为根视图,使其成为屏幕上的活动视图。
  4. 同时我们还需要在Fragment的视图销毁时销毁当前的Binding引用。

经过如上步骤,我们就能够使用绑定类的实例来引用视图了,格式和Activity中的使用相似,binding.XX格式,代码如下:

    @Override
    public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
        super.onViewCreated(view, savedInstanceState);
        binding.tvTest1.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Toast.makeText(getActivity(), "这是一条测试数据", Toast.LENGTH_SHORT).show();
            }
        });
    }

在BaseFragment中做简单封装方便使用,如下:

public abstract class BaseFragment<VB extends ViewBinding> extends Fragment {
    protected VB binding;

    @Nullable
    @Override
    public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
        binding = initViewBinding(inflater, container, savedInstanceState);
        return binding.getRoot();
    }

    abstract protected VB initViewBinding(@NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState);

    @Override
    public void onDestroyView() {
        super.onDestroyView();
        binding = null;
    }
}

在Fragment中实现initViewBinding方法就能够调用实例引用了,示例代码如下:

public class Test1Fragment extends BaseFragment<FragmentTest1Binding> {

    public Test1Fragment() {
        // Required empty public constructor
    }

    @Override
    protected FragmentTest1Binding initViewBinding(@NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
        return FragmentTest1Binding.inflate(inflater,container,false);
    }

    @Override
    public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
        super.onViewCreated(view, savedInstanceState);
        binding.tvTest1.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Toast.makeText(getActivity(), "这是一条测试数据", Toast.LENGTH_SHORT).show();
            }
        });
    }
}

四、与findViewById区别

与使用 findViewById 相比,视图绑定具有一些很显著的优点:

  • Null 安全:由于视图绑定会创建对视图的直接引用,因此不存在因视图 ID 无效而引发 Null 指针异常的风险。此外,如果视图仅出现在布局的某些配置中,则绑定类中包含其引用的字段会使用 @Nullable 标记。
  • 类型安全:每个绑定类中的字段均具有与它们在 XML 文件中引用的视图相匹配的类型。这意味着不存在发生类转换异常的风险。

这些差异意味着布局和代码之间的不兼容将会导致构建在编译时(而非运行时)失败。

总结

在Kotlin-android-extensions此插件已经被废弃后,我们可以使用View Binding来替代extensions插件的功能,简化开发代码,并且同时支持Java和kotlin,两种语言处理基本相同,本文以Java代码作为举例说明。

参考文章

Google官方文档

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,859评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,772评论 2 374
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,956评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,729评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,611评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,441评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,850评论 3 388
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,485评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,770评论 1 293
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,803评论 2 314
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,598评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,434评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,856评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,065评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,365评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,852评论 2 343
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,065评论 2 338

推荐阅读更多精彩内容