自研一套带双向认证的Android通用网络库

当前，许多网络库基于Retrofit或OkHttp开发，但实际项目中常需要定制化，并且需要添加类似双向认证等安全功能。这意味着每个项目都可能需要二次开发。那么，有没有一种通用的封装方式，可以满足大多数项目需求？本文将介绍一种通用化的封装方法，帮助你用最少的代码量开发出自己的网络库。

框架简介

FlexNet 网络库是基于 Square 公司开源的 Retrofit 网络框架进行封装的。Retrofit 底层采用 OkHttp 实现，但相比于 OkHttp，Retrofit 更加便捷易用，尤其适合用于 RESTful API 格式的请求。

在网络库内部，我们实现了双向认证功能。在初始化时，您可以选择是否开启双向认证，框架会自动切换相应的 URL，而业务方无需关注与服务端认证的具体细节。

接入方式

1. 本地aar依赖

下载aar到本地（下载地址见文末），copy到app的libs目录下，如图：

implementation(files("libs/flex-net.aar"))

然后sync只会即可

2. 通过Maven远程依赖

FlexNet目前已上传Maven，可通过Maven的方式引入，在app的build.gradle中加入以下依赖：

implementation("com.max.android:flex-net:3.0.0")

sync之后即可拉到Flex-Net

快速上手

网络库中默认打开了双向认证，并根据双向认证开关配置了相应的 baseUrl，大多数场景下只需要控制双向认证开关，其余配置走默认即可。

1. 初始化

在发起网络请求之前（建议在Application的onCreate()中），调用:

fun initialize(
    app: Application,
    logEnable: Boolean = BuildConfig.LOG_DEBUG,
    sslParams: SSLParams? = null,
)

• application： Application类型，传入当前App的Application实例；
• logEnable： Boolean类型，网络日志开关，会发打印Http的Request和Resonpse信息，可能涉及敏感数据，release包慎用；（仅限网络请求日志，和双向认证的日志不同）
• sslParams： 双向认证相关参数，可选，为空则关闭双向认证。具体描述见下文。

当App需要双向认证功能时，需要在initialize()方法中传递sslParams参数，所有双向认证相关的参数都放在sslParams当中，传此参数默认打开双向认证。

SSLParams的定义如下：

data class SSLParams(
    /** App 是否在白名单之中。默认不在 */
    val inWhiteList: Boolean = false,
    /** 双向认证日志开关，可能涉及隐私，release版本慎开。默认关 */
    val logSwitch: Boolean = true,
    /** 是否开启双向认证。默认开 */
    val enable: Boolean = true,
    /** 双向认证回调。默认null */
    val callback: MutualAuthCallback = null,
)

• inWhiteList： App是否在白名单中，默认不在
• logSwitch： 双向认证日志开关，可能涉及隐私，release版本慎开。默认关，注意这里仅针对双向认证日志，与initialize()方法中的logEnable不同
• callback ： 监听初始化结果回调，true表示成功，反之失败。可选参数，默认为null，仅enableMutualAuth为true时有效

在调用了initialize之后就完成了初始化工作，内部包含了双向认证、网络状态、本地网络缓存等等功能，所有的网络请求都需要在初始化之后发起。

初始化示例代码：

FlexNetManger.initialize(this,
    logEnable = true,
    SSLParams {
        Timber.i("Mutual auth result : $it")
    })

PS *： *部分App在启动的时候获取不到证书，所以这里会失败。如果失败了后续可以在合适的时机通过MutualAuthenticate.isSSLReady()来检查是否认证成功，然后通过MutualAuthentic