Android 9.0(P)默认禁止Http协议,OkHttp3报异常CLEARTEXT communication to host not permitted by network

今天公司之前的项目适配Android 9.0(P) ,进入到登录界面,输入账号密码,报错,内容为:

CLEARTEXT communication to host(host主机地址) not permitted by network.

翻译:网络安全策略不允许与host(host主机地址)进行明文通信。

查看报错异常来源


异常来源

发现是OkHttp3做网络请求框架时,如果是http请求而非https请求,会导致请求失败。

此项目使用的就是OkHttp3做网络请求框架,并且是Http请求。现在App应该都是使用的是OkHttp3网络请求框架吧,哎呀,咱也不知道,咱也不敢问呀。

查看OkHttp3的源码可以看到,它做了网络请求的检查。

if (!Platform.get().isCleartextTrafficPermitted(host)) {
      throw new RouteException(new UnknownServiceException(
          "CLEARTEXT communication to " + host + " not permitted by network security policy"));
}

如果请求是明文流量,默认情况下,在Android 9.0(P)版本Okhttp3就会抛出异常:

throw new RouteException(new UnknownServiceException(
            "CLEARTEXT communication to " + host + " not permitted by network security policy"));

因为是适配Android 9.0(P),(并且之前App正常运行)所以直接去官网查看关于Android 9.0(P)的新特性,发现Android 9.0(P)系统默认禁止http协议,即禁止明文传输,必须使用https来通讯。找到关于Android 9.0(P)的网络安全配置文章。

网络安全配置

阅读完毕
现在开始重新解决问题,

问题如下:

发起网络请求时App打印错误信息:CLEARTEXT communication to host(host主机地址) not permitted by network

解决方案:(因为项目着急上线)现在必须得禁用掉明文流量请求的检查。

在res下新建xml文件夹,然后创建一个name.xml的文件(name可自由命名),文件内容如下:

<?xml version="1.0" encoding="utf-8"?>
<network-security-config>
    <base-config cleartextTrafficPermitted="true" />
</network-security-config>

接着在清单文件中的application节点下添加代码:android:networkSecurityConfig="@xml/name.xml"(上述新建文件的名字)。此处名字为network_config_sdjy_banker,结构如下:

<application
        ...
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:networkSecurityConfig="@xml/network_config_sdjy_banker"
        ...>

重新编译运行,报错。

MMP又报错,自己明明那么那么查看官网文档的。

算了,还是先看一下报错信息(此时如果项目本没有引入关于修改网络安全配置的库时,加入上述代码,就已经可以禁用掉明文流量请求的检查了,使用Http协议的App就可以正常使用了。)

...l4_app\src\main\AndroidManifest.xml:47:9-64 Error:
    Attribute application@networkSecurityConfig value=(@xml/network_config_sdjy_banker) from AndroidManifest.xml:47:9-64
    is also present at [com.baijiayun.live:liveplayer-sdk-core:2.0.0-rc01] AndroidManifest.xml:18:18-79 value=(@xml/network_config_baijiayun).
    Suggestion: add 'tools:replace="android:networkSecurityConfig"' to <application> element at AndroidManifest.xml:42:5-441:19 to override.

        
FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':l4_app:processDebugManifest'.
> Manifest merger failed : Attribute application@networkSecurityConfig value=(@xml/network_config_sdjy_banker) from AndroidManifest.xml:47:9-64
    is also present at [com.baijiayun.live:liveplayer-sdk-core:2.0.0-rc01] AndroidManifest.xml:18:18-79 value=(@xml/network_config_baijiayun).
    Suggestion: add 'tools:replace="android:networkSecurityConfig"' to <application> element at AndroidManifest.xml:42:5-441:19 to override.

报错信息理解就是此App项目中引入的关于百家云的库文件,清单文件配置项与刚才在主module(l4_app)的配置项有冲突。

依据报错信息和AS建议
Suggestion: add 'tools:replace="android:networkSecurityConfig"' to <application> element at AndroidManifest.xml:42:5-441:19 to override.

修改AndroidManifest.xml文件,覆盖掉百家云清单文件配置项。

<application
        ...
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:networkSecurityConfig="@xml/network_config_sdjy_banker"
        ...
        tools:replace="android:networkSecurityConfig">

重新运行App,完美运行。

这样的操作是使得App不使用Https请求,使用Http明文的网络请求。

但是呢,推荐建议后台服务器和App都改用Https,毕竟Android 9.0(P)系统默认禁止http协议,咱们也要与时俱进呢。

推荐阅读更多精彩内容