Android 网络请求框架 OkHttp 的使用

窗台的花花

已于 2023-06-21 11:16:24 修改

阅读量1.8w

点赞数 16

分类专栏： Android 文章标签： android 网络 java

于 2018-03-04 22:20:26 首次发布

本文链接：https://blog.csdn.net/qq_40116418/article/details/79438674

版权

Android 专栏收录该内容

85 篇文章

订阅专栏

本文详细介绍了OkHttp的使用方法及优势，包括替代HttpUrlConnection的原因、如何实现GET和POST请求、同步与异步的区别、拦截器的应用以及图片上传的实现。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一.OkHttp的历史和意义
一个处理网络请求的开源项目,是安卓端最火热的轻量级框架,由移动支付Square公司贡献(该公司还贡献了Picasso)
用于替代HttpUrlConnection和Apache HttpClient(android API23 6.0里已移除HttpClient,现在已经打不出来)。
尽管Google在大部分安卓版本中推荐使用HttpURLConnection，但是这个类相比HttpClient实在是太难用，太弱爆了。

OkHttp是一个相对成熟的解决方案，据说Android4.4的源码中可以看到HttpURLConnection已经替换成OkHttp实现了。

优点：
允许连接到同一个主机地址的所有请求,提高请求效率
共享Socket,减少对服务器的请求次数
通过连接池,减少了请求延迟
缓存响应数据来减少重复的网络请求
减少了对数据流量的消耗

自动处理GZip压缩

二.OkHttp实现Get请求

1.引入包

compile 'com.squareup.okhttp3:okhttp:3.3.0'

compile 'com.squareup.okio:okio:1.5.0'

compile 'com.google.code.gson:gson:2.6.2'

2.权限

<uses-permission android:name="android.permission.INTERNET"/>

Call是一个请求任务，enqueue是执行

CallBack是请求回调。

请求成功后数据封装在response的body里面。注意：

这些事在子线程里面。如果想更新Ui,还是需要在子线程里面。

最简单的使用:

三. OkHttp实现Post请求

关键代码：

四. OkHttp中同步和异步方法区别

五. OkHttp的拦截器和日志处理

拦截器是一种强大的机制,可以监视、重写和重试调用.下面是一个简单例子,拦截发出的请求和传入的响应的日志.

利用logger打印完整的okhttp网络请求和响应日志_hyb1234hi的专栏-CSDN博客

六. OkHttp的实现图片上传

实际代码展示:

------------------MainActivity-------------------

package com.gjl.day08_ok;

import android.content.Context;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.view.ViewGroup;
import android.widget.BaseAdapter;
import android.widget.Button;
import android.widget.ListView;
import android.widget.TextView;
import android.widget.Toast;

import java.util.List;

public class MainActivity extends AppCompatActivity implements View.OnClickListener{
   private String key = "2f41498b35e69877fc56dc96776e5d1f";
   private String url = "http://v.juhe.cn/toutiao/index?type=top&key="+key;
   private Button get;
   private ListView listView;

   @Override
   protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);

      initViews();

   }

   private void initViews() {
      get = findViewById(R.id.get);
      get.setOnClickListener(this);
      listView = findViewById(R.id.listview);
   }

   @Override
   public void onClick(View v) {
      //创建OKHttpClient对象
      OKHttpUitls okHttpUitls = new OKHttpUitls();
      okHttpUitls.get(url);
      okHttpUitls.setOnOKHttpGetListener(new OKHttpUitls.OKHttpGetListener() {
         @Override
         public void error(String error) {
            Toast.makeText(MainActivity.this,error,Toast.LENGTH_SHORT).show();
         }

         @Override
         public void success(String json) {
            Toast.makeText(MainActivity.this,json,Toast.LENGTH_SHORT).show();
         }
      });
   }


   //adapter
   class MyAdapter extends BaseAdapter{

      private final Context context;
      private final List<NewsBean.ResultBean.DataBean> list;

      public MyAdapter(Context context, List<NewsBean.ResultBean.DataBean> list){
         this.context = context;
         this.list = list;
      }

      @Override
      public int getCount() {
         return list.size();
      }

      @Override
      public Object getItem(int position) {
         return null;
      }

      @Override
      public long getItemId(int position) {
         return 0;
      }

      @Override
      public View getView(int position, View convertView, ViewGroup parent) {

         TextView textView = new TextView(context);
         textView.setText(list.get(position).getTitle());
         return textView;
      }
   }
}

----------------OKHttpUitls---------------------

package com.gjl.day08_ok;

import android.os.Handler;
import android.os.Message;
import android.util.Log;

import java.io.IOException;
import java.util.logging.LogRecord;

import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

/**
 * OKHttp网络请求工具类
 * get
 * post
 * 上传图片
 */

public class  OKHttpUitls {
   private OKHttpGetListener onOKHttpGetListener;
   private MyHandler myHandler = new MyHandler();
   private static final String TAG = "OKHttpUitls";
   // /get
   public void get(String url){
      OkHttpClient client = new OkHttpClient();
      //创建请求对象
      Request request = new Request.Builder().url(url).build();
      //创建Call请求队列
      //请求都是放到一个队列里面的
      Call call = client.newCall(request);

      Log.d(TAG, "get() returned: " + call+"------------");
      //开始请求
      call.enqueue(new Callback() {
         //       失败，成功的方法都是在子线程里面，不能直接更新UI
         @Override
         public void onFailure(Call call, IOException e) {
            Message message = myHandler.obtainMessage();
            message.obj = "请求失败";
            message.what = 0;
            myHandler.sendMessage(message);
         }

         @Override
         public void onResponse(Call call, Response response) throws IOException {
            Message message = myHandler.obtainMessage();
            String json = response.body().string();
            message.obj = json;
            message.what = 1;
            myHandler.sendMessage(message);
         }
      });
   }
   //使用接口回到，将数据返回
   public interface OKHttpGetListener{
      void error(String error);
      void success(String json);
   }
   //给外部调用的方法
   public void setOnOKHttpGetListener(OKHttpGetListener onOKHttpGetListener){
      this.onOKHttpGetListener = onOKHttpGetListener;
   }
   //使用Handler，将数据在主线程返回
   class MyHandler extends Handler {
      @Override
      public void handleMessage(Message msg) {
         int w = msg.what;
         Log.d(TAG, "handleMessage() returned: " +msg );
         if (w ==0){
            String error = (String) msg.obj;
            onOKHttpGetListener.error(error);
         }
         if (w==1){
            String json = (String) msg.obj;
            onOKHttpGetListener.success(json);
         }
      }
   }
}

---------------NewsBean------------------

package com.gjl.day08_ok;

import java.util.List;

/**
 * Created by Administrator on 2018/1/3 0003.
 */

public class NewsBean {


   private String reason;
   private ResultBean result;
   private int error_code;

   public String getReason() {
      return reason;
   }

   public void setReason(String reason) {
      this.reason = reason;
   }

   public ResultBean getResult() {
      return result;
   }

   public void setResult(ResultBean result) {
      this.result = result;
   }

   public int getError_code() {
      return error_code;
   }

   public void setError_code(int error_code) {
      this.error_code = error_code;
   }

   public static class ResultBean {
     

      private String stat;
      private List<DataBean> data;

      public String getStat() {
         return stat;
      }

      public void setStat(String stat) {
         this.stat = stat;
      }

      public List<DataBean> getData() {
         return data;
      }

      public void setData(List<DataBean> data) {
         this.data = data;
      }

      public static class DataBean {
         
         private String uniquekey;
         private String title;
         private String date;
         private String category;
         private String author_name;
         private String url;
         private String thumbnail_pic_s;
         private String thumbnail_pic_s02;
         private String thumbnail_pic_s03;

         public String getUniquekey() {
            return uniquekey;
         }

         public void setUniquekey(String uniquekey) {
            this.uniquekey = uniquekey;
         }

         public String getTitle() {
            return title;
         }

         public void setTitle(String title) {
            this.title = title;
         }

         public String getDate() {
            return date;
         }

         public void setDate(String date) {
            this.date = date;
         }

         public String getCategory() {
            return category;
         }

         public void setCategory(String category) {
            this.category = category;
         }

         public String getAuthor_name() {
            return author_name;
         }

         public void setAuthor_name(String author_name) {
            this.author_name = author_name;
         }

         public String getUrl() {
            return url;
         }

         public void setUrl(String url) {
            this.url = url;
         }

         public String getThumbnail_pic_s() {
            return thumbnail_pic_s;
         }

         public void setThumbnail_pic_s(String thumbnail_pic_s) {
            this.thumbnail_pic_s = thumbnail_pic_s;
         }

         public String getThumbnail_pic_s02() {
            return thumbnail_pic_s02;
         }

         public void setThumbnail_pic_s02(String thumbnail_pic_s02) {
            this.thumbnail_pic_s02 = thumbnail_pic_s02;
         }

         public String getThumbnail_pic_s03() {
            return thumbnail_pic_s03;
         }

         public void setThumbnail_pic_s03(String thumbnail_pic_s03) {
            this.thumbnail_pic_s03 = thumbnail_pic_s03;
         }
      }
   }
}

--------------------activity_main.xml------------------

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    tools:context="com.gjl.day08_ok.MainActivity">

    <Button
        android:id="@+id/get"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="get请求"/>

    <ListView
        android:id="@+id/listview"
        android:layout_width="match_parent"
        android:layout_height="wrap_content">

    </ListView>
</LinearLayout>

2021年11月1日附加：OkHttp3的使用

    implementation("com.squareup.okhttp3:okhttp:4.9.2")

最新依赖查看github

一个比较全面的工具类：

OkHttp封装_星空2021的博客-CSDN博客