Android OkHttp3 知识总结

1 开始使用

// okhttp:3.8.0 里面引用了 okio:1.13.0
compile 'com.squareup.okhttp3:okhttp:3.8.0'
//MockWebServer
//testCompile 'com.squareup.okhttp3:mockwebserver:3.8.0'

  • 默认客户端
String url = "https://github.com/";
final OkHttpClient okHttpClient=new OkHttpClient();
  • 设置请求超时
okHttpClient = new OkHttpClient.Builder()
        .connectTimeout(10, TimeUnit.SECONDS)
        .writeTimeout(10, TimeUnit.SECONDS)
        .readTimeout(30, TimeUnit.SECONDS)
        .build();
  • 设置缓存
File sdcache = getExternalCacheDir();
int cacheSize = 10 * 1024 * 1024;
okHttpClient = new OkHttpClient.Builder()
        .cache(new Cache(sdcache.getAbsoluteFile(), cacheSize));
        .build();

2 GET

  • 同步 GET
   final Request request=new Request.Builder().url(url).build();
        //get
       new Thread(new Runnable() {
           @Override
           public void run() {
               //
               try {
                   Response response=okHttpClient.newCall(request).execute();
                   if (response.isSuccessful()){
                       String body=response.body().string();
                       String headers=response.headers().toString();
                       Log.i("zfq", "run: ");
                   }else {
                       Log.e("zfq", "run: "+response.code()+response.message());
                   }
                   Log.i("zfq", "run: ");
               } catch (IOException e) {
                   e.printStackTrace();
               }

               //
           }
       }).start();

   
  • 异步 GET
     //get
     okHttpClient.newCall(request).enqueue(null);
     //
        okHttpClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                Log.e("zfq", "onFailure: "+e.getMessage());
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                String body=response.body().string();
                String headers=response.headers().toString();
                Log.i("zfq", "onResponse: ");
            }
        });

3 POST

  • 异步、同步不再赘述
  • MediaType
    /**
     * "application/x-www-form-urlencoded",是默认的MIME内容编码类型,一般可以用于所有的情况,但是在传输比较大的二进制或者文本数据时效率低。
这时候应该使用"multipart/form-data"。如上传文件或者二进制数据和非ASCII数据。
     */
    public static final MediaType MEDIA_TYPE_NORAML_FORM = MediaType.parse("application/x-www-form-urlencoded;charset=utf-8");
    
    //既可以提交普通键值对,也可以提交(多个)文件键值对。
    public static final MediaType MEDIA_TYPE_MULTIPART_FORM = MediaType.parse("multipart/form-data;charset=utf-8");
   
    //只能提交二进制,而且只能提交一个二进制,如果提交文件的话,只能提交一个文件,后台接收参数只能有一个,而且只能是流(或者字节数组)
    public static final MediaType MEDIA_TYPE_STREAM = MediaType.parse("application/octet-stream");
    
    public static final MediaType MEDIA_TYPE_TEXT = MediaType.parse("text/plain;charset=utf-8");
    
    public static final MediaType MEDIA_TYPE_JSON = MediaType.parse("application/json;charset=utf-8");

  • POST String

  MediaType MEDIA_TYPE_TEXT = MediaType.parse("text/plain;charset=utf-8");
        String str = "AndroidContent";
        RequestBody requestBody=RequestBody.create(MEDIA_TYPE_TEXT,str);
        Request requestPost=new Request.Builder().url(url).post(requestBody).build();
        
  • POST Json

  MediaType MEDIA_TYPE_JSON= MediaType.parse("application/json; charset=utf-8");
        String jsonStr = "[\"Android\",\"Java\",\"C#\"]";
        RequestBody requestBody=RequestBody.create(MEDIA_TYPE_JSON,jsonStr);
        Request requestPost=new Request.Builder().url(url).post(requestBody).build();
        
  • POST Params
        String paramsStr="name=zfq&qq=1212";
        MediaType MEDIA_TYPE_NORAML_FORM = MediaType.parse("application/x-www-form-urlencoded;charset=utf-8");
        RequestBody requestBody=RequestBody.create(MEDIA_TYPE_NORAML_FORM,paramsStr);
        Request requestPost=new Request.Builder().url(url).post(requestBody).build();
        

  • POST File
 MediaType MEDIA_TYPE_MARKDOWN = MediaType.parse("text/x-markdown; charset=utf-8");
       File file = new File("README.md");
       Request request = new Request.Builder()
                    .url("https://api.github.com/markdown/raw")
                    .post(RequestBody.create(MEDIA_TYPE_MARKDOWN, file))
                    .build();
        Response response = okHttpClient.newCall(request).execute();
  • POST Stream
final MediaType MEDIA_TYPE_MARKDOWN = MediaType.parse("text/x-markdown; charset=utf-8");
        File file = new File("README.md");
        final FileInputStream fileInputStream1=new FileInputStream(file);
        RequestBody requestBody1=new RequestBody() {
            @Nullable
            @Override
            public MediaType contentType() {
                return MEDIA_TYPE_MARKDOWN;
            }

            @Override
            public void writeTo(BufferedSink sink) throws IOException {
                OutputStream outputStream=sink.outputStream();
                int length;
                byte[] buffer = new byte[1024];
                while ((length = fileInputStream1.read(buffer)) != -1) {
                    outputStream.write(buffer, 0, length);
                }
            }
        };

        RequestBody requestBody2=new RequestBody() {
            @Nullable
            @Override
            public MediaType contentType() {
                return MEDIA_TYPE_MARKDOWN;
            }

            @Override
            public void writeTo(BufferedSink sink) throws IOException {
                int length;
                byte[] buffer = new byte[1024];
                while ((length = fileInputStream1.read(buffer)) != -1) {
                    sink.write(buffer, 0, length);
                }
            }
        };

        Request request = new Request.Builder()
                .url(url)
                .post(requestBody1)
                .build();

4 返回类型

Response response=okHttpClient.newCall(requestPost).execute();
//
            String string=response.body().string();//
            byte[] bytes= response.body().bytes();//
            InputStream inputStream=response.body().byteStream();//
            Reader reader=response.body().charStream();//
            
            ……
            
            //文件保存
               FileOutputStream fileOutputStream = new FileOutputStream(new File(
                    "android.jpg"));
            //
            int length;
            byte[] buffer = new byte[1024];
            while ((length = inputStream.read(buffer)) != -1) {
               // System.out.println(length);
                fileOutputStream.write(buffer, 0, length);
            }

5 Headers

  • 设置请求头
  Request request = new Request.Builder()
                .url(url)
                .header("headerKey1", "headerValue1")// 设置请求头
                .headers(Headers headers)// 批量设置请求头
                .addHeader("headerKey2", "headerValue2")// 追加请求头
                .removeHeader("headerKey2")//去除请求头
                .build();
  • 获取请求头
        Response response=okHttpClient.newCall(request).execute();
        response.header("responseHeader");
        response.header("responseHeader", "defaultValue");
        //
        Headers headers = response.headers();
      

6 Form Params

  • 其实FormBody内部就是封装了
MediaType CONTENT_TYPE =MediaType.parse("application/x-www-form-urlencoded");
  • 所以就是相当于【3 POST Params 】
  RequestBody formBody = new FormBody.Builder()
                .add("platform", "android")
                .add("name", "dasd")
                .add("subject", "231321")
                .build();
Request request = new Request.Builder().url(url).post(formBody).build();

7 MultipartBody 上传文件同时传其他字段

  • MultipartBody extends RequestBody
    RequestBody requestBody = new MultipartBody.Builder()
                .setType(MultipartBody.FORM)
                .addPart()
                .addFormDataPart("title", "Square Logo")
                .addFormDataPart("image", "logo-square.png",
                        RequestBody.create(MEDIA_TYPE_PNG, new File("website/static/logo-square.png")))
                .build();

        Request request = new Request.Builder()
                .header("Authorization", "Client-ID " + IMGUR_CLIENT_ID)
                .url("https://api.imgur.com/3/image")
                .post(requestBody)
                .build();

8 配合 Gson

  Response response = okHttpClient.newCall(request).execute();
        if (response.isSuccessful()){
        User user = new Gson().fromJson(response.body().charStream(), User.class);
        }

9 取消请求

  
        call.cancel();//取消请求,不能取消已经准备完成的请求
        
        okHttpClient.dispatcher().cancelAll();//取消所有请求

参考文章

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,053评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,527评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,779评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,685评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,699评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,609评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,989评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,654评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,890评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,634评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,716评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,394评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,976评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,950评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,191评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,849评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,458评论 2 342

推荐阅读更多精彩内容