Retrofit2.0实践记录

最新推荐文章于 2024-07-11 17:50:45 发布
最新推荐文章于 2024-07-11 17:50:45 发布
阅读量4.2k 收藏 1
点赞数 1
分类专栏： Android
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u012858313/article/details/51330541
版权

前言

Type-safe HTTP client for Android and Java by Square, Inc.

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

API：http://square.github.io/retrofit/2.x/retrofit/

参考：http://gank.io/post/56e80c2c677659311bed9841
http://blog.csdn.net/lmj623565791/article/details/51304204

简介

主要记录一下GET,POST请求，以及Query,Path等注解的理解以及使用。主要有：

  • GET方式请求String

  • GET方式请求Json

  • GET方式访问自签名网站https

  • POST方式请求Json（需要header情况）

Converter（转化器）

Converter:用于对象转化的。默认情况下，Retrofit 请求结果为responsebody型 

  Response<T> parseResponse(okhttp3.Response rawResponse) throws IOException {
    ResponseBody rawBody = rawResponse.body();

    // Remove the body's source (the only stateful object) so we can pass the response along.
    rawResponse = rawResponse.newBuilder()
        .body(new NoContentResponseBody(rawBody.contentType(), rawBody.contentLength()))
        .build();

    int code = rawResponse.code();
    if (code < 200 || code >= 300) {
      try {
        // Buffer the entire body to avoid future I/O.
        ResponseBody bufferedBody = Utils.buffer(rawBody);
        return Response.error(bufferedBody, rawResponse);
      } finally {
        rawBody.close();
      }
    }

    if (code == 204 || code == 205) {
      return Response.success(null, rawResponse);
    }

    ExceptionCatchingRequestBody catchingBody = new ExceptionCatchingRequestBody(rawBody);
    try {
      T body = serviceMethod.toResponse(catchingBody);
      return Response.success(body, rawResponse);
    } catch (RuntimeException e) {
      // If the underlying source threw an exception, propagate that rather than indicating it was
      // a runtime exception.
      catchingBody.throwIfCaught();
      throw e;
    }
  }
 T toResponse(ResponseBody body) throws IOException {
    return responseConverter.convert(body);
  }

其中 T body = serviceMethod.toResponse(catchingBody);就是将ResponseBody通过Converter转换成相应的类型

Retrofit定义好的转化器有下面几种：

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

其中Gson,Jackson,Moshi是用来转换Json对象的
Scalars 转换基本类型和String，eg：int，boolen，byte…
Simple XML:xml
Protobuf和Wire我还没有用过。

需要自定义的看这里：http://blog.csdn.net/lmj623565791/article/details/51304204

实践

  • GET方式请求String

    1. 创建一个接口RequsetService

      /**
 * Created by Administrator on 2016/5/4.
 */
public interface RequsetService {
    /**
     * https://api.douban.com/v2/movie/top250?start=0&count=10
     * GET方式请求String
     */
    @GET("top250")
    Call<String> getTopMovieStr(@Query("start") int start, @Query("count") int count);

}

      这里我response的类型是一个String,所以Call里面泛型为String

    2. 通过Retrofit完成上述请求

          /**
     * method: GET
     *
     * @Query response:String
     */
    private void getStrByGetMethod() {
        String baseUrl = "https://api.douban.com/v2/movie/";
        Retrofit retrofit = new Retrofit.Builder().baseUrl(baseUrl).addConverterFactory(ScalarsConverterFactory.create()).build();
        RequsetService requsetService = retrofit.create(RequsetService.class);
        Call<String> call = requsetService.getTopMovieStr(0, 10);
        call.enqueue(new Callback<String>() {
            @Override
            public void onResponse(Call<String> call, Response<String> response) {
                Log.e(TAG, "call:" + call.toString());
                Log.e(TAG, "response:" + response.body());
            }

            @Override
            public void onFailure(Call<String> call, Throwable t) {

            }
        });
    }

  • GET方式请求Json

    1. 创建一个接口

          @GET("top250")
    Call<MovieEntity> getTopMovieJson(@Query("start") int start, @Query("count") int count);

    2. Retrofit完成请求

          /**
     * method: GET
     *
     * @Query response:Gson
     */
    private void getJsonByGetMethod() {
        String baseUrl = "https://api.douban.com/v2/movie/";
        Retrofit retrofit = new Retrofit.Builder().baseUrl(baseUrl).addConverterFactory(GsonConverterFactory.create()).build();
        RequsetService requsetService = retrofit.create(RequsetService.class);
        Call<MovieEntity> call = requsetService.getTopMovieJson(0, 10);
        Log.e(TAG, "request:" + call.request().toString());
        call.enqueue(new Callback<MovieEntity>() {
            @Override
            public void onResponse(Call<MovieEntity> call, Response<MovieEntity> response) {
                tvRequset.setText(response.body().toString());
                Log.e(TAG, "response:" + response.body().toString());
            }

            @Override
            public void onFailure(Call<MovieEntity> call, Throwable t) {

            }
        });
    }

  • GET方式访问自签名网站https

    1. 获取自签名证书
      //未完

    2. 创建接口

      @GET
Call<String> getHttpsHtml(@Url String url);

    3. Retrofit完成请求

       /**
     *  method: GET
     *  @Url
     *  response:String
     */
    private void getHttpsHtml(){
        InputStream[] inputStream = new InputStream[]{new Buffer().writeUtf8(CER_WIFI).inputStream()};
        SSLSocketFactory sslSocketFactory = HttpsUtils.getSslSocketFactory(inputStream, null, null);

        OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
        httpClient.sslSocketFactory(sslSocketFactory);
        OkHttpClient client = httpClient.build();

        String baseUrl = "https://www.wifi4.cn/wifi/yyhuang/";
        Retrofit retrofit = new Retrofit.Builder().baseUrl(baseUrl).addConverterFactory(ScalarsConverterFactory.create()).client(client).build();
        RequsetService requsetService = retrofit.create(RequsetService.class);
        Call<String> call = requsetService.getHttpsHtml("BC96802F9960");
        Log.e(TAG, "request:" + call.request().toString());
        call.enqueue(new Callback<String>() {
            @Override
            public void onResponse(Call<String> call, Response<String> response) {
                Log.e(TAG, "call:" + call.toString());
                Log.e(TAG, "response:" + response.body());
            }

            @Override
            public void onFailure(Call<String> call, Throwable t) {
                Log.e(TAG, "onFailure call:" + call.toString());
                Log.e(TAG, "onFailure response:" + t.toString());
            }
        });
    }

  • POST方式请求Json（需要header情况）

    1. 创建一个接口

      @POST("login")
Call<Object> getInfoByPost(@Body String str);

      我这里Body写成String,是因为我的数据需要加密，如果不需要加载，可以直接传对象

    2. Retrofit完成请求

       /**
     * POST
     * @Body
     */

    private void loginByPostMethod() {
        OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
        httpClient.addInterceptor(new Interceptor() {
            @Override
            public okhttp3.Response intercept(Chain chain) throws IOException {
                Request original = chain.request();

                Request request = original.newBuilder()
                        .header("ver", "V3.0.6")
                        .header("ctype", "0")
                        .method(original.method(), original.body())
                        .build();

                return chain.proceed(request);
            }
        });

        OkHttpClient client = httpClient.build();
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://xxxx:11203/")
                .addConverterFactory(GsonConverterFactory.create())
                .client(client)
                .build();
        RequsetService requsetService = retrofit.create(RequsetService.class);
        String body = "xxx";
        Call<Object> call = requsetService.getInfoByPost(body);
        Log.e(TAG, "url:" + call.request().url());
        call.enqueue(new Callback<Object>() {
            @Override
            public void onResponse(Call<Object> call, Response<Object> response) {
                // tvRequset.setText(response.body().toString());
                Log.e(TAG, "response:" + response.body());
            }

            @Override
            public void onFailure(Call<Object> call, Throwable t) {

            }
        });
    }

注解

  • @Query （询问）：Query 作为符号“？”，然后再将Query 的参数拼接到Url，value转换成String,null忽略。以@GET(“/list”)为例：

    1. 简单例子：

       Call<ResponseBody> getListMethod(@Query(“page”) int page)

      foo.getListMethod(1) ：baseUrl /list?page=1.

    2. Array/Varargs例子：

      Call<ResponseBody> getListMethod(@Query(“category”) String… categories)

      foo.getListMethod(“bar”, “baz”) ：baseUrl /list?category=bar&category=baz.

    3. encoded = true例子： 

       Call<ResponseBody> getListMethod(@Query(value=”foo”, encoded=true) String foo)

      foo.getListMethod(“foo+bar”) ：baseUrl /list?foo=foo+bar.

  • @Path（路径）：请求的URL可以根据使用的方法替换块和参数进行动态更新。替换块是由{ 和 } 环绕的字母数字字符串构成，而相应的参数必须用 @Path 注解标注，同时要求注解的参数使用相同的字符串,以@GET(“/user/{name}”)为例：

    1. 简单例子：

      Call<ResponseBody> exampleMethod(@Path(“name”) String name)

      foo.exampleMethod(“John”) ：baseUrl /user/John.

    2. encoded 例子： 

       Call<ResponseBody> encodedMethod(@Path(“name”) String name)

      foo.encodedMethod(“John+Doe”) ：baseUrl /user/John%2BDoe .

    3. encoded = true例子：

      Call<ResponseBody> encodedMethod(@Path(value=”name”, encoded=true) String name)

      foo.encodedMethod(“John+Doe”) ：baseUrl /user/John%+Doe .

  • @QueryMap： @GET(“/search”)

    1. Call<ResponseBody> exampleMethod(@QueryMap Map<String, String> filters);

      foo.exampleMethod(ImmutableMap.of(“foo”, “bar”, “kit”, “kat”))， baseUrl/search?foo=bar&kit=kat.

    2. Call<ResponseBody> exampleMethod(@QueryMap(encoded=true) Map<String, String> filters);

      foo.exampleMethod(ImmutableMap.of(“foo”, “foo+bar”))， baseUrl/search?foo=foo+bar.

  • @Body： 声明一个对象当作 HTTP 请求体, @POST/PUT (“users/new”),用于POST/PUT请求

    • @POST("users/new")
Call<User> createUser(@Body User user);

      @Body以json格式提交数据，所以不能用@FormUrlEncoded 或者@Multipart 标签

  • @FormUrlEncoded： application/x-www-form-urlencoded方式提交form-encoded 数据(表单数据)，请求类似于下面这样：

    • POST http://www.example.com HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

title=test&sub%5B%5D=1&sub%5B%5D=2&sub%5B%5D=3

      首先，Content-Type 被指定为 application/x-www-form-urlencoded；其次，提交的数据按照 key1=val1&key2=val2 的方式进行编码，key 和 val 都进行了 URL 转码。了解其他提交方式：未完。

  • @Field： 一般用于表单的方式传递键值对，多用于POST

    1. 简单例子： 

      @FormUrlEncoded
@POST("/")
Call<ResponseBody> example(@Field("name") String name,@Field("occupation") String occupation);

      用法:foo.exampleMethod(“Bob Smith”, “President”),body:name=Bob+Smith&occupation=President.

    2. Array/Varargs例子：

      @FormUrlEncoded 
@POST(“/list”) 
Call<ResponseBody> exampleMethod(@Field(“name”) String… names);

      用法：foo.exampleMethod(“Bob Smith”, “Jane Doe”)，body：name=Bob+Smith&name=Jane+Doe.

  • @FieldMap：

    1. 简单例子： 

       @FormUrlEncoded
 @POST("/things")
 Call<ResponseBody> things(@FieldMap Map<String, String> fields); ;

      用法:foo.things(ImmutableMap.of(“foo”, “bar”, “kit”, “kat”), request body :foo=bar&kit=kat.

  • @Headers： 设置静态的 header,header 不能互相覆盖。

    •  @Headers("Cache-Control: max-age=640000")
 @GET("/")
       @Headers({
   "X-Foo: Bar",
   "X-Ping: Pong"
 })
 @GET("/")

  • @Header： 更新一个请求的 header,必须给 @Header 提供相应的参数，如果参数的值为空 header 将会被忽略.


    • @GET("/")

Call<ResponseBody> foo(@Header("Accept-Language") String lang);

  • @Multipart： multipart/form-data方式提交multipart数据，请求类似于下面这样：，（上传文件）

    • POST http://www.example.com HTTP/1.1
Content-Type:multipart/form-data; boundary=----WebKitFormBoundaryrGKCBY7qhFd3TrwA

------WebKitFormBoundaryrGKCBY7qhFd3TrwA
Content-Disposition: form-data; name="text"

title
------WebKitFormBoundaryrGKCBY7qhFd3TrwA
Content-Disposition: form-data; name="file"; filename="chrome.png"
Content-Type: image/png

PNG ... content of chrome.png ...
------WebKitFormBoundaryrGKCBY7qhFd3TrwA--

  • @Part： 一般用于上传文件

    • @Multipart

@POST("/")

Call<ResponseBody> example(@Part MultipartBody.Part photo,@Part("description") String description,@Part(value = "image", encoding = "8-bit") RequestBody image);

      eg:

      File file = new File(Environment.getExternalStorageDirectory(), "icon.png");
RequestBody photoRequestBody = RequestBody.create(MediaType.parse("image/png"), file);
MultipartBody.Part photo = MultipartBody.Part.createFormData("photos", "icon.png", photoRequestBody);
Call<ResponseBody> call = example(photo, RequestBody.create(null, "abc"), photoRequestBody );

  • @PartMap： 一般用于多文件上传

    • @Multipart

@POST("/upload")

Call<ResponseBody> upload(@Part("file") RequestBody file,@PartMap Map<String, RequestBody> params);
      File file = new File(Environment.getExternalStorageDirectory(), "messenger_01.png");
        RequestBody photo = RequestBody.create(MediaType.parse("image/png", file);
Map<String,RequestBody> photos = new HashMap<>();
photos.put("photos\"; filename=\"icon.png", photo);
photos.put("username",  RequestBody.create(null, "abc"));
Call<ResponseBody> call = upload(null,photos);

代码以后再上传
第一次使用Retrofit，如果有什么问题或者BUG，希望能给我留言

抽烟的青蛙
关注
专栏目录
两行代码搞定发送 Retrofit GET/POST 请求
qingtiantianqing的博客
05-06 2996
目前Android开发几乎都离不开网络请求，而很多Android App网络框架都使用Retrofit来发送网络请求和响应交互，其优点是一底层依赖了强大灵活的Okhttp，二是其符合标准的RESTFUL和后端交互更爽。本身Retrofit已经封装得很好了，其使用也很简单://定以接口 public interface GitHubService { @GET("users/{user}/repo
Retrofit 2.0 超能实践（三），轻松实现文件/多图片上传/Json字符串
Tamic （大白）
06-24 3万+
通过前两篇姿势的入门 Retrofit 2.0 超能实践，完美支持Https传输 Retrofit2.0 完美同步Cookie实现免登录 通过对Retrofit2.0的前两篇的基础入门和案例实践，掌握了怎么样使用Retrofit访问网络，加入自定义header，包括加入SSL证书，基本的调试基础，coolkie同步，但很多需求需要文件的上传，今天主题就来分享怎么用Retrofit2.0 上传文件
Retrofit post请求raw传参
csdn_zxw的博客
03-20 875
RequestBody requestBody1 = RequestBody.create(MediaType.parse("text/plain"),"我要传的字符串"); 接口： Observable<JsonObject> postMessageToNet(@Body RequestBody requestBody);
Android Retrofit post请求，@Body传递的参数转义问题
最新发布
snoto的专栏
07-11 588
因为传递的参数字符串中有等号 = ，结果传递的时候，打印出来。Gson解析的时候转义了。
非web工程使用slf4j输出日志
jingshenbusi的博客
05-23 2636
1.先看目录结构2.main方法public class Slf4j { private static final Logger logger = LoggerFactory .getLogger(Slf4j.class); public static void main(String[] args) { String log4j = Slf4j.class.getClassLoa...
http 返回raw java,使用Retrofit获取原始HTTP响应
weixin_34649022的博客
02-28 280
I want to get the raw http response from my API REST. I have tried with this interface:@POST("/login")@FormUrlEncodedCall login(@Field("username") String login, @Field("password") String pass,@Field("...
retrofit 源码解读
点滴积累
07-05 314
Thanks https://www.jianshu.com/p/0c055ad46b6c 刘望舒：http://liuwangshu.cn/application/network/11-retrofit2-sourcecode.html https://blog.piasy.com/2016/07/11/Understand-OkHttp/
Retrofit 2.0 使用实践总结
Crystal_xing的专栏
01-28 334
Retrofit2.0是基于okhttp封装的网络请求库，无论是MVP还是MVVM，都是网络请求框架的首选，总结一些开发中重要的记录下来，理解自用。 发请求的步奏可以理解为3个步奏： 1. 创建OkHttpClient ,创建Retrofit实例(Retrofit Builder) 2.创建ApiHttpService ...
Retrofit 2.0 超能实践（四），完成大文件断点下载
Tamic （大白）
07-21 1万+
作者：码小白 文/CSDN 博客 本文出自：http://blog.csdn.net/sk719887916/article/details/51988507 码小白 通过前几篇系统的介绍和综合运用，忘记介绍文件下载功能了，有朋友问到，目前APP文件下载主要有断点续传，多线程并发下载，多类型下载，今天就介绍下其Retrofit下载文件功能。 Retrofit 2.0 超能实践，完美
Retrofit2.0 ，OkHttp3完美同步持久Cookie实现免登录(二)
Tamic （大白）
06-17 3万+
通过对Retrofit2.0的<Retrofit 2.0 超能实践，完美支持Https传输>基础入门和案例实践，掌握了怎么样使用Retrofit访问网络，加入自定义header，包括加入SSL证书，基本的调试基础，但是正常的开发中会涉及cookie同步问题，可以实现一些自动或免登录登陆问题，接下来进入cookie同步姿势CookieCookies是一种能够让网站服务器把少量数据储存到客户端的硬盘或内
RetrofitDemo:改造2.0演示
05-02
在这个"RetrofitDemo:改造2.0演示"项目中，我们将会深入探讨Retrofit 2.0版本的一些关键特性和用法。 Retrofit 2.0是Square公司推出的更新版，相比于早期版本，它提供了更多的改进和优化。以下是一些核心知识点： ...
Retrofit2基础使用与解析：从使用步骤深入分析源码
MagicSound的博客
06-15 631
联网权限： 步骤二 创建接收数据实体类 依据服务器返回的数据，建造实体类承载数据 使用注解进行请求方式、参数的设置。 方法的返回值默认使用Call。（使用RxJava时用Observable） 步骤五 创建网络请求接口实例 调用retrofit.create方法获取请求接口的实体类，调用该实体类方法即可对请求进行封装。 使用生成的call，分别调用enqueue、execute进行异步、同步请求。 使用数据response进行数据处理。 可以看出实例是使用建造者模式创建的，由用户...
Retrofit网络请求参数注解，@Path、@Query、@Post、Body等总结
热门推荐
郭昊的博客
12-31 7万+
Retrofit网络请求参数注解，@Path、@Query、@Post、Body等总结具体用法 -
初识Retrofit2.0
weixin_33882452的博客
06-27 253
1.Retrofit简介 Retrofit无疑是当下最流行的Android网络请求框架了，是Square提供的开源产品。官方网站是这样介绍Retrofit的—-A type-safe HTTP client for Android and Java，为Android平台的应用提供一个类型安全的HTTP客户端。Retrofit 是一套注...
rawResponse must be successful response
一个人的暗
11-30 1万+
      使用环境：        遇到此类报错时查看 java.lang.IllegalArgumentException: rawResponse must be successful response 11-30 09:38:25.717 6518-6518/com.bhxcw.Android W/System.err: at com.lzy.okgo.model....
解决response.body().string()无法读取多次的问题
Mike_Fei的博客
03-09 3318
解决response.body().string()无法读取多次的问题
Android 网络框架之Retrofit源码解析
鸿蒙开发知识记录
10-21 945
在使用了Retrofit之后，你是否会有这样的疑问： 1、为什么有OkHttp这么强大的网络框架了，Retrofit还能脱颖而出？ 2、Retrofit是怎么适配第三方框架的？ 3、Retrofit用了哪些设计模式？ 4、Retrofit为什么好用？ 下面我们就来探索Retrofit的真面目吧！ 本文基于以下Java版本解析： // retrofit implementation 'com.squareup.retrofit2:retrofit:2.5.0' implementation 'com.s.
retrofit post get请求使用request body传输
qq_38373150的博客
04-10 4447
http传输，post请求使用form表单的形式的话是在api请求中用@fIeld 字段 如果使用body传输，则如下： 1.post请求 @POST("/api/v1/user") fun getUser(@Body body: RequestBody?): Observable<BaseBean<String>> 2.model中： fu...
Android Retrofit2.0 实现微信风格说说上传
本文将详细介绍如何在Android应用中利用Retrofit2.0技术来实现一个类似微信的发说说功能，包括拍照、图库选择以及多图片上传。首先，Retrofit2.0是基于Java的网络请求库，它简化了与RESTful API的交互，使开发者能够...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值