Android Retrofit 2.0（一）初次见面请多多关照

最新推荐文章于 2021-10-24 23:26:11 发布
最新推荐文章于 2021-10-24 23:26:11 发布
阅读量2.8k 收藏 12
点赞数 3
分类专栏： Android 实战 文章标签： android Retrofit2.0 基础 初识
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/csdn_aiyang/article/details/72303367
版权

前言

    Retrofit 是SQUARE美国一家移动支付公司最近新发布的在Android平台上 Http 访问的开源项目。官方标语：“A type-safe HTTP client for Android and Java”语意很明显是一款Android 安全类型的http客户端。 这里安全指什么呢？是支持https或是支持本地线程安全呢？而且，Retrofit其内部都是支持lambda语法（链式语法），内部支持okHttp, 并且支持响应式RxJava，当然JDK 1.8 和 android studio工具也支持lambda。带着这些疑问 我开始探究一下。

Retrofit 官方GitHub地址 

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


系列文章推荐：

Android 必须知道的网络请求框架库，你不可错过的框架介绍篇

Android Retrofit 2.0（一）初次见面请多多关照

Android Retrofit 2.0（二）使用教程OkHttp3 + Gson + RxJava

Android Retrofit 2.0（三）从源码分析原理 


添加依赖

compile 'com.squareup.retrofit2:retrofit:2.0.0-beta4'
compile 'com.squareup.retrofit2:converter-gson:2.0.0-beta4'

com.squareup.retrofit2:converter-gson:2.0.0-beta4 此依赖非必须，只是方便我对http返回的数据进行解析，下面会讲到。


基础使用

private  void getLogin() {
    Retrofit retrofit = new Retrofit.Builder()
            .baseUrl("http://localhost:8080/")
            .addConverterFactory(GsonConverterFactory.create())
            .build();
    ApiManager apiService = retrofit.create(ApiManager.class);

    Call<LoginResult> call = apiService.getData("lyk", "1234");
   call.enqueue(new Callback<LoginResult>() {
       @Override
       public void onResponse(Call<LoginResult> call, Response<LoginResult> response) {
           if (response.isSuccess()) {
               // 请求成功
           } else {
              //直接操作UI 或弹框提示请求失败
           }
       }

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

           //错误处理代码
       }
   });
}

ApiManager接口

public interface ApiManager {

 @GET("login/")
 Call<LoginResult> getData(@Query("name") String name, @Query("password") String pw);

以上就是实现一个登录Login接口的小功能 ，先了解一下Retrofit的基本用法。


基础介绍


1、首先，实例化一个Retrofit对象。

 Retrofit retrofit = new Retrofit.Builder()
          .baseUrl("http://localhost:8080/")
          .addConverterFactory(GsonConverterFactory.create())
          .build();

*addConverterFactory 制定数据解析器，上面添加依赖的gson就是用在这里做默认数据返回的， 之后通过build()创建出来。

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

2、然后，定义带参的请求接口

  @GET("login/")
  Call<LoginResult> getData(@Query("name") String name, @Query("password") String pw);

Call<T>是继承Cloneable的 并支持泛型，且此类是Retrofit统一返回对象，支持Callback<T>回调，在2.0上已支持RxJava观察者对象Observable<T>，此案例暂时用call ，后面入门了retrofit之后再接入RxJava。

接着我们可以传入制定的解析Modle，就会在主线程里返回对应的model数据，无需开发者手动解析json数据。返回格式由开发者自己设置。

这里主要用注解@get @post 设置请求方式，后面“login/”是方法Url, @Query("name")来设定body的parameters。

  • 如果想用表单 @FieldMap
    @FormUrlEncoded
@POST("/url")
 Call<T> postForm(
     @FieldMap Map<String , Object> maps);

  • 如果直接用对象 @Body

    @POST("url")
 Call<T> PostBody(
      @Body Objects objects);

  • 如果直接多参数 @QueryMap

    @PUT("/url")
Call<T> queryMap(
      @QueryMap Map<String, String> maps);

  • 如果上传文件 @Part

    @Multipart
@POST("/url")
Call<ResponseBody> uploadFlie(
      @Part("description") RequestBody description,
      @Part("files") MultipartBody.Part file);

  • 如果多文件上传 @PartMap()

    @Multipart
@POST("{url}")
Call<T> uploadFiles(
      @Path("url") String url,
      @PartMap() Map<String, RequestBody> maps);

3、最后，调用API发起请求

   Call<LoginResult> call = apiService.getData("lyk", "1234");
   call.enqueue(new Callback<LoginResult>() {
       @Override
       public void onResponse(Call<LoginResult> call, Response<LoginResult> response) {

       }

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

       }
   });
}

Retrofit支持异步和同步：

  • call.enqueue(new Callback<LoginResult>）采用异步请求；
  • call.execute() 采用同步方式。

4、取消请求

 call.cancel();

进阶练习


我们依然要面对的问题是 ，Retrofit 的内部怎么无法输出Log ？header怎么加入？请求怎么支持https？包括怎么结合RxJava? 不用担心，这些问题Retrofit 2.0 都提供了支持okhttp的自定义的Interceptor（拦截器）解决了。通过不同的拦截器可以实现不同的自定义请求形式，比如统一加head、参数、加入证书（ssl）等，前提必须结合okhttp来实现 , 通过给OkHttpClient添加Interceptor，然后给Retrofit设置http即可。Retrofit提供了.client(）方法供我们自定义请求，当然默认请求就是okhttps的。

1、开启Log

用拦截器实现， retrofit已经提供了 HttpLoggingInterceptor 里面有四种级别，输出的格式，可以看下面介绍。

public enum Level {
    /** No logs. */
    NONE,
    /**
     * Logs request and response lines.
     *
     * <p>Example:
     * <pre>{@code
     * --> POST /greeting http/1.1 (3-byte body)
     *
     * <-- 200 OK (22ms, 6-byte body)
     * }</pre>
     */
    BASIC,
    /**
     * Logs request and response lines and their respective headers.
     *
     * <p>Example:
     * <pre>{@code
     * --> POST /greeting http/1.1
     * Host: example.com
     * Content-Type: plain/text
     * Content-Length: 3
     * --> END POST
     *
     * <-- 200 OK (22ms)
     * Content-Type: plain/text
     * Content-Length: 6
     * <-- END HTTP
     * }</pre>
     */
    HEADERS,
    /**
     * Logs request and response lines and their respective headers and bodies (if present).
     *
     * <p>Example:
     * <pre>{@code
     * --> POST /greeting http/1.1
     * Host: example.com
     * Content-Type: plain/text
     * Content-Length: 3
     *
     * Hi?
     * --> END GET
     *
     * <-- 200 OK (22ms)
     * Content-Type: plain/text
     * Content-Length: 6
     *
     * Hello!
     * <-- END HTTP
     * }</pre>
     */
    BODY
  }

例如，开启请求头添加拦截器

   Retrofit retrofit = new Retrofit.Builder().client(new OkHttpClient.Builder()

                         .addNetworkInterceptor(
                                    new   HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.HEADERS))       
     .build())

开启body日志添加拦截器

.addNetworkInterceptor(
                                    new   HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY))

基础的输出添加拦截器

.addNetworkInterceptor(
                                    new   HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BASIC))

2、增加头部信息

通用请求头

 new Retrofit.Builder()
           .addConverterFactory(GsonConverterFactory.create())

           .client(new OkHttpClient.Builder()
                   .addInterceptor(new Interceptor() {
                       @Override
                       public Response intercept(Chain chain) throws IOException {
                           Request request = chain.request()
                                   .newBuilder()
                                   .addHeader("mac", "f8:00:ea:10:45")
                                   .addHeader("uuid", "gdeflatfgfg5454545e")
                                   .addHeader("userId", "Fea2405144")
                                   .addHeader("netWork", "wifi")
                                   .build();
                           return chain.proceed(request);
                       }
                   })

                   .build()

特殊API接口单独加入

@Headers({ "Accept: application/vnd.github.v3.full+json", "User-Agent: Retrofit-your-App"})
@get("users/{username}")
Call<User>   getUser(@Path("username") String username);

3、添加证书Pinning

证书可以在自定义的OkHttpClient加入certificatePinner 实现

OkHttpClient client = new OkHttpClient.Builder()
    .certificatePinner(new CertificatePinner.Builder()
            .add("YOU API.com", "sha1/DmxUShsZuNiqPQsX2Oi9uv2sCnw=")
            .add("YOU API..com", "sha1/SXxoaOSEzPC6BgGmxAt/EAcsajw=")
            .add("YOU API..com", "sha1/blhOM3W9V/bVQhsWAcLYwPU6n24=")
            .add("YOU API..com", "sha1/T5x9IXmcrQ7YuQxXnxoCmeeQ84c=")
            .build())

4、支持https

加密和普通http客户端请求支持https一样，步骤如下：

  1. CertificateFactory 得到Context.getSocketFactory；
  2. 添加证书源文件；
  3. 绑定到okhttpClient；
  4. 设置okhttpClient到retrofit中。

证书同样可以设置到okhttpclient中，我们可以把证书放到raw路径下：

 SLSocketFactory sslSocketFactory =getSSLSocketFactory_Certificate(context,"BKS", R.raw.XXX);

准备证书源文件

加入证书源文件，我的证书是放在Raw下面的： 


证书

绑定证书

protected static SSLSocketFactory getSSLSocketFactory(Context context, int[] certificates) {

if (context == null) {
    throw new NullPointerException("context == null");
}

CertificateFactory certificateFactory;
try {
    certificateFactory = CertificateFactory.getInstance("X.509");
    KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
    keyStore.load(null, null);

    for (int i = 0; i < certificates.length; i++) {
        InputStream certificate = context.getResources().openRawResource(certificates[i]);
        keyStore.setCertificateEntry(String.valueOf(i), certificateFactory.generateCertificate(certificate));

        if (certificate != null) {
            certificate.close();
        }
    }
    SSLContext sslContext = SSLContext.getInstance("TLS");
    TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
    trustManagerFactory.init(keyStore);
    sslContext.init(null, trustManagerFactory.getTrustManagers(), new SecureRandom());
   return sslContext.getSocketFactory();

构建HostnameVerifier

 protected static HostnameVerifier getHostnameVerifier(final String[] hostUrls) {

    HostnameVerifier TRUSTED_VERIFIER = new HostnameVerifier() {

        public boolean verify(String hostname, SSLSession session) {
            boolean ret = false;
            for (String host : hostUrls) {
                if (host.equalsIgnoreCase(hostname)) {
                    ret = true;
                }
            }
            return ret;
        }
    };

return TRUSTED_VERIFIER;
}

设置setSocketFactory

okhttpBuilder.socketFactory(HttpsFactroy.getSSLSocketFactory(context, certificates));

certificates 是你raw下证书源ID, int[] certificates = {R.raw.myssl}

设置setNameVerifie

okhttpBuilder.hostnameVerifier(HttpsFactroy.getHostnameVerifier(hosts));

hosts是你的host数据，例如 String hosts[]`= {“https//:aaaa,com”, “https//:bbb.com”}

实现自定义 添加到Retrofit

okHttpClient = okhttpBuilder.build(); 
  Retrofit retrofit = new Retrofit.Builder() .client(okHttpClient) .build();

如果信任所有https请求，
可以直接将OkHttpClient的HostnameVerifier设置为false

OkHttpClient client = new OkHttpClient();

    client.setHostnameVerifier(new HostnameVerifier() {
        @Override
        public boolean verify(String s, SSLSession sslSession) {
            return true;
        }
    });
    TrustManager[] trustAllCerts = new TrustManager[] { new X509TrustManager() {
        @Override
        public void checkClientTrusted(
                java.security.cert.X509Certificate[] x509Certificates,
                String s) throws java.security.cert.CertificateException {
        }

        @Override
        public void checkServerTrusted(
                java.security.cert.X509Certificate[] x509Certificates,
                String s) throws java.security.cert.CertificateException {
        }

        @Override
        public java.security.cert.X509Certificate[] getAcceptedIssuers() {
            return new java.security.cert.X509Certificate[] {};
        }
    } };
    try {
        SSLContext sc = SSLContext.getInstance("TLS");
        sc.init(null, trustAllCerts, new java.security.SecureRandom());
        client.setSslSocketFactory(sc.getSocketFactory());
    } catch (Exception e) {
        e.printStackTrace();
    }

   clent.protocols(Collections.singletonList(Protocol.HTTP_1_1)) .build();

常规问题

1 url被转义

   http://api.myapi.com/http%3A%2F%2Fapi.mysite.com%2Fuser%2Flist

请将@path改成@url

   public interface APIService { 
    @GET Call<Users> getUsers(@Url String url);}

或者：

  public interface APIService {
    @GET("{fullUrl}")
    Call<Users> getUsers(@Path(value = "fullUrl", encoded = true) String fullUrl);
}

2Method方法找不到

java.lang.IllegalArgumentException: Method must not be null

请指定具体请求类型@get @post等

   public interface APIService { 

   @GET Call<Users> getUsers(@Url String url);
}

3Url编码不对，@fieldMap parameters must be use FormUrlEncoded

如果用fieldMap加上FormUrlEncoded编码

@POST()
@FormUrlEncoded
Observable<ResponseBody> executePost(
        @FieldMap Map<String, Object> maps);

上层需要转换将自己的map转换为FieldMap

 @FieldMap(encoded = true) Map<String, Object> parameters,

4 paht和url一起使用

Using @Path and @Url paramers together with retrofit2 

java.lang.IllegalArgumentException: @Path parameters may not be used with @Url. (parameter #4

如果你是这样的：

 @GET
Call<DataResponse> getOrder(@Url String url,
 @Path("id") int id);

请在你的url指定占位符.url:

www.myAPi.com/{Id}

总结

看了以上的知识点你发现Retrofit同样支持RxJava,通过以下设置Call适配模式.就可以完美关联RxJava。

 retrofit .addCallAdapterFactory(RxJavaCallAdapterFactory.create())


艾阳Blog
关注
  • 3
    点赞
  • 踩
  • 12
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 4
    评论
专栏目录
Retrofit2 使用Demo示例
06-22
Retrofit2 使用Demo
Nginx
热门推荐
xiawan的博客
08-31 3万+
1、简述一下什么是Nginx，它有什么优势和功能 Nginx是一个web服务器和方向代理服务器，用于HTTP、HTTPS、SMTP、POP3和IMAP协议。因它的 稳定性、丰富的功能集、示例配置文件和低系统资源的消耗而闻名。 Nginx—Ngine X，是一款免费的、自由的、开源的、高性能HTTP服务器和反向代理服务器;也是一个IMAP、POP3、SMTP代理服务器;Nginx以其高性能、稳定性、丰富的功能、简单的配置和 低资源消耗而闻名。 也就是说Nginx本身就可以托管网站(类似于Tomcat一样)，进
安装部署ubuntu18
bgy1996的博客
10-24 2万+
下载地址 Index of /ubuntu-releases/18.04/
在网址中跳转APP（进入XXXAPP内查看）
qq_41985689的博客
07-14 1万+
清单文件内加入intent-filter <activity android:name=".StartupPageActivity" android:launchMode="singleTask" android:screenOrientation="portrait"> <intent-filter> <action android:name="
Pow(x, n)
liuchenjane的博客
09-26 2万+
Pow(x, n) 思路：x^n=(x*x)^(n/2),当n为偶数；x^n=(x*x)^(n/2)*x，当n为奇数. 当n为负数时,x^n=(1/x)^(-n) 注意：对边界条件的处理，当n=INT_MIN时，直接取负会溢出。 https://discuss.leetcode.com/topic/5425/short-and-easy-to-understand-solution
Android使用Retrofit2.0技术仿微信发说说
08-31
主要介绍了Android使用Retrofit2.0技术仿微信发说说，实现拍照，选图库，多图案上传功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
Android Retrofit 2.0框架上传图片解决方案
09-02
主要介绍了Android Retrofit 2.0框架上传一张与多张图片解决方案，感兴趣的小伙伴们可以参考一下
Retrofit2.0 Demo
04-23
这是一个基于Retrofit2.0 + Okhttp +Gson的一个请求网络的小案例
Android中Retrofit2.0的使用Demo
04-02
这个Demo实现了使用Retrofit2.0网络请求框架请求数据，使用Gson解析数据,希望对大家有用
Android中Retrofit 2.0直接使用JSON进行数据交互
08-29
本篇文章主要介绍了Android中Retrofit 2.0直接使用JSON进行数据交互，具有一定的参考价值，有兴趣的可以了解一下
详解Retrofit2.0 公共参数（固定参数）
08-27
主要介绍了Retrofit2.0 公共参数（固定参数），小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
RxJava整合Retrofit2.0网络框架
12-07
RxJava整合Retrofit2.0网络框架，将城市天气查询作为一个使用案例
retrofit2.0+mvp 登录 demo
10-25
个人写的一个mvp+retrofit2.0 的简单登录demo。希望对刚学习mvp和retrofit的童鞋有帮助。
Android-EHttp是一个基于OkHttp3.0RxJava2.0和Retrofit2.0封装的Http网络请求框架
08-13
目前支持：get请求，post请求，多文件上传，文件下载，图片加载，上传下载进度监听，设置自定义拦截器，cookie管理，https证书设置，自定义Retrofit接口，多种Callback处理返回的不同数据类型。
Android-rxjava2.0和retrofit2.0兼容的网络框架的封装
08-13
rxjava2.0和retrofit2.0兼容的网络框架,即能使用仅基于retrofit的封装，又可以使用基本retrofit rxjava的封装
工作中使用了一些触发器
长期深耕于云计算、大数据、数据库领域！
02-06 3万+
之前工作中做数据同步用到的触发器，做了如下笔记，总结如下： 数据中心 ----------------------------------学院 create or replace trigger tger_XX_YXSDWJBSJZL_ist before insert on zfdxc.XX_YXSDWJBSJZL for each row begin insert into xg
nginx 配置404页面
依恋
11-29 7852
vi nginx.conf #在http定义区域加入：  fastcgi_intercept_errors on; vi vhost/**.conf #在server 区域加入：  error_page 404 = /404.html;  #或者 error_page 404 = http://www.xxx.com/404.html; 重启nginx
nexus免费下载
Xu_XiaoXiao_Ji的博客
05-21 1万+
本人提供两个nexus下载地址： 蓝奏云下载地址：https://xuji.lanzous.com/icvdbyb 百度云盘下载地址：https://pan.baidu.com/s/1pKfV9SSilIkGJUy0TUta9A 提取码：hupv
Nginx介绍
qixiang_chen的博客
11-11 1万+
Nginx (engine x) 是一个高性能的HTTP和反向代理服务器，也是一个IMAP/POP3/SMTP服务器。Nginx是由伊戈尔·赛索耶夫为俄罗斯访问量第二的Rambler.ru站点（俄文：Рамблер）开发的，第一个公开版本0.1.0发布于2004年10月4日。 其将源代码以类BSD许可证的形式发布，因它的稳定性、丰富的功能集、示例配置文件和低系统资源的消耗而闻名。2011年6月1日...
Android用retrofit上传图片,Retrofit2.0 实现图文（参数+图片）上传方法总结
最新发布
05-25
在 Android 中使用 Retrofit 上传图片可以通过 `@Multipart` 和 `@Part` 注解实现。以下是 Retrofit 2.0 实现图文上传的方法总结： 1. 添加依赖库 在项目的 `build.gradle` 文件中添加以下依赖库： ```groovy ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

艾阳Blog

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值