Android okhttp3.0 框架使用總結(jié)

最近工作主要用到OkHttp3.0網(wǎng)絡請求框架,進行Get請求,Post請求,多文件上傳等功能,本文內(nèi)容大部分來源于網(wǎng)上博文,僅做個人總結(jié)記錄

以下內(nèi)容來源其他博文:
在使用OKHttp之前,首先要先了解如下幾個比較核心的類:

OkHttpClient:客戶端對象
Request:訪問請求,Post請求中需要包含RequestBody
RequestBody:請求數(shù)據(jù),在Post請求中用到
Response:即網(wǎng)絡請求的響應結(jié)果
MediaType:數(shù)據(jù)類型,用來表明數(shù)據(jù)是json,image,pdf等一系列格式
client.newCall(request).execute():同步的請求方法
client.newCall(request).enqueue(Callback callBack):異步的請求方法,但Callback是執(zhí)行在子線程中的,因此不能在此進行UI更新操作

GitHub地址

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

依賴庫導入

使用前需要先在項目中添加OkHttp的依賴庫,在對應的Module的gradle中添加如下語句,目前最新應該是3.7.0

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

此外,OkHttp內(nèi)部以來另外一個開源庫Oklo

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

添加網(wǎng)絡權限

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

一、GET請求

OkHttp支持同步和異步的網(wǎng)絡請求,demo代碼如下:

同步GET請求

        //1.創(chuàng)建OkHttpClient對象
        OkHttpClient okHttpClient = new OkHttpClient();
        //2.創(chuàng)建Request對象,設置一個url地址(百度地址),設置請求方式。
        Request request = new Request.Builder()
                      .url("http://www.baidu.com")
                      .get()
                      .build();
        //3.創(chuàng)建一個call對象,參數(shù)就是Request請求對象
        Call call = okHttpClient.newCall(request);
        //4.同步調(diào)用會阻塞主線程,這邊在子線程進行
        new Thread(new Runnable() {
                @Override
                public void run() {
                    try {
                        //同步調(diào)用,返回Response,會拋出IO異常
                        Response response = call.execute();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
            }).start();

異步GET請求

        //1.創(chuàng)建OkHttpClient對象
        OkHttpClient okHttpClient = new OkHttpClient();
        //2.創(chuàng)建Request對象,設置一個url地址(百度地址),設置請求方式。
        Request request = new Request.Builder()
              .url("http://www.baidu.com")
              .get()
              .build();
        //3.創(chuàng)建一個call對象,參數(shù)就是Request請求對象
        Call call = okHttpClient.newCall(request);
        //4.請求加入調(diào)度,重寫回調(diào)方法
        call.enqueue(new Callback() {
            //請求失敗執(zhí)行的方法
            @Override
            public void onFailure(Call call, IOException e) {
                String err = e.getMessage().toString();
            }
            //請求成功執(zhí)行的方法
            @Override
            public void onResponse(Call call, Response response) throws IOException {
                  final String rtn = response.body().string();
                  runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                    }
                  );
            }
        });

需要注意的是,異步調(diào)用的回調(diào)函數(shù)是在子線程當中的,因為需要用Handler或者runOnUiThread來更新UI

二、POST類型

在OkHttp中用Post方法向服務器發(fā)送一個請求體時,請求體需要是一個RequestBody。這個請求體可以是:

key-value:鍵值對類型
String:字符串類型
Form:類似于Html的表單數(shù)據(jù)提交
Stream:流類型
File:文件類型

三、Post 鍵值對

        //1.創(chuàng)建OkHttpClient對象
        OkHttpClient okHttpClient = new OkHttpClient();

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

        //2.創(chuàng)建Request對象,設置一個url地址(百度地址),設置請求方式。
        Request request = new Request.Builder()
              .url("http://www.baidu.com")
              .post(requestBodyPost )
              .build();
        //3.創(chuàng)建一個call對象,參數(shù)就是Request請求對象
        Call call = okHttpClient.newCall(request);
        //4.請求加入調(diào)度,重寫回調(diào)方法
        call.enqueue(new Callback() {
            //請求失敗執(zhí)行的方法
            @Override
            public void onFailure(Call call, IOException e) {
                String err = e.getMessage().toString();
            }
            //請求成功執(zhí)行的方法
            @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 字符串

有時候我們會有要傳送字符串的需要,比如向服務器發(fā)送一個JSON字符串。那么就可以用如下方法:

        //1.創(chuàng)建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.創(chuàng)建Request對象,設置一個url地址(百度地址),設置請求方式。
        Request request = new Request.Builder()
              .url("http://www.baidu.com")
              .post(requestBody )
              .build();
        //3.創(chuàng)建一個call對象,參數(shù)就是Request請求對象
        Call call = okHttpClient.newCall(request);
        //4.請求加入調(diào)度,重寫回調(diào)方法
        call.enqueue(new Callback() {
            //請求失敗執(zhí)行的方法
            @Override
            public void onFailure(Call call, IOException e) {
                String err = e.getMessage().toString();
            }
            //請求成功執(zhí)行的方法
            @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數(shù)據(jù)

      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("http://www.lxweimin.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("http://www.lxweimin.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/*";  
}

同時上傳文件加上鍵值對參數(shù)的方法:

        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)方法將輸入流轉(zhuǎn)為Bitmap然后顯示出來,然后將圖片保存到本地存儲卡根目錄下
記得要申請存儲卡的寫權限

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

參考博文

Android OkHttp的基本用法
Android 網(wǎng)絡編程之最新OKHTTP:3.9.0
android獲取文件getMimeType的方法

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,797評論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,179評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,628評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,642評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,444評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 54,948評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,040評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,185評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,717評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,602評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,794評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,316評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,045評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,418評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,671評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,414評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,750評論 2 370

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 134,779評論 18 139
  • http://blog.csdn.net/lmj623565791/article/details/4791108...
    測天測地測空氣閱讀 1,450評論 1 6
  • 前言 在Android開發(fā)中,發(fā)送HTTP請求是很常見的。SDK中自帶的HttpURLConnection雖然能基...
    Jowney閱讀 790評論 0 5
  • 一大早,我們做了半個小時的船,來到山腳下。只見一條臺階小路,一直向山頂,我們沿小路向上行走。漸漸的,隱隱約約聽到了...
    劉姝娣123閱讀 409評論 0 0
  • “杏花讓我飛出露臺 在三月里飛翔 我思念遠方說出的話語: '請觸碰我,讓我飲馬山泉。'” 一只貓吃掉了一只飛蛾 我...
    水檻閱讀 275評論 10 9