android Retrofit2网络请求封装介绍

目录
  • 1. Retrofit使用
  • 2. Retrofit封装
  • 3. RetrofitUtil使用
  • 最后

1. Retrofit使用

Retrofit是一个现在网络请求框架,先来说一下怎么使用

网络权限(添加到AndroidManifest.xml)

<uses-permission android:name="android.permission.INTERNET" />

gradle依赖(添加到build.gradle)

    implementation("com.squareup.okhttp3:okhttp:4.9.2")
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
    implementation 'com.squareup.retrofit2:converter-scalars:2.9.0'

定义接口,网络请求的方法

public interface Request {

    @GET("/xx/xx")
    Call<ResponseBody> get();

}

实例化Retrofit

Retrofit retrofit = new Retrofit.Builder().baseUrl("BASE_URL").build();

通过Retrofit实例创建接口服务对象

Request request = retrofit.create(Request.class);

调用接口中的方法

Call<ResponseBody> call = request.get();

执行异步请求(同步请求需要创建一个新的线程去执行)

call.enqueue(new retrofit2.Callback<ResponseBody>() {
            @Override
            public void onResponse(retrofit2.Call<ResponseBody> call, retrofit2.Response<ResponseBody> response) {

            }

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

            }
});

2. Retrofit封装

以上可以看出Retrofit是个好东西,可是用起来是比较麻烦的,所有在实际使用中对Retrofit进行一下小小的封装是很有必要的。

定义接口(所有的请求参数都是以map的形式)

public interface Request {

    /**
     * 不带参数的get请求
     * @param url
     * @return
     */
    @GET()
    Call<ResponseBody> get(@Url String url);

    /**
     * 带参数的get请求
     * @param url
     * @param map 参数默认是map
     * @return
     */
    @GET()
    Call<ResponseBody> get(@Url String url, @QueryMap Map<String,String> map);

    /**
     * 不带参数的post请求
     * @param url
     * @return
     */
    @POST()
    Call<ResponseBody> post(@Url String url);

    /**
     * 带参数的post请求
     * @param url
     * @param map
     * @return
     */
    @POST()
    @FormUrlEncoded
    Call<ResponseBody> post(@Url String url, @FieldMap Map<String,String> map);

}

定义RetrofitManager,以单例模式获取Retrofit实例

public enum RetrofitManager {

    /**
     * RetrofitManager的实例
     */
    INSTANCE;

    /**
     *
     * 后端接口的baseUrl,且只考虑一个url的情况(ip+端口,或者域名)
     */
    private static final String BASE_URL = " Your BASE_URL";

    private Retrofit retrofit;

    /**
     * 返回Retrofit实例,不添加转换器
     * @return
     */
    public Retrofit getRetrofit(){
        if(retrofit == null){
            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .build();
        }
        return retrofit;
    }
}

自定义的RetrofitCallback,在发送请求时,通过匿名对象作为参数获取后端的响应结果。

public abstract class RetrofitCallback {

    /**
     * 开始执行的方法
     */
    public void onStart(){
        //开启loading
    }

    /**
     * 结束执行的方法
     */
    public void onCompleted(){
        //关闭loading
    }

    /**
     * 执行成功
     * @param resultJsonString  返回的json字符串
     */
    public abstract void onSuccess(String resultJsonString);

    /**
     * 失败
     * @param t 异常
     */
    public abstract void onError(Throwable t);

    /**
     * 提示:服务异常
     */
    public void serverErrMsg(){
        //xxx
    }

    /**
     * 提示:请求失败
     */
    public void reqErrMsg(){
        //xxx
    }

    /**
     * 提示:成功
     */
    public void okMsg(){
        //xxx
    }

}

定义RetrofitUtil,封装get和post方法。将RetrofitCallback作为请求参数,在发送请求时重写onSuccess和onError方法,执行具体的操作。

public class RetrofitUtil {

    private Retrofit(){}

    /**
     * 无参的get请求
     * @param url
     * @param callback
     */
    public static void get(String url, RetrofitCallback callback){
        sendRequest(getRequest().get(url),callback);
    }

    /**
     * 有参的get请求
     * @param url  请求的url
     * @param map  参数
     * @param callback  请求结束的回调
     */
    public static void get(String url, Map<String,String> map, RetrofitCallback callback){
        sendRequest(getRequest().get(url,map),callback);
    }

    /**
     * 无参的post请求
     * @param url
     * @param callback
     */
    public static void post(String url, RetrofitCallback callback){
        sendRequest(getRequest().post(url), callback);
    }

    /**
     * 有参的post请求
     * @param url
     * @param map
     * @param callback
     */
    public static void post(String url, Map<String,String> map, RetrofitCallback callback){
        sendRequest(getRequest().post(url,map), callback);
    }

    /**
     * 获取Request实例
     * @return
     */
    private static Request getRequest(){
        Retrofit retrofit = RetrofitManager.INSTANCE.getRetrofit();
        return retrofit.create(Request.class);
    }

    /**
     * 发送请求的共通方法,并对响应结果进行处理
     * @param call
     * @param callback 自定义的Callback
     */
    private void sendRequest(Call<ResponseBody> call,RetrofitCallback callback){

        //开启loading
        callback.onStart();
        //异步请求
        call.enqueue(new Callback<ResponseBody>() {
            @Override
            public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
                //关闭loading
                callback.onCompleted();
                if(response.isSuccessful()){
                    //执行RetrofitCallback的onSuccess方法,获取响应结果的json字符串
                    try {
                        String result = response.body().string();
                        callback.onSuccess(result);
                        //响应成功
                        if(StringUtils.equals(result, Constant.SUCCESS)){
                            callback.okMsg();
                        }
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }else{
                    //服务异常
                    callback.serverErrMsg();
                }
            }

            @Override
            public void onFailure(Call<ResponseBody> call, Throwable t) {
                callback.onCompleted();
                //请求失败
                callback.onError(t);

                callback.reqErrMsg();
               }
            }
        });
    }
}

3. RetrofitUtil使用

get无参请求

RetrofitUtil.get("/xx/xx", new RetrofitCallback() {
    @Override
    public void onSuccess(String resultJsonString) {

    }

    @Override
    public void onError(Throwable t) {

    }
});

get有参请求

Map<String,String> map = new HashMap<>(16);
map.put("key","value");
//xxx
RetrofitUtil.get("/xx/xx", map,new RetrofitCallback() {
    @Override
    public void onSuccess(String resultJsonString) {
        xxxx
    }

    @Override
    public void onError(Throwable t) {
        xxxx
    }
});

post请求和get的使用方法相似

最后

本次只对get和post进行了封装,项目中只用到了这些就没有对文件上传下载以及别的请求方式进行封装。且没有添加转换器,可在RetrofitManager的getRetrofit()方法中自行添加。大概的封装思路就是这样的,可以自行发挥。

此文也只是在记录项目中对Retrofit的使用,对Retrofit的原理并没有较深的了解。

到此这篇关于android Retrofit2网络请求封装介绍的文章就介绍到这了,更多相关android Retrofit2网络封装内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • 基于Retrofit2+RxJava2实现Android App自动更新

    本文实例为大家分享了Retrofit2 RxJava2实现Android App自动更新,具体内容如下 功能解析 自动更新可以说已经是App的标配了,很多第三方平台也都支持这个功能,最近手头上的项目需要加入这个App自动更新,考虑到项目里有用到Retrofit2和RxJava2,于是打算使用它俩自己实现这个功能. 分析App自动更新,可以分为以下三个功能点: 1.APK文件的下载 2.下载进度的实时更新显示 3.下载完成后的自动安装 其中比较难的一点是下载进度的实时更新显示,更难的是如何优雅的进

  • Android Retrofit2网路编程实现方法详解

    Android里面本身有OKHttp,不过不是很好用,这里就用Retrofit2,简单好用. 首先,需要加入网络权限: <uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/> <uses-permission andro

  • android Retrofit2网络请求封装介绍

    目录 1. Retrofit使用 2. Retrofit封装 3. RetrofitUtil使用 最后 1. Retrofit使用 Retrofit是一个现在网络请求框架,先来说一下怎么使用 网络权限(添加到AndroidManifest.xml) <uses-permission android:name="android.permission.INTERNET" /> gradle依赖(添加到build.gradle) implementation("com.

  • fetch网络请求封装示例详解

    export default ({ url, method = 'GET', data = null, }) => { // 请求配置 let options = { method } // data不为空时,它就是post请求 if (data) { options = { ...options, body: JSON.stringify(data), headers: { 'content-type': 'application/json' } } } return fetch(url, o

  • Android Xutils3网络请求的封装详解及实例代码

     Xutils3网络请求的封装详解 封装了一个Xutil3的网络请求工具类,分享给大家,本人水平有限,不足之处欢迎指出. 使用前先配置xutils3: 1.gradle中添加 compile 'org.xutils:xutils:3.3.40' 2.自定义Application /** * Created by Joe on 2016/9/25. */ public class MyApp extends Application { @Override public void onCreate(

  • RxJava+Retrofit实现网络请求封装的方法

    简要介绍 Retrofit是当前应用非常广泛的网络请求框架,通常结合RxJava来进行网络请求,本文将展示一个采用RxJava+Retrofit的网络请求demo. 集成步骤 1.app工程的build.gradle中添加依赖 //retrofit2 implementation 'com.google.code.gson:gson:2.8.5' implementation 'com.squareup.retrofit2:retrofit:2.5.0' implementation 'com.

  • Android HTTP网络请求的异步实现

    前言 大家都知道网络操作的响应时间是不定的,所有的网络操作都应该放在一个异步操作中处理,而且为了模块解耦,我们希望网络操作由专门的类来处理.所有网络数据发送,数据接收都有某几个类来实现,外部其它模块只要调用和处理回调函数即可.外部模块和网络模块之间的调用关系可以用如下图表示: 调用端只要创建Request对象,设置参数,发起请求,即可.最后结果通过回调函数返回.右边的异步任务,HttpClient创建,参数解析,错误处理全部交给网络处理模块来完成.由此来看,这个网络模块其实是重复性很高的开发工作

  • Spring Boot + Vue 前后端分离开发之前端网络请求封装与配置

    前端网络访问,主流方案就是 Ajax,Vue 也不例外,在 Vue2.0 之前,网络访问较多的采用 vue-resources,Vue2.0 之后,官方不再建议使用 vue-resources ,这个项目本身也停止维护,目前建议使用的方案是 axios.今天松哥就带大家来看看 axios 的使用. axios 引入 axios 使用步骤很简单,首先在前端项目中,引入 axios: npm install axios -S 装好之后,按理说可以直接使用了,但是,一般在生产环境中,我们都需要对网络请

  • 微信小程序网络请求封装示例

    网络请求 网络请求小程序提供了wx.request, 仔细看一下 api,这不就是n年前的 $.ajax 吗,好古老啊. // 官方例子 wx.request({ url: 'test.php', //仅为示例,并非真实的接口地址 data: { x: '' , y: '' }, header: { 'content-type': 'application/json' // 默认值 }, success: function(res) { console.log(res.data) } }) 小程

  • 初学Android之网络封装实例

    前言: 模拟用户登录,从安卓发送请求到服务端校验,再从服务端返回给安卓校验结果 1.在AndroidManifest.xml文件中添加网络权限 <uses-permission android:name="android.permission.INTERNET"/>  所放位置如图所示:  2.添加依赖,在app模块下的build.gradle中添加okhttp和json的依赖 implementation group: 'com.squareup.okhttp3', na

  • Android最基本的异步网络请求框架

    本篇文章我们来一起写一个最基本的Android异步网络请求框架,借此来了解下Android中网络请求的相关知识.由于个人水平有限,文中难免存在疏忽和谬误,希望大家可以指出,谢谢大家. 1. 同步网络请求 以HTTP的GET请求为例,我们来介绍一下Android中一个基本的同步请求框架的实现.直接贴代码: public class HttpUtils { public static byte[] get(String urlString) { HttpURLConnection urlConnec

  • 详解微信小程序网络请求接口封装实例

    网络请求封装实例 实现定制要求和方便调用,对微信小程序的网络请求接口进行了封装 封装位置:app.js,方便全局调用 实现方法调用,只用关注接口url和入参 默认和自定义的请求成功.失败和完成的回调处理 可设置请求失败自动重新请求的次数 可以防止重复提交 每个请求设定requestCode 代码 直接将这个方法放在了app.js中 /** * 接口公共访问方法 * @param {Object} urlPath 访问路径 * @param {Object} params 访问参数(json格式)

随机推荐