浅谈Android中的meta-data及其应用

code小生,一个专注 Android 领域的技术分享平台

作者：brucevanfdm
地址：https://www.jianshu.com/p/75e0f4f16471
声明：本文来自 brucevanfdm 投稿,转发等请联系原作者授权

题图

前言

在日常的Android开发中，AndroidManifest中总会出现一些标签，或是第三方SDK配置信息，或是系统配置，不禁让人思考到底是什么？有什么用？怎么用？有哪些应用场景？

meta-data简介

<meta-data>
直译为“元数据”，该标签可为<activity>、<activity-alias>、<application>、<provider>、<receiver>、<service>等组件提供附加数据项。
组件元素可以包含任意数量的子元素。系统将meta-data配置的数据存储于一个Bundle对象中，可以通过PackageItemInfo.metaData字段获取。

语法配置

<meta-data android:name="string"
           android:resource="resource specification"
           android:value="string" />

android:name

分配给该标签的键，即唯一名称。为确保名称唯一应使用Java风格命名约定，如“ com.example.project.activity.fred”。

android:resource

对资源的引用，如“@string/app_name”。该资源ID可以通过该metaData.getInt()方法获取。

android:value

分配给该标签的值，如String、Boolean等。

meta-data用法

正如前文所说，可用于常见的组件，那么在程序中应该如何配置，并获取这些配置好的外部数据呢？

配置示例：

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.fedming.notches">

    <application
        ...
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
            <meta-data
                android:name="meta_act"
                android:resource="@string/app_name" />
        </activity>
        <meta-data
            android:name="meta_app"
            android:value="value from meta_app" />
    </application>

</manifest>

获取配置信息示例

//获取value
private String getMetaDataFromApp() {
    String value = "";
    try {
        ApplicationInfo appInfo = getPackageManager().getApplicationInfo(getPackageName(),
                PackageManager.GET_META_DATA);
        value = appInfo.metaData.getString("meta_app");
    } catch (PackageManager.NameNotFoundException e) {
        e.printStackTrace();
    }
    return value;
}
//获取resource id
private int getMetaDataIdFromAct() {
    int resId= 0;
    try {
        ActivityInfo activityInfo = getPackageManager().getActivityInfo(getComponentName(),
                PackageManager.GET_META_DATA);
        resId= activityInfo.metaData.getInt("meta_act");
    } catch (PackageManager.NameNotFoundException e) {
        e.printStackTrace();
    }
    return resId;
}

运行结果

06-09 21:21:04.624 14238-14238/com.fedming.notches D/fdm:  meta_app : value from meta_app
06-09 21:21:04.625 14238-14238/com.fedming.notches D/fdm:  meta_act_id : 2131427357, meta_act_string : Notches

可以看到，我们在manifest中配置了，并在Activity中获取了这些配置的信息。
我们点进去看一下源码，metaData到底是什么？如图：本质上就是个Bundle罢了。

metaData.png

再对照一下我们的配置，确实与Logcat中打印的信息无误，并且注意到我们可以从resource id中获取该应用的名称——“Notches”。可以说非常简单易懂了。

meta-data应用场景

讲到这里，可能就会有人问了，那你这个东西什么用啊？我自己程序里用这个配置拿自己的数据，那不是脱裤子放屁？
别急…咱们一开始就说到了这个标签我们经常是在接入第三方SDK时见到，那么它的应用场景肯定很SDK开发有关啊！并且在系统属性配置上也有应用，比如配置屏幕支持比例，配置SearchableActivity等等。来看几个示例：

示例一：某分享

<meta-data
      android:name="UMENG_APPKEY"
      android:value="oooooooooooooxxxxxxxxxxxx" />

示例二：桌面快捷方式

<meta-data
       android:name="android.app.shortcuts"
       android:resource="@xml/shortcuts" />

示例三：18:9屏幕适配

 <meta-data
      android:name="android.max_aspect"
      android:value="2.1" />

示例四：某地图

<meta-data
      android:name="com.amap.api.v2.apikey"
      android:value="oooooooooooooxxxxxxxxxxxx" />

我们接入某分享、某地图、其他私有第三方SDK时，一般都要先申请一个账号，用于接入配置。SDK则会在内部代码中读取这些数据，通过这些key标记来源的信息，分辨接入方，进行访问控制、数据统计等。
其实不知不觉之中，开发者接入了这些SDK，App运营中产生的一些数据也就分享给SDK开发商了，包括使用频率、用户画像等等。

我们在开发自己的SDK过程中，也可以使用这种方法控制访问。通过分配账号的方式要求接入方配置相关信息，并在SDK中读取配置好的信息，用于对比鉴权，若无相关匹配账号，则直接抛异常或者返回相关返回码。当然了，账号分配这一步也可以放到后台做，然而并不是所有的SDK接入都需要后台接入，比如分享SDK。

结语

最后，吐槽一下，本来昨天文章就写得差不多了，辣鸡Typora编辑器崩了…没来得及保存的半篇文章都没了…真是无语啊！

参考文章

stackoverflow:what-is-metadata
https://stackoverflow.com/questions/38687159/what-is-metadata-and-what-is-the-use-of-it-in-android

developer guide:meta-data-element
https://developer.android.com/guide/topics/manifest/meta-data-element

640