Retrofit2.0使用过程中所踩到的坑

Retrofit2.0使用过程中所踩到的坑

转载请注明出处
作者：AboutJoke ( http://blog.csdn.net/u013200308 )
原文链接：http://blog.csdn.net/u013200308/article/details/52562722

---

简介

http://square.github.io/retrofit/ 官网

Retrofit2.0是Square公司的开源项目之一，Square还有众多的开源项目，推荐大家可以去GitHub上关注和学习。笔者对于Retrofit2.0也还处在学习过程中，更多的深层次的理解和认识推荐大家去鸿洋大神的博客学习。本篇博客主要介绍一下使用过程中所出现的一些问题，方便各位同学们去学习使用。

---

Retrofit的使用

Maven

<dependency>
  <groupId>com.squareup.retrofit2</groupId>
  <artifactId>retrofit</artifactId>
  <version>2.1.0</version>
</dependency>

Gradle

compile ‘com.squareup.retrofit2:retrofit:2.1.0’

---

简单使用

retrofit的使用需要先定义一个接口对象来作为http请求的对象，我们先以官网的示例来做一个学习。
此处请求的接口地址是https://api.github.com/repos/square/retrofit/contributors

1.创建请求API接口

public interface ApiDemo {

    /**
     *1.这里的url不可以用 / 来开头
     *2.这里{owner}起到的是占位的作用，即表示将被我们定义的owner代替
     *3.如我们所传递的参数是按照一定的顺序拼接在url后面则可以将占位省略掉
     */
    @GET("repos/{owner}/{repo}/contributors")
    Call<String> simpleGet(@Path("owner") String owner,
                           @Path("repo") String repo);

}

2.实现Retrofit对象

        /**
         *注意：这里所传递的url必须以 / 结尾
         */
        Retrofit retrofit=new Retrofit.Builder()
                .baseUrl("https://api.github.com/")
                .addConverterFactory(ScalarsConverterFactory.create())
                .build();

3.调用http请求接口

ApiDemo apiDemo = retrofit.create(ApiDemo.class);
        Call<String> simpleGet = apiDemo.simpleGet("square", "retrofit");
        simpleGet.enqueue(new Callback<String>() {
            @Override
            public void onResponse(Call<String> call, Response<String> response) {
                L.json(TAG,response.body().toString());
            }

            @Override
            public void onFailure(Call<String> call, Throwable t) {
                L.e(t.toString());
            }
        });

4.结果

这样我们就完成了一次简单的get请求，但这个简单的请求也包含着一些坑，其中之一关于url的拼接已经在注释中说明。那么我是如何将获取到的json以string输出的呢？关键就在于 “addConverterFactory(ScalarsConverterFactory.create())”这句代码，添加了这个转换工厂后，就可以将我们获取的数据原样输出，从而方便去筛选需要的信息。“addConverterFactory”为我们提供了7种可以选择的格式：

• 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 Simple
• XML:com.squareup.retrofit2:converter-simplexml
• Scalars (primitives,boxed, and String): com.squareup.retrofit2:converter-scalars

当然你想要使用哪种格式就需要去添加相应的依赖，如果上述的类型无法满足你的需求，你也可以去自定义，具体的就不在这里说了。

---

封装使用

可能很多人看了上面的使用过程后都会觉得很麻烦，不像其他的网络请求库，传入请求地址和参数后就可以使用，所以我们需要对retrofit做一定的封装来更加的方便我们的使用。

1.对Retrofit做封装

public class BaseRetrofit {

    private static String baseUrl = "https://api.github.com/";

    private static Retrofit stringRetrofit = new Retrofit.Builder()
            .baseUrl(baseUrl)
            .addConverterFactory(ScalarsConverterFactory.create())
            .addConverterFactory(GsonConverterFactory.create())
            .build();

    public static ApiDemo getService() {
        ApiDemo apiService = stringRetrofit.create(ApiDemo.class);
        return apiService;
    }
}

2.对CallBack做封装

这里对CallBack做封装的原因是，我们在使用过程中或多或少都会遇到网络请求失败的问题，比如404、超时等等。但是Retrofit并没有给我们提供一个很好的方式去操作，在源码的注释里也写到

An HTTP response may still indicate an application-level failure such as a 404 or 500.

这样就导致404的失败响应也出现在了“onResponse”方法中，而不是“onFailure”，而且如果不对返回的数据做处理的话可能会直接导致应用的崩溃。有些同学会说这些都是需要后台和服务器去处理的，于我们关系不大。诚然，在公司开发中会有人去处理相应的问题，但如果没有就需要我们自己去处理了。下面，我贴出我对应需求的代码，大家可以去按照自己的需求做更多的操作。

public abstract class MyCallBack<T extends BaseCallModel> implements Callback<T> {
    @Override
    public void onResponse(Call<T> call, Response<T> response) {
        if (response.raw().code() == 200) {//200是服务器有合理响应
            String code = response.body().dec.getCode();
            if (code!=null) {
                if (code.equals("000000")) {
                    onSuccess(response);
                } else {
                    onFail(response.body().dec.getMsg());
                }
            }
        } else {//失败响应
            //这里可以按照自己的需求对返回的数据做一定的处理
            String s = response.errorBody().byteStream().toString();
            onFailure(call, new RuntimeException(s));
        }
    }

    @Override
    public void onFailure(Call<T> call, Throwable t) {//网络问题走该回调
        //根据自己的需求可以去定义多种的错误方式，响应多种的操作
        if (t instanceof SocketTimeoutException) {
            //
        } else if (t instanceof ConnectException) {
            //
        } else if (t instanceof RuntimeException) {
            onError(t.getMessage());
        }
    }

    protected abstract void onError(String message);

    protected abstract void onSuccess(Response<T> response);

    protected abstract void onFail(String message);
}

3.具体的使用

APIService service = BaseRetrofit.getService();
        //这块的BaseCallModel是对返回数据的类型做了一定封装，大家可以按照自己的需求去实现
        Call<BaseCallModel<CashBean>> cashList = service.cashList("1", user_token, 1);
        cashList.enqueue(new MyCallBack<BaseCallModel<CashBean>>() {
            @Override
            protected void onError(String message) {
                // 错误的响应
            }

            @Override
            public void onSuccess(Response<BaseCallModel<CashBean>> response) {
                // 成功获取到数据
            }

            @Override
            public void onFail(String message) {
                // 数据请求失败
            }
        });

从这里的代码已经可以看出和最开始的使用方式相比简洁了很多，而且经过我们的封装，使用起来也更加的便利。

---

图片上传

请求接口定义

    @Multipart
    @POST("user/avatar")
    //u_avatar为请求接口参数
    Call<String> upLoadIcon(@Part MultipartBody.Part u_avatar, @Part("u_id")
            RequestBody u_id, @Part("u_token") RequestBody u_token);

具体使用

File file = new File(Environment.getExternalStorageDirectory() + icon_url);
        RequestBody photoRequestBody = RequestBody.create(MediaType.parse("image/png/jpeg/jpg"), file);
        MultipartBody.Part u_avatar = MultipartBody.Part.createFormData("u_avatar", icon_name, photoRequestBody);
        APIService service = BaseRetrofit.getService();
        Call<String> Call = service.upLoadIc(u_avatar, RequestBody.create(null, user_id), RequestBody.create(null, user_token));

---

其他

1. POST请求记得添加“@FormUrlEncoded”注解；
2. 同步请求“execute()”记得在子线程中去使用；
3. 无论同步还是异步每个call对象只能被执行一次，可通过“clone()”去创建一个相同的实例;Call<String> clone = simpleGet.clone();
4. 不要忘记添加网络请求权限；

以后如果遇到其他的问题，我也会在此篇博文中进行更新。