Android网络请求库 - Say hello to retrofit

Android 网络请求库Retrofit使用详解 1、首先在Android项目中引入需要的依赖。2、创建一个单例类,返回Retrofit对象。 阅读详情

回顾:


之前对Android里常用的网络请求库OkHttp与Volley做了简单的学习归纳与总结,这里看这个系列中的最后一篇,来认识一下Retrofit。
Retrofit可以认为是OkHttp的“升级版”。之所以这么说,是因为其内部默认正是基于OkHttp来进行封装的。这点从Retrofit这个命名就可以看出端倪。
回顾一下OkHttp,我们会发现虽然是封装过后的库,但OkHttp的封装是比较“碎片化”的。所以如果不自己再进行封装,使用时代码就比较容易耦合。
而Retrofit作为其升级版,有一个最吸引人的特色就是:将所有的请求封装为interface,并通过“注解”来声明api的相关信息。让你爽到停不下来。


RESTful API

在正式开始了解Retrofit的使用之前,我们有必要先了解一个概念,即RESTful。这是因为Retrofit的初衷就是根据RESTful风格的API来进行封装的。
关于RESTful的学习,可以参考一下RESTful API 设计指南此文。相信看完之后,就会对Restful有一个基本的认识和理解了。
但我们这里可以对RESTful的核心思想做一个最简练的总结,那就是:所谓”资源”,就是网络上的一个实体,或者说是网络上的一个具体信息。那么我们访问API的本质就是与网络上的某个资源进行互动而已。那么,因为我们实质是访问资源,所以RESTful设计思想的提出者Fielding认为:
URI当中不应当出现动词,因为”资源“表示一种实体,所以应该用名词表示,而动词则应该放在HTTP协议当中。那么举个最简单的例子:

  • xxx.com/api/createUser
  • xxx.com/api/getUser
  • xxx.com/api/updateUser
  • xxx.com/api/deleteUser

这样的API风格我们应该很熟悉,但如果要遵循RESTful的设计思想,那么它们就应该变为类似下面这样:

  • [POST]xxx.com/api/User
  • [GET] xxx.com/api/User
  • [PUT]xxx.com/api/User
  • [DELETE]xxx.com/api/User

也就是说:因为这四个API都是访问服务器的USER表,所以在RESTful里URL是相同的,而是通过HTTP不同的RequestMethod来区分增删改查的行为。
而有的时候,如果某个API的行为不好用请求方法描述呢?比如说,A向B转账500元。那么,可能会出现如下设计:

POST /accounts/1/transfer/500/to/2

在RESTful的理念里,如果某些动作是HTTP动词表示不了的,你就应该把动作做成一种资源。可以像下面这样使用它:

  POST /transaction HTTP/1.1
  Host: 127.0.0.1
  
  from=1&to=2&amount=500.00

好了,当然实际来说RESTful肯定不是就这点内容。这里我们只是了解一下RESTful最基本和核心的设计理念。


从官方介绍初识Retrofit

当我们要去学习一样新的技术,还有什么是比官方的资料更好的了呢?所以,第一步我们打开网址http://square.github.io/retrofit/。然后开始阅读:
我们发现官方的介绍非常简单粗暴,一上来就通过一个Introduction来展示了如何使用Retrofit来进行一个最基本的请求。下面我们就逐步的分析一下:
这里写图片描述
从上图中,我们首先注意到了一个关键的说明信息:Retrofit会将你的HTTP API转换为Java中的interface的形式。OK,接着看:
这里写图片描述
这里我们读到的描述是:Retrofit类可以针对之前定义的interface生成一个具体实现。我们发现官方对此解释的很言简意赅,但更通俗的来讲的话:
也就是说虽然我们之前将此次请求的API信息封装为了一个接口,但我们也知道Java中接口是不能产生对象的,这时Retrofit类就站出来扮演了这个角色。
我们可以将Retrofit类看作是一个“工厂类”的角色,我们在接口中提供了此次的“产品”的生产规格信息,而Retrofit则通过信息负责为我们生产。
这里写图片描述
这里我们看到了一个重要的东西“Call”:通过之前封装的请求接口对象创建的任一的Call都可以发起一个同步(或异步)的HTTP请求到远程服务器。
之后说了一些通过注解来描述request的好处,然后这个简单的Introduction就结束了。那么,现在我们来简单总结一下,目前为止我们的感受如何。
我觉得就仅从以上简单的介绍当中我们起码有两点直观感受:那就是解耦明确;使用简单。通过注解的方式描述request让人眼前一亮。但与此同时:
我们发现读完Introduction后,仅仅是这个基本的用例中,都仍然有很多小细节需要我们通过实际使用之后才能搞明白。这可能在一定程度上说明了:
为什么说Retrofit的使用门槛相对于其它库来说要更高一些。不过没关系,我们自己先来写一个比官方Introduction更简单的用例,再逐步深入。


动手写第一个Demo来碰坑

现在我们已经阅读完了官方的用例介绍,乍看之下没什么,但实际用起来说不定就得碰坑。为方便测试,仍然通过servlet在本地简单的实现服务器。
我们现在的设想可能是这样的,我只是想要写一个demo来测试一下用Retrofit来成功发起一次最基本的get请求,所以最初的doGet无比简单:

    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setHeader("Content-type", "text/html;charset=UTF-8");
        PrintWriter out = response.getWriter();
        out.print("{\"describe\":\"请求成功\"}");
        out.flush();
        out.close();
    }

完成了以上代码的编写,然后我们把该servlet的URL配置一下,言简意赅的,就配置为“/api/retrofitTesting”好了。这时服务器就准备完毕了。
很显然,下面我们就可以把焦点放在Android客户端的实现上来了。为了使用Retrofit,所以我们的第一步工作自然就是在自己的项目中设置依赖:

这里写图片描述

配置好了依赖,接着我们就可以开始编码工作了。还记得官方用例的第一步吗?所以我们要做的显然是模仿它也把我们自己的HTTP API封装成interface。

public interface DemoService {
    @GET("api/retrofitTesting")
    Call<ResponseInfo> testHttpGet();
}
// GSON - BEAN
class ResponseInfo {
    String describe;
}

现在我们再来看这个所谓的API接口,可能就更加明确一点了。首先是通过注解@GET来声明本次请求方式为GET以及注明API-URL。
而就之后声明的方法来说:从其为Call的返回类型不难猜想多半与请求的发起有关,因为如果我们对OkHttp有所了解的话,一定就记得下面这样的代码:

        OkHttpClient client = new OkHttpClient();
        Request request = new Request.Builder().url(url).build();
        Response response = client.newCall(request).execute();

newCall方法实际就是返回一个Call类型的实例。而Retrofit中的Call接口相对于OkHttp添加了一个泛型,该泛型用于说明本次请求响应的数据解析类型。
那么这里的泛型为什么是我们自己建立的一个实体类呢?其实回忆一下之前服务器在response中返回的内容(JSON),就不难猜想到与GSON有关。
好的,我们继续按照官方用例中接下来的步骤去完善我们的demo。封装好了interface,接下来自然就是调用了,最终的代码如下:

    private void testRetrofitHttpGet() {
        // step1
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://192.168.2.100:8080/TestServer/")
                .build();
        // step2
        DemoService service = retrofit.create(DemoService.class);
        // step3
        Call<ResponseInfo> call = service.testHttpGet();
        // step4
        call.enqueue(new Callback<ResponseInfo>() {
            @Override
            public void onResponse(Call<ResponseInfo> call, Response<ResponseInfo> response) {
                Log.d(TAG,response.body().describe);
            }

            @Override
            public void onFailure(Call<ResponseInfo> call, Throwable t) {
                Log.d(TAG, t.getMessage());
            }
        });
   }

有了之前的说明并对照官方示例,现在会发现以上代码很容易理解。而我们发现官方没有给出的step4其实也很熟悉,因为它和OkHttp的使用是相同的。
这个时候看上去我们的准备工作就已经完成了,于是兴致勃勃的编译并运行demo来查看一下效果,却发现收到了如下的一个异常:

这里写图片描述

为什么会出现这种情况呢?蛋疼啊!别急,通过异常信息的描述,我们得知这似乎与类型的转换相关,然后带着这个疑问再去查看官方文档,于是发现:

这里写图片描述

从上述信息我们得知Retrofit默认只能将响应体转换为OkHttp中的ResponseBody,而我们之前为Call设置的泛型类型是自定义的类型ResponseInfo 。
将JSON格式的数据转换为Java-BEAN,很自然就会想到GSON。而Retrofit如果要执行这种转换是要依赖于另一个库的,所以我们还得在项目中配置另一个依赖:

这里写图片描述

之后,在构造Retrofit对象的时候加上一句代码就可以了:

        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://192.168.2.100:8080/TestServer/")
                .addConverterFactory(GsonConverterFactory.create()) // 加上这一句哦,亲
                .build();

这个时候,当我们再次运行程序就没问题了,成功的得到如下的日志打印:

这里写图片描述

现在,经过我们的一番摸索和折腾,关于Retrofit很基本的第一个demo就捣鼓出来了。
其实这是有意义的,因为回想一下会发现:现在我们对于Retrofit大致的使用套路,在心里已经有个一二三了。


回到官方文档继续学习

前面我们说到对于Retrofit的使用已经有了一个基本的认识和了解,接下来要做的自然就是深入和继续学习更多的使用细节。那么很显然,回到官方吧。

这里写图片描述

事实上前面我们已经使用到了注解@GET,这里就是告诉我们这种注解其实对于HTTP其它常用的请求方式(GET,POST,PUT,DELETE等等)都封装了。
而对于@GET来说,我们知道HTTP-GET是可以将一些简单的参数信息直接通过URL进行上传的,所以URL又可以像下面那样使用:

@GET("api/retrofitTesting?param=value")
  • replacement blocks与@path

不知道大家注意到官方示例和我们刚才自己测试写的demo中有一个细小的差别没,就是下面这样的东西:

//官方的
@GET("users/{user}/repos")
//我们的
@GET("api/retrofitTesting")

我们注意到官方的API的URL中有一个”{user}“这样的东西?它的作用是什么呢?我们也能在官方文档上找到答案:

这里写图片描述

从上述介绍中,我们注意到一个叫做replacement blocks的东西。可以最简单的将其理解为路径替换块,用”{}”表示,与注解@path配合使用。
当然我们自己实际去使用一下能够对其有一个更加深刻的理解,所以我们将我们之前的demo修改一下,变成下面这样:

public interface DemoService {
    @GET("api/{name}")
    Call<ResponseInfo> testHttpGet(@Path("name") String apiAction);
}

使用的方式也会有所不同,我们在调用的使用需要将对应的值传给responseInfo方法。

Call<ResponseInfo> call = service.testHttpGet("retrofitTesting");

这样修改过后的实际效果实际上与我们之前的demo是一样的,那么这样做的好处是什么?显然是为了解耦。以官方的例子来说:
“https://api.github.com/users/{user}/repos”中的{user}就是为了针对不同的github用户解耦。因为这里假设代入我的github,URL就将变成:
“https://api.github.com/users/RawnHwang/repos”。而github的用户千千万万,如果使用我们之前的方式代码就会如下:

@GET("users/RawnHwang/repos")

这二者的优劣一目了然,我们肯定不会想要为了获取不同的user的repos去写N多个套路完全相同的API - interface吧。

  • @Query

前面我们讲到:对于@GET来说,参数信息是可以直接放在url中上传的。那么你马上就反应过来了,这一样也存在严重的耦合!于是,就有了@query。

这里写图片描述

同样,为了便于理解,我们仍然自己来实际的使用一下。就用我们之前的举到的例子好了,这里我们用@query来替换我们之前说到的如下代码:

@GET("api/retrofitTesting?param=value")

替换为:

public interface DemoService {
    @GET("api/retrofitTesting")
    Call<ResponseInfo> testHttpGet(@Query("param") String param);
}

调用的时候改为:

Call<ResponseInfo> call = service.testHttpGet("value");

然后就可以在服务器查看是否成功接收到参数了:

    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        System.out.println(request.getParameter("param"));
        }
  • @QueryMap

聪明的你现在肯定还不满足,因为可能有这样的疑问:假设我要在参数中上传10个参数呢?这意味着我要在方法中声明10个@Query参数?当然不是!

这里写图片描述

我们看到了,Retrofit也考虑到了这点,所以针对于复杂的参数上传,为我们准备了@QueryMap。现在来修改我们自己的demo:

public interface DemoService {
    @GET("api/retrofitTesting")
    Call<ResponseInfo> testHttpGet(@QueryMap Map<String,String> params);
}

调用的时候自然也发生了变化:

        Map<String,String> params =new HashMap<>();
        params.put("param1","value1");
        params.put("param2","value2");
        Call<ResponseInfo> call = service.testHttpGet(params);
  • @POST

有了之前的基础,现在我们免不了要捣鼓一下POST。相信有了@GET的使用经验,如果只是想发发简单的POST请求是没有多大的难度,我们关注下POST的BODY,即请求体的使用技巧。

这里写图片描述

通过官方文档,我们发现出现了一个新的东西叫做“@Body”,顾名思义它就是用来封装请求体的。而同时通过后面的“User”参数类型,我们不难推断出:使用@Body时,是通过实体对象的形式来进行封装的。那么闲话少说,我们当然仍旧是自己动手来试一下:
首先,我们编写一下servlet的doPost方法,假设我们这里提供一个新建User的API。完成后为该POST-request配置一个新的API URL,我们这里配置为:“/api/users”。然后,在Android端编写一个新的interface,大致如下:

public interface DemoService {
    @POST("api/users")
    Call<ResponseInfo> uploadNewUser(@Body User user);
}

class User{
    private String name;
    private String gender;
    private int age;

    public User(String name, String gender, int age) {
        this.name = name;
        this.gender = gender;
        this.age = age;
    }
}

class ResponseInfo{
    String describe;
}

这样其实就搞定了,是不是很简单。然后我们通过如下代码去调用测试就行了:

Call<ResponseInfo> call = service.uploadNewUser(new User("tsr","male",24));

这里唯一需要说明的就是,通过@BODY这种方式封装请求体,Retrofit是通过JSON的形式来封装数据的。我们可以在服务器读取流中的数据打印:

{"name":"tsr","gender":"male","age":24}

我单独额外说明一下这个的初衷是因为:这种情况以servlet来说,通过如下的形式是读取不到的对应的参数值的(返回null),需要自己解析。

System.out.println(request.getParameter("username"));//输出为null
  • @FormUrlEncoded

这时有的朋友就说了,那我要是就想要通过request.getParameter的方式直接读取参数信息呢?没关系,也是可以的,使用@FormUrlEncoded搞定。

这里写图片描述

其实通过这个注解的命名,我们就很容易联系到HTTP Content-Type中的application/x-www-form-urlencoded:而其实在服务器打印Content-Type的话,会发现的确如此。也就是说,其实使用该注解过后,正是通过表单形式来上传参数的。

public interface DemoService {
    @FormUrlEncoded
    @POST("api/users")
    Call<ResponseInfo> uploadNewUser(@Field("username") String username,@Field("gender") String male,@Field("age") int age);
}

然后是依旧是调用,这时服务器就可以通过request.getParameter直接读取参数了:

Call<ResponseInfo> call = service.uploadNewUser("tsr","male",24);

当然,这个时候难免又会想起那个老梗:要写这么多的@Field参数?当然不是,也有@FieldMap供我们使用,使用方法参照@QueryMap

  • @Headers与@Header

使用了@FormUrlEncoded之后,不知道你有没有好奇一下,假设我们的参数中含有中文信息,会不会出现乱码?让我们来验证一下:

Call<ResponseInfo> call = service.uploadNewUser("张德帅","male",24);

这里上传的username信息是中文,而在服务器读取后进行打印,其输出的是“?????·???”。没错,确实出现乱码了。
这个时候我们应该如何去解决呢?当然可以通过URLEncode对数据进行指定编码,然后服务器再进行对应的解码读取:

        String name =  URLEncoder.encode("张德帅","UTF-8");
        Call<ResponseInfo> call = service.uploadNewUser(name,"male",24);

但如果了解一点HTTP协议的使用,我们知道还有另一种解决方式:在Request-Header中设置charset信息。于是,这个时候就涉及到添加请求头了:

这里写图片描述

关于@Headers的使用看上去非常简单。那么,接下来我们就来修改一下我们之前的代码:

public interface DemoService {
    @Headers("Content-type:application/x-www-form-urlencoded;charset=UTF-8")
    @FormUrlEncoded
    @POST("api/users")
    Call<ResponseInfo> uploadNewUser(@Field("username") String username,@Field("gender") String male,@Field("age") int age);
}

通过@Headers我们在Content-type中同时指明了编码信息,再次运行程序测试,就会发现服务器正确读取到了中文的信息。

除了@Headers之外,还有另一个注解叫做@Header。它的不同在于是动态的来添加请求头信息,也就是说更加灵活一点。我们也可以使用一下:

public interface DemoService {
    // @Headers("Content-type:application/x-www-form-urlencoded;charset=UTF-8")
    @FormUrlEncoded
    @POST("api/users")
    Call<ResponseInfo> uploadNewUser(@Header("Content-Type") String contentType,@Field("username") String username,@Field("gender") String male,@Field("age") int age);
}
// 调用
Call<ResponseInfo> call = service.uploadNewUser("application/x-www-form-urlencoded;charset=UTF-8","张德帅","male",24);
  • 读取response header

通过上面的总结我们知道通过@Header可以在请求中添加header,那么我们如何去读取响应中的header呢?我们会发现官方文档并没有相关介绍。
那么显然我们就只能自己看看了,一找发现对于Retrofit2来说Response类有一个方法叫做headers(),通过它就获取了本次请求所有的响应头。
那么,我们记得在OkHttp里面,除了headers(),还有用于获取单个指定头的header()方法。我们能不能在Retrofit里使用这种方式呢?答案是可以。
我们发现Retrofit的Response还有一个方法叫做raw(),调用该方法就可以把Retrofit的Response转换为原生的OkHttp当中的Response。而现在我们就很容器实现header的读取了吧。

okhttp3.Response okResponse = response.raw();
response.raw().header("Cache-Control");
}

进阶技巧

  • @Multipart 与文件上传

在官方文档中,实际上还有一个重要的注解,那就是@Multipart。这个使用起来相对要复杂一点,所以放在这里。下面我们就来看一下这个东西的使用。

这里写图片描述

可以看到官方文档上对该注解使用的说明非常简单,但这个注解使用起来却不是那么简单,这就很烦人了。不过也没关系,我们由浅入深的来看一下。

public interface DemoService {
    @Multipart()
    @POST("api/multipartTesting")
    Call<ResponseInfo> testMultipart(@Part("part1") String part1,@Part("part2") String part2);
}

这里对官方示例做了简化,因为我们在@Part参数中只使用了String类型,而没有声明RequestBody类型。接着就是调用它来进行测试:

Call<ResponseInfo> call = service.testMultipart("this is the part1","this is the part2");

为了一探究竟,我们现在在服务器打印一下Content-Type与请求体(request-body)分别是怎样的:

这里写图片描述

现在我们来分析一下从打印的请求体中,我们能够得到哪些信息:

  • 首先,本次请求的Content-Type是multipart/form-data; 也就是代表通过2进制形式上传多部分的数据。
  • boundary故名思议就是分割线,它是用来对上传的不同部分的数据来进行分隔的,就像上图中体现的一样。
  • 通过@Part传入的参数信息都像上图中一样被组装,首先是相关的内容信息,然后间隔一个空行,之后是实际数据内容,最后接以boundary。
  • 当使用@Part上传String参数信息时,我们可以看到其默认的参数类型为application/json。
    (这代表如果你的服务器接不支持解析此类型的Content-Type,就需要自己修改为对应的类型)

现在我们注意到一个问题,那就是multipart/form-data将会以2进制形式来上传数据信息。那么,什么时候我们才需要2进制呢?显然就是文件的上传。
OK,那么我们继续修改代码,这次我们尝试通过@Part来上传一个文件会是什么情况?

public interface DemoService {
    @Multipart()
    @POST("api/files")
    Call<ResponseInfo> uploadFile(@Part("file") RequestBody photo);
}
//调用部分
File path = Environment.getExternalStorageDirectory();
File file = new File(path,"test.jpg");
RequestBody image = RequestBody.create(MediaType.parse("image/png"),file);
Call<ResponseInfo> call = service.uploadFile(image);

这里可以发现,当要上传的数据是文件时,就要使用到RequestBody了。再次运行程序,然后截取服务器打印的请求体的部分进行查看:

这里写图片描述

我们其实可以很直观的看到,大体的格式与之前都是一样的,而不同之处在于:

  • Content-Type不再是application/json,而是image/png了。
  • 空行之后的数据内容不再是之前直观的文本,而是二进制的图片内容。

这个时候就会出现一个问题,假设我们为了方便,打算通过一些公有的API去测试一下上传文件(图片)什么的,会发现上传不成功。这是为什么呢?
实际上如果我们完全自己动手来写服务器,完全根据之前的请求体打印信息的格式来写解析的方法,肯定是也能完成文件上传的。但问题在于:
我们说到multipart/form-data是支持多部分数据同时上传的,于是就出现了一个听上去很有逼格的梗,叫做“图文混传”。那么:
为了区别于同一个request-body中的文本或文件信息,所以通常实际开发来说,上传文件的时候,Content-Disposition是这样的:

Content-Disposition: form-data; name="file";filename="test.jpg"

而不是我们这里看到的:

Content-Disposition: form-data; name="file"

于是别人的api里读取不到这个关键的“filename”,自然也就无法完成上传了。所以如果想通过Retrofit实现文件上传,可以通过如下方式来改造一下:

public interface DemoService {
    @Multipart()
    @POST("api/files")
    Call<ResponseInfo> uploadFile(@Part("file\";filename=\"test.jpg") RequestBody photo);
}

然后我们在servlet服务器中进行解析,完成文件的上传。这里当然就不自己去写解析body的代码了,可以使用现有的库commons-fileupload。

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        try {
            DiskFileItemFactory factory = new DiskFileItemFactory();

            ServletFileUpload upload = new ServletFileUpload(factory);

            List<FileItem> items = upload.parseRequest(request);// 得到所有的文件
            Iterator<FileItem> i = items.iterator();
            while (i.hasNext()) {
                FileItem fi = (FileItem) i.next();
                String fileName = fi.getName();
                if (fileName != null) {
                    File fullFile = new File(fi.getName());
                    // 写入到D盘
                    File savedFile = new File("D://", fullFile.getName());
                    fi.write(savedFile);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

再次运行程序,从代码中可以看到,我们希望将客户端上传的图片保存电脑的D盘根目录下,打开D盘看一下吧,已经成功上传了!
这里写图片描述

  • 不同类型的Converter

相信我们还记得之前我们读取服务器返回的json数据时,依赖于GsonConverterFactory就成功完成了解析。那么问题来了:
假设有的时候我们服务器返回的就是一段简单的文本信息呢?这叫老夫如何是好,其实这在之前就已经有了答案了:

这里写图片描述

我们看到除了基于GSON的converter之外,官方还提供了很多其它的Converter。眼尖的马上就看到了Scalars后面有一个东西叫做String。
于是接下来的工作就简单了,依然是配置依赖;然后将Call的泛型指定为String;最后记得将Converter改掉,像下面这样:

//...
.addConverterFactory(ScalarsConverterFactory.create())

再次运行程序,查看日志打印信息,发现成功搞定:

这里写图片描述

有了这个例子,对于同类型的需求我们就很容易举一反三了。但马上又想到:假设我们的数据类型官方没有提供现成的Converter呢?很简单,自己造!

这里写图片描述

从官方描述中,我们发现自定义Converter其实很简单。即创建一个继承自Converter.Factory的类,然后提供自己的Converter实例就行了。
那么假设,我们现在服务返回的数据格式是下面这样的。而我们的需求是希望在客户端对其解析后,将其放进一个Map里面。

username=张三&male=男性

根据这样的需求,我们可以像下面这样很容易的实现我们自己的Converter:

public class CustomConverterFactory extends Converter.Factory{

    public static CustomConverterFactory create() {
        return new CustomConverterFactory();
    }

    @Override
    public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {
        return new CustomConverter();
    }

    class CustomConverter implements Converter<ResponseBody,Map<String,String>>{

        @Override
        public Map<String,String> convert(ResponseBody body) throws IOException {
            Map<String,String> map = new HashMap<>();
            String content = body.string();
            String [] keyValues = content.split("&");

            for (int i = 0;i<keyValues.length;i++){
                String keyValue = keyValues[i];
                int postion = keyValue.indexOf("=");
                String key  = keyValue.substring(0,postion);
                String value = keyValue.substring(postion+1,keyValue.length());
                map.put(key,value);
            }
            return map;
        }
    }
}

现在,我们就可以进行调用测试了:

            public void onResponse(Call<Map<String,String>> call, Response<Map<String,String>> response) {
                Map<String,String> map = response.body();
                Set<String> keySet = map.keySet();

                for (String key : keySet){
                    Log.d(TAG,key+":"+map.get(key));
                }

            }

查看日志打印:
这里写图片描述

  • 使用Interceptor

之前在学习@Headers的用法的时候,其实官方文档中还有一个东西,我们没有总结。官方的描述是这样的:

Headers that need to be added to every request can be specified using an OkHttp interceptor.
简单易懂,也就是说:如果你项目里的每一个请求需要加入某个header,那么就可以使用interceptor(interceptor本身是OkHttp里的东西)

interceptor顾名思义就是拦截器,其具体使用方法可以参照https://github.com/square/okhttp/wiki/Interceptors。这里我们看下官方的第一个例子:

这里写图片描述

这里面的其它东西相信都很熟悉,一个新的关键叫做Interceptor.chain。很明显,从命名我们可以猜想出它就是完成拦截的关键。
事实上,我们可以对以上的示例进行简化,最后其实我们需要学习的就两行代码:

Request request = chain.request();
Response response = chain.proceed(request);

也就是说:

  • 通过chain的request()方法,可以返回Request对象。
  • 通过chain的proceed()方法,可以返回此次请求的响应对象。

那么,以我们之前的需求来说:对所有的请求都添加某个请求头。实际就很容易实现了。

            public okhttp3.Response intercept(Chain chain) throws IOException {
                Request request = chain.request();
                // 重写request
                Request requestOverwrite = request.newBuilder().header("User-Agent","Android").build();

                return chain.proceed(requestOverwrite);
            }

同理,如果我们想要在每个Response中都添加某个header值呢?做法是一样的:

            @Override
            public okhttp3.Response intercept(Chain chain) throws IOException {
                Request request = chain.request();
                okhttp3.Response originalResponse = chain.proceed(request);

                return originalResponse.newBuilder().header("Cache-Control","max-age=100").build();
            }

但是,到现在为止,我们说到的都是interceptor在OkHttp中的使用。那么对应在Retrofit呢,其实很简单,因为我们说了Retrofit就是基于OkHttp的。
那么,前面一切的步骤都可以按照在OkHttp里的使用方法按部就班。唯一额外要做的工作就是,构建好OkHttpClient对象后,记得把它设置给Retrofit。

        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://192.168.2.100:8080/TestServer/")
                .client(mOkHttpClinet) // 看这里,看这里
                .build();

总结

到了这里,对Android中常用的网络请求库say hello系列的三篇博客总算是总结完毕了。而针对Retrofit的此文是写的最认真的一篇,一个是因为现在它的确是流行;其次是因为个人也比较感兴趣。如果您观看后有任何想法,望多多指正,给出宝贵意见。

SVN 代码提交:从基础到高级的全面指南 SVN代码提交步骤指南:1)使用svn update更新工作副本;2)通过svn add添加新文件;3)用svn commit -m提交更改并添加描述信息。建议提交前测试所有更改,保持提交内容有意义。可使用svn status查看修改状态。这些是SVN命令行工具的基本操作流程。 阅读详情

相关推荐

Retrofit2.0添加Header的方法总结(推荐)

最近在项目里面需要添加header,然后就想大家分想一下retrofit添加header的方法 (1)使用注解的方式添加一个header参数 public interface ApiService { @Headers(Cache-Control: max-age=560000) @GET(/data) Call<List>> getData(); } (2)使用注解的方式添加多个header参数 public interface ApiService { @Headers({ Accept: application/vnd.yourapi.

Retrofit官方使用文档

介绍 Retrofit 将你的HTTP API转化为一个Java接口 public interface GitHubService { @GET("users/{user}/repos") Call&lt;List&lt;Repo&gt;&gt; listRepos(@Path("user") String user); } Retrofit 类会生成GitHubService接口的实现...

hober的专栏 1551

python blp模型 估计_随机系数Logit模型及Stata实现

欢迎投稿(荐稿)计量经济圈,计量相关都行邮箱:econometrics666@sina.cn作者:北京交通大学经济管理学院博士生,王琦珀。欢迎你加入计量经济圈社群,一起探讨前沿计量理论和实证方法。一、随机系数Logit模型1.背景实证产业组织(Empirical Industrial Organization,EIO)是目前产业组织理论的前沿,其中又以Ariel Pakes为带头人,其近期工作论文...

weixin_42298927的博客 2641

Android Retrofit添加header参数

有些接口需要单独设置header参数 作为标记如何灵活 或者统一设置请求header呢。

吕氏春秋i 2948

rk3566-11.0新增device分区

1.增加块设备 2.修改根目录节点权限 3.开机启动自动挂载 增加块设备 1.修改parameter.txt文件,新增块设备大小及命名 device/rockchip/rk356x/rk3566_r/parameter.txt FIRMWARE_VER: 11.0 MACHINE_MODEL: rk3566_r MACHINE_ID: 007 MANUFACTURER: rockchip MAGIC: 0x5041524B ATAG: 0x00200800 MACHINE

weixin_51115260的博客 3383

HFSS新手避坑指南:手把手教你用FR4基板仿真威尔金森功分器(附参数优化技巧)

本文详细介绍了使用HFSS仿真FR4基板威尔金森功分器的12个关键细节,包括介质基板设置、微带线建模、隔离电阻设置等实战技巧。特别针对微波技术中的常见问题,提供了参数优化和结果解读的实用方法,帮助新手快速掌握HFSS仿真技能。

weixin_27310417的博客 225

Say Hello to Retrofit

该文章转载自LaterEqualsNever的Say Hello to Retrofit之前对Android里常用的网络请求库OkHttp与Volley做了简单的学习归纳与总结,这里看这个系列中的最后一篇,来认识一下Retrofit。 Retrofit可以认为是OkHttp的“升级版”。之所以这么说,是因为其内部默认正是基于OkHttp来进行封装的。这点从Retrofit这个命名就可以看出端倪。

Ricky 的博客 1393

别再凭感觉估算!用ADS的EBOND库精确仿真Bonding线寄生电感(附完整参数设置指南)

本文详细介绍了在ADS中使用EBOND库精确仿真Bonding线寄生电感的方法,帮助射频工程师在毫米波频段实现高精度建模。通过三维物理参数和电磁场求解算法,EBOND模型能将误差控制在5%以内,显著提升电路性能。文章还提供了完整的参数设置指南和实战操作步骤,适用于5G毫米波前端模块等高频应用场景。

weixin_28730131的博客 504

工作中使用到的单词(软件开发)

1.エイリアス   alias 别名 powershell使用 get-help 命令时,会得到与此命令 相关(别名)的命令 2.プロキシ proxy 代 理 3.プロモート   promote 促进,提升   开发的系统新功能上线发布,有时会使用到这个词,比如 STプロモート 还有使用リリース这个词的。比如STリリース。个人认为两者含义相同。 4.見逃し み................................................................

sun0322 6万+

【系统分析师】高分论文:论软件需求验证方法及应用

本文以某清算平台建设项目为例,探讨了软件需求验证方法的应用。该项目旨在隔离银行与支付公司的直接通信,满足央行监管要求。作为系统分析师,作者通过需求测试和需求评审两种方法确保需求质量。需求测试采用概念测试用例提前发现问题;需求评审通过正式与非正式形式多方确认需求。项目结合邮件评审、专家会议等方式,最终形成完善的需求文档。平台上线后运行良好,验证了需求管理的重要性。该案例表明,科学的需求验证是项目成功的关键保障。

数据知道的博客 8123

YOLOv11涨点改进| TGRS 2026 | 独家创新首发、特征融合改进篇| 引入STSAM协同时空注意力融合模块,发论文热点创新,注意力能够互相引导强化边界和结构细节,增强目标检测、图像分割涨点

🔥本文提出了一种改进YOLOv11网络模型的STSAM协同时空注意力融合模块,用于提升高分辨率遥感变化检测的精度。STSAM通过并行处理全局跨时相注意力和局部坐标注意力,能有效聚焦真实变化目标,强化边界和结构细节。该模块包含两个分支:Cross-Attention分支通过时间嵌入增强双时相特征的时间差异,CoordAtt分支则强化局部结构细节。实验表明,STSAM能显著提升变化检测性能,同时保持训练稳定性。文章详细介绍了模块结构、原理、优势,并提供了完整的核心代码实现和配置方法,包括三种改进方案。

Ai缝合怪、助力小伙伴高效发论文 216

Retrofit添加header参数的几种方法。

(1)使用注解的方式 添加一个Header参数 public interface UserService { @Headers("Cache-Control: max-age=640000") @GET("/tasks") Call> getTasks(); } 添加多个Header参数 public interface UserService {

zhuhai__yizhi的专栏 5万+

漏洞挖掘之工具配置

本文主要讲解burp工具的插件安装。

qq_64775230的博客 3273

【网络】app(retorfit2+RxJava)+javaweb(服务器) retrofit2官方文档实践

retrofit2 实践,retrofit2+rxjava +javaweb(server) 根据官方文档对retrofit2的进一步学习

在远处,不远处 6152

把 ABAP SQL 窗口函数讲透:从 OVER 到 LEAD、RANK 与累计分析

ABAP SQL窗口函数在不丢失明细记录的前提下,为每行数据提供组内统计和排名功能。它通过OVER子句定义计算窗口,支持三类函数:聚合型(AVG/SUM等)、排名型(ROW_NUMBER/RANK等)和取值型(LEAD/LAG)。相比GROUP BY会合并多行数据,窗口函数保留原始记录同时附加计算结果,特别适合需要保留明细又要展示统计信息的业务场景,如销售排名、客户分层分析等。语法核心是OVER子句,通过PARTITION BY分组,ORDER BY排序,可灵活定义计算范围。

2007 年 ~ 2025 年,深耕 SAP 技术 18 年 1272

android 蓝牙通讯demo

android 下蓝牙通讯demo,实现了发现蓝牙,使能蓝牙,通过蓝牙发送消息。

Retrofit2.0 添加Header的方法总结

一、使用注解 1. 添加单个header 2. 添加多个header 3. 动态添加header 4. 动态添加多个header 1. Post添加单个header 2.post添加固定的多个header 二、如果要添加全局header,则需要在代码中添加header ———————————————— 版权声明:本文为优快云博主「天兰之珠」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。 原文链接:https://blog.c

chuyouyinghe的专栏 6903

VC中sqlite的使用

在VC中对sqlite的使用,实现数据库大批数据的快速插入,读取数据库中的数据在ListCtrl中显示

Android网络请求库的使用(okhttp、retrofit、rxjava)

首先新建项目,添加网络权限,这个权限不需要⽤户授权, 默认申请就给, 不添加的话会报错: 然后在gradle中添加一下依赖: dependencies { implementation 'com.squareup.okhttp3:okhttp:4.9.1' implementation 'com.squareup.retrofit2:retrofit:2.9.0' implementation 'com.squareup.retrofit2:converter-gson:2.9.0

Xzike的博客 3059

计算机控制技术及应用

《计算机控制技术及应用》通过总结作者的科研成果和吸收国内外的先进理论、方法和技术,以计算机控制系统的网络化、开放化、智能化和集成化发展趋势为主线索,主要介绍计算机控制系统的基本概念和计算机控制系统的典型形式,计算机控制系统的数学描述与基本分析方法,以及数字PID控制器、最少拍控制系统、达林算法、状态变量设计法等设计方法及其各种改进算法。重点突出计算机控制系统输入输出通道接口的设计方法和典型控制系统的设计案例与实现方法等。

Android okhttputils 第三方库网络请求库

Android okhttp

MrYanXi的博客 1447

手把手教你搭建android项目框架(四)network网络库封装

network网络组件封装。 本系列持续更新,直到完成一个完整项目。

flowerdanceX的博客 530

Retrofit 2.0 官方文档

Retrofit来自移动支付公司square公司的作品,开源世界top5的最小公司,首先我自己是一个忠实广场粉,okhttp、picasso、greendao、okio等等~ 据Square CTO Bob Lee的说法,Square已经将超过60个项目提交到开源社区,贡献了25万行左右的代码。

王永迪的专栏 5567

Retrofit2.0使用以及注解

Retrofit2.0前言Retrofit2.0注解请求方法参数类标记类Retrofit2.0基本使用Retrofit2.0结合Rxjava2使用 前言 Retrofit在我的理解是针对于okhttp的二次封装,它支持反序列化来解析数据,支持Rxjava,具有强大的可扩展性 Retrofit2.0注解 看Retrofit的源码发现共有有24个注解类,其中8个为请求方法类,13个参数类,3个标记类 ...

浮生若梦-笑叹人生 604

Retrofit 官方文档翻译

介绍Retrofit 把 HTTP API 转成 a Java (接口)interface.public interface GitHubService { @GET("users/{user}/repos") Call&lt;List&lt;Repo&gt;&gt; listRepos(@Path("user") String user); }The Retrofit class 生成一...

jack22001的博客 440

Retrofit中的注解

参数method:使用http注解时必须要指定method,method如果是POST就会执行http方法执行post请求,method如果指定GET就会执行http方法执行get请求。@path注解作用于参数部分,意思是{id}里面是id会被@path中的id替换掉替换成参数path。可以看到请求的url是http://www.httpbin.org/post,使用的是post请求。@url注解作用于参数中,作用是指定完整的http地址,不像之前的注解还要自己进行拼接。@Header是用来设置请求头的。

Rssqzqyp的博客 1365
上一篇: Android网络请求库 - Say hello to Volley
下一篇: 带着疑惑走进Dagger2
LaterEqualsNever
博客等级 码龄12年 297粉丝 61原创
评论 28
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值