前言

開門見山，本文記錄瞭如何接入並使用square出品的retrofit網路框架。

一、準備工作

• 新增retrofit 的依賴（或直接使用jar包）

這邊並不能直接連線網路，所以直接下載jar包並使用了

• 新增okio依賴或引用jar包

新增jar包之後，還要新增okio的jar包，不然會報錯

java.lang.NoClassFoundError:okio.Buffer

• 新增converter-gson的依賴或引用jar包

由於程式碼中要解析資料到實體類裡，retrofit是預設用的Gson來轉換的，而且官方也給了一個轉換的包，使用也很簡單，直接用GsonConverterFactory.create()就能直接轉換：

         Retrofit retrofit = new Retrofit.Builder().baseUrl(THost.Host)
            .addConverterFactory(GsonConverterFactory.create())
            .build();

• 新增okhttp的依賴或引用jar包

這裡直接下載的最新版的okhttp的jar包，版本為okhttp-3.8.0，如果不加，則會報錯：

• 新增Gson的依賴

這裡有個坑，就是gson版本不能太低，這邊原本使用的是gson 2.2.4，結果請求是正常的，但是解析會出錯，無法得到想要的資料，在onFailure方法裡打的log如下：

請求是正常的，抓包顯示返回正常，但是方法裡跑不到onResponse，而是進了onFailure，log顯示java.lang.NoSuchMethodError: com.google.gson.Gson.newJsonReader

解決方法是用最新的gson包就行了。這邊使用的是gson 2.8.0

總結下，新增的依賴就是這些了：

二、開始使用

以一個簡單的登入為例，需求如下：

請求地址為http://app.test.com/testapp.php

請求方式為POST，引數有username和pwd，以及一個action，通過表單傳送到伺服器

我們先定義一個介面類，裡面有一個login方法

public interface TestApiService {

    @FormUrlEncoded
    @POST("http://app.test.com/testapp.php")
    Call<TPHPResult<TLogin>> login ( @Field("username") String username,
                                     @Field("pwd") String pwd,
                                     @Field("action") String aciton ) ;
} 

這裡用註解表明了login方法的引數形式

• @Field註解代表引數為表單格式，key為username，value在呼叫的時候傳入。
• @POST註解裡面放的是請求的url地址。

由於引數以表單形式提交，所以方法上還要加@FormUrlEncoded註解

然後再在MainActivity裡使用這個方法來實現登入：

public class MainActivity extends AppCompatActivity {

    private String token ;
    private int uid ;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        Retrofit retrofit = new Retrofit.Builder().baseUrl("http://app.test.com/testapp.php/")
                .addConverterFactory(GsonConverterFactory.create())
                .build();

        TestApiService service = retrofit.create(TestApiService.class);

        Call<TPHPResult<TLogin>> loginCall = service.login("Naruto", "123456","login");

        //enqueue是非同步的，所以可以直接在主執行緒請求網路
        loginCall.enqueue(new Callback<TPHPResult<TLogin>>() {
                @Override
                public void onResponse(Call<TPHPResult<TLogin>> call, Response<TPHPResult<TLogin>> response) {

                    if (response.code() == 200) {
                        TLogin loginInfo = response.body().getData() ;

                        token = loginInfo.getToken() ;
                        uid = loginInfo.getUid() ;

                        getUserInfo();
                    }
                }

                @Override
                public void onFailure(Call<TPHPResult<TLogin>> call, Throwable throwable) {
                    Toast.makeText(MainActivity.this,"登入錯誤： " + throwable.toString(),Toast.LENGTH_SHORT).show(); ;
                }
            });
    }
}

在上面可以看到，我們的請求地址末尾是不帶”/”的，直接請求帶”/”的url會報錯404 Not Found，但是程式碼裡的baseUrl裡的url為何又有”/”呢？

這是因為，在retrofit2.0以後，規定baseUrl裡面的url，必須以”/”結尾，不然會報錯：

這裡要打個岔，說明下伺服器介面的定義方式了。

一般來說，很多後臺開發人員，都會把呼叫的方法名字直接放到請求url的後面，比如：
http://app.test.com/testapp.php/login
針對這種定義方式，在請求時，就很簡單，只需在baseUrl裡放http://app.test.com/testapp.php/

Retrofit retrofit = new Retrofit.Builder().baseUrl("http://app.test.com/testapp.php/")
//略...

，然後在login方法的@POST註解裡面放上login，

@FormUrlEncoded
@POST("login")
Call<TPHPResult<TLogin>> login(...) //略......

就可以拼接成
http://app.test.com/testapp.php/login 了

然而，也有的後臺人員，定義介面時，讓客戶端把方法名字當做表單引數傳過來，如上面的action欄位，裡面的值為login，就是我們要請求的介面名字。

請求url永遠是一樣的，通過action來區別各個介面。

這種情況下，如果伺服器不做相容，那麼請求的url只能是不帶”/”的，不然就會404 Not Found。 但是由於retrofit 2.0的限制，baseUrl裡只能是帶”/”的url （http://app.test.com/testapp.php/），這樣是訪問不到伺服器的。怎麼辦呢？

我們可以在@POST裡面放真正的請求地址，這樣就能覆蓋掉baseUrl裡面的url了。那麼，為什麼不把.baseUrl("")去掉，只在@POST裡寫url呢？這是因為不寫會報錯呀 ：(

總結下使用方法：

首先定義請求的介面類（TestApiService），根據介面引數的格式（表單/鍵值對/body/etc），請求的格式（POST/GET/etc），以及返回結果T（TPHPResult），來宣告一個返回值為Call<T>的login方法

然後定義Retrofit 例項retrofig，通過retrofit例項的create方法建立一個介面類的例項service，呼叫service例項的login方法生成Call物件，然後再enqueue非同步將請求發出去，得到結果並在回撥中解析。

可以看得出來，實際上retrofit的使用還是很簡單的，當然，這也僅僅是入門而已，真正要用到實際業務上，就要考慮架構和封裝了。