安卓基础学习 Day23 |HTTP框架-OkHttp3

写在前面的话

1、主要参考自：https://b23.tv/FABE0n
2、内容如果有不对的，希望可以指出或补充。
3、新知识。

一、概述

OKHttp：是一个高效的HTTP客户端。支持get请求和post请求，支持基于Http/https的（大）文件上传和下载，支持加载图片，支持连接同一个地址的链接共享同一个socket（计算机之间进行通信的一种约定或一种方式），通过连接池来减小响应延迟，还有下载文件透明的GZIP压缩（网站压缩加速的一种技术），请求缓存等优势。用于替代HttpUrlConnection和AsyncHttpClient。

其核心主要有：路由、连接协议、拦截器（主要是指添加、移除或转换请求或回应的头部信息）、代理、安全性认证、连接池以及网络适配。

这个框架也是square公司开源的一个网络请求库（okhttp内部依赖okio）。已被Google使用在Android源码上。

以下的测试都是在同一个文件中进行的。

二、GET和POST请求（原生OKHttp）

OKHttp使用时必须在子线程中执行。

（一）步骤展示

1 依赖

对应的build.gradle文件

项目清单文件

2 布局

3 代码

MainActivity.java

package com.example.testokhttp;

import androidx.appcompat.app.AppCompatActivity;

import android.os.Bundle;
import android.os.Handler;
import android.os.Message;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;

import java.io.IOException;

import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

public class MainActivity extends AppCompatActivity implements View.OnClickListener {
    private static final int GET = 1;
    private static final int POST = 2;

    private Button btnGet,btnPost;
    private TextView tvResult;
    private OkHttpClient client = new OkHttpClient();

    //解决不能在子线程中显示在文本上
    private Handler handler = new Handler(){
        @Override
        public void handleMessage(Message msg) {
            super.handleMessage(msg);
            switch (msg.what){
                case GET:
                    tvResult.setText((String) msg.obj);//获取数据
                    break;
                case POST:
                    tvResult.setText((String) msg.obj);//获取数据
                    break;
            }
        }
    };

    //编码配置
    public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        //获取控件
        btnGet = findViewById(R.id.btn_get);
        btnPost = findViewById(R.id.btn_post);
        tvResult = findViewById(R.id.tv_result);
        //设置点击事件
        btnGet.setOnClickListener(this);
        btnPost.setOnClickListener(this);
    }

    @Override
    //点击事件
    public void onClick(View v) {
        switch (v.getId()){
            //使用原生的okhttp请求网络数据-get、post
            case R.id.btn_get:
                getDataFromGet();
                break;
            case R.id.btn_post:
                getDataFromPost();
                break;
        }
    }

    //开启子线程，调get方法
    private void getDataFromGet() {
        //new一个子线程
        new Thread(){
            @Override
            public void run() {
                super.run();
                try {
                    String result = get("http://wwww.baidu.com");

                    Message msg = Message.obtain();
                    msg.what = GET;
                    msg.obj = result;//携带返回的数据
                    handler.sendMessage(msg);//发到这
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }.start();
    }
    //开启子线程，调post方法
    private void getDataFromPost() {
        //new一个子线程
        new Thread(){
            @Override
            public void run() {
                super.run();
                try {
                    String result = post("https://api.github.com/markdown/raw","");

                    Message msg = Message.obtain();
                    msg.what = POST;
                    msg.obj = result;//携带返回的数据
                    handler.sendMessage(msg);//发到这
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }.start();
    }

    //异步GET请求-默认get请求
    private String get(String url) throws IOException{
        Request request = new Request.Builder()
                .url(url)
                .build();
        Response response = client.newCall(request).execute();
        return response.body().string();
    }
    //post请求
    //参数-json：上传数据时需要
    private String post(String url, String json) throws IOException{
        RequestBody body = RequestBody.create(JSON, json);

        Request request = new Request.Builder()
                .url(url)
                .post(body)//
                .build();
        Response response = client.newCall(request).execute();
        return response.body().string();
    }
}

（二）效果展示

运行结果如下。

三、OkHttpUtils（封装的OKHttp库）

OkHttpUtils相较OkHttp使用更简便。

（一）GET和POST请求

在上一个例子测试中进行-继续。

可解决原生的GET和POST请求（上个例子）不能直接的进行网络请求，需要再new个子线程。
1、步骤展示

1 依赖

2 布局

在上一个例子的布局中的Button控件下再做如下添加：

    <!--OkHttpUtils-->
    <Button
        android:id="@+id/btn_get_okhttputils"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="GET请求ByOkHttpUtils"
        android:textAllCaps="false"
        android:textSize="15sp"/>
    <Button
        android:id="@+id/btn_post_okhttputils"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="POST请求ByOkHttpUtils"
        android:textAllCaps="false"
        android:textSize="15sp"/>

3 代码

在上一个例子的MainActivity.java中做如下添加：


其中的方法实现部分

    /**OkHttpUtils 异步GET请求
     *只是的execute()代表同步的方法调用
     */
    public void getDataGetByOkHttpUtils(){
        String url = "http://www.baidu.com/";
        OkHttpUtils
                .get()//默认也是get请求
                .url(url)
                .id(100)
                .build()
                .execute(new MyStringCallback());//代表是异步
    }
    /**OkHttpUtils POST请求
     *
     */
    public void getDataPostByOkHttpUtils(){
        String url = "http://www.csdn.net/";
        OkHttpUtils
                .post()
                .url(url)
                .build()
                .execute(new MyStringCallback());//代表是异步
    }
    public class MyStringCallback extends StringCallback{

        @Override
        public void onError(Call call, Exception e, int id) {
            e.printStackTrace();
            tvResult.setText("onError"+e.getMessage());//出错显示的信息，在页面上
        }

        @Override
        public void onResponse(String response, int id) {
            tvResult.setText("onResponse"+response);
            //id对应提示
            switch (id){
                case 100:
                    Toast.makeText(MainActivity.this,"http",Toast.LENGTH_SHORT).show();
                    break;
                case 101:
                    Toast.makeText(MainActivity.this,"https",Toast.LENGTH_SHORT).show();
                    break;
            }
        }

        @Override
        //进度
        public void inProgress(float progress, long total, int id){
            Log.e(TAG,"inProgress:"+progress);
        }
    }

2、效果展示

运行结果如下。

（二）下载大文件

Day24。
也是在以上例子中接着进行的。

1、步骤展示

1 在项目文件中做如下添加：

2 在布局中做如下添加、更改：

3 在MainActivity.java中做如下添加：

获取控件以及绑定事件监听器、点击事件略（类似之前的例子）

方法的实现部分：

    /**
     * 使用OkHttpUtils下载大文件
     */
    public void downloadFile(){
        //随便在网上找的一个视频，复制的链接
        String url = "https://vd4.bdstatic.com/mda-mar13wu160fw2gn3/v1-cae/1080p/mda-mar13wu160fw2gn3.mp4?" +
                "v_from_s=tc_haokanvideoui_5488&auth_key=1612615469-0-0-75462382d598bb7127a4693952c69150" +
                "&bcevod_channel=searchbox_feed&pd=1&pt=3&abtest=8_1";
        OkHttpUtils
                .get()
                .url(url)
                .build()
                .execute(new FileCallBack(Environment.getExternalStorageDirectory().getAbsolutePath(),
                        "okhttp-utils-test.mp4") {//下载到sdcard根目录下

                    @Override
                    public void onBefore(Request request, int id) {
                    }

                    @Override
                    //进度
                    public void inProgress(float progress, long total, int id) {
                        Bar.setProgress((int) (100 * progress));
                        Log.e(TAG, "inProgress："+(int)(100*progress));
                        //
                        int inProgress = (int)(100*progress);
                        if(inProgress == 100) {
                            Toast.makeText(MainActivity.this, "下载成功", Toast.LENGTH_SHORT).show();
                        }
                    }

                    @Override
                    public void onError(Call call, Exception e, int id) {
                        Log.e(TAG, "onError :" + e.getMessage());
                    }

                    @Override
                    public void onResponse(File response, int id) {
                        Log.e(TAG, "onResponse :" + response.getAbsolutePath());//下载到的路径
                    }

                });
    }

2、效果展示

运行结果如下：

验证查看：

找到下载的文件。

在保存的位置打开。

（三）请求图片-单张

在以上例子中接着进行。

1、步骤展示

1 在布局中做如下添加：

2 在MainActivity.java中做如下添加：

获取控件以及绑定事件监听器、点击事件略（类似之前的例子）

主要方法的实现：

    /**
     * 使用OkHttpUtils请求图片
     *
     */
    public void getImageByOkHttpUtils(){
        tvResult.setText("");
        String url = "https://ss0.bdstatic.com/70cFuHSh_Q1YnxGkpoWK1HF6hhy/it/u=3456825387," +
                "270175843&fm=26&gp=0.jpg";
        OkHttpUtils
                .get()
                .url(url)
                .tag(this)
                .build()
                .connTimeOut(20000)//链接超时
                .readTimeOut(20000)
                .writeTimeOut(20000)
                .execute(new BitmapCallback() {
                    @Override
                    public void onError(Call call, Exception e, int id) {
                        tvResult.setText("onError:"+e.getMessage());
                    }

                    @Override
                    public void onResponse(Bitmap response, int id) {
                        Log.e("TAG","onResponse:complete");
                        Img.setImageBitmap(response);//显示图片
                    }
                });
    }

2、效果展示

运行结果如下。

四、补充

1、Okhttp3基本使用

2、Socket技术详解

3、下载地址

4、Android 一个改善的okHttp封装库

5、okhttp在https连接中出现java.net.ProtocolException: Expected ‘:status’ header not present的解决办法