Android開發之Retrofit小試牛刀

yungfan發表於2017-01-07
Android

感覺好久沒有寫Android的文章了，囧囧囧！因為Retrofit實在是太火了， 火得我一直躍躍欲試，但是由於種種原因吧，一直都沒有用過。週末閒來無事，利用一個以前開發中用過的伺服器API來小試牛刀一下，非常簡單，記錄自己的第一次Retrofit之旅。

重要說明：由於涉及到商業機密，所以對請求的資料和伺服器地址進行了處理。自己實驗時，請換成自己的伺服器。

一、新增依賴、配置專案

這一步就不詳細說了，會的都會，基本就是新增兩個依賴和網路訪問許可權。

compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'

<uses-permission android:name="android.permission.INTERNET" />
複製程式碼

二、根據伺服器端返回的JSON資料配置自己的JavaBean

在專案中用Retrofit的時候，肯定和伺服器端的哥們商量好了如何互動，也就是說已經知曉了伺服器端會返回什麼樣的資料（基本都是JSON，只是內容不一樣而已），這些資料你可以直接用字串接收，然後自己處理，但是這麼low的事情，Retrofit肯定可以幫我處理了，用上面的converter-gson就可以自動將JSON轉成我們的物件，前提是需要與返回的JSON欄位進行對映，預設情況下欄位名一樣就不會出什麼問題，但是我卻踩了一個坑，下文會介紹。

  • 伺服器端返回的JSON資料如下：
{"message":"ok","list":["id":"","abstract":"","title":"","url":""},...]
複製程式碼
  • 根據上面的JSON資料建立JavaBean
import com.google.gson.annotations.SerializedName;
import java.util.List;

/**
 * Created by yangfan on 2017/1/7.
 */

//與伺服器端資料進行欄位對映
public class NewsInfo {
  
    private String message;
    private List<News> list;

    public String getMessage() {
        return message;
    }

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

    public List<News> getList() {
        return list;
    }

    public void setList(List<News> list) {
        this.list = list;
    }


    public static class News {

        private String id;
        //@SerializedName：後面是伺服器端返回的資料欄位名 可以與本地不一樣 該關鍵字就是用來對映的
        @SerializedName("abstract")
        private String _abstract;
        private String title;
        private String url;

        public String getId() {
            return id;
        }

        public void setId(String id) {
            this.id = id;
        }

        public String get_abstract() {
            return _abstract;
        }

        public void set_abstract(String _abstract) {
            this._abstract = _abstract;
        }

        public String getTitle() {
            return title;
        }

        public void setTitle(String title) {
            this.title = title;
        }

        public String getUrl() {
            return url;
        }

        public void setUrl(String url) {
            this.url = url;
        }
    }
}

複製程式碼

踩坑記錄：伺服器端居然有一個abstract欄位，但是這個是Java關鍵字啊，怎麼辦？用@SerializedName告訴Retrofit，我想你把該欄位對映成我自定義的名字。

配置訪問伺服器API的介面

這個就是真正的訪問伺服器的本地API了，我這裡只用了GET，其實遠不止這個功能，可以參考官方文件。

import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Query;

/**
 * Created by yangfan on 2017/1/7.
 */
public interface NewsInterface {

    //獲取伺服器的新聞列表，由於新聞型別和分頁顯示的需要，需要傳遞三個引數
    @GET("news/list")
    Call<NewsInfo> newsList(@Query("type") String type, @Query("pn") String pn, @Query("ps") String ps);

}
複製程式碼

Activity

配置好以上資訊以後，就可以開始寫Android的程式了。因為我的程式比較簡單，所以我很快就成功獲取資料了，這一塊沒怎麼踩坑。

public class MainActivity extends AppCompatActivity {

    private TextView tvResult;
    //伺服器的基地址 與  @GET("news/list")拼接
    private static final String baseUrl = "http://伺服器地址/";

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

        tvResult = (TextView) findViewById(R.id.tvResult);

        initRetrofit();
    }

    private void initRetrofit() {

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


        NewsInterface newsInterface = retrofit.create(NewsInterface.class);

        Call<NewsInfo> callNewsInfo = newsInterface.newsList("1", "1", "10");

        callNewsInfo.enqueue(new Callback<NewsInfo>() {
            @Override
            public void onResponse(Call<NewsInfo> call, Response<NewsInfo> response) {
                //成功
                if (response.code() == 200) {
                    //將返回的資料轉換成自定義的物件
                    NewsInfo newsInfo = response.body();

                    if(newsInfo.getMessage().equals("ok")){
                        //最爽的地方---直接可以進行UI操作
                        tvResult.setText(newsInfo.getList().get(0).get_abstract());
                    }
                } else {
                    //請求失敗
                    tvResult.setText("查詢失敗！響應碼為：" + response.code());
                }
            }

            @Override
            public void onFailure(Call<NewsInfo> call, Throwable t) {
                //請求失敗
                t.printStackTrace();
                tvResult.setText("查詢失敗！錯誤原因：" + t.getCause());
            }
        });

    }
}

複製程式碼

執行結果

Retrofit小試牛刀.gif

Retrofit功能非常強大，我也看了很多文件，上面用的只是冰山一角。目前感覺最大的好處就是可以直接在回撥中操作主執行緒的UI，再也不需要用Handler了，其他牛逼的功能和好處待學習、待發掘。

相關文章