Android Jetpack架构组件(五)之Navigation

时间 2020-12-24

标签 java android web shell 浏览器安全架构 app ide 工具栏目 Android 繁體版

原文原文链接

1、 Navigation简介

1.1 Navigation诞生背景

采用单个Activity嵌套多个Fragment的UI架构模式，已经被大多数的Android工程师所接受。可是，对于Fragment的管理一直是一件比较麻烦的事情，工程师须要经过FragmentManager和FragmentTransaction来管理Fragment之间的切换。java

在Android中，页面的切换和管理包括应用程序Appbar的管理、Fragment的动画切换以及Fragment之间的参数传递等内容。而且，纯代码的方式使用起来不是特别友好，而且Appbar在管理和使用的过程当中显得很混乱。所以，Jetpack提供了一个名为Navigation的组件，旨在方便开发者管理Fragment页面和Appbar。android

相比以前Fragment的管理须要借助FragmentManager和FragmentTransaction，使用Navigation组件有以下一些优势：web

可视化的页面导航图，方便咱们理清页面之间的关系

经过destination和action完成页面间的导航
方便添加页面切换动画
页面间类型安全的参数传递
经过Navigation UI类，对菜单/底部导航/抽屉蓝菜单导航进行统一的管理
支持深层连接DeepLink

1.2 Navigation元素

在正式学习Navigation组件以前，咱们须要对Navigation的主要元素有一个简单的了解，Navigation主要由三部分组成。shell

Navigation Graph：一个包含全部导航和页面关系相关的 XML资源。
NavHostFragment：一种特殊的Fragment，用于承载导航内容的容器。
NavController：管理应用导航的对象，实现Fragment之间的跳转等操做。

2、Navigation使用

2.1 添加依赖

首先，新建一个Android项目，而后在build.gradle中引入以下依赖脚本。浏览器

dependencies {
  def nav_version = "2.3.2"
  // Java language implementation
  implementation "androidx.navigation:navigation-fragment:$nav_version"
  implementation "androidx.navigation:navigation-ui:$nav_version"

  // Kotlin
  implementation "androidx.navigation:navigation-fragment-ktx:$nav_version"
  implementation "androidx.navigation:navigation-ui-ktx:$nav_version"
}

2.2 建立导航图

在【Project】窗口中，res 目录下右键而后依次选择【New】->【Android Resource File】建立 New Resource File 对话框，以下图所示。

在弹出的界面中，File name可随意输入，Resource type选择Navigation，而后点击肯定便可。

点击肯定后，就会在res目录下建立navigation目录，以及导航文件nav_graph.xml。安全

2.3 Navigation graph

打开新建的nav_graph.xml文件，在Design界面能够看到目前尚未内容，能够【依次点击 New Destination】图标，而后点击【 Create new destination】，便可快速建立新的Fragment，这里分别新建了FragmentA、FragmentB、FragmentC三个fragment。架构

而后，可经过手动配置页面之间的跳转关系，点击某个页面，右边会出现一个小圆点，拖曳小圆点指向跳转的页面，好比设置跳转的关系为FragmentA -> FragmentB -> FragmentC。

而后，咱们再切换到Code面板，能够看到生成的代码以下所示。app

<?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/nav_graph"
    app:startDestination="@id/fragmentA">

    <fragment
        android:id="@+id/fragmentA"
        android:name="com.example.testnavigation.FragmentA"
        android:label="fragment_a"
        tools:layout="@layout/fragment_a" >
        <action
            android:id="@+id/action_fragmentA_to_fragmentB"
            app:destination="@id/fragmentB" />
    </fragment>
    <fragment
        android:id="@+id/fragmentB"
        android:name="com.example.testnavigation.FragmentB"
        android:label="fragment_b"
        tools:layout="@layout/fragment_b" >
        <action
            android:id="@+id/action_fragmentB_to_fragmentC"
            app:destination="@id/fragmentC" />
    </fragment>
    <fragment
        android:id="@+id/fragmentC"
        android:name="com.example.testnavigation.FragmentC"
        android:label="fragment_c"
        tools:layout="@layout/fragment_c" />
</navigation>

上面的生成的代码中用到了几个标签，含义以下。ide

navigation：根标签，经过startDestination配置指定默认的启动页面。
fragment： fragment标签表明一个fragment视图。
action：action标签订义了页面跳转的行为，destination标签订义跳转的目标页，跳转时还能够定义跳转动画。

2.4 NavHostFragment

咱们知道，Fragment须要有一个Activity容器才能正常运行，NavHostFragment就是承载导航内容的容器，而且它须要和Activity绑定。工具

<?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">

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

</androidx.constraintlayout.widget.ConstraintLayout>

其中， android:name="androidx.navigation.fragment.NavHostFragment"这行代码的做用就是告诉Android系统这是一个特殊的Fragment。而且当 app:defaultNavHost="true"属性为true时，该Fragment会自动处理系统返回。

android：name指定NavHostFragment
app：navGraph指定导航视图，即建好的nav_graph.xml
app:defaultNavHost=true，能够拦截系统的返回键，能够理解为默认给fragment实现了返回键的功能。

而后咱们运行程序，能够看到默认展现的是FragmentA页面，这是由于MainActivity的布局文件中配置了NavHostFragment，而且给NavHostFragment指定了默认展现的页面为FragmentA。

2.5 NavController

NavController主要用来管理fragment之间的跳转，每一个 NavHost 均有本身的相应 NavController。能够经过findNavController来获取NavController，而后使用NavController的navigate或者navigateUp方法来进行页面之间的路由操做。

打开FragmentA.java文件，而后在onViewCreated生命周期方法中添加以下代码。

public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment_a, container, false);
        Button btnB = view.findViewById(R.id.btn_b);
        btnB.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Navigation.findNavController(v).navigate(R.id.action_fragmentA_to_fragmentB);
            }
        });
        return view;
    }

运行上面的代码，而后点击FragmentA页面上的按钮，系统就会经过Navigation.findNavController(v).navigate()方法导航到FragmentB。

2.6 添加动画

在Fragment之间进行跳转时，还能够添加跳转的动画。打开nav_graph.xml文件的Design选项，而后在Attributes 面板的 Animations 部分中，点击要添加的动画旁边的下拉箭头，开发者能够从如下类型中进行选择，以下图所示。

其中，Attributes面板涉及的属性含义以下。

enterAnim：跳转时的目标页面动画
exitAnim：跳转时的原页面动画
popEnterAnim：回退时的目标页面动画
popExitAnim：回退时的原页面动画

而后，打开Code面板，生成的代码以下。

<fragment
        android:id="@+id/fragmentA"
        android:name="com.xzh.jetpack.FragmentA"
        android:label="fragment_a"
        tools:layout="@layout/fragment_a" >
        <action
            android:id="@+id/action_fragmentA_to_fragmentB"
            app:destination="@id/fragmentB"
            app:enterAnim="@android:anim/slide_in_left"
            app:exitAnim="@android:anim/slide_out_right"
            app:popEnterAnim="@anim/fragment_fade_enter"
            app:popExitAnim="@anim/fragment_fade_exit" />
    </fragment>

3、参数传递

在Android中，页面之间若是要传递数据，建议传递最少许的数据，由于在 Android 上用于保存全部状态的总空间是有限的。若是您须要传递大量数据，可使用 ViewModel。

Fragment的切换常常伴随着参数的传递，为了配合Navigation组件在切换Fragment时传递参数，Android Studio为开发者提供了Safe Args和Bundle两种参数传递方式。

3.1 使用Bundle传递数据

使用Bundle传递数据时，首先建立 Bundle 对象，而后使用 navigate() 将它传递给目的地，以下所示。

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
    super.onViewCreated(view, savedInstanceState)
    tv.setOnClickListener {
         Bundle bundle = new Bundle();
         bundle.putString("key", "from fragmentA");
         Navigation.findNavController(v).navigate(R.id.action_fragmentA_to_fragmentB,bundle);
    }
}

而后，接受方使用getArguments() 方法来获取Bundle 传递的数据，以下所示。

String keyStr = getArguments().getString("key");

3.2 使用 Safe Args传递数据

首先，在项目的 build.gradle 中添加classpath配置，以下所示。

dependencies {
    def nav_version = "2.3.2"
    classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version"
}

而后，在app的 build.gradle添加 apply plugin脚本，以下所示。

apply plugin: 'androidx.navigation.safeargs'

配置完成后记从新rebuild下项目，会生成{module}/build/generated/source/navigation-args/{debug}/{packaged}/{Fragment}Dircetions，以下所示。

若是须要往目的页面传递数据，首先请按照如下步骤将参数添加到接收它的目的页面中。Navigation提供了一个子标签argument能够用来传递参数。

首先，在 Navigation Editor 中，点击接收参数的目的页面，在 Attributes 面板中，点击 Add (+)。而后，在显示的 Add Argument Link 窗口中，输入参数名称、参数类型、参数是否可为 null，以及默认值（若是须要）点击【Add】按钮，以下所示。

点击 Text 标签页切换到 XML 视图，会发现生成的代码以下。

<argument
     android:name="key"
     app:argType="string"
     app:nullable="false"
     android:defaultValue="navigation参数传递" />

而后，咱们在FragmentA.java中使用以下代码传递数据，以下所示。

@Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment_a, container, false);
        Button btnB = view.findViewById(R.id.btn_b);
        btnB.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
              FragmentADirections.ActionFragmentAToFragmentB action=FragmentADirections.actionFragmentAToFragmentB().setKey("经过safeArgs进行参数传递");
              Navigation.findNavController(v).navigate(action);
            }
        });
        return view;
    }

在接受的页面的onCreate方法中使用以下的方法进行接受。

public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        if (getArguments() != null) {
            String name=  FragmentBArgs.fromBundle(getArguments()).getKey();
        }
    }

4、深层连接DeepLink

当应用程序接受到某个通知推送，但愿用户在点击该通知时，可以直接跳转到展现该通知内容的页面，这就是深层连接DeepLink最多见的场景，Navigation组件提供了对深层连接（DeepLink）的支持。

DeepLink有两种应用场景，一种是PendingIntent，另外一种是真实的URL连接，利用这两种方式均可以跳转到程序中指定的页面。

4.1 PendingIntent

PendingIntent方式通常用在消息通知中，当应用程序接收到某个通知时，而且但愿用户在单击该通知时直接跳转到到指定的页面，那么就能够经过PendingIntent来完成。

例如，下面的代码实现功能是，在MainActivity中单击按钮弹出通知栏，点击通知栏跳转到指定NotificationActivity页面中，代码以下。

public class MainActivity extends AppCompatActivity {

    NotificationManager manager=null;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        init();
    }

    private void init() {
        manager = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
        if (Build.VERSION.SDK_INT>=Build.VERSION_CODES.O){
            //注意通知渠道一旦创建就无权修改
            NotificationChannel channel =new NotificationChannel("normal","Normal",NotificationManager.IMPORTANCE_DEFAULT);
            manager.createNotificationChannel(channel);
            NotificationChannel channel2 =new NotificationChannel("important","Important",NotificationManager.IMPORTANCE_HIGH);
            manager.createNotificationChannel(channel2);
        }

        Button pending=findViewById(R.id.btn_pendingintent);
        pending.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                sendNotification();
            }
        });
    }

    void sendNotification(){
        Intent intent =new Intent(this,NotificationActivity.class);
        PendingIntent pi = PendingIntent.getActivity(this,0,intent,0);
        //使用NotificationCompat兼容8.0之前的系统
//        val notification = NotificationCompat.Builder(this,"normal")
        Notification notification = new NotificationCompat.Builder(this,"important")
                .setContentTitle("This is content title")
                .setContentText("This is content text")
                .setStyle(new NotificationCompat.BigTextStyle().bigText("Learn how to build notification,send any sync data,and use voice actions.Get the " +
                        "official Android IDE and developer tools to build apps for Android."))
                .setStyle(new NotificationCompat.BigPictureStyle().bigPicture(BitmapFactory.decodeResource(getResources(),R.drawable.ic_launcher_background)))
                .setSmallIcon(R.drawable.ic_launcher_foreground)
                .setLargeIcon(BitmapFactory.decodeResource(getResources(),R.drawable.ic_launcher_background))
                .setContentIntent(pi)
                .setAutoCancel(true)
                .build();
        manager.notify(1,notification);
    }
}

而后，须要新建一个通知的目的页面，为了MainActivity作区分，咱们在NotificationActivity页面仅放了一个TextView组件，以下所示。

public class NotificationActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_notification);
    }
}

而后运行上面的代码，最终的效果以下图所示。

4.2 URL

使用URL连接方式，当用户经过手机浏览器浏览网站上的某个页面时，能够经过网页浏览器的方式打开对应的应用页面。若是用户的手机安装有咱们得应用程序，那么经过DeepLink就能打开相应的页面；若是没有安装，那么网站能够导航到应用程序的下载页面，从而引导用户安装应用程序。

首先，在导航图中为destination添加<deepLink/>标签，在app:uri属性中填入的是你的网站的相应web页面地址，以下所示。

<fragment
    android:id="@+id/deepLinkSettingsFragment"
    android:name="com.michael.deeplinkdemo.DeepLinkSettingsFragment"
    android:label="fragment_deep_link_settings"
    tools:layout="@layout/fragment_deep_link_settings">

    <!-- 为destination添加<deepLink/>标签 -->
    <deepLink app:uri="www.YourWebsite.com/{params}" />

</fragment>

如上所示，app:uri里面填的是网站的相应Web页面地址，{params}里面的参数会经过Bundle对象传递到页面中。

而后，为相应的Activity设置<nav-graph/>标签，当用户在Web中访问到连接时，你的应用程序便能监听到，以下所示。

<application
    android:allowBackup="true"
    android:icon="@mipmap/ic_launcher"
    android:label="@string/app_name"
    android:roundIcon="@mipmap/ic_launcher_round"
    android:supportsRtl="true"
    android:theme="@style/AppTheme">
    <activity android:name=".DeepLinkActivity">
        <intent-filter>
            <action android:name="android.intent.action.VIEW" />
            <action android:name="android.intent.action.MAIN"/>
            <category android:name="android.intent.category.LAUNCHER"/>
        </intent-filter>

        <!-- 为Activity设置<nav-graph/>标签 -->
       <nav-graph android:value="@navigation/nav_graph"/>
    </activity>

</application>

通过上面的设置后，接下来就能够测试咱们的功能了。咱们能够在Google app中输入相应的Web地址，也能够经过adb工具，使用命令行来完成测试操做。

adb shell am start -a android.intent.action.VIEW -d "http://www.YourWebsite.com/fromWeb"

执行完命令，手机便能直接打开deepLinkSettingsFragment。在该Fragment中，咱们能够经过Bundle对象获取相应的参数（fromWeb），从而完成后续的操做。

@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState){
    View view = inflater.inflate(R.layout.fragment_deep_link_settings, container, false);
    Bundle bundle = getArguments();
    if(bundle != null){
        String params = bundle.getString("params");
        TextView tvDesc = view.findViewById(R.id.tvDesc);
        if(!TextUtils.isEmpty(params)){
            tvDesc.setText(params);
        }
    }
    return view;
}