下载引擎的组件化之路

Android 下载引擎的组件化源于应用场景的广泛性和存储字段的固定性。起初，下载引擎是通过 Module 的形式引入项目的，这种方式的引入在形式上起到了解耦作用，同时，也可针对项目个性化的存储字段进行增减。但随着下载引擎复用需求的增加和业务的积淀，Module 不再是下载引擎的最优引用方式了。首先，随着业务的积淀，存储字段的数量逐渐趋于稳定，这意味着下载引擎已经可以满足大部分的应用场景了；其次，Module 引入项目的方式不利于源码的维护。试想下，如果下载引擎出现了问题，并且修复过程异常复杂，那么每个以 Module 方式引入下载引擎的应用在修复同类问题的时候将会非常痛苦，如果再考虑个性化存储字段，这个修复过程将会变成一场灾难。所以，需要一种更加便捷的引用方式来改变现状，比如：AAR 或者 Maven。

引用方式的改变还是比较棘手的。为了理解这里的困惑，需要了解一下下载引擎的实现方式。下载引擎是通过服务启动下载线程来下载内容的，如果下载的信息有变更，这些信息在入库的同时会通知已注册的观察者，前台会通过内容提供者获取下载信息，并展示在界面上。这里需要注意的是内容提供者，也就是 ContentProvider，同一部手机上是不允许同时存在拥有相同 Authorities 的两个应用的。这意味着下载的引擎的内容提供者应该同时具备动态配置和动态读取 Authorities 的能力。下面，就通过改造让下载引擎来具备这些能力。

1. 改造下载引擎库

1.1 动态配置 Authorities

Authorities 的动态配置可通过 Manifest 占位符来实现，在下载引擎库清单文件的 provider 节点中进行配置即可，代码如下：

<application>

    <provider
        android:name="com.sunzn.down.library.DownloadProvider"
        android:authorities="${AUTHORITIES}"
        android:exported="false" />

</application>

1.2 动态读取 Authorities

什么时候读取 Authorities 呢？我们将读取窗口选在了 ContentProvider 的 attachInfo 方法中，因为这个方法是内容提供者实例化完成后进行调用的，作用是返回内容提供者自身的信息，其中就包括 Authorities 信息。我们可以在这个方法中为 URI 匹配器设置匹配的权限和路径。代码如下：

public final class DownloadProvider extends ContentProvider {
   
    @Override
    public void attachInfo(Context context, ProviderInfo info) {
        initContentProvider(info);
        super.attachInfo(context, info);
    }

    private void initContentProvider(ProviderInfo info) {
        String authorities = info.authority;
        // TODO 为 UriMatcher 设置匹配的权限和路径
    }

    @Override
    public boolean onCreate() {
        // TODO 在创建阶段完成初始化逻辑
        return true;
    }

}

1.3 源码分析

为什么选择 attachInfo 方法作为 Authorities 的读取窗口呢？先来看下 ContentProvider 的源码，attachInfo 方法的注释为：实例化完成后，将调用它来告诉内容提供者有关其自身的信息。这个方法会将内容提供者初始化时从清单文件读取到的信息返回来，并在最后调用自身的 onCreate 方法。如何证明这里的 ProviderInfo 就是从清单文件中读取的呢？可以查看 setAuthorities 方法的注释，这个方法用于更改 ContentProvider 的 Authorities，方法里的 Authorities 值通常是内容提供者首次创建时根据清单信息进行设置的。

/**
 * After being instantiated, this is called to tell the content provider
 * about itself.
 *
 * @param context The context this provider is running in
 * @param info Registered information about this content provider
 */
public void attachInfo(Context context, ProviderInfo info) {
    attachInfo(context, info, false);
}

private void attachInfo(Context context, ProviderInfo info, boolean testing) {
    mNoPerms = testing;
    mCallingAttributionSource = new ThreadLocal<>();

    /*
     * Only allow it to be set once, so after the content service gives
     * this to us clients can't change it.
     */
    if (mContext == null) {
        mContext = context;
        if (context != null && mTransport != null) {
            mTransport.mAppOpsManager = (AppOpsManager) context.getSystemService(
                    Context.APP_OPS_SERVICE);
        }
        mMyUid = Process.myUid();
        if (info != null) {
            setReadPermission(info.readPermission);
            setWritePermission(info.writePermission);
            setPathPermissions(info.pathPermissions);
            mExported = info.exported;
            mSingleUser = (info.flags & ProviderInfo.FLAG_SINGLE_USER) != 0;
            setAuthorities(info.authority);
        }
        if (Build.IS_DEBUGGABLE) {
            setTransportLoggingEnabled(Log.isLoggable(getClass().getSimpleName(),
                    Log.VERBOSE));
        }
        ContentProvider.this.onCreate();
    }
}

/**
 * Change the authorities of the ContentProvider. This is normally set for
 * you from its manifest information when the provider is first created.
 * @hide
 * Params:authorities - the semi-colon separated authorities of the ContentProvider.
 */
protected final void setAuthorities(String authorities) {
    if (authorities != null) {
        if (authorities.indexOf(';') == -1) {
            mAuthority = authorities;
            mAuthorities = null;
        } else {
            mAuthority = null;
            mAuthorities = authorities.split(";");
        }
    }
}

通过上面的内容，我们已经具备了动态配置和动态读取 Authorities 的能力，同时我们也从源码上得到了验证。下面，只需要在项目中进行配置，并验证结果就可以了。

2. 引用下载引擎库

在主项目 build.gradle 的 defaultConfig 节点下增加 Manifest 占位符配置，这里需要注意的是占位符的键要与 Provider 中预设的一致，这里的值通常是 applicationId，也可自行设定。

android {

    defaultConfig {

        applicationId "com.sunzn.down.sample"
        manifestPlaceholders = [AUTHORITIES: applicationId]

    }

}

3. 验证结果

运行程序，下载功能正常。转到 build 目录下输出的 APK 文件，查看 AndroidManifest.xml 会发现，上面设置的 Authorities 信息已经被整合到了 provider 节点内。至此，Authorities 的动态配置和动态读取能力验证完毕。

<?xml version="1.0" encoding="utf-8"?>
<manifest
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:versionCode="1"
    android:versionName="1.0"
    android:compileSdkVersion="33"
    android:compileSdkVersionCodename="13"
    package="com.sunzn.down.sample"
    platformBuildVersionCode="33"
    platformBuildVersionName="13">

    <application
        android:theme="@ref/0x7f100008"
        android:label="@ref/0x7f0f001c"
        android:icon="@ref/0x7f0d0000"
        android:debuggable="true"
        android:testOnly="true"
        android:allowBackup="true"
        android:supportsRtl="true"
        android:usesCleartextTraffic="true"
        android:roundIcon="@ref/0x7f0d0001"
        android:appComponentFactory="androidx.core.app.CoreComponentFactory">

        <provider
            android:name="com.sunzn.down.library.DownloadProvider"
            android:exported="false"
            android:authorities="com.sunzn.down.sample" />
        
    </application>
</manifest>

赏

谢谢你请我吃糖果