利用DrawerLayout實現側滑選單學習總結

take2020發表於2020-10-05

start：2020年10月5日

一、前言

最近在做畢設了，我想做一個Material Design風格的工具App，參考了幾款類似的App之後我決定採用Google提供的 DrawerLayout元件進行搭建App的基本框架。經過幾天的學習，我實現了我想要的效果，現在把我在學習過程中遇到的內容和問題總結在本博中，方便以後進一步的學習，當然也提供給大家學習交流，如果你需要的話。

人生，看透不如看淡。在歲月中跋涉，每個人都有自己的故事，看淡心境才會秀麗，看開心情才會明媚。累時歇一歇，隨清風漫舞，煩時靜一靜，與花草凝眸，急時緩一緩，和自己微笑。

二、效果圖

三、相關類的認識

DrawerLayout 抽屜佈局：谷歌推出的類似SildingMenu的一種元件，可以直接在佈局定義內容快速實現側滑選單的效果
NavigationView 導航檢視類：配合DrawerLayout實現側滑選單裡的佈局內容，包括headerLayout(頭部)和menu(內容條目)兩部分
NavController 導航管理類：新一代Fragment管理器，它主要負責操作Navigation框架下的Fragment的跳轉與退出、動畫、監聽當前Fragment資訊的變化
NavigationUI類：主要對App bar和頁面切換進行管理，可以將App bar與NavController進行繫結，系統會自動為你在App bar中完成一些常見操作，eg：增加三橫選單圖示、App bar標題為Fragment的label、自動切換App bar標題、返回上一級
AppBarConfiguration類：用於傳遞AppBar的配置資訊給NavigationUI，便於AppBar與Fragment進行繫結

四、Layout部分

DrawerLayout：

<?xml version="1.0" encoding="utf-8"?>
<androidx.drawerlayout.widget.DrawerLayout 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:id="@+id/drawer_layout"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:fitsSystemWindows="true"
    tools:openDrawer="start">

    <include
        layout="@layout/app_bar_main"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />

    <!--NavigationView必須位於所有元件程式碼的最下方，也就是元件顯示的最上方，否則NavigationView的Item監聽事件會被上層攔截-->
    <com.google.android.material.navigation.NavigationView
        android:id="@+id/nav_view"
        android:layout_width="wrap_content"
        android:layout_height="match_parent"
        android:layout_gravity="start"
        android:fitsSystemWindows="true"
        app:headerLayout="@layout/nav_header_main"
        app:menu="@menu/activity_main_drawer" />

</androidx.drawerlayout.widget.DrawerLayout>

app_bar_main：

<?xml version="1.0" encoding="utf-8"?>
<androidx.coordinatorlayout.widget.CoordinatorLayout 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">

    <com.google.android.material.appbar.AppBarLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:theme="@style/AppTheme.AppBarOverlay">

        <androidx.appcompat.widget.Toolbar
            android:id="@+id/toolbar"
            android:layout_width="match_parent"
            android:layout_height="?attr/actionBarSize"
            android:background="?attr/colorPrimary"
            app:popupTheme="@style/AppTheme.PopupOverlay" />

    </com.google.android.material.appbar.AppBarLayout>

    <com.google.android.material.floatingactionbutton.FloatingActionButton
        android:id="@+id/fab"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_gravity="bottom|end"
        android:layout_margin="@dimen/fab_margin"
        app:srcCompat="@drawable/but_home"
        tools:ignore="VectorDrawableCompat" />

    <include layout="@layout/content_main" />

</androidx.coordinatorlayout.widget.CoordinatorLayout>

nav_header_main:

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="@dimen/nav_header_height"
    android:background="#31cdcc"
    android:gravity="bottom"
    android:orientation="vertical"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:theme="@style/ThemeOverlay.AppCompat.Dark">

    <ImageView
        android:id="@+id/imageView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:contentDescription="@string/nav_header_desc"
        android:paddingTop="@dimen/nav_header_vertical_spacing"
        app:srcCompat="@mipmap/ic_launcher_round" />

    <TextView
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:paddingTop="@dimen/nav_header_vertical_spacing"
        android:text="@string/nav_header_title"
        android:textAppearance="@style/TextAppearance.AppCompat.Body1" />

    <TextView
        android:id="@+id/textView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="@string/nav_header_subtitle" />

</LinearLayout>

activity_main_drawer：

<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    tools:showIn="navigation_view">

    <group android:checkableBehavior="single">
         <item
             android:id="@+id/nav_home"
             android:icon="@drawable/ic_menu_camera"
             android:title="@string/menu_home" />
         <item
             android:id="@+id/nav_gallery"
             android:icon="@drawable/ic_menu_gallery"
             android:title="@string/menu_gallery" />
         <item
             android:id="@+id/nav_slideshow"
             android:icon="@drawable/ic_menu_slideshow"
             android:title="@string/menu_slideshow" />
     </group>

     <item android:title="分類名">
        <menu>
            <item
                android:id="@+id/menu_com_base"
                android:icon="@drawable/ic_menu_camera"
                android:title="功能1" />
            <item
                android:id="@+id/menu_apps"
                android:icon="@drawable/ic_menu_camera"
                android:title="功能2" />
            <item
                android:id="@+id/menu_wifi_chat"
                android:icon="@drawable/ic_menu_camera"
                android:title="功能3" />
        </menu>
     </item>

</menu>

五、Java程式碼部分

package com.signalelf.cl;

import android.os.Bundle;
import android.view.Menu;
import android.view.MenuItem;
import android.view.View;

import com.google.android.material.floatingactionbutton.FloatingActionButton;
import com.google.android.material.navigation.NavigationView;
import com.google.android.material.snackbar.Snackbar;

import androidx.annotation.NonNull;
import androidx.appcompat.app.AppCompatActivity;
import androidx.appcompat.widget.Toolbar;
import androidx.drawerlayout.widget.DrawerLayout;
import androidx.navigation.NavController;
import androidx.navigation.Navigation;
import androidx.navigation.ui.AppBarConfiguration;
import androidx.navigation.ui.NavigationUI;

public class MainActivity extends AppCompatActivity {

    private AppBarConfiguration mAppBarConfiguration;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        //設定Activity的佈局
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        //設定頂部導航欄AppBar
        Toolbar toolbar = findViewById(R.id.toolbar);
        setSupportActionBar(toolbar);

        //懸浮按鈕初始化
        final FloatingActionButton fab = findViewById(R.id.fab);
        fab.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                Snackbar.make(view, "Replace with your own action", Snackbar.LENGTH_LONG)
                        .setAction("Action", null).show();
            }
        });

        //抽屜佈局初始化
        final DrawerLayout drawer = findViewById(R.id.drawer_layout);
        final NavigationView navigationView = findViewById(R.id.nav_view);
        final NavController navController = Navigation.findNavController(this, R.id.nav_host_fragment);

        // Passing each menu ID as a set of Ids because each
        // menu should be considered as top level destinations.
        mAppBarConfiguration = new AppBarConfiguration.Builder(
                R.id.nav_net_check,R.id.nav_signal_info,R.id.nav_phone_info)
                .setDrawerLayout(drawer)
                .build();

        //將App bar與NavController進行繫結，系統會自動為你在App bar中完成一些常見操作，eg：增加三橫選單圖示、App bar標題為Fragment的label、自動切換App bar標題、返回上一級
        NavigationUI.setupActionBarWithNavController(this, navController, mAppBarConfiguration);
        NavigationUI.setupWithNavController(navigationView, navController);

        //給NavigationView的Menu Item設定點選事件
        navigationView.setNavigationItemSelectedListener(new NavigationView.OnNavigationItemSelectedListener() {
            @Override
            public boolean onNavigationItemSelected(@NonNull MenuItem item) {
                int itemId = item.getItemId();
                switch (itemId) {
                    case R.id.menu_net_check:
                        navController.navigate(R.id.nav_net_check);
                        drawer.close();
                        break;
                    case R.id.menu_signal_info:
                        navController.navigate(R.id.nav_signal_info);
                        drawer.close();
                        break;
                    case R.id.menu_phone_info:
                        navController.navigate(R.id.nav_phone_info);
                        drawer.close();
                        break;
                }
                return false;
            }
        });
    }

    @Override//重寫選單條目建立事件
    public boolean onCreateOptionsMenu(Menu menu) {
        // Inflate the menu; this adds items to the action bar if it is present.
        getMenuInflater().inflate(R.menu.main, menu);
        return true;
    }

    @Override//重寫後退事件，可以返回上一級Fragment
    public boolean onSupportNavigateUp() {
        NavController navController = Navigation.findNavController(this, R.id.nav_host_fragment);
        return NavigationUI.navigateUp(navController, mAppBarConfiguration)
                || super.onSupportNavigateUp();
    }
}

六、新Fragment管理器——Navigation

重點：navGraph——導航圖表的概念

使用：

我們可以將多個Fragment定義在一個Graph(圖表)裡面，
然後再在content佈局裡定義一個Fragment元件去引用這個圖示，
然後再java程式碼中用NavController去管理我們定義的Fragment。

1.將多個Fragment定義在一個圖表(Graph)裡：

<?xml version="1.0" encoding="utf-8"?>
<navigation 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:id="@+id/mobile_navigation"
    app:startDestination="@+id/nav_net_check">
<!--app:startDestination="@+id/nav_net_check"：指定開始的目的地，也就是首次啟動的Fragment-->

    <fragment
        android:id="@+id/nav_home"
        android:name="com.signalelf.cl.ui.netcheck.NetCheckFragment"
        android:label="@string/menu_home"
        tools:layout="@layout/fragment_net_check" />

    <fragment
        android:id="@+id/nav_net_check"
        android:name="com.signalelf.cl.ui.netcheck.NetCheckFragment"
        android:label="@string/menu_net_check"
        tools:layout="@layout/fragment_net_check" />

    <fragment
        android:id="@+id/nav_signal_info"
        android:name="com.signalelf.cl.ui.signalinfo.SignalInfoFragment"
        android:label="@string/menu_signal_info"
        tools:layout="@layout/fragment_signal_info" />

    <fragment
        android:id="@+id/nav_phone_info"
        android:name="com.signalelf.cl.ui.phoneinfo.PhoneInfoFragment"
        android:label="@string/menu_phone_info"
        tools:layout="@layout/fragment_phone_info" />
    
</navigation>

2.在內容佈局的Fragment裡引用這個圖表：

<?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"
    app:layout_behavior="@string/appbar_scrolling_view_behavior"
    tools:showIn="@layout/app_bar_main">

    <fragment
        android:id="@+id/nav_host_fragment"
        android:name="androidx.navigation.fragment.NavHostFragment"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:defaultNavHost="true"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:navGraph="@navigation/mobile_navigation" />

</androidx.constraintlayout.widget.ConstraintLayout>

3.利用NavController管理Fragment：

//例項化NavController物件
final NavController navController = Navigation.findNavController(this, R.id.nav_host_fragment);

//將Fragment與AppBar進行繫結
NavigationUI.setupActionBarWithNavController(this, navController, mAppBarConfiguration);

//Fragment跳轉 
navController.navigate(在Fragment圖表中定義的id值);

七、初始ViewModel——Live資料管理

簡介：ViewModel類是被設計用來以可感知生命週期的方式儲存和管理 UI 相關資料，ViewModel中資料會一直存活即使 activity configuration發生變化，比如橫豎屏切換的時候。

功能：

快取Activity使用過程中的資料（LiveData）
網路請求非同步回撥問題
資料處理與UI展示分開管理，提高獨立性
資料共享（Activity與Fragment，Fragment與Fragment）

使用：

1.繼承ViewModel自定義資料管理類(eg：使用者資料載入、資料更新)：

package com.signalelf.cl.ui.netcheck;

import androidx.lifecycle.MutableLiveData;
import androidx.lifecycle.ViewModel;

public class NetCheckViewModel extends ViewModel {
    // TODO: Implement the ViewModel

    MutableLiveData<UserInfo> userInfoLiveData = new MutableLiveData<>();

    public NetCheckViewModel() {
//        可以在例項化ViewModel物件時去獲取伺服器裡使用者的資料，然後賦值給LiveData物件
        UserInfo userInfo = new UserInfo("XX", "男生");
//        setValue()只能在主執行緒中呼叫，postValue()可以在任何執行緒中呼叫。
        userInfoLiveData.postValue(userInfo);
    }

    public MutableLiveData<UserInfo> getUserInfoLiveData() {
        return userInfoLiveData;
    }

    public void updateData(){//模擬使用者資料更新
        UserInfo value = userInfoLiveData.getValue();
        if (value != null){
            value.setName("YY");
            value.setGender("女生");
            userInfoLiveData.postValue(value);
        }
    }
}

2.在Activity(Fragment)中例項化我們定義的ViewModel類

//ViewModelProviders.of(this)被棄用，用ViewModelProvider(this)代替
ViewModelProvider mViewModel = new ViewModelProvider(this).get(NetCheckViewModel.class);

3.觀察資料的變化，並且更新UI顯示

//可以通過ViewModel中定義的get方法觀察資料的變化
mViewModel.userInfoLiveData.observe(getViewLifecycleOwner(), new Observer<UserInfo>() {
            @Override
            public void onChanged(UserInfo userInfo) {
                if (userInfo != null) {
                    name.setText(userInfo.getName());
                    gender.setText(userInfo.getGender());
                }
            }
        });

八、優秀開源庫

自由度更高的，功能更加強大的：Material Drawer（GitHub）

效果圖：

左上角帶導航動畫的：LDrawer（GitHub）

效果圖：

九、總結

通過本次的學習，我總算是接觸到了MD風格App基礎介面的搭建，瞭解到了很多新的概念，同時也感受到了技術更新之快，在以前我感覺側滑選單實現也是比較麻煩的，但是沒想到現在實現是如此的簡單，不管是Google提供的DraweLayout還是其他大佬開放的第三方庫使用起來都是非常方便的。其他感覺：要多多敲程式碼，熟悉快捷鍵。

畏之行之

end：by take

Android側滑選單DrawerLayout使用
2017-12-26
Android
短視訊平臺開發，依靠DrawerLayout實現側滑選單效果
2022-06-30
自定義View：側滑選單實現
2017-04-28
View
自定義View：側滑選單動畫實現
2017-04-28
View動畫
android的左右側滑選單實現
2014-07-13
Android
MaterialDesgin系列文章（二）NavigationView和DrawerLayout實現側滑功能
2018-04-24
NavigationView
css3實現側邊滑動選單
2018-03-22
CSSS3
MaterialDesign系列文章（二）NavigationView和DrawerLayout實現側滑功能
2018-04-24
NavigationView
Android入門教程 | DrawerLayout 側滑欄
2021-11-04
Android
（有圖）仿QQ側滑選單：RecyclerView側滑選單，長按拖拽，滑動刪除
2016-08-25
View
自定義ViewGroup，實現Android的側滑選單
2017-12-26
ViewAndroid
Android最簡單的側劃選單，DrawerLayout的使用
2018-04-17
Android
原生Android 側滑選單實踐（部分）
2019-02-23
Android
Swift - 仿寫QQ側滑選單
2016-05-18
Swift
Flutter 側滑欄及城市選擇UI的實現
2019-07-19
FlutterUI
Flutter：手把手教你實現一個仿QQ側滑選單的功能
2018-10-22
Flutter
實現 UITableViewCell 側滑操作列表
2017-12-19
UIView
Flutter | 超簡單仿微信QQ側滑選單元件
2019-09-18
Flutter元件
jQuery實現左側分類選單
2016-11-28
jQuery
Activity側滑返回的實現原理
2021-06-24
自定義view——仿酷狗的側滑選單
2018-02-26
View
【只發精品】匠心打造Vue側滑選單元件
2017-12-18
Vue元件
View—drawerLayout學習
2017-11-23
View
自定義控制元件？試試300行程式碼實現QQ側滑選單
2019-03-04
控制元件行程
電商左側商品分類選單實現
2019-10-11
TornadoFx實現側邊欄選單效果
2022-05-29
Android SlidingMenu側滑選單使用介紹
2014-09-16
Android
Flutter 仿iOS側滑返回案例實現
2020-10-16
FlutteriOS
自定義RecyclerView實現側滑刪除
2017-05-10
View
直播軟體搭建，通過Android DrawerLayout實現側邊欄功能
2022-03-08
Android
(十)如果實現滑動展示選單效果
2018-08-08
kotlin語言：解決drawerLayout與viewpager的衝突、NavigationView側滑裡面menu的點選事件
2020-10-29
KotlinViewpagerNavigation事件
讓web擁有原生手機側滑選單那種順滑外掛
2020-11-12
Web
帶有視覺滾動差的選單側滑欄
2018-01-11
視覺
ItemTouchHelper實現可拖拽和側滑的列表
2019-03-04
[UI]抽屜選單DrawerLayout分析（二）
2014-04-20
UI
函式節流實現滑動下拉選單
2020-11-26
函式
iOS開發UI篇--一個側滑選單SlidingMenu
2018-11-15
iOSUI