Retrofit详解

作者: 就这样e | 来源:发表于2016-12-02 02:00 被阅读296次

    警言:慎终如始!

    1. REST 介绍:

    Resources Representational State Transfer

    资源表现层状态转化

    每一个URI代表一种资源 客户端和服务器之间,传递这种资源的某种 表现层(“资源”具体呈现出来的形式,比如.txt,.png,.jpg) 客户端通过四个HTTP动词(GET用来获取资源,POST用来新建或更新资源,PUT用来更新资源,DELETE用来删除资源)对服务器端资源进行操作,实现”表现层状态转化”

    关于REST,这里只仅仅列出了结论,文末有超级好的链接,请查看。如果你所使用的API是REST的,那么恭喜你,这样的API看起来真的很舒服,庆幸的是我司就使用的是REST API。

    2.Retrofit基本用法

    (1)在build.gradle中添加依赖

    compile 'com.squareup.retrofit2:retrofit:2.0.2'

    compile 'com.squareup.retrofit2:converter-gson:2.0.2'

    compile 'com.squareup.retrofit2:adapter-rxjava:2.0.2'

    compile 'com.squareup.okhttp3:logging-interceptor:3.2.0'

    compile 'com.squareup.retrofit2:converter-scalars:2.0.0'

    (小问题,想通过retrofit得到json字符串)

    在使用Retrofit来作为网络请求库之后,笔者查阅了网上的有关教程,无外乎都是请求json数据,使用addConverterFactory(GsonConverterFactory.create())来作为转化器,如果业务需求是请求 字符串,而不是json数据格式呢,继续使用这个转换器就会产生错误。

    好,来到正题,如何使用Retrofit请求一段字符串:

    其实官方已经提供了一个字符串的转换器,那么接下来把它导入项目使用就可以了。

    添加gradle依赖

    compile'com.squareup.retrofit2:converter-scalars:2.0.0'

    mRetrofit = new Retrofit.Builder()                .baseUrl(HttpAddress.SITE).addConverterFactory(ScalarsConverterFactory.create()).build();

    (2)创建接口,声明API

    //创建接口,声明GitHub的API

    publicinterfaceGitHubAPI {

    /*

    请求该接口:https://api.github.com/users/baiiu

    */

    @GET("users/{user}")

    Call userInfo(@Path("user") String user);

    }

    (3)在MainActivity.onCreate()方法中调用

    1.初始化OkHttpClient

    */

    OkHttpClient client =newOkHttpClient();

    /*

    2.创建Retrofit

    */

    retrofit =newRetrofit.Builder()

    //设置OKHttpClient

    .client(client)

    //设置baseUrl,注意,baseUrl必须后缀"/"

    .baseUrl("https://api.github.com/")

    //添加Gson转换器

    .addConverterFactory(GsonConverterFactory.create())

    .build();

    /*

    2.获取GitHub的API

    */

    GitHubAPI gitHubAPI = retrofit.create(GitHubAPI.class);

    /*

    3.异步调用

    */

    Call userCall = gitHubAPI.userInfo("baiiu");

    userCall.enqueue(newCallback() {

    @OverridepublicvoidonResponse(Call call, Response response) {

    User body = response.body();

    LogUtil.d(body ==null?"body == null": body.toString());

    }

    @OverridepublicvoidonFailure(Call call, Throwable t) {

    /*

    判断是否被cancel掉了

    */

    if(call.isCanceled()) {

    LogUtil.d("the call is canceled , "+ toString());

    }else{

    LogUtil.e(t.toString());

    }

    }

    });

    /*

    取消调用

    */

    //userCall.cancel();

    /*

    同步调用,举个例子,写法如下(当然不能在主线程调用):

    */

    Call clone = userCall.clone();

    Response response = clone.execute();

    User body = response.body();

    LogUtil.d(body ==null?"body == null": body.toString());

    (Android正常情况下都只会用到异步回调)

    注意:

    1. 设置BaseUrl时必须后缀”/”,如https://api.github.com/

    (否而: java.lang.IllegalArgumentException: baseUrl must end in /:)

    2. 因为Retrofit在创建时候传入了BaseUrl,所以基本上所有请求都基于该BaseUrl了。但是总有些API不是以该BaseUrl开头的,特别是有些公司可能不是restful API的。那么该怎么办呢。Retrofit提供了一个注解@Url解决这个问题,可以在运行时直接使用该Url直接访问。代码如下:

    //使用@Url注解,传入该Url地址就OK啦,跨过BaseUrl,直接访问该Url地址

    @GETCall getNewsList(@UrlString url);  get后面不能加参数

    4. Retrofit注解

    请求头的设置可以通过@Header注解添加,又有两种添加方式:

    设置静态的请求头:

    @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);

    动态的设置请求头:

    @GET("user")

    Call getUser(@Header("Authorization") String authorization)

                                   希望小伙伴们多多支持(如有错误,希望指出)

    相关文章

      网友评论

        本文标题:Retrofit详解

        本文链接:https://www.haomeiwen.com/subject/krpfmttx.html