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

简介

        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>() {@Overridepublic void onResponse(Call<ReSon> call, Response<ReSon> response) {ReSon reSon =  response.body();textView.setText(reSon.getDate());}@Overridepublic 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.mzph.cn/diannao/35800.shtml

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

相关文章

在前端开发过程中如果函数参数很多,该如何精简

1. 在前端开发过程中如果函数参数很多&#xff0c;该如何精简 1.1. 对象参数&#xff08;对象字面量&#xff09;&#xff1a;1.2. 默认参数和解构赋值&#xff1a;1.3. 使用类或构造函数&#xff1a;1.4. 利用闭包或者高阶函数&#xff1a;1.5. 利用ES6的扩展运算符&#xff1…

【LeetCode】每日一题:反转链表

题解思路 循环的方法需要注意prev应该是None开始&#xff0c;然后到结束的时候prev是tail&#xff0c;递归的思路很难绕过弯来&#xff0c;主要在于很难想清楚为什么可以返回尾节点&#xff0c;需要多做递归题&#xff0c;以及递归过程中&#xff0c;可以不使用尾节点来找当前…

Nuxt3 的生命周期和钩子函数(二)

title: Nuxt3 的生命周期和钩子函数&#xff08;二&#xff09; date: 2024/6/26 updated: 2024/6/26 author: cmdragon excerpt: 摘要&#xff1a;本文深入介绍了Nuxt.js框架中几个关键的生命周期钩子函数&#xff0c;包括app:redirected&#xff08;SSR环境下重定向前触发…

20240626让飞凌的OK3588-C开发板在相机使用1080p60分辨率下预览

20240626让飞凌的OK3588-C开发板在相机使用1080p60分辨率下预览 2024/6/26 15:15 4.2.1 全编译测试 在源码路径内&#xff0c;提供了编译脚本 build.sh&#xff0c;运行该脚本对整个源码进行编译&#xff0c;需要在终端切换到解压 出来的源码路径&#xff0c;找到 build.sh 文件…

6.26作业

1.整理思维导图 2.统计家目录下.c文件的个数 ls ~/*.c | wc -l 3.终端输入一个.sh文件&#xff0c;判断文件是否由可执行权限&#xff0c;如果有可执行权限运行脚本&#xff0c;没有可执行权限添加可执行权限后&#xff0c;再运行脚本 #!/bin/bash read -p "请输入一个.…

spring模块(二)SpringBean(2)InitializingBean

一、介绍 InitializingBean是Spring框架提供的一个接口&#xff0c;用于在Bean初始化完成后执行特定的初始化逻辑。 二、使用 1、使用方法 1.1、实现InitializingBean接口 可以让Bean实现该接口&#xff0c;并重写其afterPropertiesSet()方法 1.2、注册 也即让bean初始化…

从官方源码精简出第1个FreeRTOS程序

一、下载官方源码 1、打开百度搜索freerots&#xff0c;找到官网:FreeRTOS官网 2、将源码解压到没有中文目录的路径下 二、删减目录 1、删除FreeRTOS-Plus和tools 2、删除FreeRTOS/Demo下除CORTEX_STM32F103_Keil外的所有文件 3、删除FreeRTOS\Source\portable下除RVDS和MemM…

vue2面试题——API

1. $set this.$set(目标对象target&#xff0c;改的位置&#xff0c;最终数据) /* 数据更新了而视图没有更新的情况 */ <template><div>{{ arr }}<button clickbtn>按钮</button></div> </template> <script> export default {name:…

海康威视摄像头修复

一、适用场景 1、室外安装的摄像头&#xff0c;长时间日晒雨淋后&#xff0c;可能因风向导致雨水进入水晶头&#xff0c;进而摄像头无法识别&#xff1b; 2、在经常施工的场地&#xff0c;可能由于车辆的进出&#xff0c;或施工设备的运行导致摄像头的网线水晶头断裂而无法使用…

浔川社团正式启用 代码付费制度——浔川总社部

浔川社团正式启用 代码付费制度。 规则&#xff1a; 浔川社团源代码收费标准表&#xff08;1&#xff09; 1-5行代码0.2元/行1-10行代码0.3元/行1-20行代码0.5元/行 浔川社团源代码收费标准表&#xff08;2&#xff09; 1-30行代码0.6元/行1-40行代码0.8元/行1-50行代码0.09元…

【PythonWeb开发】Flask中间件钩子函数实现封IP

在 Flask 框架中&#xff0c; 提供了几种类型的钩子&#xff08;类似于Django的中间件&#xff09;&#xff0c;它们是在请求的不同阶段自动调用的函数。这些钩子让你能够对请求和响应的处理流程进行扩展&#xff0c;而无需修改核心代码。 Flask钩子的四种类型 before_first_r…

IT入门知识第八部分《云计算》(8/10)

目录 云计算&#xff1a;现代技术的新篇章 1. 云计算基础 1.1 云计算的起源和发展 云计算的早期概念 云计算的发展历程 1.2 云计算的核心特点 按需自助服务 广泛的网络访问 资源池化 快速弹性 按使用量付费 1.3 云计算的优势和挑战 成本效益 灵活性和可扩展性 维…

[leetcode]intersection-of-two-arrays-ii 两个数组的交集 II

. - 力扣&#xff08;LeetCode&#xff09; class Solution { public:vector<int> intersect(vector<int>& nums1, vector<int>& nums2) {sort(nums1.begin(), nums1.end());sort(nums2.begin(), nums2.end());int length1 nums1.size(), length2 …

动态规划——123. 买卖股票的最佳时机 III

目录 1、题目链接 2、题目分析 1.状态表示 2.状态转移方程 3.初始化 4.填表 5.返回值 3、代码解析 1、题目链接 123. 买卖股票的最佳时机 III 2、题目分析 1.状态表示 由题目可知&#xff0c;我们分为两种状态&#xff0c;买入和卖出&#xff0c;又因为只能完成两次交易…

windows下如何配置vs code的编译环境

在 Windows 上配置 VS Code 的编译环境涉及安装编译器、配置 VS Code 以及编写和运行代码。以下是具体的步骤&#xff1a; 步骤 1&#xff1a;安装必要的软件 安装 Visual Studio Code&#xff1a; 访问 VS Code 的官方网站并下载安装包。按照安装向导进行安装。 安装 C/C 编译…

盲源信道分离—FastICA算法性能仿真

本案例中使用Matlab软件对FastICA算法的声音分离性能进行了仿真&#xff0c;分别对简单波形的混合信号、不同类型声音的混合信号、同一类型的混合信号这三种情况进行仿真&#xff0c;主要从分离信号的波形形状、串音误差两方面对分离性能进行衡量&#xff0c;仿真结果显示快速I…

Gradle学习-3 Gradle构建的生命周期

Gradle常用文件目录 Gradle 构建的生命周期&#xff0c;有3个阶段: 初始化阶段配置阶段执行阶段 1、初始化阶段 Gradle 支持构建单个工程个多个子工程&#xff0c;初始化阶段主要负责收集所有参与本次构建的子工程&#xff0c;创建一个项目的层次结构&#xff0c;并未每个…

SpringBoot优点达项目实战:获取系统配置接口(三)

SpringBoot优点达项目实战&#xff1a;获取系统配置接口&#xff08;二&#xff09; 文章目录 SpringBoot优点达项目实战&#xff1a;获取系统配置接口&#xff08;二&#xff09;1、查看接口2、查看数据库3、代码实现1、创建实体类SysConfig2、创建返回数据的vo3、创建control…

【INTEL(ALTERA)】Eclipse Nios II SBT 无法从模板创建新应用程序和 BSP

目录 说明 解决方法 说明 您应该能够创建新的应用程序和 BSP 模板包含以下步骤&#xff1a; 选择 Nios II应用程序和 BSP 来自模板。选择您的.sopcinfo 文件并选择模板。从您的工作区单击 选择现有的 BSP 项目。单击 创建。选择所需的 BSP 选项。单击 完成。 但是&#xf…

API 安全策略和基础指南

API 是当今数字创新计划的核心&#xff0c;已成为应用程序的头号攻击载体。了解什么是 API 安全、为什么它如此重要&#xff0c;以及如何保护您的 API 免受现代威胁至关重要。 什么是 API 安全&#xff1f; 应用程序编程接口&#xff08;API&#xff09;是现代应用程序的基石…