Retrofit类型安全的HTTP客户端库(json)

news2024/10/7 8:31:31

简介

        Retrofit是Square公司开发的一个类型安全的HTTP客户端库,用于Android和Java平台,它使得与Web服务的交互变得更加简单快捷。Retrofit将HTTP API转换成Java接口,让你可以用更简洁的代码形式调用RESTful API,Android网络编程重点之一,基于互联网,从服务器上获取数据。

一、添加依赖(资源包)

需要添加的依赖:

com.squareup.retrofit2:retrofit:2.x.y
com.squareup.okhttp3:okhttp:4.9.1
com.squareup.retrofit2:converter-scalars:2.x.y
com.squareup.retrofit2:converter-gson:2.x.y
org.jsoup:jsoup:1.17.2

首先,在你的build.gradle.kts(Module级别)文件中添加Retrofit的依赖:

在versions中添加名称及版本

retrofit = "2.9.0"
gson="2.9.0"

在libraries中添加到相应的地址,包名,配置管理

retrofit = {group = "com.squareup.retrofit2", name ="retrofit",version.ref = "retrofit"}
gson={group="com.squareup.retrofit2",name="converter-gson",version.ref="gson"}

最后在"dependencies"(依赖关系)中添加上文中的名称

implementation(libs.retrofit)
    implementation(libs.gson)

二、定义API接口

创建一个接口来描述Web服务的端点。Retrofit会根据这个接口生成实现类。

原理:

public interface ApiService {
    @GET("users/{user}/repos")
    Call<List<Repo>> listRepos(@Path("user") String user);
}

实例:

public interface WHttp {
    @GET("api/weather/city/{id}")
    Call<ReSon> getCall(@Path("id") String id);
}

创建 Retrofit 实例

        创建一个接口来描述Web服务的端点。Retrofit会根据这个接口生成实现类。

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .addConverterFactory(GsonConverterFactory.create()) // 如果你使用Gson解析JSON
    .client(new OkHttpClient())
    .build();

这里,@GET注解指定了HTTP的GET方法,{user}是一个动态部分,将由@Path注解的参数填充。

三、创建服务接口的实例

创建实例:

使用Retrofit实例来创建API接口的实例,并用gson中的addConverterFactory()方法解析数据

四、发送请求:

创建Retrofit服务接口实例

WHttp wHttp = retrofit.create(WHttp.class);

这一行代码通过Retrofit实例创建了一个名为WHttp的服务接口实现。WHttp接口应该事先定义好,包含了一些用于定义HTTP请求的方法,比如这里的getCall方法。

构建请求

Call<ReSon> call = wHttp.getCall("101260101");

调用WHttp接口中的getCall方法,并传入参数"101260101"(这个参数根据实际接口需求可能代表某种ID或查询条件)。这个操作返回一个类型为Call<ReSon>的对象,表示一个即将发出的HTTP请求,目的是获取一个ReSon类型的响应数据。

异步执行请求enqueue

call.enqueue(new Callback<ReSon>() {
    //...
});

使用enqueue方法异步发送请求。它不会阻塞当前线程,适合在主线程中调用,避免UI冻结。

onResponse
@Override
public void onResponse(Call<ReSon> call, Response<ReSon> response) {
    ReSon reSon = (ReSon) response.body();
    textView.setText(reSon.getDate());
}

        当请求成功完成并且服务器返回一个成功的响应(HTTP状态码在200-299之间)时,onResponse方法会被调用。通过response.body()获取到服务器返回的ReSon对象,然后从中提取数据(这里假设ReSon类有一个getDate方法用于获取日期信息),并将这个信息设置到一个名为textView的TextView控件中显示。

onFailure
@Override
public void onFailure(Call<ReSon> call, Throwable t) {
    textView.setText("错误" + t);
}

        如果请求过程中出现错误,比如网络问题、超时、服务器无响应等,onFailure方法会被触发。这里简单地将错误信息以文本形式显示在textView中,实际应用中可能需要更细致的错误处理,比如根据错误类型给出不同的提示信息,或者进行重试逻辑等。

总的来说,这段代码演示了如何使用Retrofit发送一个异步HTTP请求,处理成功响应和失败情况的基本模式。

五、最总代码:

WHttp wHttp = retrofit.create(WHttp.class);
                Call<ReSon> call = wHttp.getCall("101260101");
               call.enqueue(new Callback<ReSon>() {
                   @Override
                   public void onResponse(Call<ReSon> call, Response<ReSon> response) {
                       ReSon reSon =  response.body();
                       textView.setText(reSon.getDate());
                   }

                   @Override
                   public void onFailure(Call<ReSon> call, Throwable t) {
                       textView.setText("错误"+t);
                   }
               });

六、网络安全错误

        该错误信息表明您的应用程序尝试与域名t.weather.itboy.net建立网络连接时,被网络安全策略阻止了。这通常是因为现代操作系统和网络框架为了提高安全性,会限制明文(未加密)的HTTP通信,鼓励或强制使用HTTPS进行加密通信。

         解决这个问题的方法通常涉及到更新应用的网络安全配置,允许特定域名的明文流量或者最好是确保所有通信都通过HTTPS进行。如果你的应用是运行在Android平台上,可以通过以下步骤解决:

创建网络安全配置文件

                在你的Android项目的res/xml目录下,创建一个名为network_security_config.xml的文件(如果该目录不存在,请先创建它),并添加如下配置以允许特定域名的明文流量(t.weather.itboy.net)(这不推荐用于生产环境,仅作示例):

1<?xml version="1.0" encoding="utf-8"?>
2<network-security-config>
3    <domain-config cleartextTrafficPermitted="true">
4        <domain includeSubdomains="true">t.weather.itboy.net</domain>
5    </domain-config>
6</network-security-config>
  1. 引用配置文件

    1. 在你的应用的AndroidManifest.xml文件中,添加android:networkSecurityConfig属性指向刚才创建的配置文件:Xml
      1<application
      2    ...
      3    android:networkSecurityConfig="@xml/network_security_config">
      4    ...
      5</application>
  2. 重启应用

    1. 保存更改后,重新编译并安装你的应用到设备上。

然而,最安全的做法是确保t.weather.itboy.net支持HTTPS,并且你的应用只通过HTTPS与之通信。如果该服务确实提供了HTTPS连接,请检查你的应用程序代码,确保所有URL都以https://开头而非http://

如果这是由于Android系统的安全策略(比如在Android 9及以上版本中对明文流量的限制),则上述解决方案是必要的。但在实施时,始终优先考虑应用和用户数据的安全性。

 数据匹配错误

如下错误:

更正数据匹配为:

七、效果

八、异步与同步请求

        Retrofit支持异步(如上所示使用enqueue方法)和同步请求(使用execute方法)。注意,同步请求不应该在主线程中执行,因为它会阻塞UI线程。在Retrofit中,异步请求通过enqueue方法实现,而同步请求则通过execute方法完成。下面分别给出这两个操作的示例代码,但请注意,同步请求应当避免在Android主线程中直接执行,以免阻塞UI,导致应用无响应(ANR)。

异步请求示例(已提供,再次展示以供参考)

1WHttp wHttp = retrofit.create(WHttp.class);
2Call<ReSon> call = wHttp.getCall("101260101");
3
4call.enqueue(new Callback<ReSon>() {
5    @Override
6    public void onResponse(Call<ReSon> call, Response<ReSon> response) {
7        if (response.isSuccessful()) {
8            ReSon reSon = response.body();
9            // 在这里处理响应数据,例如更新UI
10            runOnUiThread(new Runnable() {
11                @Override
12                public void run() {
13                    textView.setText(reSon.getDate());
14                }
15            });
16        } else {
17            // 处理错误情况,例如HTTP错误码
18        }
19    }
20
21    @Override
22    public void onFailure(Call<ReSon> call, Throwable t) {
23        // 处理网络请求失败的情况
24        runOnUiThread(new Runnable() {
25            @Override
26            public void run() {
27                textView.setText("错误: " + t.getMessage());
28            }
29        });
30    }
31});

同步请求示例

同步请求应当在后台线程执行,例如使用ThreadAsyncTask(尽管AsyncTask在Android 11及以上版本已被废弃,推荐使用其他并发机制如java.util.concurrent包下的工具类)。以下使用一个简单的Thread示例:

1new Thread(new Runnable() {
2    @Override
3    public void run() {
4        try {
5            WHttp wHttp = retrofit.create(WHttp.class);
6            Call<ReSon> call = wHttp.getCall("101260101");
7            Response<ReSon> response = call.execute();
8
9            if (response.isSuccessful()) {
10                final ReSon reSon = response.body();
11                // 由于不能直接在后台线程更新UI,需要切换到主线程
12                runOnUiThread(new Runnable() {
13                    @Override
14                    public void run() {
15                        textView.setText(reSon.getDate());
16                    }
17                });
18            } else {
19                // 错误处理,同样需要回到主线程更新UI
20                runOnUiThread(new Runnable() {
21                    @Override
22                    public void run() {
23                        textView.setText("同步请求错误: " + response.code());
24                    }
25                });
26            }
27        } catch (IOException e) {
28            e.printStackTrace();
29            // 异常处理,同样需要回到主线程更新UI
30            runOnUiThread(new Runnable() {
31                @Override
32                public void run() {
33                    textView.setText("同步请求失败: " + e.getMessage());
34                }
35            });
36        }
37    }
38}).start();

在上述同步请求示例中,我们通过创建一个新的Thread并在其中执行execute方法来发送请求。由于execute会阻塞直到请求完成,所以它不能直接在主线程中使用。请求完成后,我们使用runOnUiThread回调到主线程更新UI,以确保遵循Android的单线程模型。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1859176.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

vue3 element-plus 实现 table表格合并单元格 和 多级表头

多级表头 数据结构比较复杂的时候&#xff0c;可使用多级表头来展现数据的层次关系。 只需要将el-table-column 放置于el-table-column 中&#xff0c;你可以实现组头。 一般可以直接用官网提供的写法&#xff0c;但是有可能数据会比较多的时候&#xff0c;就需要我们稍微改造…

unordered_set和unordered_map

用哈希结构封装map和set 哈希表的改造 节点 数据类型改为模板 迭代器 成员 一个节点的指针&#xff0c;哈希表和下标用来访问&#xff0c;哈希表需要支持修改&#xff0c;传入指针&#xff0c;const为了常迭代器可以传递哈希表 当前节点的next有内容&#xff0c;先遍历…

分布式数据库系统MyCat

MyCat简介 MyCat是一个开源的分布式数据库系统&#xff0c;是一个实现了MySQL协议的服务器&#xff0c;前端用户可以把它看作是一个数据库代理&#xff0c;用MySQL客户端工具和命令行访问&#xff0c;而其后端可以用MySQL原生协议与多个MySQL服务器通信&#xff0c;也可以用JD…

Tita的OKR:如何高效写好一个 OKR ?

OKR 是一个简单而强大的目标设定系统&#xff0c;世界各地的企业都依靠它来提高&#xff08;除其他外&#xff09;对战略、调整和参与的关注度。该系统由目标&#xff08;你想实现的目标&#xff09;和关键结果&#xff08;衡量目标实现情况的量化陈述&#xff09;组成。 目标…

参数页面设计

目录 一 设计原型 二 后台源码 一 设计原型 二 后台源码 namespace 参数页面设计 {public partial class Form1 : Form{List<PMs> PMs new List<PMs>();public Form1(){InitializeComponent();}private void Form1_Load(object sender, EventArgs e){for (int …

element-ui table使用type=‘selection‘复选框全禁用-全选禁用_elementui table禁用全选

问题点&#xff1a;当条件数据全被禁用时&#xff0c;全选按钮不是禁用的状态。 复选框全被禁用时&#xff0c;全选按钮将被隐藏 问题总结&#xff1a; 当条件数据全被禁用时&#xff0c;全选按钮也变成禁用的状态&#xff0c;而不是隐藏。有会做的小伙伴希望跟帖。谢谢&#x…

PasteSpiderFile文件同步管理端使用说明(V24.6.21.1)

PasteSpider作为一款适合开发人员的部署管理工具&#xff0c;特意针对开发人员的日常情况做了一个PasteSpiderFile客户端&#xff0c;用于windows上的开发人员迅速的更新发布自己的最新代码到服务器上&#xff01; 虽然PasteSpider也支持svn/git的源码拉取&#xff0c;自动编译…

0802功放2

功放要记一般的式子&#xff0c;而非最大的式子&#xff0c;因为总不能总开到最大音量上工作&#xff0c;而是在比较合适的音量上工作 运放的最大电压也是比电源低1~2V 饱和三极管的功率&#xff0c;电流越大&#xff0c;饱和压降越大&#xff1f;&#xff1f;&#xff1f;不…

SpringBoot优点达项目实战:项目初始化(一)

SpringBoot优点达项目实战&#xff1a;项目初始化&#xff08;一&#xff09; 文章目录 SpringBoot优点达项目实战&#xff1a;项目初始化&#xff08;一&#xff09;1、项目介绍2、项目搭建3、依赖导入4、数据准备 1、项目介绍 技术框架 SpringbootmybatisPlusvueknife 2、项目…

机器学习之逻辑回归丨KNN测试

选择题 【 正确答案: A D】 A. B. C. D. 【 正确答案: B】 A. B. C. D. 【 正确答案: C, D】 A. B. C. D. 假设我们三个类别中心&#xff0c;若某测试样本为&#xff0c;它的 c ( i ) c^{(i)} c(i)是多少&#xff1f; 【 正确答案: B】 A.1 B.2 C.3 D.不确定 假设你…

跨境电商货源渠道哪里找?盘点11个拿货产业带

一、跨境货源渠道哪里找&#xff1f; 说到找货源&#xff0c;应该很多卖家都上过阿里巴巴1688“淘货”&#xff0c;阿里巴巴1688作为一个全球采购批发平台&#xff0c;在2017年上线了个跨境专供板块&#xff0c;专为跨境卖家供货&#xff0c;跨境专供板块的供货商需要经过严格…

将 MinIO 与 Keycloak OIDC 集成

Keycloak是一种单点登录解决方案。使用Keycloak&#xff0c;用户使用Keycloak而不是MinIO进行身份验证。如果没有Keycloak&#xff0c;您将不得不为每个用户创建一个单独的身份 - 从长远来看&#xff0c;这将很麻烦。您需要一个集中身份解决方案来管理 MinIO 的身份验证和授权。…

vue3 vxe-grid列中绑定vxe-switch实现数据更新

1、先上一张图&#xff1a; <template #valueSlot"{ row }"><vxe-switch :value"getV(row.svalue)" change"changeSwitch(row)" /></template>function getV(value){return value 1;};function changeSwitch(row) {console.l…

数据分析必备:一步步教你如何用matplotlib做数据可视化(11)

1、Matplotlib 三维绘图 尽管Matplotlib最初设计时只考虑了二维绘图&#xff0c;但是在后来的版本中&#xff0c;Matplotlib的二维显示器上构建了一些三维绘图实用程序&#xff0c;以提供一组三维数据可视化工具。通过导入Matplotlib包中包含的mplot3d工具包&#xff0c;可以启…

推荐免费好用的日历和浏览器,你一定要下载使用

猫眼浏览器 猫眼浏览器是一款基于Chromium内核的增强版网页浏览器&#xff0c;融合了Chrome的核心功能与Safari的优美外观。它以简约和安全为目标&#xff0c;提供了快速、流畅的网页加载和浏览体验。 猫眼浏览器内置了隐私保护和广告屏蔽功能&#xff0c;能够有效防止用户数据…

Linux tcpdump抓包必备知识

author: 放牛娃学编程 moto: 分享与热爱&#xff0c;不是大爱我不说 放牛娃每日一语: 除了你自己&#xff0c;没有人可以说你不行 别急着划开&#xff0c;这篇笔记一定能够给你带来收获 因为这里你能学到AI永远也给不了你的知识 Linux tcpdump抓包必备知识 文章目录 Linux tcp…

Vue3 头像是圆形,hover上去时头像出现黑色半透明样式,且中间显示修改两字的实现

实现效果 原头像 hover效果 实现方式 博主在实际开发过程中使用mouseover和mouseout会出现无法点击或hover频繁闪动的问题&#xff0c;故这里采用的是css中的hover&#xff0c;利用hover也能轻松实现上述效果&#xff0c;且完全不会影响点击事件的使用。 <template> &…

Mysql: 数据模型

一.关系型数据库 概念:建立在关系型基础上,由多张相互连接的二维表组成的数据库。 1.关系型数据库: 2.特点&#xff1a; 1.使用表存储数据,格式统一,便于维护。 2.使用SQL语言操作,标准统一,使用方便。 3.数据模型 通过客户端连接DBMS可以创建多个数据库,在数据库中…

TOPGP-TIPTOP调用外部Webservice

功能要求&#xff1a;ERP作业调用外部系统的webserice更新数据。 演示环境&#xff1a;ERP作业cooi002&#xff08;员工档案&#xff09;录入后更新到外部系统员工档案表。 1、外部系统的WebSerice使用.net搭建 2、在Service.cs中写一个调用方法erp_other erp_other中两个参数…

Windows 中 Chrome / Edge / Firefox 浏览器书签文件默认存储路径

1. Chrome 浏览器 按组合键 Win R&#xff0c;打开运行对话框&#xff0c;输入 %USERPROFILE%\AppData\Local\Google\Chrome\User Data\Default或在Chrome 浏览器地址栏输入 chrome://version查看【个人资料路径】 2. Edge 浏览器 按组合键 Win R&#xff0c;打开运行对…