[关闭]
@linux1s1s 2016-11-19T01:58:48.000000Z 字数 9798 阅读 1622

Android 开源库 - Retrofit

AndroidRefine 2016-11

系列博文
Android 开源库 - OkHttp
Android 开源库 - Retrofit
Android 开源库 - Okio
Android 开源库 - Fresco

Retrofit是什么

我们用官网的一句话概括：
A type-safe HTTP client for Android and Java

为什么要用Retrofit

Retrofit用来简化Client API请求，尤其适用于REST API

如何使用

我们通过一个简单的demo来直观感受一下Retrofit，此damo使用retrofit:2.1.0版本

配置

build.gradle配置

  1. // OkHttp
  2. compile 'com.squareup.okhttp3:okhttp:3.4.2'
  3. // OkIo
  4. compile 'com.squareup.okio:okio:1.11.0'
  6. //Retrofit
  7. compile 'com.squareup.retrofit2:retrofit:2.1.0'
  9. //Maven Address
  10. // https://mvnrepository.com/artifact/com.squareup.retrofit2/
  12. //Converter: Gson
  13. compile group: 'com.squareup.retrofit2', name: 'converter-gson', version: '2.1.0'
  14. //Converter: Jackson
  15. //    compile group: 'com.squareup.retrofit2', name: 'converter-jackson', version: '2.1.0'
  16. //Converter: Protocol Buffers
  17. compile group: 'com.squareup.retrofit2', name: 'converter-protobuf', version: '2.1.0'
  18. //Converter: Wire Protocol Buffers
  19. compile group: 'com.squareup.retrofit2', name: 'converter-wire', version: '2.1.0'
  20. //Converter: Moshi
  21. compile group: 'com.squareup.retrofit2', name: 'converter-moshi', version: '2.1.0'
  22. //Converter: SimpleXML
  23. //    compile group: 'com.squareup.retrofit2', name: 'converter-simplexml', version: '2.1.0'
  24. //Converter: Java Scalars
  25. compile group: 'com.squareup.retrofit2', name: 'converter-scalars', version: '2.1.0'

AndroidManifest.xml

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <manifest xmlns:android="http://schemas.android.com/apk/res/android"
  3.     package="okhttp.mutex.com.okhttpdemo">
  5.     <uses-permission android:name="android.permission.INTERNET" />
  6.     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  8.     <application
  9.         android:allowBackup="true"
  10.         android:icon="@mipmap/ic_launcher"
  11.         android:label="@string/app_name"
  12.         android:supportsRtl="true"
  13.         android:theme="@style/AppTheme">
  16.         <activity android:name=".MainActivity">
  17.             <intent-filter>
  18.                 <action android:name="android.intent.action.MAIN" />
  20.                 <category android:name="android.intent.category.LAUNCHER" />
  21.             </intent-filter>
  22.         </activity>
  23.     </application>
  25. </manifest>

补充说明：

  • retrofit 2.1.0 依赖okHttp，而okHttp依赖okIo
  • 需要选择至少一种Converter，这里选择Gson作为Converter
  • retrofit提供了上面列出来的Converter，如果不满足你的要求，可以自己做扩展
选择测试API

为了验证retrofit，这里选择度娘最近低调发布的API Store，进一步选择天狗药店大全。

  1. {
  2.     "status": true,
  3.     "tngou": [{
  4.         "address": "浦东新区周浦镇康沈路2578号",
  5.         "area": 3,
  6.         "business": "中成药、化学药制剂、抗生素、生化药品、生物制品",
  7.         "charge": "张杰",
  8.         "count": 80,
  9.         "createdate": 1347984000000,
  10.         "fcount": 0,
  11.         "id": 79037,
  12.         "img": "/store/081302/1d2a3c03ff722604bb6abd1e15c61a4c.jpg",
  13.         "leader": "李赢",
  14.         "legal": "李金锋",
  15.         "message": "",
  16.         "name": "上海好药师德高药店",
  17.         "number": "沪CA0140423",
  18.         "rcount": 0,
  19.         "supervise": 12,
  20.         "tel": "",
  21.         "type": "零售连锁企业加盟店",
  22.         "url": "",
  23.         "waddress": "****** ;",
  24.         "x": 121.582,
  25.         "y": 31.0968,
  26.         "zipcode": "200001"
  27.     }]
  28. }
生成POJO

然后做好POJO类，Android Studio可以利用插件GsonFormat快速生成，可以参考Android Studio Plugins

  1. import java.io.Serializable;
  2. import java.util.List;
  4. public class Info implements Serializable {
  7.     /**
  8.      * status : true
  9.      * tngou : [{"address":"浦东新区周浦镇康沈路2578号","area":3,"business":"中成药、化学药制剂、抗生素、生化药品、生物制品","charge":"张杰","count":80,"createdate":1347984000000,"fcount":0,"id":79037,"img":"/store/081302/1d2a3c03ff722604bb6abd1e15c61a4c.jpg","leader":"李赢","legal":"李金锋","message":"","name":"上海好药师德高药店","number":"沪CA0140423","rcount":0,"supervise":12,"tel":"","type":"零售连锁企业加盟店","url":"","waddress":"****** ;","x":121.582,"y":31.0968,"zipcode":"200001"}]
  10.      */
  12.     private boolean status;
  13.     private List<TngouBean> tngou;
  15.     public boolean isStatus() {
  16.         return status;
  17.     }
  19.     public void setStatus(boolean status) {
  20.         this.status = status;
  21.     }
  23.     public List<TngouBean> getTngou() {
  24.         return tngou;
  25.     }
  27.     public void setTngou(List<TngouBean> tngou) {
  28.         this.tngou = tngou;
  29.     }
  31.     public static class TngouBean {
  32.         /**
  33.          * address : 浦东新区周浦镇康沈路2578号
  34.          * area : 3
  35.          * business : 中成药、化学药制剂、抗生素、生化药品、生物制品
  36.          * charge : 张杰
  37.          * count : 80
  38.          * createdate : 1347984000000
  39.          * fcount : 0
  40.          * id : 79037
  41.          * img : /store/081302/1d2a3c03ff722604bb6abd1e15c61a4c.jpg
  42.          * leader : 李赢
  43.          * legal : 李金锋
  44.          * message :
  45.          * name : 上海好药师德高药店
  46.          * number : 沪CA0140423
  47.          * rcount : 0
  48.          * supervise : 12
  49.          * tel :
  50.          * type : 零售连锁企业加盟店
  51.          * url :
  52.          * waddress : ****** ;
  53.          * x : 121.582
  54.          * y : 31.0968
  55.          * zipcode : 200001
  56.          */
  58.         private String address;
  59.         private int area;
  60.         private String business;
  61.         private String charge;
  62.         private int count;
  63.         private long createdate;
  64.         private int fcount;
  65.         private int id;
  66.         private String img;
  67.         private String leader;
  68.         private String legal;
  69.         private String message;
  70.         private String name;
  71.         private String number;
  72.         private int rcount;
  73.         private int supervise;
  74.         private String tel;
  75.         private String type;
  76.         private String url;
  77.         private String waddress;
  78.         private double x;
  79.         private double y;
  80.         private String zipcode;
  82.         public String getAddress() {
  83.             return address;
  84.         }
  86.         public void setAddress(String address) {
  87.             this.address = address;
  88.         }
  90.         public int getArea() {
  91.             return area;
  92.         }
  94.         public void setArea(int area) {
  95.             this.area = area;
  96.         }
  98.         public String getBusiness() {
  99.             return business;
  100.         }
  102.         public void setBusiness(String business) {
  103.             this.business = business;
  104.         }
  106.         public String getCharge() {
  107.             return charge;
  108.         }
  110.         public void setCharge(String charge) {
  111.             this.charge = charge;
  112.         }
  114.         public int getCount() {
  115.             return count;
  116.         }
  118.         public void setCount(int count) {
  119.             this.count = count;
  120.         }
  122.         public long getCreatedate() {
  123.             return createdate;
  124.         }
  126.         public void setCreatedate(long createdate) {
  127.             this.createdate = createdate;
  128.         }
  130.         public int getFcount() {
  131.             return fcount;
  132.         }
  134.         public void setFcount(int fcount) {
  135.             this.fcount = fcount;
  136.         }
  138.         public int getId() {
  139.             return id;
  140.         }
  142.         public void setId(int id) {
  143.             this.id = id;
  144.         }
  146.         public String getImg() {
  147.             return img;
  148.         }
  150.         public void setImg(String img) {
  151.             this.img = img;
  152.         }
  154.         public String getLeader() {
  155.             return leader;
  156.         }
  158.         public void setLeader(String leader) {
  159.             this.leader = leader;
  160.         }
  162.         public String getLegal() {
  163.             return legal;
  164.         }
  166.         public void setLegal(String legal) {
  167.             this.legal = legal;
  168.         }
  170.         public String getMessage() {
  171.             return message;
  172.         }
  174.         public void setMessage(String message) {
  175.             this.message = message;
  176.         }
  178.         public String getName() {
  179.             return name;
  180.         }
  182.         public void setName(String name) {
  183.             this.name = name;
  184.         }
  186.         public String getNumber() {
  187.             return number;
  188.         }
  190.         public void setNumber(String number) {
  191.             this.number = number;
  192.         }
  194.         public int getRcount() {
  195.             return rcount;
  196.         }
  198.         public void setRcount(int rcount) {
  199.             this.rcount = rcount;
  200.         }
  202.         public int getSupervise() {
  203.             return supervise;
  204.         }
  206.         public void setSupervise(int supervise) {
  207.             this.supervise = supervise;
  208.         }
  210.         public String getTel() {
  211.             return tel;
  212.         }
  214.         public void setTel(String tel) {
  215.             this.tel = tel;
  216.         }
  218.         public String getType() {
  219.             return type;
  220.         }
  222.         public void setType(String type) {
  223.             this.type = type;
  224.         }
  226.         public String getUrl() {
  227.             return url;
  228.         }
  230.         public void setUrl(String url) {
  231.             this.url = url;
  232.         }
  234.         public String getWaddress() {
  235.             return waddress;
  236.         }
  238.         public void setWaddress(String waddress) {
  239.             this.waddress = waddress;
  240.         }
  242.         public double getX() {
  243.             return x;
  244.         }
  246.         public void setX(double x) {
  247.             this.x = x;
  248.         }
  250.         public double getY() {
  251.             return y;
  252.         }
  254.         public void setY(double y) {
  255.             this.y = y;
  256.         }
  258.         public String getZipcode() {
  259.             return zipcode;
  260.         }
  262.         @Override
  263.         public String toString() {
  264.             return "TngouBean{" +
  265.                     "address='" + address + '\'' +
  266.                     ", area=" + area +
  267.                     ", business='" + business + '\'' +
  268.                     ", charge='" + charge + '\'' +
  269.                     ", count=" + count +
  270.                     ", createdate=" + createdate +
  271.                     ", fcount=" + fcount +
  272.                     ", id=" + id +
  273.                     ", img='" + img + '\'' +
  274.                     ", leader='" + leader + '\'' +
  275.                     ", legal='" + legal + '\'' +
  276.                     ", message='" + message + '\'' +
  277.                     ", name='" + name + '\'' +
  278.                     ", number='" + number + '\'' +
  279.                     ", rcount=" + rcount +
  280.                     ", supervise=" + supervise +
  281.                     ", tel='" + tel + '\'' +
  282.                     ", type='" + type + '\'' +
  283.                     ", url='" + url + '\'' +
  284.                     ", waddress='" + waddress + '\'' +
  285.                     ", x=" + x +
  286.                     ", y=" + y +
  287.                     ", zipcode='" + zipcode + '\'' +
  288.                     '}';
  289.         }
  291.         public void setZipcode(String zipcode) {
  292.             this.zipcode = zipcode;
  293.         }
  294.     }
  295. }
定义接口
  1. import retrofit2.Call;
  2. import retrofit2.http.GET;
  3. import retrofit2.http.Header;
  4. import retrofit2.http.Path;
  5. import retrofit2.http.Query;
  7. public interface StoreService {
  9.     @GET("/tngou/{path}/name")
  10.     Call<Info> getStoreResult(@Path("path") String path, @Header("apikey") String apiKey, @Query("name") String name);
  11. }
Retrofit使用

简单的分为三步，分别如下创建Retrofit对象/获取Retrofit API请求/异步&同步发送请求

创建Retrofit对象
  1. /**
  2.  * 1. 创建Retrofit对象
  3.  *
  4.  * @return
  5.  */
  6. private static Retrofit buildRetrofit() {
  8.     return new Retrofit.Builder().baseUrl(BASE_URL).addConverterFactory(GsonConverterFactory.create()).build();
  9. }
获取Retrofit API请求
  1. /**
  2.  * 2. 获取Retrofit API请求
  3.  *
  4.  * @return
  5.  */
  6. private static Call<Info> obtainCall() {
  7.     Retrofit retrofit = buildRetrofit();
  9.     StoreService service = retrofit.create(StoreService.class);
  11.     return service.getStoreResult("store", API_KEY, NAME);
  12. }
异步发送请求
  1. /**
  2.  * 3. 异步发送请求
  3.  *
  4.  * @param context
  5.  */
  6. public static void enqueue(final Activity context) {
  7.     Call<Info> call = obtainCall();
  8.     if (call == null) return;
  10.     call.enqueue(new Callback<Info>() {
  11.         @Override
  12.         public void onResponse(Call<Info> call, Response<Info> response) {
  13.             if (response.isSuccessful()) {
  15.                 final Info info = response.body();
  17.                 context.runOnUiThread(new Runnable() {
  18.                     @Override
  19.                     public void run() {
  20.                         Toast.makeText(context, "onResponse() Result is: " + info.getTngou().toString(), Toast.LENGTH_SHORT).show();
  21.                     }
  22.                 });
  23.             }
  24.         }
  26.         @Override
  27.         public void onFailure(Call<Info> call, final Throwable t) {
  28.             context.runOnUiThread(new Runnable() {
  29.                 @Override
  30.                 public void run() {
  31.                     Toast.makeText(context, "onFailure() " + t.getMessage(), Toast.LENGTH_SHORT).show();
  32.                 }
  33.             });
  34.         }
  35.     });
  36. }
TestCase
  1. /**
  2.  * Retrofit get方式请求API，异步，添加Header
  3.  *
  4.  * @param view
  5.  */
  6. public void retrofitSendGetWithHeader(final View view) {
  8.     new Thread() {
  9.         @Override
  10.         public void run() {
  11.             RetrofitUtil.enqueue(MainActivity.this);
  12.         }
  14.     }.start();
  15. }
验证结果

app运行截图：
此处输入图片的描述
charles请求截图：
此处输入图片的描述

绕开Retrofit，使用原生OkHttp

这里我们不再使用Retrofit给我们提供的Converter，而是直接获取OkHttp给我们的Raw数据，下面给个栗子。

接口
  1. import okhttp3.ResponseBody;
  2. import retrofit2.Call;
  3. import retrofit2.http.GET;
  4. import retrofit2.http.Header;
  5. import retrofit2.http.Path;
  6. import retrofit2.http.Query;
  8. public interface RawService {
  10.     @GET("/tngou/{path}/name")
  11.     Call<ResponseBody> getRawResult(@Path("path") String path, @Header("apikey") String apiKey, @Query("name") String name);
  12. }
使用Raw
  1. /**
  2. * 1. 创建Retrofit对象
  3. *
  4. * @return
  5. */
  6. private static Retrofit buildRetrofit() {
  7.     return new Retrofit.Builder().baseUrl(BASE_URL).build();
  8. }
  9. /**
  10.  * 2. 获取Retrofit Raw API请求
  11.  *
  12.  * @return
  13.  */
  14. private static Call<ResponseBody> obtainRawCall() {
  15.     Retrofit retrofit = buildRetrofit();
  17.     RawService service = retrofit.create(RawService.class);
  19.     return service.getRawResult("store", API_KEY, NAME);
  20. }
  22. /**
  23.  * 3. 异步发送请求
  24.  *
  25.  * @param context
  26.  */
  27. public static void enqueueRaw(final Activity context) {
  28.     Call<ResponseBody> call = obtainRawCall();
  29.     if (call == null) return;
  31.     try {
  32.         Response<ResponseBody> response = call.execute();
  34.         String result = response.body().string();
  36.         Gson gson = new Gson();
  37.         final Info info = gson.fromJson(result, Info.class);
  39.         if (info != null) {
  40.             context.runOnUiThread(new Runnable() {
  41.                 @Override
  42.                 public void run() {
  43.                     Toast.makeText(context, "onResponse() Result is: " + info.getTngou().toString(), Toast.LENGTH_SHORT).show();
  44.                 }
  45.             });
  46.         } else {
  47.             Toast.makeText(context, "onResponse() Result is: NULL", Toast.LENGTH_SHORT).show();
  48.         }
  49.     } catch (IOException e) {
  50.         e.printStackTrace();
  51.     }
  52. }

经过验证，使用RAW抛弃了Retrofit给我们提供的Converter便利，当然这里仅仅是验证可行性，读者可以自行参考选择哪种方式。

参考文章：
OkHttp GitHub Doc
Retrofit GitHub DocR Doc Maven
Fresco GitHub Doc
Okio GitHub Video

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注