Retrofit使用案例、源码简析

最新推荐文章于 2021-08-29 16:15:26 发布
最新推荐文章于 2021-08-29 16:15:26 发布
阅读量387 收藏
点赞数
分类专栏： Android 文章标签： retrofit
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u010296640/article/details/52829915
版权

Retrofit

(a type-safe HTTP client for Android and Java) HTTP网络请求工具

Retrofit使用步骤

1.定义一个接口(封装url地址和数据请求)
2.实例化Retrofit
3.调用Retrofit实例创建接口服务对象
4.接口服务对象调用接口中的方法获取Call对象
5.call对象执行请求(异步、同步请求)

封装url地址和数据请求的接口类

public interface INewsBiz {
    /*
    通过@GET注解标示为get请求 @GET中填写的value和baseUrl指定的地址组成完成的访问路径
    baseUrl构造retrofit对象时指定
    */
    @GET("api/GetFeeds?column=0&PageSize=20&pageIndex=1&val=100511D3BE5301280E0992C73A9DEC41")
    Call<ResponseBody> getResonsebody();

    @GET("api/GetFeeds?column=0&PageSize=20&pageIndex=1&val=100511D3BE5301280E0992C73A9DEC41")
    Call<String> getJsonString();

    @GET("category?app_id=161")
    Call<List<Tea>> getTeas();

    @GET("api/{type}?column=0&PageSize=20&pageIndex=1&val=100511D3BE5301280E0992C73A9DEC41")
    Call<NewsInfo> getNewsInfo(@Path("type") String type);//String type="GetFeeds"

    //http://42.120.4.67/api/app/business/category?app_id=161
    @GET("category")
    Call<List<Tea>> getTeaByNetWork(@Query("app_id") int id);//int id=161

    //api/GetFeeds?column=0&PageSize=20&pageIndex=1&val=100511D3BE5301280E0992C73A9DEC41
    @GET("api/GetFeeds")
    Call<NewsInfo> getInfo(@QueryMap Map<String,String> map);

//    @GET("api/{type}")
//    Call<NewsInfo> getInfo(@Path("type") String type,@QueryMap Map<String,String> map);

    //网络上下载文件
    @GET("download")
     Call<ResponseBody> downLoad();

    //post请求中通过@FormUrlEncoded和@POST注解 指明访问的地址  @Field("向服务器提交的key")
    @POST("LoginServlet")//采用post请求方式
    @FormUrlEncoded  //表单提交
    Call<String> login(@Field("username") String username,
                       @Field("password") String password);
}

activity中具体使用

public class MainActivity extends AppCompatActivity {
    private TextView tv;
    private ImageView iv;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        tv= (TextView) findViewById(R.id.tv);
        iv= (ImageView) findViewById(R.id.iv);
//        initRetrofit01();
//        initRetrofit02();
//        initRetrofit03();
//        initRetrofit04();
//        initRetrofit05();
//        initRetrofit06();
//        initRetrofit07();
        initRetrofit08();
    }

    /**
     *  采用同步访问的方式 excute()
     */
    public void initRetrofit08(){
        Retrofit retrofit=new Retrofit
                .Builder()
                .baseUrl(Constant.BASE_URL)
                .build();
        final INewsBiz iNewsBiz=retrofit.create(INewsBiz.class);
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    Call<ResponseBody> call=iNewsBiz.getResonsebody();
                    // 采用同步方式请求数据
                    Response<ResponseBody> response=call.execute();
                    final String str=response.body().string();
                    tv.post(new Runnable() {
                        @Override
                        public void run() {
                            tv.setText(str);
                        }
                    });
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }).start();
    }
    /**
     * 下载网络图片文件
     */
    public void initRetrofit07(){
         Retrofit retrofit=new Retrofit
                 .Builder()
                 .baseUrl(Constant.IMAGE_URL)
                 .build();
        INewsBiz iNewsBiz=retrofit.create(INewsBiz.class);
        Call<ResponseBody> call=iNewsBiz.downLoad();
        call.enqueue(new Callback<ResponseBody>() {
            @Override
            public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
                if(response.isSuccess()){
//                    String str=response.body().string();
//                    byte[] buff=response.body().bytes();
                    InputStream inputStream=response.body().byteStream();
                    Bitmap bm= BitmapFactory.decodeStream(inputStream);
                    iv.setImageBitmap(bm);
                }
            }

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

            }
        });
    }
    /**
     * get 请求通过@queryMap注解动态传递多个参数
     */
    public void initRetrofit06(){
        Retrofit retrofit=new Retrofit
                .Builder()
                .baseUrl(Constant.BASE_URL)
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        INewsBiz iNewsBiz=retrofit.create(INewsBiz.class);
        //column=0&PageSize=20&pageIndex=1&val=100511D3BE5301280E0992C73A9DEC41
        //将参数根据key－value对的形式存储到map集合中
        Map<String,String> map=new HashMap<>();
        map.put("column",0+"");
        map.put("PageSize",20+"");
        map.put("pageIndex",1+"");
        map.put("val","100511D3BE5301280E0992C73A9DEC41");
        Call<NewsInfo> call=iNewsBiz.getInfo(map);
        //api/GetFeeds?column=0&PageSize=20&pageIndex=1&val=100511D3BE5301280E0992C73A9DEC41
//        Call<NewsInfo> call=iNewsBiz.getInfo("GetFeeds",map);
        call.enqueue(new Callback<NewsInfo>() {
            @Override
            public void onResponse(Call<NewsInfo> call, Response<NewsInfo> response) {
                if(response.isSuccess()){
                    List<NewsInfo.ParamzBean.FeedsBean> news=
                            response.body().getParamz().getFeeds();
                    StringBuilder sb=new StringBuilder();
                    for(NewsInfo.ParamzBean.FeedsBean feed:news){
                        sb.append(feed.getData().getSubject());
                    }
                    tv.setText(sb.toString());
                }
            }

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

            }
        });
    }

    /**
    get请求 通过@query注解动态传递参数的值
     */
    public void initRetrofit05(){
        Retrofit retrofit=new Retrofit
                .Builder()
                .baseUrl(Constant.TEABASE_URL)
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        INewsBiz iNewsBiz=retrofit.create(INewsBiz.class);
        Call<List<Tea>> call=iNewsBiz.getTeaByNetWork(161);
        call.enqueue(new Callback<List<Tea>>() {
            @Override
            public void onResponse(Call<List<Tea>> call, Response<List<Tea>> response) {
                if(response.isSuccess()){
                    StringBuilder sb=new StringBuilder();
                    List<Tea> list=response.body();
                    for(Tea t:list){
                        sb.append(t.getProduct_cat_name());
                    }
                    tv.setText(sb.toString());
                }
            }

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

            }
        });
    }

    /**
     * get请求 通过占位符指定path路径
     */
    public void initRetrofit04(){
        Retrofit retrofit=new Retrofit
                .Builder()
                .baseUrl(Constant.BASE_URL)
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        INewsBiz iNewsBiz=retrofit.create(INewsBiz.class);
        Call<NewsInfo> call=iNewsBiz.getNewsInfo("GetFeeds");
        call.enqueue(new Callback<NewsInfo>() {
            @Override
            public void onResponse(Call<NewsInfo> call, Response<NewsInfo> response) {
                if(response.isSuccess()){
                    List<NewsInfo.ParamzBean.FeedsBean> news=
                            response.body().getParamz().getFeeds();
                    StringBuilder sb=new StringBuilder();
                    for(NewsInfo.ParamzBean.FeedsBean feed:news){
                        sb.append(feed.getData().getSubject());
                    }
                    tv.setText(sb.toString());
                }
            }

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

            }
        });
    }
    /**
     * 普通的get请求 返回的数据为gson解析后的list集合
     */
    public void initRetrofit03(){
        Retrofit retrofit=new Retrofit
                .Builder()
                .baseUrl(Constant.TEABASE_URL)
                //如果服务器返回的时json格式数据 设置了GsonConverterFactory
                //实现对对象的转化
                // 自定义数据解析器 只要解析器继承Converter.Factory即可
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        INewsBiz iNewsBiz=retrofit.create(INewsBiz.class);
        Call<List<Tea>> call=iNewsBiz.getTeas();
        call.enqueue(new Callback<List<Tea>>() {
            @Override
            public void onResponse(Call<List<Tea>> call, Response<List<Tea>> response) {
                if(response.isSuccess()){
                    List<Tea> list=response.body();//获取解析后的集合
                    StringBuilder sb=new StringBuilder();
                    for(Tea t:list){
                        sb.append(t.getProduct_cat_name());
                    }
                    tv.setText(sb.toString());
                }
            }

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

            }
        });

    }
    /**
     * 普通get请求 返回的数据为String类型
     */
    public void initRetrofit02(){
        Retrofit retrofit=new Retrofit
                .Builder()
                .baseUrl(Constant.BASE_URL)
                //设置回调时的适配器 get请求后可以返回String字符串类型的内容
                .addConverterFactory(ScalarsConverterFactory.create())
                .build();
         INewsBiz iNewsBiz=retrofit.create(INewsBiz.class);
         Call<String> call=iNewsBiz.getJsonString();
         call.enqueue(new Callback<String>() {
             @Override
             public void onResponse(Call<String> call, Response<String> response) {
                 if(response.isSuccess()){
                     tv.setText(response.body());
                 }
             }

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

             }
         });
    }
    /**
     * 普通get请求
     */
    public void initRetrofit01(){
        //构建Retrofit网络访问对象
        Retrofit retrofit=new Retrofit
                .Builder()
                .baseUrl(Constant.BASE_URL)//设置访问的跟路径
                .build();
        //根据接口的字节码文件对象获取接口的对象
        INewsBiz iNewsBiz=retrofit.create(INewsBiz.class);
        //调用接口中定义的函数
        Call<ResponseBody> call=iNewsBiz.getResonsebody();
        /*enqueue 采用异步访问数据   execute()采用同步访问数据*/
        call.enqueue(new Callback<ResponseBody>() {
            @Override
            public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
                if(response.isSuccess()){//成功的获取响应
                    try {
                        String result=response.body().string();//获取网络访问的字符串
                        tv.setText(result);
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
            }

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

            }
        });
    }
}

retrofit底层源码

底层使用注解反射 动态代理 okhttp访问网络

Retrofit 底层使用注解反射 动态代理

  1. Retrofit retrofit=new Retrofit.Builder().baseUrl(url).build();

源码:

public static final class Builder {
    private List<Converter.Factory> converterFactories = new ArrayList<>();
    private okhttp3.Call.Factory callFactory;
    .....
     public Builder() {
         ...
          converterFactories.add(new BuiltInConverters());
     }

     public Builder baseUrl(String baseUrl) {
           checkNotNull(baseUrl, "baseUrl == null"); //检查传递的baseUrl不能为null
           //将根路径封装成HttpUrl对象
           HttpUrl httpUrl = HttpUrl.parse(baseUrl);
           if (httpUrl == null) {
             throw new IllegalArgumentException("Illegal URL: " + baseUrl);
           }
           return baseUrl(httpUrl);
      }

      ....
      public Builder baseUrl(final HttpUrl baseUrl) {
            checkNotNull(baseUrl, "baseUrl == null");
            //检查根路径是否以／结尾
            List<String> pathSegments = baseUrl.pathSegments();
            if (!"".equals(pathSegments.get(pathSegments.size() - 1))) {
              throw new IllegalArgumentException("baseUrl must end in /: " + baseUrl);
            }
            return baseUrl(new BaseUrl() {
              @Override public HttpUrl url() {
                return baseUrl;
              }
            });
          }
     .....
       public Builder baseUrl(BaseUrl baseUrl) {
                this.baseUrl = checkNotNull(baseUrl, "baseUrl == null");
                return this;
       }

       .....

       public Retrofit build() {
            //判断根路径必须存在
             if (baseUrl == null) {
               throw new IllegalStateException("Base URL required.");
             }

             //retrofit底层采用okhttp访问网络
             okhttp3.Call.Factory callFactory = this.callFactory;
             if (callFactory == null) {
               callFactory = new OkHttpClient();
             }

             //CallAdapter.Factory 主要用于对call进行转化
             List<CallAdapter.Factory> adapterFactories = new ArrayList<>(this.adapterFactories);
             adapterFactories.add(Platform.get().defaultCallAdapterFactory(callbackExecutor));

             //Converter.Factory 主要用于转化数据
             List<Converter.Factory> converterFactories = new ArrayList<>(this.converterFactories);

                //构建retrofit对象
             return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
                 callbackExecutor, validateEagerly);
           }
         }
  }
///////////////////////////////////////////////////////////////////////////////////////////
2.INewsBiz iNewsBiz=retrofit.create(INewsBiz.class);


public <T> T create(final Class<T> service) {
    .....
    return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service },
        new InvocationHandler() {
          private final Platform platform = Platform.get();

          @Override public Object invoke(Object proxy, Method method, Object... args)
              throws Throwable {
            // If the method is a method from Object then defer to normal invocation.
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            return loadMethodHandler(method).invoke(args);
          }
        });
  }

CallBack
retrofit请求数据返回的接口 onResponse() onFailure()

Call
接口主要用用就是发送Http请求 默认实现的okHttpCall

爱喝白酒的啤酒猫
关注
专栏目录
Retrofit实例
06-10
retrofit网络请求框架的简单demo .
新版Retrofit 2可运行例子（解决Could not locate ResponseBody converter for问题）
weixin_30268921的博客
01-29 852
Retrofit这东西我就不多做解释了，反正最近应用很广，基本都快和OkHttp一起成为安卓的事实网络访问标准框架了。 这么好的一个东西，官网文档实在是不算太好，说的不太清晰。按官网的经常会有“Could not locate ResponseBody converter for”问题。 反正折腾了一番，终于跑出来了一个例子。这里把正确的例子写出来，方便大家参考。 首先要注意的是Ret...
Retrofit实战(一)一个简单的示例
fendo
05-01 3183
一、Retrofit简介 Retrofit是一个Http请求库，和其它Http库最大区别在于通过大范围使用注解简化Http请求。目前Retrofit 2.0底层是依赖OkHttp实现的，也就是说Retrofit本质上就是对OkHttp的更进一步封装。 1.Retrofit请求方式 Retrofit支持RESTful,HTTP请求方法包含get、post、delet
retrofit的成功案例
tr1991103的专栏
09-27 102
AS部分： 定义接口 public interface LoginServer { //@Headers({"Content-type:application/json;charset=utf-8","Accept:application/json"}) //@FormUrlEncoded @POST("QueryLogin") Call<JSONObject> queryLoginUserInfo(@Body JSONObject json); }
第一个Retrofit的案例
pvmsmfchcs的博客
07-31 169
为什么使用Retrofit 在之前做项目的时候，使用的是Volley做网络请求，因为是接手一个学长的项目，底层封装已经做好了，可是在出现新需求要调用时有着诸多不便，一是虽然做了封装，但在调用时结构不清晰；二是每个接口地址都保存在一个专门的api类，只要多一个功能，就要在该类中添加一个api，尽管很多内容十分相似，所以耦合性很高。而接触到Retrofit后让我眼前一亮，使用Retrofit可以完美解决上述问题。Retrofit使用了目前比较流行的链式调用，结构十分清晰，并且将api封装成接口，通过注解的方式声
Retrofit 源码分析初探
01-04
介绍源码前，我们先看下Retrofit的基本使用，大致了解下流程，跟着这个流程来分析源码才不会乱。 1、初始化Retrofit对象 Retrofit retrofit = new Retrofit.Builder() //使用自定义的mGsonConverterFactory ....
Retrofit源码简析：简化Android RESTful API集成
`Retrofit.Builder`可以配置基础URL、转换器（如GsonConverter）等，然后创建Retrofit实例，最后通过这个实例的`create()`方法得到服务接口的实例，即可调用接口方法发起请求。 在源码层面，Retrofit通过动态代理...
Retrofit2 Demo源码
12-17
Retrofit2是一款在Android开发中广泛使用的网络请求库，它由Square公司开发，以其简洁的API设计和强大的功能深受开发者喜爱。在这个"Retrofit2 Demo源码"中，我们可以深入理解Retrofit2如何处理各种类型的网络请求，...
Retrofit教程例子源码
01-05
总的来说，这个`Retrofit教程例子源码`提供了从零开始学习和实践Retrofit的完整流程，包括接口定义、实例化、请求发起以及响应处理。通过深入研究这个项目，你将能够熟练地运用Retrofit来处理Android或Java项目中的...
Retrofit实例讲解，让你醍醐灌顶
11-14
讲解五种注解的形式包含@Get，@Post，@Path，@Query ，@QueryMap的实例，帮助更好的理解应用。详细博客讲解https://blog.csdn.net/lou_liang/article/details/84069006
Retrofit2使用案例及源码解析
梦工厂
12-27 3421
Retrofit2是一个基于OkHttp进行封装的网络请求框架，Retrofit中使用了大量的@GET、@POST这类注解方法，刚开始学习的时候会感觉特别的不适应，但只要理解了这些注解方法和使用逻辑，会发现网络请求也可以做的很优雅 一、案例 先写一个简单的程序跑起来，再详细讲解 首先添加依赖 compile 'com.squareup.retrofit2:retrofit:2.1.0'
Retrofit的使用，及介绍,Retrofit中的各种方法的详细描述简单案例，三分钟学会Retrofit
世界流浪者的博客
11-11 3280
Retrofit的使用，及介绍： 一，概念描述及理解： Retrofit的底层是封装的okhttp是对okhttp的封装其内置okhttp框架，说retrfit是网络请求的框架在这里是不准确的，其实在这里网络请求还是使用的okhttp,Retrofit的作用在于网络请求的高效，二者分工协作，宛如古人的『你耕地来我织布』 这里我写了大约7--8中小的案例，大家需要哪一种可以跳过不需要的部分，直
Retrofit 从入门封装到源码解析
02-21
该教程从Retrofit的入门开始讲解，然后搭配Rxjava使用，主要讲解在实战项目中如何进行Retrofit封装(主要涉及到OkHttp，部分涉及到Retrofit)，后会对源码进行解析，让你知其然，知其所以然。
Retrofit的使用案例
梦否
08-29 645
官网地址：Retrofit，注意到：
Carson带你学Android：这是一份详细的 Retrofit使用教程（含实例讲解）
热门推荐
Carson带你学Android
06-26 25万+
前言 在Andrroid开发中，网络请求十分常用 而在Android网络请求库中，Retrofit是当下最热的一个网络请求库 今天，我将献上一份非常详细Retrofit v2.0的使用教程，希望你们会喜欢。 如果对Retrofit v2.0的源码感兴趣，可看文章：Android：手把手带你深入剖析 Retrofit 2.0 源码 目录![目录](http://upload-
if(response.isSuccess){}else{}的方式，如果我们由于忽略没有设置success字段的值，就可能导致...
liuyaokai1990的博客
12-20 1571
在日常开发中，我们会经常要在类中定义布尔类型的变量，比如在给外部系统提供一个RPC接口的时候，我们一般会定义一个字段表示本次请求是否成功的。 关于这个”本次请求是否成功”的字段的定义，其实是有很多种讲究和坑的，稍有不慎就会掉入坑里，在很久之前就遇到过类似的问题，本文就来围绕这个简单分析一下。到底该如何定一个布尔类型的成员变量。 一般情况下，我们可以有以下四种方式来定义一个布尔类型的成员变...
Retrofit响应数据及异常处理策略
Floating Cat
09-28 1万+
今天我们来谈谈客户端对通讯协议的处理，主要分为三部分：约定响应数据格式，响应数据的自动映射以及错误处理三部分。由于数据协议采用json的居多，因此我们在此基础上进行说明。
retrofit 异步网络请求 小项目案例
博水之野，人杰地灵
09-25 631
使用retrofit异步获取网络数据；在原来的官方demo基础上略加修改； 具体下载链接见：稍后补上；1.引入 gradlecompile ‘com.google.code.gson:gson:2.6.2’ compile ‘com.squareup.retrofit2:retrofit:2.1.0’ compile ‘io.reactivex:rxjava:1.1.0’
Retrofit2源码解析与使用总结
"这篇博客文章是对Retrofit网络框架的源码解析，作者分享了学习Retrofit的心得，并提供了源码下载。文章分为前言、简介、四大热门网络框架、如何使用和源码分析等部分。Retrofit2是Square公司开发的，基于OkHttp的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值