项目搭建阅历记录

Android App封装 ——架构（MVI + kotlin + Flow）
Android App封装 —— ViewBinding
Android App封装 —— DI结构 Hilt？Koin？
Android App封装 —— 实现自己的EventBus

一、布景

在前面的Github wanandroid项目中能够看到，我获取控件目标仍是用的findviewbyId

button = findViewById(R.id.button)
viewPager = findViewById(R.id.view_pager)
recyclerView = findViewById(R.id.recycler_view)

现在肯定是需求对这个最常用的获取View的findViewById代码进行优化，主要是有两个原因

过于冗余

findViewById对应一切的View都要书写findViewById(R.id.xxx)的办法，代码过于繁琐
不安全

强制转化不安全，findViewById获取到的是一个View目标，是需求强转的，一旦类型给的不对则会出现异常，比方将TextView错转成ImageView

所以咱们需求一个结构解决这个问题，大致是有三个计划

二、计划

计划一 butterkniife

这个应该许多人都用过，由大大佬JakeWharton开发，经过注解生成findViewById的代码来获取对应的View。

@BindView(R.id.button)
EditText mButton;

可是2020年3月份，大佬已在GitHub上说明不再保护，推荐运用 ViewBinding了。

计划二 kotlin-android-extensions（KAE）

kotlin-android-extensions只需求直接引入布局能够直接运用资源Id拜访View，节约findviewbyid()。

import kotlinx.android.synthetic.main.＜布局＞.*
button.setOnClickListener{...}

可是这个插件也现已被Google废弃了，会影响功率并且安全性和兼容性都不太友爱，Google推荐ViewBinding代替

计划三 ViewBinding

已然都推荐ViewBinding，那现在来看看ViewBinding是啥。官网是这么说的

经过ViewBinding功能，您能够更轻松地编写可与视图交互的代码。在模块中启用视图绑定之后，体系会为该模块中的每个 XML 布局文件生成一个绑定类。绑定类的实例包括对在相应布局中具有 ID 的一切视图的直接引证。在大多数情况下，视图绑定会代替 findViewById。

简而言之就是就是代替findViewById来获取View的。那咱们来看看ViewBinding如何运用呢？

三、ViewBinding运用

1. 条件

确保你的Android Studio是3.6或更高的版本

ViewBinding在 Android Studio 3.6 Canary 11 及更高版本中可用

2. 启用ViewBinding

在模块build.gradle文件android节点下添加如下代码

android {
    viewBinding{
        enabled = true
    }
}

Android Studio 4.0 中，viewBinding 变成特点被整合到了 buildFeatures 选项中，所以配置要改成:

// Android Studio 4.0
android {
     buildFeatures {
          viewBinding = true
     }
}

配置好后就现已启用好了ViewBinding，从头编译后体系会为每个布局生成对应的Binding类，类中包括布局ID对应的View引证，并采纳驼峰式命名。

3. 运用

以activity举例，咱们的MainActivity的布局是activity_main，之前咱们布局代码是：

class MainActivity : BaseActivity() {
    private lateinit var button: Button
    private lateinit var viewPager: ViewPager2
    private lateinit var recyclerView: RecyclerView
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        button = findViewById(R.id.button)
        button.setOnClickListener { ... }
    }
}

现在就要改为

对应的Binding类如ActivityMainBinding类去用inflate加载布局
然后经过getRoot获取到View
将View传入到setContentView(view:View)中

Activity就能显示activity_main.xml这个布局的内容了，并能够经过Binding目标直接拜访对应View目标。

class MainActivity : BaseActivity() {
    private lateinit var mBinding: ActivityMainBinding
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        mBinding = ActivityMainBinding.inflate(layoutInflater)
        setContentView(mBinding.root)
        mBinding.button.setOnClickListener { ... }
    }
}

而在其他UI elements中，如fragment、dialog、adapter中，运用办法迥然不同，都是经过inflate去加载出View，然后后面加以运用。

四、原理

生成的类能够在/build/generated/data_binding_base_class_source_out下找到

public final class ActivityMainBinding implements ViewBinding {
  @NonNull
  private final ConstraintLayout rootView;
  @NonNull
  public final Button button;
  @NonNull
  public final RecyclerView recyclerView;
  @NonNull
  public final ViewPager2 viewPager;
  private ActivityMainBinding(@NonNull ConstraintLayout rootView, @NonNull Button button,
      @NonNull RecyclerView recyclerView, @NonNull ViewPager2 viewPager) {
    this.rootView = rootView;
    this.button = button;
    this.recyclerView = recyclerView;
    this.viewPager = viewPager;
  }
  @Override
  @NonNull
  public ConstraintLayout getRoot() {
    return rootView;
  }
  @NonNull
  public static ActivityMainBinding inflate(@NonNull LayoutInflater inflater) {
    return inflate(inflater, null, false);
  }
  @NonNull
  public static ActivityMainBinding inflate(@NonNull LayoutInflater inflater,
      @Nullable ViewGroup parent, boolean attachToParent) {
    View root = inflater.inflate(R.layout.activity_main, parent, false);
    if (attachToParent) {
      parent.addView(root);
    }
    return bind(root);
  }
  @NonNull
  public static ActivityMainBinding bind(@NonNull View rootView) {
    // The body of this method is generated in a way you would not otherwise write.
    // This is done to optimize the compiled bytecode for size and performance.
    int id;
    missingId: {
      id = R.id.button;
      Button button = ViewBindings.findChildViewById(rootView, id);
      if (button == null) {
        break missingId;
      }
      id = R.id.recycler_view;
      RecyclerView recyclerView = ViewBindings.findChildViewById(rootView, id);
      if (recyclerView == null) {
        break missingId;
      }
      id = R.id.view_pager;
      ViewPager2 viewPager = ViewBindings.findChildViewById(rootView, id);
      if (viewPager == null) {
        break missingId;
      }
      return new ActivityMainBinding((ConstraintLayout) rootView, button, recyclerView, viewPager);
    }
    String missingId = rootView.getResources().getResourceName(id);
    throw new NullPointerException("Missing required view with ID: ".concat(missingId));
  }
}

能够看到关键的办法就是这个bind办法，里边经过ViewBindings.findChildViewById获取View目标，而持续查看这个办法

public class ViewBindings {
    private ViewBindings() {
    }
    /**
     * Like `findViewById` but skips the view itself.
     *
     * @hide
     */
    @Nullable
    public static <T extends View> T findChildViewById(View rootView, @IdRes int id) {
        if (!(rootView instanceof ViewGroup)) {
            return null;
        }
        final ViewGroup rootViewGroup = (ViewGroup) rootView;
        final int childCount = rootViewGroup.getChildCount();
        for (int i = 0; i < childCount; i++) {
            final T view = rootViewGroup.getChildAt(i).findViewById(id);
            if (view != null) {
                return view;
            }
        }
        return null;
    }
}

可见仍是运用的findViewById，ViewBinding这个结构只是帮咱们在编译阶段自动生成了这些findViewById代码，省去咱们去写了。

五、优缺点

长处

比照kotlin-extension，能够控制拜访效果域，kotlin-extension能够拜访不是该布局下的view;
比照butterknife，减少注解以及id的1对1匹配
兼容Kotlin、Java；
官方推荐。

缺点

添加编译时刻，由于ViwBinding是在编译时生成的，会产生而外的类，添加包的体积；
include的布局文件无法直接引证，需求给include给id值，然后直接引证；

整体来说ViewBinding的长处仍是远远大于缺点的，所以能够放心运用。

六、封装

已然挑选了计划ViewBinding，那咱们要在项目中运用，肯定还需求对他加一些封装，咱们能够用泛型封装setContentView的代码

abstract class BaseActivity<T : ViewBinding> : AppCompatActivity() {
    private lateinit var _binding: T
    protected val binding get() = _binding;
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        _binding = getViewBinding()
        setContentView(_binding.root)
        initViews()
        initEvents()
    }
    protected abstract fun getViewBinding(): T
    open fun initViews() {}
    open fun initEvents() {}
}

class MainActivity : BaseActivity<ActivityMainBinding>() {
    override fun getViewBinding() = ActivityMainBinding.inflate(layoutInflater)
    override fun initViews() {
        binding.button.setOnClickListener {
            ...
        }
    }
}

这样在Activity中运用起来就很方便，fragment也能够做类似的封装

abstract class BaseFragment<T : ViewBinding> : Fragment() {
    private var _binding: T? = null
    protected val binding get() = _binding!!
    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
    ): View? {
        _binding = getViewBinding(inflater, container)
        return binding.root
    }
    protected abstract fun getViewBinding(inflater: LayoutInflater, container: ViewGroup?): T
    override fun onDestroyView() {
        super.onDestroyView()
        _binding = null
    }
}

注意：

这里会发现Fragment和Activity的封装办法不一样，没有用lateinit。
由于binding变量只要在onCreateView与onDestroyView才是可用的，而fragment的生命周期和activity的不同，fragment能够超出其视图的生命周期，比方fragment hide的时候，如果不将这里置为空，有可能引起内存泄漏。
所以咱们要在onCreateView中创建，onDestroyView置空。

七、总结

ViewBinding比较长处仍是许多的，解决了安全性问题和兼容性问题，所以咱们能够放心大胆的运用。

项目源码地址： Github wanandroid

相关链接：
Android App封装 ——架构（MVI + kotlin + Flow）

Android App封装 —— ViewBinding

一、布景

二、计划

计划一 butterkniife

计划二 kotlin-android-extensions（KAE）

计划三 ViewBinding

三、ViewBinding运用

1. 条件

2. 启用ViewBinding

3. 运用

四、原理

五、优缺点

长处

缺点

六、封装

注意：

七、总结

作者信息

推广

Android App封装 —— ViewBinding

一、布景

二、计划

计划一 butterkniife

计划二 kotlin-android-extensions（KAE）

计划三 ViewBinding

三、ViewBinding运用

1. 条件

2. 启用ViewBinding

3. 运用

四、原理

五、优缺点

长处

缺点

六、 封装

注意：

七、总结

相关文章

Activity的启动流程

分享一下在实际项目中是如何使用(封装) glide 的吧

Flutter(十二)实战-工程配置及本地资源使用

学了redis不会实战？看这篇就够了

作者信息

推广

六、封装