Android MVP+Retrofit+dagger2+RxAndroid架構整合（6）----Retrofit篇

作者:hwj3747

轉載請注明

Retrofit 是什麼

Retrofit 是一套 RESTful 架構的 Android（Java）用戶端實作，基于注解，輕量級且安全的網絡請求架構。

Retrofit具有如下優勢：

使用注解的方式簡化了寫用戶端接口的方法，并且注解一目了然，簡單易懂。
使用簡單結構清晰，能清晰的表達出整個流程。
擴充性強，支援使用者自定義業務邏輯和interceptor。
原生支援RxJava，可以很好的支援RxJava式的傳回結果處理。
可以直接把服務端請求的資料轉化為java對象，如json，xml資料直接轉化為對象。

基本用法

Retrofit1.x版本的使用比較簡單，首先定義一個攔截器，在攔截器裡面設定請求參數等資訊：

RequestInterceptor requestInterceptor = request -> {
            request.addHeader("Accept", "text/html");
            request.addHeader("os","Android");
            request.addHeader("ver","1");
        };

然後建立一個RestAdapter設定基礎URL，攔截器，日志列印等：

RestAdapter restAdapter = new RestAdapter.Builder()
                .setEndpoint("http://baike.baidu.com/api/openapi")
                .setRequestInterceptor(requestInterceptor)
                .setLogLevel(RestAdapter.LogLevel.FULL)
                        // .setClient(new OkClient(new OkHttpClient()))
                .build();

最後建立一個通路接口的API接口類：

public interface AbsApi {
        @GET("BaikeLemmaCardApi")
        Observable<jsonOut>
        getBaidu(@Query("bk_key")String key);//擷取資訊
    }

再建立一個接口執行個體就可以用過這個接口執行個體範文伺服器接口了：

AbsApi  mAbsApi = restAdapter.create(AbsApi.class);

相對于1.x版本，Retrofit2.0版本有幾個不一樣的地方：

必須指定OKHttp支援。
基礎URL一定要以“/”結尾。
要手動指定資料格式支援，Retrofit1.x預設以Gson支援。
列印日志的interceptor必須手動添加。

在Retrofit2.0中，首先建立一個OKHttp用戶端,添加日志支援，以及固定請求參數設定

//添加強定請求參數執行個體
Interceptor addQueryParameterInterceptor = new Interceptor() {
            @Override
            public Response intercept(Chain chain) throws IOException {
                Request originalRequest = chain.request();
                Request request;
                String method = originalRequest.method();
                Headers headers = originalRequest.headers();
                HttpUrl modifiedUrl = originalRequest.url().newBuilder()
                        // Provide your custom parameter here
                        .addQueryParameter("scope", "103")
                        .addQueryParameter("format", "json")
                        .addQueryParameter("appid", "379020")
                        .addQueryParameter("bk_length", "600")
                        .build();
                request = originalRequest.newBuilder().url(modifiedUrl).build();
                return chain.proceed(request);
            }
        };

//列印日志
        HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();

//建立OkHttp用戶端
OkHttpClient client = new OkHttpClient.Builder()
                .addInterceptor(interceptor)
                .addInterceptor(addQueryParameterInterceptor)
                .retryOnConnectionFailure(true)
                .connectTimeout(15, TimeUnit.SECONDS)
                .build();

然後用Retrofit類加載OKHttp用戶端：

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(FORUM_SERVER_URL)
                .client(client)
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .addConverterFactory(GsonConverterFactory.create(gson))
                .build();

其他步驟與1.x一樣。

###Retrofit的常用注解

對于一般性的GET請求，注解如下：

@GET("BaikeLemmaCardApi")
        Observable<jsonOut>
        getBaidu(@Query("bk_key")String key);//擷取新聞，直接将傳回資料轉化為JsonOut對象，bk_key為請求的參數

對于POST請求，有兩種方法，第一種把請求的資料組裝成一個對象直接用對象送出，第二種是用表單的方式一個一個資料單個送出：

@POST("user/register")
        Observable<jsonOut>
        register(@Body PostRegister register);//注冊
 
@FormUrlEncoded
@POST("user/register")
        Observable<jsonOut>
        register(@Field("username") String username,@Field("password") String password,);//注冊

對于上傳圖檔的處理，把圖檔轉化為TypedFile 類型，用@Multipart注解送出：

@Multipart
        @POST("sys/upload")
        Observable<jsonOut>
        uploadFile(@Part("file") TypedFile file);//上傳圖檔

對于REST接口：

@GET("news/{id}/getNews")
        Observable<jsonOut>
        getNews(@Path("id") String id);//擷取新聞

封裝Retrofit網絡請求：

public class AbsService {

    private static final String FORUM_SERVER_URL = "http://baike.baidu.com/api/openapi/";//基礎URL
    private AbsApi mAbsApi;
    private volatile static AbsService singleton;
    final static Gson gson = new GsonBuilder()
            .setDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
            .serializeNulls()
            .create();

    public AbsService() {
//公共參數
        Interceptor addQueryParameterInterceptor = new Interceptor() {
            @Override
            public Response intercept(Chain chain) throws IOException {
                Request originalRequest = chain.request();
                Request request;
                String method = originalRequest.method();
                Headers headers = originalRequest.headers();
                HttpUrl modifiedUrl = originalRequest.url().newBuilder()
                        // Provide your custom parameter here
                        .addQueryParameter("scope", "103")
                        .addQueryParameter("format", "json")
                        .addQueryParameter("appid", "379020")
                        .addQueryParameter("bk_length", "600")
                        .build();
                request = originalRequest.newBuilder().url(modifiedUrl).build();
                return chain.proceed(request);
            }
        };

//列印日志
        HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
        interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
        OkHttpClient client = new OkHttpClient.Builder()
                .addInterceptor(interceptor)
                .addInterceptor(addQueryParameterInterceptor)
                .retryOnConnectionFailure(true)
                .connectTimeout(15, TimeUnit.SECONDS)
                .build();


        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(FORUM_SERVER_URL)
                .client(client)
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .addConverterFactory(GsonConverterFactory.create(gson))
                .build();
        mAbsApi = retrofit.create(AbsApi.class);
    }
    public AbsApi getApi() {

        return mAbsApi;
    }

//在這裡定義，服務端的各種請求
    public interface AbsApi {
        @GET("BaikeLemmaCardApi")
        Observable<jsonOut>
        getBaidu(@Query("bk_key")String key);//擷取新聞
    }

    public static AbsService getInstance() {//以單例模式通路AbsService 
        if (singleton == null) {
            synchronized (AbsService.class) {
                if (singleton == null) {
                    singleton = new AbsService();
                }
            }
        }
        return singleton;
    }

    public static AbsApi getService(){
        return getInstance().mAbsApi;
    }
}

在通路的時候，在Presenter層隻要建立一個AbsService 執行個體，直接調用這個方法就可以了，異步傳回的資料處理在onNext方法進行：

AbsService mAbsService=new AbsService();
        mAbsService.getApi().getBaidu(key).subscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread()).subscribe(new Observer<jsonOut>() {
            @Override
            public void onCompleted() {

            }

            @Override
            public void onError(Throwable e) {

            }

            @Override
            public void onNext(jsonOut jsonOut) {

            }
        });

優化

對于伺服器傳回的資料，我們一般采用這種格式：

{
	"code": 1,
	"message": "success",
	"data": {
	}
}

是以，我們可以寫一個模闆：

public class AbsReturn<V> {
    String message;
    V data;
    int  code;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public V getData() {
        return data;
    }

    public void setData(V data) {
        this.data = data;
    }


    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }
}

在寫接口的時候就可以這樣定義,以便于以後，對結果進行統一判斷處理：

@GET("BaikeLemmaCardApi")
        Observable<AbsReturn<jsonOut>>
        getBaidu(@Query("bk_key")String key);

這樣就基本完成了Retrofit2.0的封裝，如有錯誤的地方，歡迎交流指正，謝謝～

Android MVP+Retrofit+dagger2+RxAndroid架構整合（6）----Retrofit篇

目錄

Retrofit 是什麼

基本用法

封裝Retrofit網絡請求：

優化

繼續閱讀

Java小案例——随機數猜測随機數猜測

nginx location中斜線的位置的重要性

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

Android APK檔案反編譯Android APK檔案反編譯

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method