Retrofit的簡單實用（get post 下載文件）

原創 流星魂小七 2020-02-22 05:46

       最近工作用到 Retrofit，以前的知識有些忘記了，又去網上查，覺得挺麻煩的，就自己寫篇博客記錄一下，方便自己以後查看。這裏主要寫Retrofit的使用。

 Retrofit的使用步驟。
 1.添加Retrofit庫的依賴和網絡權限：
        compile 'com.squareup.retrofit2:retrofit:2.2.0'// Retrofit庫
        compile 'com.squareup.retrofit2:converter-gson:2.3.0'
        <uses-permission android:name="android.permission.INTERNET" />

 2.創建 用於描述網絡請求 的接口
         Retrofit將 Http請求 抽象成 Java接口：採用 註解 描述網絡請求參數 和配置網絡請求參數

 3.創建Retrofit實例（這裏可以設置回調代碼運行的線程，默認回調代碼運行在主線程，可以自己設置運行在主線程或者子線程。）

 4.將服務器返回的數據封裝成一個bean類，用於接收服務器返回的數據。

 5.發送請求
 請求分爲同步請求和異步請求

主要就分爲這幾部，下面來具體介紹：

1.添加Retrofit庫的依賴和網絡權限（只需要網絡權限，本文中用到了本地存儲下載的文件，所以加的存儲讀寫權限）：

    compile 'com.squareup.retrofit2:retrofit:2.2.0'// Retrofit庫
    compile 'com.squareup.retrofit2:converter-gson:2.3.0'//返回的數據是json的，用到了gson解析

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

2.創建 用於描述網絡請求 的接口，Retrofit將 Http請求 抽象成 Java接口：採用 註解 描述網絡請求參數 和配置網絡請求參數

import okhttp3.ResponseBody;
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Query;
import retrofit2.http.Streaming;
import retrofit2.http.Url;
/**
 *   創建 用於描述網絡請求 的接口
 *   Retrofit將 Http請求 抽象成 Java接口：採用 註解 描述網絡請求參數 和配置網絡請求參數
 */
public interface ApiService {
    //測試 get
    @GET("ajax.php?a=fy&f=auto&t=auto&w=hello")
    Call<ResponseInfo> testGet();

    //測試 post
    @POST("ajax.php?a=fy&f=auto&t=auto")
    Call<ResponseInfo> testPost(@Query("w") String w);

    //測試 下載文件
    @Streaming
    @GET
    Call<ResponseBody> testDownload(@Url String fileUrl);
    
}

3.創建Retrofit實例（這裏可以設置回調代碼運行的線程，默認回調代碼運行在主線程，可以自己設置運行在主線程或者子線程。）

get 請求和 post請求 創建的 Retrofit實例（不指定回調運行的線程，默認運行在主線程）

// 創建Retrofit實例時需要通過Retrofit.Builder,並調用baseUrl方法設置URL。
//Retrofit2的baseUlr 必須以 /（斜線）結束，不然會拋出一個IllegalArgumentException
        retrofit = new Retrofit.Builder()
                .baseUrl("http://fy.iciba.com/") // 設置 網絡請求 Url
                .addConverterFactory(GsonConverterFactory.create()) //設置使用Gson解析(記得加入依賴)
                .build();

文件下載 的 Retrofit 實例  （指定回調運行的線程，指定運行在子線程中，因爲受到文件之後要做io流的操作）

 Retrofit retrofitLoaddown = new Retrofit.Builder()
                .baseUrl("http://imtt.dd.qq.com/")
                //通過線程池獲取一個線程，指定callback在子線程中運行。
                .callbackExecutor(Executors.newSingleThreadExecutor())
                .build();
4.將服務器返回的數據封裝成一個bean類，用於接收服務器返回的數據。
/**
 * 講服務器返回的數據封裝成一個bean類
 */
public class ResponseInfo {
    public Content content;
    public int status;

    public ResponseInfo() {

    }

    public ResponseInfo(Content content, int status) {
        this.content = content;
        this.status = status;
    }

    @Override
    public String toString() {
        return "ResponseInfo{" +
                "content=" + content +
                ", status=" + status +
                '}';
    }

    class Content {
        public String ph_am;
        public String ph_am_mp3;
        public String ph_en_mp3;
        public String ph_tts_mp3;
        public List<String> word_mean;

        public Content() {
        }

        public Content(String ph_am, String ph_am_mp3, String ph_en_mp3, String ph_tts_mp3, List<String> word_mean) {
            this.ph_am = ph_am;
            this.ph_am_mp3 = ph_am_mp3;
            this.ph_en_mp3 = ph_en_mp3;
            this.ph_tts_mp3 = ph_tts_mp3;
            this.word_mean = word_mean;
        }

        @Override
        public String toString() {
            return "Content{" +
                    "ph_am='" + ph_am + '\'' +
                    ", ph_am_mp3='" + ph_am_mp3 + '\'' +
                    ", ph_en_mp3='" + ph_en_mp3 + '\'' +
                    ", ph_tts_mp3='" + ph_tts_mp3 + '\'' +
                    ", word_mean=" + word_mean +
                    '}';
        }
    }
    
}

5.發送請求 。請求分爲同步請求和異步請求

          同步請求的代碼

 ApiService request = retrofit.create(ApiService.class);
        Call<ResponseInfo> call = request.testGet();// 封裝請求
        try {
            Response<ResponseInfo> execute = call.execute();
        } catch (IOException e) {
            e.printStackTrace();
        }

       同步請求比較簡單，我這裏主要講異步請求。

              下面分別是get請求post請求和下載文件的代碼

 public void testGet() {
        ApiService request = retrofit.create(ApiService.class);
        Call<ResponseInfo> call = request.testGet();// 封裝請求
        try {
            Response<ResponseInfo> execute = call.execute();
        } catch (IOException e) {
            e.printStackTrace();
        }
        call.enqueue(new Callback<ResponseInfo>() {// 發送網絡請求(異步)
            @Override
            public void onResponse(Call<ResponseInfo> call, Response<ResponseInfo> response) {//主線程中調用
                ResponseInfo body = response.body();
                Log.i("gao", "測試  get body = " + body + "  線程名字 = " + Thread.currentThread().getName());
                Toast.makeText(MainActivity.this, "測試GET= " + body.content.word_mean.get(0), Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onFailure(Call<ResponseInfo> call, Throwable t) {//主線程中調用
                Log.i("gao", " testGet onFailure " + "  線程名字 = " + Thread.currentThread().getName());
                Toast.makeText(MainActivity.this, " testGet onFailure ", Toast.LENGTH_SHORT).show();
            }
        });
    }

    public void testPost(String string) {
        ApiService request = retrofit.create(ApiService.class);
        Call<ResponseInfo> call = request.testPost(string);// 封裝請求
        call.enqueue(new Callback<ResponseInfo>() {// 發送網絡請求(異步)
            @Override
            public void onResponse(Call<ResponseInfo> call, Response<ResponseInfo> response) {
                ResponseInfo body = response.body();
                Log.i("gao", "測試  post body = " + body + "  線程名字 = " + Thread.currentThread().getName());
                Toast.makeText(MainActivity.this, "測試  post body = " + body, Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onFailure(Call<ResponseInfo> call, Throwable t) {
                Log.i("gao", "testPost onFailure " + "  線程名字 = " + Thread.currentThread().getName());
                Toast.makeText(MainActivity.this, "testPost onFailure ", Toast.LENGTH_SHORT).show();
            }
        });
    }

    public void testLoaddown(final String path, String url) {
        Retrofit retrofitLoaddown = new Retrofit.Builder()
                .baseUrl("http://imtt.dd.qq.com/")
                //通過線程池獲取一個線程，指定callback在子線程中運行。
                .callbackExecutor(Executors.newSingleThreadExecutor())
                .build();

        ApiService request = retrofitLoaddown.create(ApiService.class);
        Call<ResponseBody> call = request.testDownload(url);//當你填進去的url是完整url的時候，設置的baseurl是無效的
        call.enqueue(new Callback<ResponseBody>() {
            @Override
            public void onResponse(@NonNull Call<ResponseBody> call, @NonNull final Response<ResponseBody> response) {
                Log.i("gao", "測試    線程名字 = " + Thread.currentThread().getName());
                //將Response寫入到從磁盤中，詳見下面分析   注意，這個方法是運行在子線程中的
                writeResponseToDisk(path, response);
            }

            @Override
            public void onFailure(@NonNull Call<ResponseBody> call, @NonNull Throwable throwable) {
                Log.i("gao", "testLoaddown 網絡錯誤～ " + "  線程名字 = " + Thread.currentThread().getName());
                Toast.makeText(MainActivity.this, "testLoaddown 網絡錯誤～ ", Toast.LENGTH_SHORT).show();
            }
        });
    }

好了，主要就是這幾部，下面在發一下代碼中的MainActivity的代碼。

import android.app.Activity;
import android.os.Environment;
import android.os.Bundle;
import android.support.annotation.NonNull;
import android.util.Log;
import android.view.View;
import android.widget.Toast;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.concurrent.Executors;
import okhttp3.ResponseBody;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

/**
 * Retrofit的使用步驟。
 * 1.添加Retrofit庫的依賴和網絡權限：
 *        compile 'com.squareup.retrofit2:retrofit:2.2.0'// Retrofit庫
 *        compile 'com.squareup.retrofit2:converter-gson:2.3.0'
 *        <uses-permission android:name="android.permission.INTERNET" />
 *
 * 2.創建 用於描述網絡請求 的接口
 *         Retrofit將 Http請求 抽象成 Java接口：採用 註解 描述網絡請求參數 和配置網絡請求參數
 *
 * 3.創建Retrofit實例（回調默認的線程是主線程，可以自己設置運行在主線程或者子線程。）
 *
 * 4.將服務器返回的數據封裝成一個bean類，用於接收服務器返回的數據。
 *
 * 5.發送請求
 * 請求分爲同步請求和異步請求
 *
 *
 */
public class MainActivity extends Activity implements View.OnClickListener {
    Retrofit retrofit;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        findViewById(R.id.testGet).setOnClickListener(this);
        findViewById(R.id.testPost).setOnClickListener(this);
        findViewById(R.id.testLoaddown).setOnClickListener(this);

        // 創建Retrofit實例時需要通過Retrofit.Builder,並調用baseUrl方法設置URL。Retrofit2的baseUlr 必須以 /（斜線）結束，不然會拋出一個IllegalArgumentException
        retrofit = new Retrofit.Builder()
                .baseUrl("http://fy.iciba.com/") // 設置 網絡請求 Url
                .addConverterFactory(GsonConverterFactory.create()) //設置使用Gson解析(記得加入依賴)
                .build();

        //動態獲取權限
        AppPermission.isGrantExternalRW(this);
    }

    @Override
    public void onClick(View view) {
        switch (view.getId()) {
            case R.id.testGet:
                testGet();

                break;
            case R.id.testPost:
                testPost("hello");
                break;

            case R.id.testLoaddown:
                if (AppPermission.isGrantExternalRW(this)) {
                    String url = "http://imtt.dd.qq.com/16891/89E1C87A75EB3E1221F2CDE47A60824A.apk?fsname=com.snda.wifilocating_4.2.62_3192.apk&csr=1bbd";
                   testLoaddown(Environment.getExternalStorageDirectory() + "/ceshi.apk", url);
                }
                break;

        }

    }

    public void testGet() {
        ApiService request = retrofit.create(ApiService.class);
        Call<ResponseInfo> call = request.testGet();// 封裝請求
        try {
            Response<ResponseInfo> execute = call.execute();
        } catch (IOException e) {
            e.printStackTrace();
        }
        call.enqueue(new Callback<ResponseInfo>() {// 發送網絡請求(異步)
            @Override
            public void onResponse(Call<ResponseInfo> call, Response<ResponseInfo> response) {//主線程中調用
                ResponseInfo body = response.body();
                Log.i("gao", "測試  get body = " + body + "  線程名字 = " + Thread.currentThread().getName());
                Toast.makeText(MainActivity.this, "測試GET= " + body.content.word_mean.get(0), Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onFailure(Call<ResponseInfo> call, Throwable t) {//主線程中調用
                Log.i("gao", " testGet onFailure " + "  線程名字 = " + Thread.currentThread().getName());
                Toast.makeText(MainActivity.this, " testGet onFailure ", Toast.LENGTH_SHORT).show();
            }
        });
    }

    public void testPost(String string) {
        ApiService request = retrofit.create(ApiService.class);
        Call<ResponseInfo> call = request.testPost(string);// 封裝請求
        call.enqueue(new Callback<ResponseInfo>() {// 發送網絡請求(異步)
            @Override
            public void onResponse(Call<ResponseInfo> call, Response<ResponseInfo> response) {
                ResponseInfo body = response.body();
                Log.i("gao", "測試  post body = " + body + "  線程名字 = " + Thread.currentThread().getName());
                Toast.makeText(MainActivity.this, "測試  post body = " + body, Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onFailure(Call<ResponseInfo> call, Throwable t) {
                Log.i("gao", "testPost onFailure " + "  線程名字 = " + Thread.currentThread().getName());
                Toast.makeText(MainActivity.this, "testPost onFailure ", Toast.LENGTH_SHORT).show();
            }
        });
    }

    public void testLoaddown(final String path, String url) {
        Retrofit retrofitLoaddown = new Retrofit.Builder()
                .baseUrl("http://imtt.dd.qq.com/")
                //通過線程池獲取一個線程，指定callback在子線程中運行。
                .callbackExecutor(Executors.newSingleThreadExecutor())
                .build();

        ApiService request = retrofitLoaddown.create(ApiService.class);
        Call<ResponseBody> call = request.testDownload(url);//當你填進去的url是完整url的時候，設置的baseurl是無效的
        call.enqueue(new Callback<ResponseBody>() {
            @Override
            public void onResponse(@NonNull Call<ResponseBody> call, @NonNull final Response<ResponseBody> response) {
                Log.i("gao", "測試    線程名字 = " + Thread.currentThread().getName());
                //將Response寫入到從磁盤中，詳見下面分析   注意，這個方法是運行在子線程中的
                writeResponseToDisk(path, response);
            }

            @Override
            public void onFailure(@NonNull Call<ResponseBody> call, @NonNull Throwable throwable) {
                Log.i("gao", "testLoaddown 網絡錯誤～ " + "  線程名字 = " + Thread.currentThread().getName());
                Toast.makeText(MainActivity.this, "testLoaddown 網絡錯誤～ ", Toast.LENGTH_SHORT).show();
            }
        });
    }


    private void writeResponseToDisk(String path, Response<ResponseBody> response) {
        //從response獲取輸入流以及總大小
        writeFileFromIS(new File(path), response.body().byteStream(), response.body().contentLength());
    }

    private static int sBufferSize = 8192;

    //將輸入流寫入文件
    private void writeFileFromIS(File file, InputStream is, long totalLength) {

        //創建文件
        if (!file.exists()) {
            if (!file.getParentFile().exists())
                file.getParentFile().mkdir();
            try {
                file.createNewFile();
            } catch (IOException e) {
                e.printStackTrace();
                Log.i("gao", "創建文件錯誤～ " + "  線程名字 = " + Thread.currentThread().getName());
            }
        }

        OutputStream os = null;
        long currentLength = 0;
        try {
            os = new BufferedOutputStream(new FileOutputStream(file));
            byte data[] = new byte[sBufferSize];
            int len;
            while ((len = is.read(data, 0, sBufferSize)) != -1) {
                os.write(data, 0, len);
                currentLength += len;
                //計算當前下載進度
                Log.i("gao", "下載 進度 = " + (int) (100 * currentLength / totalLength));
            }
            //下載完成，並返回保存的文件路徑
            Log.i("gao","下載完成 file.getAbsolutePath() = "+file.getAbsolutePath());
        } catch (IOException e) {
            e.printStackTrace();
            Log.i("gao","下載失敗");
        } finally {
            try {
                is.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
            try {
                if (os != null) {
                    os.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

主要的內容就是這些，需要源代碼的朋友可以下載  文中例子的   源碼

下一篇我們將  Retrofit 和Rxjava的結合：Retrofit 和 Rxjava 的簡單實用

如果對 Rxjava 不懂的朋友可以看一下上篇博客： Rxjava的使用_1

流星魂小七
發佈了15 篇原創文章 · 獲贊 1 · 訪問量 6637
私信 關注
發表評論
所有評論
還沒有人評論，想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章

用逃避來面對過去

用逃避來面對過去   面對曾經的過失，因爲年輕所犯下的錯誤，總是懊悔中帶着些許自責！面對失去唯一可以拉近距離的機會，也有隱隱中的痛苦煎熬，因爲那已經無法挽回只會讓我變得措手不及；還有一些是因爲刻意躲避，更多的時候是茫然地站到了一邊，就這樣

Ackarlix 2020-07-07 23:44:56

搬運--domoticz的 MQTT API接口 函數英文

以下是我從domoticz 官網搬運來的 MQTT 的 API 接口函數 https://www.domoticz.com/wiki Domoticz API/JSON URL’s Jump to navigation Jump

战神-B 2020-07-07 22:22:03

記錄一次程序異常 添加一個函數之後整個程序邏輯運行錯誤 Stm32F407Vet6 keil5 啓動文件

畢設程序，修改了硬件之後 重新編譯 發生了未知的錯誤 ：有兩個屏幕的模塊  墨水屏和 OLED ； 當墨水屏的初始化程序加到總代碼中時  OLED 就無法顯示， 當去除墨水屏部分的代碼時程序就可以運行了。   原因是  棧  開的太小了

战神-B 2020-07-07 22:22:03

聯盛德畢業設計--01 JLink 下載器 無法下載程序問題 解決方法--DAP

準備用 W601 做一個畢業設計， 現在開始學習 W601.  （解決方法就是換一個DAP下載器，以下純屬扯淡） 學習 W601 第一步應該就是搭建一個開發平臺，我這裏使用的開發板是正點原子的  W601 開發板，開始的時候我是用的 Jl

战神-B 2020-07-07 22:21:53

愛情到底什麼時候死

                   愛情到底什麼時候死                   我一直奔跑在路上，                  

lovehuayue1314 2020-07-07 07:15:40

提筆忘字！

   拼音用的多了容易提筆忘字，所以我決定以後重新使用五筆！時間長了字根記不清了，現在要重新學習。這兩行字就是我用五筆打的，用了好幾分鐘，汗！

iteye_14413 2020-07-05 08:51:45

redis的jedis使用

首先第一步我們建一個普通的java項目，這裏比較簡單 就不寫了 第二步導入我們jedis用到的jar包       下面就是我寫的 demo  都是帶註釋的 寫的很清楚 package jedis; import org.junit

忘忆丶 2020-07-04 22:19:22

使用itext導出多個 數據庫中的富文本html標籤(帶佔位符可替換的)的word文檔並壓縮

首先引入 itext 需要的jar包  <dependency> <groupId>com.lowagie</groupId> <artifactId>iText</artifactId>

忘忆丶 2020-07-04 22:19:22

日常學習2017..18

    昨天主要講了嵌套循環，另外還有break爲中斷，打斷 結束當前循環。continue繼續，結束本次循環並且繼續循環 嵌套循環三要素:外打行，內打列，找規律。其中比較經典的程序有打印一個正方形，下面是程序。 public stat

忘忆丶 2020-07-04 22:19:22

日常學習2017.7.21

    方法和重載.    方法:函數,解決一些問題的過程,在程序裏面實現某些功能的代碼集合;   重載:在同一個類中,方法名一樣,參數類型,個數、順序至少一個不同。   數組的優缺點：數組在找數組中的某個參數非常方便，但是在插入或刪除

忘忆丶 2020-07-04 22:19:22

redis五種基本數據類型 常用操作命令

redis共有5種數據類型     一、string 賦值  set  name  zhangsan 取值  get name 刪除  del name 遞增 (需要先設置一個能遞增的數字字符串 set num 2)         

忘忆丶 2020-07-04 22:19:22

RxJava 進擊的Rx

Action 先看看 之前使用的代碼如果使用Action來代替Subscriber得到的代碼是這樣的 Observable.just("Hi", "Man") .subscribe(new Acti

花前月下的细说 2020-07-07 15:32:06

詳細講解下Hook技術,以Hook點擊事件來示範

Hook技術:  Hook就是有一段程序邏輯一直走下去,我們可以捕獲到其中間的一些邏輯,加於處理然後再讓他接着執行下去; 比如Android裏面的setOnclickListener這個方法. 正常我們是這樣操作的 Te

AncelyF 2020-07-07 14:52:16

初探Retrofit使用方法

概念Retrofit框架是Square公司出品的網絡框架，效率快、實現簡單。運用註解和動態代理，極大簡化網絡請求繁瑣步驟特點    性能好、處理快，使用簡單；默認使用okhttp處理網絡請求；默認使用Gson解析。常用註解接口    Re

Androider_Zxg 2020-07-07 08:50:36

Android 網絡請求：Retrofit 使用

Android 網絡請求：Retrofit 使用 網絡請求：retrofit+okhttp3 示例項目： 有妹子的日報 MeiZiNews 總結：結合 RxJava 使用得十分的爽。如果沒有用到 RxJava，個人感覺這樣使用和用 Ok

changhaiSmile 2020-07-05 21:56:14