深度链接(Deeplinking)

[TOC]

前言

随着线上推广力度加大,不可避免的需要通过网页的形式向用户推广,进行APP的引流以及下载,这就使用了深度链接技术

介绍

深度链接(Deeplinking)是通过网页链接直接启动原生应用的方法。确切地说是通过映射预定义行为到唯一的链接上,让用户无缝跳转到相关内容页面。

官方技术介绍
<<--->> 中文翻译版本

官方推荐的使用深度链接的方法是通过定义URI(统一资源定位符),唯一标识一个APP的具体行为;
例如:eganprojest://needstartactivity
其对应的定义是:scheme://host

或者是网络地址的写法:
例如:https://www.eganproject.com/needstartactivity
起对应的定义是:scheme://host//pathPrefix

实际上,只要按照约定好即可。

使用

按照官方文档:

  1. 在需要的页面注册位置进行配置:
<activity
    android:name=".Task2Activity">

    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT"/>
        <category android:name="android.intent.category.BROWSABLE"/>
        <!-- 接受以"testproject://task2”开头的 URIs  -->
        <data android:scheme="testproject"
              android:host="task2" />
        <!-- 接受以"https://www.eganproject.com/aaaa”开头的 URIs  -->
        <data android:scheme="https"
              android:host="www.eganproject.com"
              android:pathPrefix="aaaa" />
    </intent-filter>
    
</activity>

对上面的属性进行意义阐释:

  • 为页面的添加intent-filter
  • <action android:name="android.intent.action.VIEW" /> -- 指定ACTION_VIEW的操作,使得Google搜索可以触及intent filter
  • <category android:name="android.intent.category.BROWSABLE"/> -- BROWSABLE category 指定该页面可以响应浏览器,如果不添加,APP无法响应深度链接
  • <category android:name="android.intent.category.DEFAULT"/> -- DEFAULT category是可选的,但建议添加。没有这个category,activity只能够使用app组件名称以显示(explicit)intent启动。
  • <data android:scheme="testproject"/> -- data标签可以一到多个,不同属性指定对于深度链接的不同解析
    • android:scheme 必须包含的标签,其一般指定所对应的启动的App
    • android:host 具体的动作/应用的唯一标识
    • android:pathPrefix 页面

数据的解析

如果我们一个页面可能支持了多个 <data> 标签,那我们如何区分是哪个URI启动的呢?Android已将uri的信息直接保存到启动ActivityIntent中,可以方便的通过下面的方法直接获取

@Override
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.main);

    // 获得启动页面的 Intent.
    Intent intent = getIntent();
    // 获得启动页面的 Uri 信息.
    Uri data = intent.getData();
}

Google约束

遵守下面这些惯例来提高用户体验:

深度链接应直接为用户打开内容,不需要任何提示,插播式广告页和登录页面。要确保用户能看到app的内容,即使之前从没打开过这个应用。当用户从启动器打开app时,可以在操作结束后给出提示。这个准则也同样适用于网站的first click free体验。
遵循Navigation with Back and Up中的设计指导,来使你的app能够满足用户通过深度链接进入app后,向后导航的需求。

但是我们实际开发中可能并不能或者是并不容易达到这个要求,比如打开的App目的页面需要App的启动信息或者登录信息,或者产品的需求等;

所以下面说一下实际开发中的使用;

具体使用

前面的准备工作,也就是知识的储备是必须的;
只是需要对一些配置信息、以及数据的解析进行简单的改动;

  • 所需要启动的目的页面不需要配置,只需要在AppLaunchActivity(启动页面)进行配置
<activity
    android:name=".LaunchActivity">

    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT"/>
        <category android:name="android.intent.category.BROWSABLE"/>
        
        <!-- 接受以"testproject://xxx”开头的 URIs  -->
        <data android:scheme="testproject"/>
    </intent-filter>
    
</activity>

我们只需要配置actionDEFAULT categoryBROWSABLE category以及data中的scheme属性

这样的话我们 App 会响应所有以 testproject:// 开头的URI,并且是在APP的启动页面,这样,可以保证我们APP流程的完整性(PS:比如启动流程)

在 Launch 页面,我们可以通过 getData() 获取到具体的URI信息,并且对数据进行解析存储(key-value),在特点的页面,比如 APP的首页,再次对所存储的数据进行解析、区分,进行不同业务的处理这同时也保证了业务完成后返回能够回到 APP 的首页,而不是直接退出 APP

完全具体实现

页面配置

<!-- 启动页面 -->
<activity android:name=".LaunchActivity">
    <intent-filter>
        <action android:name="android.intent.action.MAIN" />
        <category android:name="android.intent.category.LAUNCHER" />
    </intent-filter>
    <!-- 支持深度链接的配置 -->
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data
            android:host="www.egan.testproject"
            android:scheme="testproject" />
    </intent-filter>
</activity>
<!-- 主页面 -->
<activity android:name=".MainActivity" />
<!-- 目标页面 -->
<activity android:name=".Task2Activity" />
public class DeepLinks {

    // 每一个短链接中有一个参数的key是 tag,用了唯一区别该短链
    // PS:也可以通过 path 来区分,一样的,这里用的第一种
    private static final String TAG_KEY = "tag";

    private final Map<String, String> dataMap = new HashMap<>();

    private DeepLinks() {
    }

    public static DeepLinks getInstance() {
        return SingletonHolder.deepLinks;
    }

    private static final class SingletonHolder {
        static final DeepLinks deepLinks = new DeepLinks();
    }

    /**
     * 深度链接的数据解析.
     *
     * @param intent 携带链接数据的 intent.
     */
    void parseData(Intent intent) {
        final Uri data = intent.getData();
        if (null != data) {
            // todo...
            Log.d("YSK", "DeepLinks:parseData >>> " + data);
            Set<String> parameterNames = data.getQueryParameterNames();
            Observable.fromIterable(parameterNames).subscribe(new Consumer<String>() {
                @Override
                public void accept(String s) throws Exception {
                    // 将数据进行数据的存储.
                    dataMap.put(s, data.getQueryParameter(s));
                }
            }, new Consumer<Throwable>() {
                @Override
                public void accept(Throwable throwable) throws Exception {
                    Log.d("YSK", "DeepLinks:accept >>> " + throwable.getMessage());
                }
            });
    }

    /**
     * 数据处理.
     */
    void processData() {
        // 可补充,比如增加App的数据有效性校验.
        // 获取目标活动数据 key
        if (dataMap.containsKey(TAG_KEY)) {
            // 打印数据
            logMap(dataMap);
            String key = dataMap.get(TAG_KEY);
            
            // 根据具体业务区分处理。
            switch (key) {
                case "Task2":
                    break;
                case "Task3":
                    break;
                default:
                    break;
            }
            // 存储的深度链接信息处理后,清空,防止后续深度链接数据的准确性.
            dataMap.clear();
        }
    }

    /**
     * 打印 map 信息.
     */
    private void logMap(final Map<String, String> map) {
        Observable.fromIterable(map.keySet()).subscribe(new Consumer<String>() {
            @Override
            public void accept(String o) throws Exception {
                Log.d("YSK", "DeepLinks:accept >>> " + o + " : " + map.get(o));
            }
        });
    }
/**
 * 启动页面
 */
public class LaunchActivity extends AppCompatActivity {

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

        // 深度链接启动的数据解析.
        DeepLinks.getInstance().parseData(getIntent());

        // 延时3s发送事件,模拟启动页面的广告时间.
        Observable.timer(3, TimeUnit.SECONDS).subscribe(new Consumer<Long>() {
            @Override
            public void accept(Long aLong) throws Exception {
                startActivity(new Intent(LaunchActivity.this, MainActivity.class));
                finish();
            }
        });
    }
}
/**
 * 主页面.
 */
public class MainActivity extends AppCompatActivity {

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

        // 深度链接启动的信息处理.
        DeepLinks.getInstance().processData();
    }
}

adb命令测试方法

google官方提供了通过ADB命令直接测试深度链接效果的命令(不用再费力的专门写一个html了)

adb shell am start
        -W -a android.intent.action.VIEW
        -d <URI-定义的URI> <PACKAGE-需要测试的应用包名>

比如我需要测试我的Demo,可以直接通过命令

adb shell am start
        -W -a android.intent.action.VIEW
        -d "testproject://www.egan.testproject/aler?tag=Task2&p1=1" com.egan.testproject

补充

深度链接一般我们可能都需要传递数据,比如我需要两个参数,这种情况下的测试,使用官方提供的adb命令无法完全获得两个参数,比如我执行的是 testproject://www.egan.testproject/aler?tag=Task2&p1=1 ,但是通过 getIntent().getData() 获取到的 uri 是 testproject://www.egan.testproject/aler?tag=Task2 ,只能获取到第一个参数;
所以请编写一个 html 自行测试;

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