Android架构组件--ViewBinding学习笔记

Android架构组件–ViewBinding学习笔记

1.解决的问题

ViewBinding的目的是为了减少样板代码findViewById(int)的使用，提升开发效率，精简Activity和Fragment的代码。

2.使用ViewBinding

ViewBinding的使用需要Android Studio版本为3.6以上，需要在模块的build.gradle文件中手动开启，如下：

android {
    ...

    buildFeatures {
        viewBinding = true
    }
}
1
2
3
4
5
6
7

之后Android Studio会自动为layout文件夹下的布局文件生成对应的Java类，命名规则为文件名的大驼峰命名并在后面加上Binding。

比如activity_main.xml布局文件如下：

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    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"
    tools:context=".MainActivity">

    <TextView
        android:id="@+id/timestampText"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:textSize="20sp"
        android:textColor="@color/colorPrimary"
        android:gravity="center"
        android:padding="20dp"
        tools:text="Hello world"
        app:layout_constraintTop_toTopOf="parent"/>

    <Button
        android:id="@+id/timestampButton"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:layout_constraintTop_toBottomOf="@id/timestampText"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        android:text="Get timestamp"/>

    <FrameLayout
        android:id="@+id/fragmentContainer"
        android:layout_width="match_parent"
        android:layout_height="0dp"
        app:layout_constraintTop_toBottomOf="@id/timestampButton"
        app:layout_constraintBottom_toBottomOf="parent"
        android:layout_marginTop="20dp"/>

</androidx.constraintlayout.widget.ConstraintLayout>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

将会生成ActivityMainBinding.java文件。然后在MainActivity中，通过ActivityMainBinding的静态方法inflate(LayoutInflater)获取一个ActivityMainBinding实例，之后通过该实例直接访问各控件。

MainActivity.java如下：

public class MainActivity extends AppCompatActivity {

    private ActivityMainBinding mBinding;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
		
		// 通过 `inflate(LayoutInflater)`方法获取 `Binding`类的实例，并通过 `getRoot()` 方法得到根布局
        mBinding = ActivityMainBinding.inflate(getLayoutInflater());
        setContentView(mBinding.getRoot());

		// 通过访问字段的方式访问各控件
        mBinding.timestampButton.setOnClickListener(v -> {
            mBinding.timestampText.setText(String.valueOf(System.currentTimeMillis()));
        });

        getSupportFragmentManager().beginTransaction()
                .replace(mBinding.fragmentContainer.getId(), new TestFragment())
                .commit();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

如果是在Fragment中，则通过如下方式使用：

public class TestFragment extends Fragment {

    private FragmentTestBinding mBinding;

    @Nullable
    @Override
    public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
		
		// 使用 `inflate(LayoutInflater, ViewGroup, boolean)` 方法获取 `Binding` 实例，后续使用方式相同。
        mBinding = FragmentTestBinding.inflate(inflater, container, false);

        mBinding.include.prettyTimeButton.setOnClickListener(v -> {
            SimpleDateFormat sdf = new SimpleDateFormat("yyy-MM-dd HH:mm:ss", Locale.CHINA);
            String prettyText = sdf.format(new Date());
            mBinding.include.prettyTimeText.setText(prettyText);
        });

        return mBinding.getRoot();
    }

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

如果使用<include/>则需要为其指定一个id，保证ViewBinding可以为其生成相应的字段

如果是在RecyclerView中使用，则使用bind(View)方法在ViewHolder构造器中获取Binding实例，在onCreateViewHolder中直接通过该实例访问view即可，如下：

public class TestRecyclerViewAdapter extends RecyclerView.Adapter<TestRecyclerViewAdapter.ViewHolder> {

    private List<RvBean> mList;

    public TestRecyclerViewAdapter(List<RvBean> list) {
        mList = list;
    }

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

    @Override
    public void onBindViewHolder(@NonNull ViewHolder holder, int position) {
        final RvBean item = mList.get(position);
        holder.mBinding.content.setText(item.content);
        holder.mBinding.title.setText(item.title);

        holder.mBinding.avatar.setImageResource(item.imageId);
    }

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

    static class ViewHolder extends RecyclerView.ViewHolder{

        RvItemTestBinding mBinding;

        public ViewHolder(@NonNull RvItemTestBinding binding) {
            super(binding.getRoot());
            mBinding = binding;
        }
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

3.原理剖析

生成的Binding文件如下：

public final class ActivityMainBinding implements ViewBinding {
  @NonNull
  private final ConstraintLayout rootView;

  @NonNull
  public final FrameLayout fragmentContainer;

  @NonNull
  public final Button timestampButton;

  @NonNull
  public final TextView timestampText;

  private ActivityMainBinding(@NonNull ConstraintLayout rootView,
      @NonNull FrameLayout fragmentContainer, @NonNull Button timestampButton,
      @NonNull TextView timestampText) {
    this.rootView = rootView;
    this.fragmentContainer = fragmentContainer;
    this.timestampButton = timestampButton;
    this.timestampText = timestampText;
  }

  @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.fragmentContainer;
      FrameLayout fragmentContainer = rootView.findViewById(id);
      if (fragmentContainer == null) {
        break missingId;
      }

      id = R.id.timestampButton;
      Button timestampButton = rootView.findViewById(id);
      if (timestampButton == null) {
        break missingId;
      }

      id = R.id.timestampText;
      TextView timestampText = rootView.findViewById(id);
      if (timestampText == null) {
        break missingId;
      }

      return new ActivityMainBinding((ConstraintLayout) rootView, fragmentContainer,
          timestampButton, timestampText);
    }
    String missingId = rootView.getResources().getResourceName(id);
    throw new NullPointerException("Missing required view with ID: ".concat(missingId));
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

为访问根布局，ViewBinding提供getRoot()方法。同时该布局中每一个带id的控件都将生成一个与之对应的字段，供调用者访问。

其核心方法是bind(View)方法，它返回一个Binding对象，将该布局中的所有带id的控件通过findViewById(int)方法构造出来并设置为字段，其它方法inflate(LayoutInflater,ViewGroup, boolean)和inflate(LayoutInflater)均为该方法的封装。

4.优缺点

优点：

• 简化样板代码，摆脱了findViewById(int)，使Activity、Fragment和RecyclerView中的样板代码大大减少，在一个页面中控件较多的时候效果很明显。
• 不会存在空指针问题，如果在SecondActivity中使用findViewById(int)引用了MainActivity的控件id，在非运行时将难以发现，View Binding有效解决了这个问题。
• 类型安全，不会存在控件类型强转出错的问题。

缺点：

• 编译时生成新的类，会导致编译时间增加。
• 类的数量增多，当布局较多时会导致包体积变大。