Retrofit2的使用

最新推荐文章于 2022-04-02 09:23:37 发布
最新推荐文章于 2022-04-02 09:23:37 发布
阅读量444 收藏
点赞数
分类专栏： Android 文章标签： retrofit2
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qby_nianjun/article/details/78646509
版权

第一次使用Retrofit2，并没有使用RxJava，解析返回的是String字符串

在app的build.gradle中添加依赖：

compile 'com.squareup.retrofit2:retrofit:2.3.0'
//字符串解析器
compile 'com.squareup.retrofit2:converter-scalars:2.3.0'
//Gson解析器
//compile 'com.squareup.retrofit2:converter-gson:2.3.0'

添加混淆

## ----------------------------------
##      retrofit2相关
## ----------------------------------
-dontwarn retrofit2.**
-dontwarn com.squareup.retrofit2.Platform$Java8
-dontnote com.squareup.retrofit2.Platform
-dontnote retrofit2.Platform$IOS$MainThreadExecutor
-keep class retrofit2.** { *; }

## ----------------------------------
##      okhttp3相关
## ----------------------------------
-dontwarn okhttp3.**
-keep class okhttp3.** { *;}
-dontwarn okio.**

创建HttpUtil工具类，retrofit的创建以及一些公共参数的添加和加密都写在util类里。

retrofit的创建：

private static HttpService mService;

    /**
     * 单例
     *
     * @return HttpService对象
     */
    public static HttpService getInstance() {
        synchronized (HttpUtil.class) {
            if (mService == null) {
                Retrofit retrofit = new Retrofit.Builder()
                        .baseUrl(Constants.BASE_URL)
                        .addConverterFactory(ScalarsConverterFactory.create())
                        .build();
                mService = retrofit.create(HttpService.class);
            }
        }

        return mService;
    }

Constants.BASE_URL为服务器根地址。

HttpService类，就是retrofit请求的方法类。

public interface HttpService {

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

    @Multipart
    @POST("/gateway")
    Call<String> uploadSingle(@Part List<MultipartBody.Part> partList);

    @Streaming
    @GET
    Call<ResponseBody> downloadFileWithUrlAsync(@Url String fileUrl);

    @GET("/validateAndCacheCardInfo.json?_input_charset=utf-8&cardBinCheck=true")
    Call<String> getCardDetail(@Query("cardNo") String cardNo);
}

其中，userCall为我们后台的接口请求方法，请求URL相当于Constants.BASE_URL+“/gateway”,@POST后path路径不能为空，由于我们的接口请求具体方法作为参数放在请求map中，所以所有获取展示信息的接口调用的都是userCall方法（根据服务器配置的不同，可以根据功能分为多个方法，或者多个service类）；uploadSingle是文件上传方法；getCardDetail是调用支付宝API银行卡校验使用的查询方法。

userCall的使用（以获取验证码为例）：

showProgressDialog("获取验证码...");
startTimer();
HashMap<String, String> postParams = new HashMap<>();
postParams.put("mobile", AppUtil.replaceBlock(phone));
postParams.put("method", Constants.GET_CODE_METHOD);
postParams.put("status", "2");
codeCall = HttpUtil.getInstance()
        .userCall(HttpUtil.getParamMap(postParams, false));
codeCall.enqueue(codeCallback);
//验证码请求
private Call<String> codeCall;
//验证回调
private Callback<String> codeCallback = new Callback<String>() {
    @Override
    public void onResponse(@NonNull Call<String> call, @NonNull Response<String> response) {
        MyLog.e(TAG, response.body());
        hideProgressDialog();
        if (HttpUtil.httpGetCode(response)) {
            CodeBean codeBean = new Gson().fromJson(response.body(), CodeBean.class);
            if (codeBean == null) {
                MyToast.showToast(Constants.ERROR_IN_TRANSLATE);
                stopTimer();
            } else {
                int code = codeBean.code;
                if (code == 200) {
                    hasSendCode = true;
                    CodeBean.DataBean jsonData = codeBean.data;
                    sessionId = jsonData.session_id;
                    MyToast.showToast("发送成功");
                } else {
                    stopTimer();
                    String message = codeBean.message;
                    if (code == 201) {
                        MyToast.showToast(message);
                    } else {
                        MyToast.showToast(code + ":" + message);
                    }
                }
            }
        } else {
            stopTimer();
        }
    }

    @Override
    public void onFailure(@NonNull Call<String> call, @NonNull Throwable t) {
        stopTimer();
        hideProgressDialog();
        if (!call.isCanceled()) {
            if ("timeout".equals(t.getLocalizedMessage())) {
                MyToast.showToast(Constants.ERROR_TIME_OUT);
            } else {
                MyToast.showToast(Constants.ERROR_REQUEST_FAILED);
            }
        }
    }
};
@Override
protected void onStop() {
    super.onStop();
    if (codeCall != null) {
        codeCall.cancel();
    }
}

其中HttpUtil.getParamMap(postParams, false)为添加公共参数和加密的方法。

uploadSingle的使用：
与userCall一样：

/**
 * 上传图片
 */
 private void uploadImage(String path) {
     HashMap<String, String> params = new HashMap<>();
     params.put("method", Constants.UPLOAD_PHOTO_METHOD);
     params.put("user_id", CacheUtil.getString(Constants.ID, "0"));
     uploadCall = HttpUtil.getInstance()
             .uploadSingle(HttpUtil.getParts(params, activity, new File(path)), true));
     showProgressDialog("图片上传中...");
     uploadCall.enqueue(uploadCallback);
 }

不同的是对传递的参数进行的操作
HttpUtil.getParts(params, activity, new File(path)), true)；

/**
 * 获取上传到服务器的参数
 *
 * @return MultipartBody.Part集合
 */
public static List<MultipartBody.Part> getParts(HashMap<String, String> postParams, Activity activity, File logoFile, boolean sso) {
    MultipartBody.Builder builder = new MultipartBody.Builder()
            .setType(MultipartBody.FORM);//表单类型
    Iterator<Map.Entry<String, String>> iterator = getParamMap(postParams, sso).entrySet().iterator();
//        添加参数
    while (iterator.hasNext()) {
        Map.Entry<String, String> next = iterator.next();
        String key = next.getKey();
        String value = next.getValue();
        builder.addFormDataPart(key, value);
    }
    File file = logoFile;
    if (logoFile.length() > 500 * 1024) {
        try {
            file = new Compressor(activity)
                    .setMaxWidth(300)
                    .setMaxHeight(300)
                    .setCompressFormat(Bitmap.CompressFormat.PNG)
                    .compressToFile(logoFile);

            MyLog.e(TAG, "图片大小" + android.text.format.Formatter.formatFileSize(activity, file.length()));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    RequestBody imageBody = RequestBody.create(MediaType.parse("multipart/form-data"), file);
    builder.addFormDataPart("pic", "logo.png", imageBody);//imgfile 后台接收图片流的参数名
    return builder.build().parts();
}

此处为了使图片大小不超过500k,对图片进行了压缩，压缩添加依赖compile ‘id.zelory:compressor:2.1.0’；
builder.addFormDataPart(“pic”, “logo.png”, imageBody);
这句代码中pic为上传图片后台需要的参数名，logo.png为图片名。

downloadFileWithUrlAsync的使用

HttpUtil.getInstance()
                .downloadFileWithUrlAsync(downUrl)
                .enqueue(downloadCallback);

下载大文件，为避免将整个文件读进内存，需要添加@Streaming注解

//下载回调
    private Callback<ResponseBody> downloadCallback = new Callback<ResponseBody>() {
        @Override
        public void onResponse(@NonNull Call<ResponseBody> call, @NonNull Response<ResponseBody> response) {
            if (!response.isSuccessful()) {
                try {
                    if (response.errorBody() == null) {
                        MyToast.showToast(response.code() + ":" + response.message());
                    } else {
                        MyToast.showToast(response.errorBody().string());
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
            } else if (response.body() == null) {
                MyToast.showToast(Constants.ERROR_NO_DATA);
            } else {
                new Thread() {
                    @Override
                    public void run() {
                        super.run();
                        downloadFileFromServer(response);
                    }
                }.start();

            }

        }

        @Override
        public void onFailure(@NonNull Call<ResponseBody> call, @NonNull Throwable t) {
            handler.sendEmptyMessage(UPDATE_END_CODE);
            MyToast.showToast("下载更新包失败");
            if (!"0".equals(type)) {
                finish();
                System.exit(0);
            }
        }
    };

getCardDetail的使用

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://ccdcapi.alipay.com")
                .addConverterFactory(ScalarsConverterFactory.create())
                .build();
HttpService mService = retrofit.create(HttpService.class);
cardDetailCall = mService.getCardDetail(cardNo);
cardDetailCall.enqueue(cardDetailCallback);

这里因为调用的是支付宝的接口，baseUrl不一致，所以retrofit的创建没使用统一的HttpUtil中的实例。
对比HttpService中的getCardDetail方法：

@GET("/validateAndCacheCardInfo.json?_input_charset=utf-8&cardBinCheck=true")
Call<String> getCardDetail(@Query("cardNo")String cardNo);

支付宝接口请求的url为：

http://ccdcapi.alipay.com/validateAndCacheCardInfo.json?_input_charset=utf-8&cardBinCheck=true&cardNo=输入的银行卡号

@Query(“cardNo”)注解表示传入的字符串为查询参数cardNo的值；

也可以使用@Url注解，重新定义接口地址，将地址以参数的形式传入。

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

调用时:

Call<List<Activity>> call = HttpUtil.getInstance()
                .getCardDetail(
                "http://ccdcapi.alipay.com/validateAndCacheCardInfo.json?_input_charset=utf-8&cardBinCheck=true&cardNo="+cardNo);

注解中还有：
@QueryMap表示传入多个查询参数；
@Path(“test”)表示传入的参数作为路径（如：@GET(“/{test}”)），方法中可传入多个
@Body CommentBody body 表示传入的参数为CommentBody对象
@Field 表示POST请求传入单个字段，使用@Field时记得添加@FormUrlEncoded

brave_shine
关注
专栏目录
Retrofit2简单使用（一）
YangZ的博客
10-18 851
版权声明：本文为博主原创文章，未经博主允许不得转载： https://mp.csdn.net/postedit/83142243 今天去看了一波 Retrofit2+RxJava2+MVP 网络请求模式，说实在的看得头都大了，还好网上大神多一点点学习下，我一次性也写不出那么高级的代码，只能一点点来， 先来一把 Retrofit2 请求网络数据吧， 后面的会补上，哎，这个还是要看理解能力 ...
Retrofit网络请求GET请求POST请求
03-30
Retrofit网络请求，内含GET、POST请求，POST请求需要用自己的服务器针对性接口测试、GET请求公开接口测试，解析内容简单按需自己项目，很好的框架通俗易懂
Retrofit2 使用
JesJiang的博客
10-14 215
1、@Multipart上传单个文件 import okhttp3.MultipartBody; import okhttp3.RequestBody; import retrofit2.http.*; @Multipart @POST("api/v1/grid/upload/{data_code}/{element}") Object uploadZip(@Part MultipartBody.Part file, @PartMap M
咬文嚼字之 Retrofit2 使用
SophieBryant的博客
08-23 206
     俗话说的好，咬文嚼字，深入到文章的每一个字，每一段话，才能体会到一篇美文的内涵和文章的美，所以对于我们开发人员来说，对工具的认识，第一步就是对其的基本的使用，会使用了才会去探究其中的奥秘，今天这篇就写一个大致的使用，下一篇就对其的原理对一个详细的说明。        1. 引入相关包以及权限             build.gradle       //    compile ...
Carson带你学Android：这是一份详细的 Retrofit使用教程（含实例讲解）
热门推荐
Carson带你学Android
06-26 25万+
前言 在Andrroid开发中，网络请求十分常用 而在Android网络请求库中，Retrofit是当下最热的一个网络请求库 今天，我将献上一份非常详细Retrofit v2.0的使用教程，希望你们会喜欢。 如果对Retrofit v2.0的源码感兴趣，可看文章：Android：手把手带你深入剖析 Retrofit 2.0 源码 目录![目录](http://upload-
Android Retrofit2使用Demo
06-04
**Android Retrofit2使用Demo** Retrofit2是Google推出的一个强大的网络请求库，它极大地简化了Android应用中的网络通信。Retrofit2基于OkHttp，提供了一种类型安全的HTTP客户端，使得开发者可以方便地进行RESTful ...
java8源码-Retrofit2Demo:Retrofit2使用
06-04
Retrofit的使用 本文注目录： Retrofit入门 Retrofit注解详解 Gson与Converter RxJava与CallAdapter 自定义Converter 自定义CallAdapter 其它说明 前言 本文中的Retrofit均指代Retrofit2.0。 本文涉及到的代码以及...
Retrofit2 使用Demo示例
06-22
Retrofit2 使用Demo
Android网络框架Retrofit2使用封装：Get/Post/文件上传/下载
10-16
为了方便Android开发，特封装了一些关于Retrofit2的代码，分享给大家。框架主要包括：Get请求、Post请求、文件上传、文件下载。效果图及讲解见：https://blog.csdn.net/ahuyangdong/article/details/82760382。...
Retrofit2 使用Demo
06-22
下面我们将详细探讨Retrofit2的使用方法和核心概念。 **一、Retrofit2简介** Retrofit2的核心设计理念是基于注解的API接口定义。开发者只需要创建一个接口，然后在方法上添加注解来指定HTTP请求的类型（GET、POST...
Retrofit2简单使用
yangmuhang2009的博客
03-10 574
一、Retrofit是什么？ 确切的讲，Retrofit是对okhttp的进一步封装，是一个现在比较火的网络请求框架。 二、使用步骤 1.引入库 implementation 'com.squareup.retrofit2:retrofit:2.9.0' 2.创建一个interface，我们将这个interface取名为HttpBinService 代码如下（示例）： package hk.hkiot.okhttp; import okhttp3.ResponseBody; import retrofi
Retrofit2的get请求和post请求
Android_Study_OK的博客
05-23 2万+
准备工作<uses-permission android:name="android.permission.INTERNET"/> compile 'com.squareup.retrofit2:retrofit:2.0.2' compile 'com.squareup.retrofit2:converter-gson:2.0.2'定义package com.github.c.retrofit2d
Android中使用retrofit2进行网络get请求查询数据和post请求上传文件
BADAO_LIUMANG_QIZHI的博客
12-17 2487
场景 Retrofit2 Retrofit 是对 OkHttp 的封装，是主流的网络框架。 适用于Android 和 Java 的类型安全的HTTP客户端，由Square提供的。 Retrofit是一种HTTP客户端框架，使用它，我们可以完成有关HTTP的工作。 Retrofit Github 主页： https://github.com/square/Retrofit 注： 博客：https://blog.csdn.net/badao_liumang_qizhi 关注公众号 霸道的程序猿
Gradle项目retrofit2+okhttp3实现http请求
TomPig_1024
10-23 1069
一 简介： 目前网上提供很多Java实现httpServer封装，其中完善的就属hutools工具和本文介绍的。至于hutools工具中HttpUtils方法，大家可以根据API文档进行使用，比较快捷，hutools官方给的案例，各位只要按葫芦画瓢基本可以实现。既然有这么好的工具为啥我不用，转而研究retrofit2呢，因为异步和同步的问题。做过安卓开发的大佬，都会发现，安卓和java的区别安卓有自己的主线程，如果在安卓使用同步请求的话，主线程或被破坏，从而出现异常，我用retrofit2起因也是因为这个。
安卓开发笔记（十）—— Retrofit2+Rxjava网络访问，多线程（利用GitHub的api接口获取数据）
dick的博客
12-18 1007
中山大学数据科学与计算机学院本科生实验报告 （2018年秋季学期） 一、实验题目 第十五周实验目的 理解Restful接口 学会使用Retrofit2 复习使用RxJava 学会使用OkHttp 二、实现内容 实现一个github用户repos以及issues应用 主界面有两个跳转按钮分别对应两次作业 github界面，输入用户名搜索该用户所有可提交issue的repo，每个item...
retrofit 2.0 简单使用
Peak1Chen的博客
06-09 2756
Retrofit与okhttp都是出于Square公司，Retrofit对okhttp做了一层包装，把网络请求都交给了okhttp（可以参考okhttp3使用），因此只需要简单的配置，就能用Retrofit进行网络请求。一、引入retrofit 2.0需要在项目下的build.gradle添加retrofit 2.0.2的引用// retrofit 库 compile 'com.squareup.r
retrofit2 发送json数据_使用Retrofit发送POST请求提交JSON数据
weixin_35437202的博客
01-14 754
示例如下HttpService.javaimportokhttp3.RequestBody;importretrofit2.Call;importretrofit2.http.Body;importretrofit2.http.Headers;importretrofit2.http.POST;public interfaceHttpService {String BASE_URL= "http:...
Retrofit2使用post发送json字符串
weixin_49446194的博客
04-02 2735
导入包 implementation 'com.squareup.retrofit2:retrofit:2.5.0' implementation 'com.squareup.retrofit2:converter-gson:2.5.0' 加入网络权限 <uses-permission android:name="android.permission.INTERNET"/> <uses-permission android:name="android.permission.ACC
Retrofit 2.0 使用教程
whj9073的专栏
12-13 489
本文的详细的使用细节请参考：https://blog.csdn.net/carson_ho/article/details/73732076 Android Retrofit 2.0 使用-补充篇 Retrofit的简易封装：https://blog.csdn.net/whj9073/article/details/84991663 使用 Retrofit 的步骤共有7个： 步骤1：添加R...
Springboot使用retrofit2 使用restemplate
最新发布
07-13
Spring Boot可以使用Retrofit2和RestTemplate来进行网络请求。 首先，我们来看如何使用Retrofit2。首先，你需要在你的`pom.xml`文件中添加Retrofit2的依赖： ```xml <dependency> <groupId>com.squareup.retrofit2</groupId> <artifactId>retrofit</artifactId> <version>2.9.0</version> </dependency> ``` 接下来，创建一个Retrofit的实例，并定义一个接口来描述你的API： ```java Retrofit retrofit = new Retrofit.Builder() .baseUrl("http://api.example.com/") .addConverterFactory(GsonConverterFactory.create()) .build(); interface MyApi { @GET("endpoint") Call<MyResponse> getData(); } ``` 然后，你可以使用该接口来发起网络请求： ```java MyApi myApi = retrofit.create(MyApi.class); Call<MyResponse> call = myApi.getData(); call.enqueue(new Callback<MyResponse>() { @Override public void onResponse(Call<MyResponse> call, Response<MyResponse> response) { // 处理响应 if (response.isSuccessful()) { MyResponse myResponse = response.body(); // 处理成功的响应 } else { // 处理错误的响应 } } @Override public void onFailure(Call<MyResponse> call, Throwable t) { // 处理请求失败 } }); ``` 接下来，我们来看如何使用RestTemplate。首先，你需要在你的`pom.xml`文件中添加Spring Web的依赖： ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> ``` 然后，在你的代码中创建一个RestTemplate实例，并使用它来发送HTTP请求： ```java RestTemplate restTemplate = new RestTemplate(); MyResponse response = restTemplate.getForObject("http://api.example.com/endpoint", MyResponse.class); ``` 以上就是使用Retrofit2和RestTemplate进行网络请求的基本步骤。你可以根据具体的需求进行适当的配置和定制化。 注意，在使用Retrofit2时，你需要定义一个接口来描述API，并使用注解来标记请求的方法和参数。而在使用RestTemplate时，你可以直接调用其提供的方法来发送请求，并将响应转换为你需要的对象类型。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值