Android okhttp3.0 框架使用总结

最近工作主要用到OkHttp3.0网络请求框架,进行Get请求,Post请求,多文件上传等功能,本文内容大部分来源于网上博文,仅做个人总结记录

以下内容来源其他博文:
在使用OKHttp之前,首先要先了解如下几个比较核心的类:

OkHttpClient:客户端对象
Request:访问请求,Post请求中需要包含RequestBody
RequestBody:请求数据,在Post请求中用到
Response:即网络请求的响应结果
MediaType:数据类型,用来表明数据是json,image,pdf等一系列格式
client.newCall(request).execute():同步的请求方法
client.newCall(request).enqueue(Callback callBack):异步的请求方法,但Callback是执行在子线程中的,因此不能在此进行UI更新操作

GitHub地址

OkHttp的GitHub地址是:OkHttp
OkIo的GitHub地址是:OkIo

依赖库导入

使用前需要先在项目中添加OkHttp的依赖库,在对应的Module的gradle中添加如下语句,目前最新应该是3.7.0

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

此外,OkHttp内部以来另外一个开源库Oklo

compile 'com.squareup.okio:okio:1.12.0'

添加网络权限

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

一、GET请求

OkHttp支持同步和异步的网络请求,demo代码如下:

同步GET请求

        //1.创建OkHttpClient对象
        OkHttpClient okHttpClient = new OkHttpClient();
        //2.创建Request对象,设置一个url地址(百度地址),设置请求方式。
        Request request = new Request.Builder()
                      .url("http://www.baidu.com")
                      .get()
                      .build();
        //3.创建一个call对象,参数就是Request请求对象
        Call call = okHttpClient.newCall(request);
        //4.同步调用会阻塞主线程,这边在子线程进行
        new Thread(new Runnable() {
                @Override
                public void run() {
                    try {
                        //同步调用,返回Response,会抛出IO异常
                        Response response = call.execute();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
            }).start();

异步GET请求

        //1.创建OkHttpClient对象
        OkHttpClient okHttpClient = new OkHttpClient();
        //2.创建Request对象,设置一个url地址(百度地址),设置请求方式。
        Request request = new Request.Builder()
              .url("http://www.baidu.com")
              .get()
              .build();
        //3.创建一个call对象,参数就是Request请求对象
        Call call = okHttpClient.newCall(request);
        //4.请求加入调度,重写回调方法
        call.enqueue(new Callback() {
            //请求失败执行的方法
            @Override
            public void onFailure(Call call, IOException e) {
                String err = e.getMessage().toString();
            }
            //请求成功执行的方法
            @Override
            public void onResponse(Call call, Response response) throws IOException {
                  final String rtn = response.body().string();
                  runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                    }
                  );
            }
        });

需要注意的是,异步调用的回调函数是在子线程当中的,因为需要用Handler或者runOnUiThread来更新UI

二、POST类型

在OkHttp中用Post方法向服务器发送一个请求体时,请求体需要是一个RequestBody。这个请求体可以是:

key-value:键值对类型
String:字符串类型
Form:类似于Html的表单数据提交
Stream:流类型
File:文件类型

三、Post 键值对

        //1.创建OkHttpClient对象
        OkHttpClient okHttpClient = new OkHttpClient();

        FormBody.Builder mBuild = new FormBody.Builder();
        mBuild.add("aa", "bb")
        .add("cc", 1);
        RequestBody requestBodyPost = mBuild.build();        

        //2.创建Request对象,设置一个url地址(百度地址),设置请求方式。
        Request request = new Request.Builder()
              .url("http://www.baidu.com")
              .post(requestBodyPost )
              .build();
        //3.创建一个call对象,参数就是Request请求对象
        Call call = okHttpClient.newCall(request);
        //4.请求加入调度,重写回调方法
        call.enqueue(new Callback() {
            //请求失败执行的方法
            @Override
            public void onFailure(Call call, IOException e) {
                String err = e.getMessage().toString();
            }
            //请求成功执行的方法
            @Override
            public void onResponse(Call call, Response response) throws IOException {
                  final String rtn = response.body().string();
                  //获取返回码
                  final String code = String.valueOf(response.code())
                  runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                    }
                  );
            }
        });

四、Post 字符串

有时候我们会有要传送字符串的需要,比如向服务器发送一个JSON字符串。那么就可以用如下方法:

        //1.创建OkHttpClient对象
        OkHttpClient okHttpClient = new OkHttpClient();
        //RequestBody中的MediaType指定为纯文本,编码方式是utf-8
        RequestBody requestBody = RequestBody.create(MediaType.parse("text/plain;charset=utf-8"),
                "{username:admin;password:admin}");
        //2.创建Request对象,设置一个url地址(百度地址),设置请求方式。
        Request request = new Request.Builder()
              .url("http://www.baidu.com")
              .post(requestBody )
              .build();
        //3.创建一个call对象,参数就是Request请求对象
        Call call = okHttpClient.newCall(request);
        //4.请求加入调度,重写回调方法
        call.enqueue(new Callback() {
            //请求失败执行的方法
            @Override
            public void onFailure(Call call, IOException e) {
                String err = e.getMessage().toString();
            }
            //请求成功执行的方法
            @Override
            public void onResponse(Call call, Response response) throws IOException {
                  final String rtn = response.body().string();
                  //获取返回码
                  final String code = String.valueOf(response.code())
                  runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                    }
                  );
            }
        });

也可以直接Post Json数据

      public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
     OkHttpClient client = new OkHttpClient();
     RequestBody body = RequestBody.create(JSON, json);
     Request request = new Request.Builder()
      .url("http://www.baidu.com")
      .post(body)
      .build();
      ...

五、Post提交表单

        OkHttpClient client = new OkHttpClient();
        MultipartBody.Builder mBuild = new MultipartBody.Builder()
                .setType(MultipartBody.FORM)
                .addFormDataPart("username", "xxx")
                .addFormDataPart("password", "xxx");
        RequestBody requestBody= mBuild.build();       
        final Request request = new Request.Builder()
                .url("//www.greatytc.com/")
                .post(requestBody)
                .build();
        ...

六、Post提交多文件

        OkHttpClient http = new OkHttpClient();
        MultipartBody.Builder mBody = new MultipartBody.Builder().setType(MultipartBody.FORM);
        int i = 0;
        for(String filePath :filelist) {
            File file = new File(filePath);
            if (!file.exists()){
                Toast.makeText(MainActivity.this,"上传"+filePath+"文件不存在!", Toast.LENGTH_SHORT).show();
                continue;
            }
            String  fileMimeType = getMimeType(file);
            //这里获取文件类型,方法自己定义
            MediaType mediaType = MediaType.parse(fileMimeType);
            RequestBody fileBody = RequestBody.create(mediaType, file);
            mBody.addFormDataPart("file" + i, file.getName(), fileBody);
            i++;
        }
        RequestBody requestBody = mBody.build();
        Request requestPostFile = new Request.Builder()
                .url("//www.greatytc.com/")
                .post(requestBody)
                .build();
         ...

android获取文件getMimeType的方法

      private static String getSuffix(File file) {  
            if (file == null || !file.exists() || file.isDirectory()) {  
                return null;  
            }  
            String fileName = file.getName();  
            if (fileName.equals("") || fileName.endsWith(".")) {  
                return null;  
            }  
            int index = fileName.lastIndexOf(".");  
            if (index != -1) {  
                return fileName.substring(index + 1).toLowerCase(Locale.US);  
            } else {  
                return null;  
            }  
    }  
  
    public static String getMimeType(File file){  
          String suffix = getSuffix(file);  
            if (suffix == null) {  
                return "file/*";  
            }  
            String type = MimeTypeMap.getSingleton().getMimeTypeFromExtension(suffix);  
            if (type != null || !type.isEmpty()) {  
                return type;  
            }  
            return "file/*";  
}

同时上传文件加上键值对参数的方法:

        RequestBody multipartBody = new MultipartBody.Builder()
        .setType(MultipartBody.ALTERNATIVE)
        .addFormDataPart("aa","bb")
        .addFormDataPart("cc",1)
        .addFormDataPart("file",filename,fileBody)*/
        .build();

七、下载图片

OkHttpClient client = new OkHttpClient();
        final Request request = new Request
                .Builder()
                .get()
                .url("http://avatar.csdn.net/B/0/1/1_new_one_object.jpg")
                .build();
        Call call = client.newCall(request);
        call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                ToastUtil.showToast(DownImageActivity.this, "下载图片失败");
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                InputStream inputStream = response.body().byteStream();
                //将图片显示到ImageView中
                final Bitmap bitmap = BitmapFactory.decodeStream(inputStream);
                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        iv_result.setImageBitmap(bitmap);
                    }
                });
                //将图片保存到本地存储卡中
                File file = new File(Environment.getExternalStorageDirectory(), "image.png");
                FileOutputStream fileOutputStream = new FileOutputStream(file);
                byte[] temp = new byte[128];
                int length;
                while ((length = inputStream.read(temp)) != -1) {
                    fileOutputStream.write(temp, 0, length);
                }
                fileOutputStream.flush();
                fileOutputStream.close();
                inputStream.close();
            }
        });

指定图片地址并下载成功后,获取图片的输入流,先用Bitmap decodeStream(InputStream is)方法将输入流转为Bitmap然后显示出来,然后将图片保存到本地存储卡根目录下
记得要申请存储卡的写权限

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

参考博文

Android OkHttp的基本用法
Android 网络编程之最新OKHTTP:3.9.0
android获取文件getMimeType的方法

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • http://blog.csdn.net/lmj623565791/article/details/4791108...
    测天测地测空气阅读 1,426评论 1 6
  • 前言 在Android开发中,发送HTTP请求是很常见的。SDK中自带的HttpURLConnection虽然能基...
    Jowney阅读 782评论 0 5
  • 一大早,我们做了半个小时的船,来到山脚下。只见一条台阶小路,一直向山顶,我们沿小路向上行走。渐渐的,隐隐约约听到了...
    刘姝娣123阅读 405评论 0 0
  • “杏花让我飞出露台 在三月里飞翔 我思念远方说出的话语: '请触碰我,让我饮马山泉。'” 一只猫吃掉了一只飞蛾 我...
    水槛阅读 265评论 10 9