[移动开发] 使用OkHttp3.0进行网络请求

开发: C++知识库 Java知识库 JavaScript Python PHP知识库人工智能区块链大数据移动开发嵌入式开发工具数据结构与算法开发测试游戏开发网络协议系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑笔记本显卡显示器固态硬盘硬盘耳机手机 iphone vivo oppo 小米华为单反装机图拉丁

-> 移动开发 -> 使用OkHttp3.0进行网络请求 -> 正文阅读

[移动开发]使用OkHttp3.0进行网络请求

`使用OkHttp3.0进行网络请求（一）`

1.1：首先现在的HTTP请求访问需要在清单文件中加入

android:usesCleartextTraffic="true"

为了保证安全性，一般非小型公司都采用https来保证网络请求的安全性，这样就不用加入上面那一行代码，但是https请求要信任证书才能访问相应的服务器，一般来说很多网站域名已经绑定了第三方证书机构颁发的证书，所以客户端直接访问即可，但是如果访问的服务器没有第三方机构颁发的证书（这种证书收费），而是采用自签证书（服务器把该自签证书放在某个文件夹下，具体不展开，网上很多例子），此时客户端必须信任该自签证书才可访问对应的服务器，以下封装的网络请求库因为没有好的证书例子，直接采用信任所有证书来进行https的网络请求（这种信任所有证书的行为极其危险，企业级项目中绝对不要使用！）

1.2: 下面来封装一个基于OkHttp3.0框架的网络请求库：

为了保证安卓项目模块化，新建一个android library，命名为networklibrary ![网络请求框架目录结构](https://img-blog.csdnimg.cn/4d2a2575d06d4ba08e1b3b41c3efa61f.png#pic_center)

1.3：统一信任所有证书极其信任所有服务器地址的代码如下：

/*统一信任所有证书*/
        TrustManager[] trustManagers = new TrustManager[]{new X509TrustManager() {
            @Override
            public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {

            }

            @Override
            public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {

            }

            @Override
            public X509Certificate[] getAcceptedIssuers() {
                return new X509Certificate[0];
            }
        }};

        try {
            /*SSL是HTTP的握手流程*/
            ssl = SSLContext.getInstance("SSL");
            ssl.init(null, trustManagers, new SecureRandom());
            HttpsURLConnection.setDefaultSSLSocketFactory(ssl.getSocketFactory());
            /* 验证主机名 */
            //信任所有服务器地址
            HttpsURLConnection.setDefaultHostnameVerifier(new HostnameVerifier() {
                @Override
                public boolean verify(String hostname, SSLSession session) {
                    /* 返回为true */
                    return true;
                }
            });
        } catch (NoSuchAlgorithmException | KeyManagementException e) {
            e.printStackTrace();
        }

此时该app的所有https网络请求都已经信任所有证书和服务器地址！

接下来创建OkHttpClient对象，进行网络请求：

HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();

        /* 可以通过 setLevel 改变日志级别共包含四个级别：NONE、BASIC、HEADER、BODY
        NONE 不记录
        BASIC 请求/响应行
        --> POST /greeting HTTP/1.1 (3-byte body)
        <-- HTTP/1.1 200 OK (22ms, 6-byte body)

        HEADER 请求/响应行 + 头

        --> Host: example.com
        Content-Type: plain/text
        Content-Length: 3

        <-- HTTP/1.1 200 OK (22ms)
        Content-Type: plain/text
        Content-Length: 6
        BODY 请求/响应行 + 头 + 体
        */

        interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

        okHttpClient = new OkHttpClient.Builder()
                .readTimeout(5, TimeUnit.SECONDS)
                .writeTimeout(5, TimeUnit.SECONDS)
                .connectTimeout(5, TimeUnit.SECONDS)
                .addInterceptor(interceptor)
                .build();

1.4: 如果把信任所有证书和服务器地址的代码结合到上述的链式代码中，可以这么写, 完整代码如下：

/**
 * Created by sjx on 2022/9/20
 */
public class ApiService {

    private static final OkHttpClient okHttpClient;

    private static SSLContext ssl;

    static {

        HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();

        /* 可以通过 setLevel 改变日志级别共包含四个级别：NONE、BASIC、HEADER、BODY
        NONE 不记录
        BASIC 请求/响应行
        --> POST /greeting HTTP/1.1 (3-byte body)
        <-- HTTP/1.1 200 OK (22ms, 6-byte body)

        HEADER 请求/响应行 + 头

        --> Host: example.com
        Content-Type: plain/text
        Content-Length: 3

        <-- HTTP/1.1 200 OK (22ms)
        Content-Type: plain/text
        Content-Length: 6
        BODY 请求/响应行 + 头 + 体
        */

        interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

        okHttpClient = new OkHttpClient.Builder()
                .readTimeout(5, TimeUnit.SECONDS)
                .writeTimeout(5, TimeUnit.SECONDS)
                .connectTimeout(5, TimeUnit.SECONDS)
                .addInterceptor(interceptor)
                .sslSocketFactory(ssl.getSocketFactory())
                //信任所有服务器地址
                .hostnameVerifier((hostname, session) -> true)
                .build();

        /*统一信任所有证书*/
        TrustManager[] trustManagers = new TrustManager[]{new X509TrustManager() {
            @Override
            public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {

            }

            @Override
            public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {

            }

            @Override
            public X509Certificate[] getAcceptedIssuers() {
                return new X509Certificate[0];
            }
        }};

        try {
            /*SSL是HTTP的握手流程*/
            ssl = SSLContext.getInstance("SSL");
            ssl.init(null, trustManagers, new SecureRandom());
        } catch (NoSuchAlgorithmException | KeyManagementException e) {
            e.printStackTrace();
        }


    }

}

1.5: 为了清晰看出使用链式和不使用链式信任证书和服务器地址的区别，贴出不使用链式的完整代码：

/**
 * Created by sjx on 2022/9/20
 */
public class ApiService {

    private static final OkHttpClient okHttpClient;

    private static SSLContext ssl;

    static {

        HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();

        /* 可以通过 setLevel 改变日志级别共包含四个级别：NONE、BASIC、HEADER、BODY
        NONE 不记录
        BASIC 请求/响应行
        --> POST /greeting HTTP/1.1 (3-byte body)
        <-- HTTP/1.1 200 OK (22ms, 6-byte body)

        HEADER 请求/响应行 + 头

        --> Host: example.com
        Content-Type: plain/text
        Content-Length: 3

        <-- HTTP/1.1 200 OK (22ms)
        Content-Type: plain/text
        Content-Length: 6
        BODY 请求/响应行 + 头 + 体
        */

        interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

        okHttpClient = new OkHttpClient.Builder()
                .readTimeout(5, TimeUnit.SECONDS)
                .writeTimeout(5, TimeUnit.SECONDS)
                .connectTimeout(5, TimeUnit.SECONDS)
                .addInterceptor(interceptor)
                .build();

        /*统一信任所有证书*/
        TrustManager[] trustManagers = new TrustManager[]{new X509TrustManager() {
            @Override
            public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException {

            }

            @Override
            public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException {

            }

            @Override
            public X509Certificate[] getAcceptedIssuers() {
                return new X509Certificate[0];
            }
        }};

        try {
            /*SSL是HTTP的握手流程*/
            ssl = SSLContext.getInstance("SSL");
            ssl.init(null, trustManagers, new SecureRandom());
            HttpsURLConnection.setDefaultSSLSocketFactory(ssl.getSocketFactory());
            /* 验证主机名 */
            //信任所有服务器地址
            HttpsURLConnection.setDefaultHostnameVerifier(new HostnameVerifier() {
                @Override
                public boolean verify(String hostname, SSLSession session) {
                    /* 返回为true */
                    return true;
                }
            });
        } catch (NoSuchAlgorithmException | KeyManagementException e) {
            e.printStackTrace();
        }
    }

}

补充https和http的概念：

HTTP协议传输的数据都是未加密的，也就是明文的，因此使用HTTP协议传输隐私信息非常不安全，为了保证这些隐私数据能加密传输，于是网景公司设计了SSL（Secure Sockets Layer）协议用于对HTTP协议传输的数据进行加密，从而就诞生了HTTPS。简单来说，HTTPS协议是由SSL+HTTP协议构建的可进行加密传输、身份认证的网络协议，要比http协议安全。

2.1: 总结就是以下几点区别：

https协议需要到ca申请证书，一般免费证书较少，因而需要一定费用。
http是超文本传输协议，信息是明文传输，https则是具有安全性的ssl加密传输协议。
http和https使用的是完全不同的连接方式，用的端口也不一样，前者是80，后者是443。
http的连接很简单，是无状态的；HTTPS协议是由SSL+HTTP协议构建的可进行加密传输、身份认证的网络协议，比http协议安全。

2.2: https的优点：

认证用户和服务器，确保数据发送到正确的客户机和服务器；(验证证书)
加密数据以防止数据中途被窃取；（加密）
维护数据的完整性，确保数据在传输过程中不被改变。（摘要算法）

2.3: Okhttp使用自签名证书

一般支持https的网站，都是CA(Certificate Authority)机构颁发的证书，但是一般该机构颁发的证书需要提供费用且有使用时间的限制，到期需要续费。否则默认该链接是不信任的，通过okHttp无法直接访问。

但是我们可以使用自签的方式，通过JDK自带的keytool.exe 生成一个自己的证书，然后使用该证书内容。虽然也是会出现提示“不安全”，但是我们可以通过okhttp访问链接!

2.3.1.使用自签名证书：
将证书文件放置在assets目录（也可以放置在其他目录下，只要能正确读取到该文件），在创建OkhttpClient对象时sslSocketFactory()将该证书信息添加。

private SSLContext getSLLContext() {
        SSLContext sslContext = null;
        try {
            CertificateFactory certificateFactory = CertificateFactory.getInstance("X.509");
            InputStream certificate = mContext.getAssets().open("gdroot-g2.crt");
            KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
            keyStore.load(null);
            String certificateAlias = Integer.toString(0);
            keyStore.setCertificateEntry(certificateAlias, certificateFactory.generateCertificate(certificate));
            sslContext = SSLContext.getInstance("TLS");
            final TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
            trustManagerFactory.init(keyStore);
            sslContext.init(null, trustManagerFactory.getTrustManagers(), new SecureRandom());
        } catch (CertificateException e) {
            e.printStackTrace();
        } catch (KeyStoreException e) {
            e.printStackTrace();
        } catch (NoSuchAlgorithmException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (KeyManagementException e) {
            e.printStackTrace();
        }
        return sslContext;
    }

通过以上代码可以看出，通过InputStream方式读取证书信息，因此为了避免将证书文件打包到APK中，我们可以直接将证书文件内容放置在String中，将该字符串转为流的形式。

在使用okhttp时，将其设置到sslSocketFactory中。

OkHttpClient httpClient = new OkHttpClient().newBuilder()
                .sslSocketFactory(getSLLContext().getSocketFactory())
                .build();