Retrofit封装

最新推荐文章于 2023-02-20 18:56:35 发布
最新推荐文章于 2023-02-20 18:56:35 发布
阅读量494 收藏 2
点赞数 1
分类专栏： Android开发 文章标签： retrofit 建造者模式
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/paomian2/article/details/79285748
版权

Retrofit+OKHttp+MVP的Android架构已经火了很久了，我自己也使用了有一段时间，但由于一直忙于这样或那样的事，一直没有做相关的笔记。年底先来无事，又重新看一了一遍相关的资料，做点笔记(好记性不如烂笔头)。
这里写图片描述

使用到的开发模式：
1.单利
2.建造者

使用的相关库：

    //网络请求依赖
    compile 'com.squareup.okio:okio:1.13.0'
    compile 'com.squareup.okhttp3:okhttp:3.8.1'
    compile 'com.squareup.retrofit2:retrofit:2.3.0'
    compile 'com.squareup.retrofit2:converter-scalars:2.3.0'

第一步：先使用Retrofit最基本的用法
1.创建对应的API接口

public interface ApiService {
    @GET
    Call<String> get(@Url String url, @QueryMap WeakHashMap<String, Object> params);
}

使用WeakHashMap的原因是该容器使用的是弱引用有利于gc回收。

2.在需要访问的Activity类中添加访问请求代码：

      private void netTest1(){
        //Retorfit对象
        Retrofit retrofit=new Retrofit.Builder()
                .client(new OkHttpClient())
                .baseUrl("https://www.baidu.com/")
                .addConverterFactory(ScalarsConverterFactory.create())
                .build();
        //接口
        ApiService apiService=retrofit.create(ApiService.class);
        Call<String> call=apiService.get("",new WeakHashMap<String, Object>());
        //发起网络请求
        call.enqueue(new Callback<String>() {
            @Override
            public void onResponse(Call<String> call, Response<String> response) {
                if (response.isSuccessful()){
                    Toast.makeText(getApplicationContext(),response.body(),Toast.LENGTH_LONG).show();
                }
            }

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

            }
        });
    }

Retrofit创建对象的时候需要添加
Http通信类：OkHttp
基本网络地址：baseUrl（如果一个项目有多个不一样的主Host会很蛋疼），并且要反斜杠结束
ResponseBody返回类型：ScalarsConverterFactory（字符串）

3.调用：

@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        netTest1();
    }

结果如下：
这里写图片描述

可以看到访问百度地址请求已经成功了！

很显然，每次调用网络的时候我们都需要重复写这段代码。
那就的做法是写个Utils吧（一般做法）。
这里写图片描述

第二步：抽出一个Utils调用
1.编写utils工具类

public class RetorfitUtils {
    public static void request(String url, WeakHashMap<String,Object> params,Callback callback){
        //Retorfit对象
        Retrofit retrofit=new Retrofit.Builder()
                .client(new OkHttpClient())
                .baseUrl("https://www.baidu.com/")
                .addConverterFactory(ScalarsConverterFactory.create())
                .build();
        //接口
        ApiService apiService=retrofit.create(ApiService.class);
        Call<String> call=apiService.get(url,new WeakHashMap<String, Object>());
        //发起网络请求
        call.enqueue(callback);
    }

}

2.Activity调用

@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        WeakHashMap<String,Object> params=new WeakHashMap<>();
        RetorfitUtils.request("", params, new Callback<String>() {
            @Override
            public void onResponse(Call<String> call, Response<String> response) {
                if (response.isSuccessful()){
                    Toast.makeText(getApplicationContext(),response.body(),Toast.LENGTH_LONG).show();
                }
            }

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

            }
        });
    }

结果：
可以看到结果与上面一致。

仔细想想，这个Utils工具类只是将我们经常调用请求代码抽出来，方便使用但代码的运行效率并没有得到优化。发起多个网络请求还是会多次实例化Retorfit/ApiService，所以工具中得将Retorfit/ApiService单利化了。最重要这种utils太没逼格了。
这里写图片描述

第三步：将Retorif进行二次封装
根据Retrofit的基本使用，主要封装思路：
ApiService对象（单利）
Retrofit对象（单利）
Http请求OkHttpClient对象(单利)
请求参数/接口回调（建造者模式）

1.创建基本Api接口BaseApiService

public interface BaseApiService {
    @GET
    Call<String> get(@Url String url, @QueryMap WeakHashMap<String, Object> params);

    @FormUrlEncoded
    @POST
    Call<String> post(@Url String url, @FieldMap WeakHashMap<String, Object> params);

    @FormUrlEncoded
    @PUT
    Call<String> put(@Url String url, @FieldMap WeakHashMap<String, Object> params);

    @DELETE
    Call<String> delete(@Url String url, @QueryMap WeakHashMap<String, Object> params);
}

2.定义好相关回调接口（访问开始/访问成功/逻辑错误/访问失败/访问结/Callbak）
访问开始

public interface IRequestStart {
    void onRequestStart();
}

访问成功

public interface ISuccess {
    void onSuccess(String response);
}

逻辑错误

public interface IError {
    void onError(int code,String msg);
}

访问失败

public interface IFailure {
    void onFailure();
}

访问结束

public interface IRequestEnd {
    void onRequestEnd();
}

Callbak

public class RequestCallBacks implements Callback<String>{
    private final ISuccess SUCCESS;
    private final IError ERROR;
    private final IFailure FAILURE;
    private final IRequestEnd REQUEST_END;

    public RequestCallBacks(ISuccess success, IError error, IFailure failure, IRequestEnd requestEnd) {
        this.SUCCESS = success;
        this.ERROR = error;
        this.FAILURE = failure;
        this.REQUEST_END = requestEnd;
    }

    @Override
    public void onResponse(Call<String> call, Response<String> response) {
        if (response.isSuccessful()){
            if (call.isExecuted()){
                if (SUCCESS!=null){
                    SUCCESS.onSuccess(response.body());
                }
            }
        }else{
            if (ERROR!=null){
                ERROR.onError(response.code(),response.message());
            }
        }
        if (REQUEST_END!=null){
            REQUEST_END.onRequestEnd();
        }
    }

    @Override
    public void onFailure(Call<String> call, Throwable t) {
       if (FAILURE!=null){
           FAILURE.onFailure();
       }
    }
}

为了确保传进来的参数不被修改，所以定义为final

3.创建一个专门生成Retrofit/ApiService的类ClientCreator

public class ClientCreator {

    /**创建Retorfit*/
    private static final class RetrofitHolder{
        private static final String BASE_URL="https://www.baidu.com/";
        private static final Retrofit RETROFIT=new Retrofit.Builder()
                .baseUrl(BASE_URL)
                .client(OkHttpClienHolder.OK_HTTP_CLIENT)
                .addConverterFactory(ScalarsConverterFactory.create())
                .build();
    }

    /**创建OkHttpClien对象*/
    private static final class OkHttpClienHolder{
        private static final int TIME_OUT=120;
        private static final OkHttpClient OK_HTTP_CLIENT=new OkHttpClient.Builder()
                .connectTimeout(TIME_OUT, TimeUnit.SECONDS)
                .build();
    }

    /**构建ApiService对象*/
    private static final class ApiServiceHolder{
        private static final BaseApiService API_SERVICE=RetrofitHolder.RETROFIT.create(BaseApiService.class);
    }

    /**获取BaseApiService对象*/
    public static BaseApiService getBaseApiService(){
        return ApiServiceHolder.API_SERVICE;
    }
}

4.定义请求方式HttpMethod
public enum HttpMethod {
GET,
POST,
PUT,
DELETE
}

5.根据构建者模式创建出暴露出来给我们调用的类MyHttpClient/HttpClientBuilder
MyHttpClient中的参数是通过HttpClientBuilder来进行设置

MyHttpClient

public class MyHttpClient {

    private final String URL;
    private final WeakHashMap<String,Object> PARAMS;
    private final IRequestStart REQUEST_START;
    private final ISuccess SUCCESS;
    private final IError ERROR;
    private final IFailure FAILURE;
    private final IRequestEnd REQUEST_END;

     MyHttpClient(String url, WeakHashMap<String,Object> params,IRequestStart requestStart, ISuccess success, IError error, IFailure failure, IRequestEnd requestEnd) {
        this.URL = url;
        PARAMS=params;
        this.REQUEST_START = requestStart;
        this.SUCCESS = success;
        this.ERROR = error;
        this.FAILURE = failure;
        this.REQUEST_END = requestEnd;
    }

    public static HttpClientBuilder builder(){
        return new HttpClientBuilder();
    }


    private RequestCallBacks getRequestCallBacks(){
        return new RequestCallBacks(
                SUCCESS,
                ERROR,
                FAILURE,
                REQUEST_END
        );
    }

    private void requset(HttpMethod method){
        Call<String> call=null;
        BaseApiService apiService=ClientCreator.getBaseApiService();
        if (REQUEST_START!=null){
            REQUEST_START.onRequestStart();
        }
        switch (method){
            case GET:
                call=apiService.get(URL,PARAMS);
                break;
            case POST:
                call=apiService.post(URL,PARAMS);
                break;
            case PUT:
                call=apiService.put(URL,PARAMS);
                break;
            case DELETE:
                call=apiService.delete(URL,PARAMS);
                break;
            default:
                break;
        }
        if (call!=null){
            call.enqueue(getRequestCallBacks());
        }
    }

    public void get(){
        requset(HttpMethod.GET);
    }

    public void post(){
        requset(HttpMethod.POST);
    }

    public void put(){
        requset(HttpMethod.PUT);
    }

    public void delete(){
        requset(HttpMethod.DELETE);
    }

}

HttpClientBuilder

public class HttpClientBuilder {

    private  String mUrl;
    private  final WeakHashMap<String,Object> PARAMS=new WeakHashMap<>();
    private  IRequestStart mRequestStart;
    private  ISuccess mSuccess;
    private  IError mError;
    private  IFailure mFailure;
    private  IRequestEnd mRequestEnd;

    /**
     * 设置接口路径
     * @param url:接口路径
     * */
    public final HttpClientBuilder url(String url){
        this.mUrl=url;
        return this;
    }

    /**
     * 设置请求参数
     * @param key:
     * @param val:
     * */
    public final HttpClientBuilder params(String key,Object val){
        this.PARAMS.put(key,val);
        return this;
    }

    /**
     * 设置请求参数
     * @param params:请求参数
     * */
    public final HttpClientBuilder params(WeakHashMap<String,Object> params){
        this.PARAMS.putAll(params);
        return this;
    }

    /**
     * 设置访问开始接口回调
     * @param requestStart:
     * */
    public final HttpClientBuilder questStart(IRequestStart requestStart){
        this.mRequestStart=requestStart;
        return this;
    }

    /**
     * 设置访问成功接口回调
     * @param success:
     * */
    public final HttpClientBuilder success(ISuccess success){
        this.mSuccess=success;
        return this;
    }

    /**
     * 设置访问错误接口回调
     * @param error:
     * */
    public final HttpClientBuilder error(IError error){
        this.mError=error;
        return this;
    }

    /**
     * 设置访问失败接口回调
     * @param failure:
     * */
    public final HttpClientBuilder failure(IFailure failure){
        this.mFailure=failure;
        return this;
    }

    /**
     * 设置访问结束接口回调
     * @param requestEnd:
     * */
    public final HttpClientBuilder requestEnd(IRequestEnd requestEnd){
        this.mRequestEnd=requestEnd;
        return this;
    }

    /**创建MyHttpClient*/
    public MyHttpClient build(){
        return new MyHttpClient(
                mUrl,
                PARAMS,
                mRequestStart,
                mSuccess,
                mError,
                mFailure,
                mRequestEnd
        );
    }
}

6.Activity调用

@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        MyHttpClient.builder()
                .url("")
                .params("name","张三")
                .questStart(new IRequestStart() {
                    @Override
                    public void onRequestStart() {
                        //loading start
                    }
                })
                .success(new ISuccess() {
                    @Override
                    public void onSuccess(String response) {
                        Toast.makeText(getApplicationContext(),response,Toast.LENGTH_LONG).show();
                    }
                })
                .error(new IError() {
                    @Override
                    public void onError(int code, String msg) {

                    }
                })
                .failure(new IFailure() {
                    @Override
                    public void onFailure() {

                    }
                })
                .requestEnd(new IRequestEnd() {
                    @Override
                    public void onRequestEnd() {
                        // loading hide
                    }
                })
                .build()
                .get();
    }

运行结果：
与上面结果一致。

从调用的结构可以看出这种建造者模式使用起来就像一条链一样，从请求url，参数，接口回调，需要设置哪个就建造对应的数据，使用起来清晰方便。当然，项目开发中，我们往往不会直接返回字符串，所以还可以封装一个泛型，让成功回调返回泛型。

后续….
这里写图片描述

小风满楼
关注
专栏目录
Retrofit的回调封装
云中采薇
10-11 580
Retrofit优雅的回调封装
retrofit封装
09-17
retrofit封装retrofit封装retrofit封装retrofit封装retrofit封装retrofit封装retrofit封装retrofit封装retrofit封装
Retrofit完美封装
王小泥的成长之旅
12-23 1712
Retrofit最佳实现 话不多说,直接上代码 1.Rretrofit 封装 public class ServiceGenerator { //服务器地址 private static final String BASE_URL = ""; //retrofit builder private static Retrofit.Builder builder = new Retrofit.Builder() .baseUrl(BASE_URL)
Retrofit的封装
一杯清泉
01-30 4569
Retrofit是Square公司基于restful风格推出的网络框架封装，截止目前github已经有了37.2kstart，可见他的受欢迎程度非常高，Retrofit基于Okhttp封装，具有非常强大的解耦特点，高度的灵活解耦导致使用起来不够简洁，下面对Retrofit进行一次二次的封装，在使用上更加简洁。封装之后具有一下特点： 支持reftofit的单例模式配置，一次配置多处使用。 支持动态切换baseUrl不影响原有的baseUrl。 支持通用格式的网络请求，返回对象或者字符串。 支持快捷的请
Retrofit的简单封装
菜鸟博客
11-20 3478
在Retrofit源码分析几篇博文中详细分析了Retrofit的内部原理，本篇再此基础上对Retrofit做了简单的封装。这次封装是基于所在项目中的情况进行的，可能不具有通用性。但是也算是一个基本思路。 如下图： 在看项目代码的时候发现如上图的接口方法很多，都有一个共性：就是方法参数一样，都是传一个map。不同的地方只是方法名字不同而已。 根据Retrofit源码分析系列博文我们知道每一个接口都...
android retrofit 封装,Android 探讨一下Retrofit封装的最佳姿势
weixin_35044945的博客
05-25 861
在上一篇文章《Android Retrofit + RxJava使用详解》中，我们学习了Retrofit的一些基本用法，但在实际的项目使用中，还是会出现一些问题，今天就让我们一起来探讨一下如何对Retrofit进行封装吧！如果你对Retrofit还不太了解，可以>戳这里如果你使用的是MVP，这篇文章可能不太适合你，请移步《Android 谈谈我所理解的MVP》。1.背景介绍首先来回顾一下Re...
android retrofit 封装,Android实战——Retrofit2的使用和封装
weixin_34163313的博客
05-25 1294
Retrofit2的使用和封装本篇文章包含以下内容：Retrofit2是什么Retrofit2工具类的演示(基于Retrofit2工具类的封装)Retrofit2工具类的封装Retrofit2是什么使用项目的原话：Android和Java中类型安全的HTTP客户端项目地址：https://github.com/square/retrofitRetrofit2的基本使用1、Get请求2、Post请求...
Retrofit的二次封装
06-05
添加 以JSON形式上传参数，自定义使用的Retrofit的二次封装的module，可直接导入项目使用，包含有无token两种情况，以及支持后台证书校验等。部分代码需根据项目需要修改后使用
Android-retrofit简单封装实现公共参数get和post统一处理
08-13
retrofit 简单封装 实现公共参数get和post统一处理,上传和下载带进度显示,图片和本文一起提交
retrofit封装使用
10-28
实现retrofit的基础使用，如GET，POST请求，JSON解析，例子是获取歌曲，并且播放，其他歌曲内容省略，原理是一样不多做解析，适用于retrofit初学者。
Android基于retrofit封装的网络请求库以及baseActivity高度集成定制
04-26
本文将深入探讨如何基于`Retrofit`封装一个网络请求库，并结合`BaseActivity`进行高度集成定制，以提升开发效率和代码质量。 首先，让我们了解`Retrofit`的基本使用。`Retrofit`由Square公司开发，它允许开发者通过...
Andorid开发记录（四）-Retrofit封装
wolf0706的专栏
02-20 305
封装Retrofit和MMKV
Android Retrofit的封装（日志、Header、返回、缓存的统一处理）
张雨的博客
01-24 3750
封装点 网络Log设置（OKHTTP拦截器） url统一追加参数（OKHTTP拦截器） header统一追加参数（OKHTTP拦截器） body统一追加参数（OKHTTP拦截器） 错误处理，无网络（OKHTTP拦截器） 错误处理，统一错误处理（flog/error） 返回值统一剥离外层包装 缓存设置 超时错误重连机制 不同的BaseUrl使用不同的Retrofit实例，同一个BaseUrl下使用同一个Retrofit实例 所有Retrofit实例公用一个OkhttpClient实例 网络Log设置 .
Retrofit简单封装
泡泡龙的博客
01-13 372
什么是Retrofit呢？** Retrofit可以理解为请求网络的一种方式 比如我们之前常用的HttpClient,HttpConnection,Okhttp等 它是基于Okhttp基础上进行研发的，优点我们可以从网上找 1.首先是定义请求接口public interface ProjectAPI { //这是get请求 @GET Call<String> getMetho
Retrofit小型封装
灿若繁星的博客
01-29 198
1.首先我们要导两个权限 compile 'com.squareup.retrofit2:retrofit:2.1.0' compile 'com.squareup.retrofit2:converter-gson:2.0.2'2.写一个接口public interface GitHubService { /*"":/到？之间的内容*/ @GET("umIPmfS6c83237d9c
retrofit封装dialog加载
最新发布
05-17
为了在使用 Retrofit 进行网络请求时，在请求过程中显示一个加载框，可以封装一个 DialogInterceptor，代码如下： ``` public class DialogInterceptor implements Interceptor { private Context mContext; private ProgressDialog mProgressDialog; public DialogInterceptor(Context context) { mContext = context; initProgressDialog(); } private void initProgressDialog() { mProgressDialog = new ProgressDialog(mContext); mProgressDialog.setMessage("加载中..."); } @Override public Response intercept(Chain chain) throws IOException { showProgressDialog(); Response response = chain.proceed(chain.request()); hideProgressDialog(); return response; } private void showProgressDialog() { if (mProgressDialog != null && !mProgressDialog.isShowing()) { mProgressDialog.show(); } } private void hideProgressDialog() { if (mProgressDialog != null && mProgressDialog.isShowing()) { mProgressDialog.dismiss(); } } } ``` 使用时，在创建 Retrofit 实例时，添加该拦截器即可： ``` DialogInterceptor dialogInterceptor = new DialogInterceptor(this); OkHttpClient okHttpClient = new OkHttpClient.Builder() .addInterceptor(dialogInterceptor) .build(); Retrofit retrofit = new Retrofit.Builder() .baseUrl(BASE_URL) .client(okHttpClient) .addConverterFactory(GsonConverterFactory.create()) .build(); ``` 这样，在发送网络请求时，就会显示一个加载框，请求结束后，加载框会自动消失。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值