Retrofit学习（一）

写在前面##

其实一直都没有写博客的习惯，借着这次公司内部分享的机会，开始写博客，希望以后渐渐养成习惯。也方便以后自己忘记的时候可以再重温一下。

先讲点周边，介绍下Jake Wharton大神，也就是Retrofit的作者之一。Jake Wharton在Android开发领域就如同传奇一般（崇拜脸），在github上贡献了N个开源项目，大名鼎鼎的Dragger，ButterKnife都是出自他的手笔。好像都是为了解耦而生的。另外还有一个很酷炫的工具就是Scalpel，通过三维效果查看APP的View Tree。这个以后有机会一定要了解下。

好，下面切回正题。

---

Retrofit是什么##

Retrofit是什么，官方只用了一句话来概述：一个在Android和Java上类型安全的REST的客户端。不是很明白，通俗点理解就是它是一个网络请求封装库，通过注解的方式来指定请求类型，请求接口，请求参数，请求头...

---

Retrofit的导入##

• MAVEN
  
  com.squareup.retrofit2
  retrofit
  2.0.2
  
  
  com.squareup.retrofit2
  converter-gson
  2.0.2
  
• GRADEL
  dependencies{
  // Retrofit & OkHttp
  compile 'com.squareup.retrofit2:retrofit:2.0.2'
  compile 'com.squareup.retrofit2:converter-gson:2.0.2'
  }
• Eclipse
  V2.0.2 Jar 下载jar包后导入Eclipse工程目录中。

Retrofit 要求java 7 和 Android 2.3 以上版本。

• 混淆
  -dontwarn retrofit2.**
  -keep class retrofit2.** { *; }
  -keepattributes Signature
  -keepattributes Exceptions

• 转换器
  Square提供了几个官方的转换器，支持

  • Gson: com.squareup.retrofit2:converter-gson
  • Jackson:com.squareup.retrofit2:converter-jackson
  • Moshi:com.squareup.retrofit2:converter-moshi
  • Protobuf: com.squareup.retrofit2:converter-protobuf
  • Wire:com.squareup.retrofit2:converter-wire
  • Simpile XML:com.squareup.retrofit2:converter-simplexml
  • Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalars

---

Retrofit 声明请求API##

Retrofit官网上已经罗列了各请求是如何使用的，这里用我自己写的例子再简单说明下。主要是为了练手，也可以直接看官网。

• get请求
  首先定义一个Java 的接口
  public interface ILoginService{
  //测试登录接口
  @GET("testhello?username=test&&psw=psw")
  public Call> login();
  }
  上面的代码只是一个简单示例，项目中请求url中的参数一般是通过传参获取而不是固定值，所以，get的方法还可以这样来写：
  public interface ILoginService{
  //测试登录接口
  @GET("testhello")
  public Call> login(@Query("username") String username，@Query("psw") String psw);
  }
  上面@Query也可以换成@QueryMap 使用一个Map的对象传入参数。
  另外还有一种方式：
  public interface ILoginService{
  //测试登录接口
  @GET("testhello/{username}/info")
  public Call> getInfo(@Path("username") String username);
  }
  上面的例子中HttpResult类是一个请求返回结果类，包含了后台数据处理自定义的状态码和描述；通过泛型来适配所有接口返回的对象类型。
  public class HttpResult{
  Code code;
  T content;
  // Getter and Setter
  }
  上面定义了一个login的方法，这个方法会通过HTTP GET的请求去访问服务器 http://baseurl.com/testhello 路径并把结果封装返回为HttpResult的对象。
  然后，通过Retrofit类来生成一个ILoginService的对象。
  Retrofit retrofit = new Retrofit.Builder()
  .baseUrl("http://baseurl.com/")
  .build();

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

获取到ILoginService的对象之后再调用login的方法来生成一个Call的对象。
Call> mCall = service.login(bean);
最后通过Call的execute方法或者enqueue方法，发起同步或异步请求。

• POST请求
  通过@Body注解可以声明一个对象作为post请求体发送到服务器。
  @POST("testhell0")
  public Call> login(@Body UserBean bean);
  Retrofit会使用对应的转换器将请求对象转换为字符串或者字符流提交到服务器。
  如果是发送表单数据的话：
  @FormUrlEncoded
  @POST("testedit")
  Call> updateUserInfo(@Field("username") String first, @Field("psw") String psw);
  通过@Multipart来上传文件，通过@Part来定义每个要发送的文件。
  @Multipart
  @POST("testupdate")
  Call> updateUserInfo(@Part MultipartBody.Part photo, @Part("username") RequestBody name);
  MultipartBody.part 和 RequestBody的生成：
  File file = new File(Environment.getExternalStorageDirectory(),"test/test.png");
  RequestBody picRequestBody = RequestBody.create(MediaType.parase("image/png"),file);
  MultipartBody.Part photo = MultipartBody.Part.createFormData("photo","test.png",picRequestBody);
  RequestBody userName = RequestBody.create("null","testName");
  通过@PartMap可以上传多个文件
  @Multipart
  @POST("testupdate")
  Call> updateUserInfo(@PartMap Map params);

• 下载文件
  @GET("test.png")
  Call download();

  Call call = user.download();
  call.enqueue(new Callback(){
  
     @Override
     public void onRespnse(Call call, Response response){
         InputStream is = reponse.body().byteStream();
      }
  
      @Override
      public void onFailure(Call call, Throwable t){
      }
  }
  

文件下载有点鸡肋，下载之后输入输出流还是要重新建立线程。

• 请求头
  通过@headers注解来设置静态的请求头
  @Headers("Cache-Control:max-age=640000")
  @GET("widget/list")
  Call> widgetList();
  或者
  @Headers({
  "Accept:application/vnd.github.v3.full+json",
  "User-Agent:retrofit-sample-app"
  })
  @GET("users/{username}")
  Call getuser(@Path("username") String username);
  如果需要动态设置请求头的话，也可以通过@Header的注解，通过参数的方式来传入
  @GET("user")
  Call getUser(@Header("Authorization") String authorization)
  如果是要添加统一的Header 而不想在每个接口上写注解或者入参，也可以通过为OkhttpClient的添加Interceptor来实现：
  OkHttpClient.Builder mBuilder = new OkHttpClientBuilder();
  mBuilder.addNetworkInterceptor(new Interceptor() {
  @Override
  public Response intercept(Chain chain) throws IOException {
  Request request = chain.request();
  Request.Builder builder = request.newBuilder();
  builder.header(key,value);
  request = builder.build();
  Response response = chain.proceed(request);
  return response;
  }});
  Retrofit mRetrofit = new Retrofit.Builder()
  .baseUrl("http://baseurl.com/")
  .client(mBuilder.build())
  .addConverterFactory(GsonConverterFactory.create())
  .build();

• 同步和异步请求
  在上面的篇幅中其实已经提到了。
  同步请求：
  Respnse resonse = mCall.execute();
  异步请求：
  mCall.enqueue(new Callback(){
  @Override
  public void onResponse(Call call, Respnse response){
  }
  @Override
  public void onFailure(Call call,Throwable t){
  }
  });

---

小结##

通过以上的介绍，应该已经可以在项目中使用了。这里只是对Retrofit的一些常用的方法进行了简单的介绍；还有一些细节上的注意点，以及原理的介绍会在后续的篇幅里再进行记录。

参考文档###

Retrofit官网： http://square.github.io/retrofit/
某大神的博客：https://futurestud.io/blog/retrofit-getting-started-and-android-client
鸿洋大神的博客：http://blog.csdn.net/lmj623565791/article/details/51304204