iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >SpringBoot中使用HTTP客户端工具Retrofit
  • 618
分享到

SpringBoot中使用HTTP客户端工具Retrofit

2024-04-02 19:04:59 618人浏览 泡泡鱼

Python 官方文档:入门教程 => 点击学习

摘要

前言 我们平时开发项目时,就算是单体应用,也免不了要调用一下其他服务提供的接口。此时就会用到Http客户端工具,之前一直使用的是Hutool中的HttpUtil,虽然容易上手,但用起

前言

我们平时开发项目时,就算是单体应用,也免不了要调用一下其他服务提供的接口。此时就会用到Http客户端工具,之前一直使用的是Hutool中的HttpUtil,虽然容易上手,但用起来颇为麻烦!最近发现一款更好用的HTTP客户端工具Retrofit,你只需声明接口就可发起HTTP请求,无需进行连接、结果解析之类的重复操作,用起来够优雅,推荐给大家!

SpringBoot实战电商项目mall(50k+star)地址:https://GitHub.com/Macrozheng/mall

简介

Retrofit是适用于AndroidJava且类型安全的HTTP客户端工具,在github上已经有39k+Star。其最大的特性的是支持通过接口的方式发起HTTP请求,类似于我们用Feign调用微服务接口的那种方式。

springBoot是使用最广泛的Java开发框架,但是Retrofit官方并没有提供专门的Starter。于是有位老哥就开发了retrofit-spring-boot-starter,它实现了Retrofit与SpringBoot框架的快速整合,并且支持了诸多功能增强,极大简化开发。今天我们将使用这个第三方Starter来操作Retrofit。

使用

在SpringBoot中使用Retrofit是非常简单的,下面我们就来体验下。

依赖集成

有了第三方Starter的支持,集成Retrofit仅需一步,添加如下依赖即可。

<!--Retrofit依赖-->
<dependency>
    <groupId>com.github.lianjiatech</groupId>
    <artifactId>retrofit-spring-boot-starter</artifactId>
    <version>2.2.18</version>
</dependency>

基本使用

下面以调用mall-tiny-swagger中的接口为例,我们来体验下Retrofit的基本使用。

首先我们准备一个服务来方便远程调用,使用的是之前的mall-tiny-swagger这个Demo,打开Swagger看下,里面有一个登录接口和需要登录认证的商品品牌CRUD接口,

项目地址:

https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-swagger

我们先来调用下登录接口试试,在application.yml中配置好mall-tiny-swagger的服务地址;

remote:
  baseUrl: http://localhost:8088/

再通过@RetrofitClient声明一个Retrofit客户端,由于登录接口是通过POST表单形式调用的,这里使用到了@POST和@FORMUrlEncoded注解;


@RetrofitClient(baseUrl = "${remote.baseUrl}")
public interface UmsAdminapi {
    @FormUrlEncoded
    @POST("admin/login")
    CommonResult<LoginInfo> login(@Field("username") String username, @Field("passWord") String password);
}

如果你不太明白这些注解是干嘛的,看下下面的表基本就懂了,更具体的话可以参考Retrofit官方文档;

接下来在Controller中注入UmsAdminApi,然后进行调用即可;


@Api(tags = "RetrofitController", description = "Retrofit测试接口")
@RestController
@RequestMapping("/retrofit")
public class RetrofitController {
    @Autowired
    private UmsAdminApi umsAdminApi;
    @Autowired
    private TokenHolder tokenHolder;
    @ApiOperation(value = "调用远程登录接口获取token")
    @PostMapping(value = "/admin/login")
    public CommonResult<LoginInfo> login(@RequestParam String username, @RequestParam String password) {
        CommonResult<LoginInfo> result = umsAdminApi.login(username, password);
        LoginInfo loginInfo = result.getData();
        if (result.getData() != null) {
            tokenHolder.putToken(loginInfo.getTokenHead() + " " + loginInfo.getToken());
        }
        return result;
    }
}

为方便后续调用需要登录认证的接口,我创建了TokenHolder这个类,把token存储到了Session中;


@Component
public class TokenHolder {
    
    public void putToken(String token) {
        RequestAttributes ra = RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = ((ServletRequestAttributes) ra).getRequest();
        request.getSession().setAttribute("token", token);
    }
    
    public String getToken() {
        RequestAttributes ra = RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = ((ServletRequestAttributes) ra).getRequest();
        Object token = request.getSession().getAttribute("token");
        if(token!=null){
            return (String) token;
        }
        return null;
    }
}

接下来通过Swagger进行测试,调用接口就可以获取到远程服务返回的token了,访问地址:http://localhost:8086/swagger-ui/

注解式拦截器

商品品牌管理接口,需要添加登录认证头才可以正常访问,我们可以使用Retrofit中的注解式拦截器来实现。

首先创建一个注解式拦截器TokenInterceptor继承BasePathMatchInterceptor,然后在doIntercept方法中给请求添加Authorization头;


@Component
public class TokenInterceptor extends BasePathMatchInterceptor {
    @Autowired
    private TokenHolder tokenHolder;
    @Override
    protected Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        if (tokenHolder.getToken() != null) {
            request = request.newBuilder()
                    .header("Authorization", tokenHolder.getToken())
                    .build();
        }
        return chain.proceed(request);
    }
}

创建调用品牌管理接口的客户端PmsBrandApi,使用@Intercept注解配置拦截器和拦截路径;


@RetrofitClient(baseUrl = "${remote.baseUrl}")
@Intercept(handler = TokenInterceptor.class, include = "/brand
@Api(tags = "RetrofitController", description = "Retrofit测试接口")
@RestController
@RequestMapping("/retrofit")
public class RetrofitController {
    @Autowired
    private PmsBrandApi pmsBrandApi;
    @ApiOperation("调用远程接口分页查询品牌列表")
    @GetMapping(value = "/brand/list")
    public CommonResult<CommonPage<PmsBrand>> listBrand(@RequestParam(value = "pageNum", defaultValue = "1")
                                                        @ApiParam("页码") Integer pageNum,
                                                        @RequestParam(value = "pageSize", defaultValue = "3")
                                                        @ApiParam("每页数量") Integer pageSize) {
        return pmsBrandApi.list(pageNum, pageSize);
    }
    @ApiOperation("调用远程接口获取指定id的品牌详情")
    @GetMapping(value = "/brand/{id}")
    public CommonResult<PmsBrand> brand(@PathVariable("id") Long id) {
        return pmsBrandApi.detail(id);
    }
    @ApiOperation("调用远程接口添加品牌")
    @PostMapping(value = "/brand/create")
    public CommonResult createBrand(@RequestBody PmsBrand pmsBrand) {
        return pmsBrandApi.create(pmsBrand);
    }
    @ApiOperation("调用远程接口更新指定id品牌信息")
    @PostMapping(value = "/brand/update/{id}")
    public CommonResult updateBrand(@PathVariable("id") Long id, @RequestBody PmsBrand pmsBrand) {
        return pmsBrandApi.update(id,pmsBrand);
    }
    @ApiOperation("调用远程接口删除指定id的品牌")
    @GetMapping(value = "/delete/{id}")
    public CommonResult deleteBrand(@PathVariable("id") Long id) {
        return  pmsBrandApi.delete(id);
    }
}

在Swagger中调用接口进行测试,发现已经可以成功调用。

全局拦截器

如果你想给所有请求都加个请求头的话,可以使用全局拦截器。

创建SourceInterceptor类继承BaseGlobalInterceptor接口,然后在Header中添加source请求头。


@Component
public class SourceInterceptor extends BaseGlobalInterceptor {
    @Override
    protected Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        Request newReq = request.newBuilder()
                .addHeader("source", "retrofit")
                .build();
        return chain.proceed(newReq);
    }
}

配置

Retrofit的配置很多,下面我们讲讲日志打印、全局超时时间和全局请求重试这三种最常用的配置。

日志打印 默认配置下Retrofit使用basic日志策略,打印的日志非常简单;

我们可以将application.yml中的retrofit.global-log-strategy属性修改为body来打印最全日志;

retrofit:
  # 日志打印配置
  log:
    # 启用日志打印
    enable: true
    # 日志打印拦截器
    logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor
    # 全局日志打印级别
    global-log-level: info
    # 全局日志打印策略
    global-log-strategy: body

修改日志打印策略后,日志信息更全面了;

Retrofit支持四种日志打印策略;

  • NONE:不打印日志;
  • BASIC:只打印日志请求记录;
  • HEADERS:打印日志请求记录、请求和响应头信息;
  • BODY:打印日志请求记录、请求和响应头信息、请求和响应体信息。

全局超时时间

有时候我们需要修改一下Retrofit的请求超时时间,可以通过如下配置实现。

retrofit:
  # 全局连接超时时间
  global-connect-timeout-ms: 3000
  # 全局读取超时时间
  global-read-timeout-ms: 3000
  # 全局写入超时时间
  global-write-timeout-ms: 35000
  # 全局完整调用超时时间
  global-call-timeout-ms: 0

全局请求重试

retrofit-spring-boot-starter支持请求重试,可以通过如下配置实现。

retrofit:
  # 重试配置
  retry:
    # 是否启用全局重试
    enable-global-retry: true
    # 全局重试间隔时间
    global-interval-ms: 100
    # 全局最大重试次数
    global-max-retries: 2
    # 全局重试规则
    global-retry-rules:
      - response_status_not_2xx
      - occur_exception
    # 重试拦截器
    retry-interceptor: com.github.lianjiatech.retrofit.spring.boot.retry.DefaultRetryInterceptor

重试规则global-retry-rules支持如下三种配置。

  • RESPONSE_STATUS_NOT_2XX:响应状态码不是2xx时执行重试;
  • OCCUR_IO_EXCEPTION:发生IO异常时执行重试;
  • OCCUR_EXCEPTION:发生任意异常时执行重试。

总结

今天体验了一把Retrofit,对比使用HttpUtil,确实优雅不少!通过接口发起HTTP请求已不再是Feign的专属,通过Retrofit我们在单体应用中照样可以使用这种方式。当然retrofit-spring-boot-starter提供的功能远不止于此,它还能支持微服务间的调用和熔断降级,感兴趣的朋友可以研究下!

参考资料

官方文档:https://github.com/LianjiaTech/retrofit-spring-boot-starter

项目源码地址

https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-retrofit

本文 GitHub https://github.com/macrozheng/mall-learning 已经收录,欢迎大家Star!

更多关于SpringBoot HTTP客户端Retrofit的资料请关注编程网其它相关文章!

--结束END--

本文标题: SpringBoot中使用HTTP客户端工具Retrofit

本文链接: https://www.lsjlt.com/news/151454.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • SpringBoot中使用HTTP客户端工具Retrofit
    前言 我们平时开发项目时,就算是单体应用,也免不了要调用一下其他服务提供的接口。此时就会用到HTTP客户端工具,之前一直使用的是Hutool中的HttpUtil,虽然容易上手,但用起...
    99+
    2024-04-02
  • SpringBoot中如何使用HTTP客户端工具Retrofit
    今天小编给大家分享一下SpringBoot中如何使用HTTP客户端工具Retrofit的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解...
    99+
    2023-07-02
  • Mac下SVN客户端工具Cornerstone使用怎么用
    Cornerstone是一款Mac下的SVN客户端工具,以下是Cornerstone的基本使用方法: 下载并安装Cornerst...
    99+
    2023-10-24
    Mac Cornerstone
  • redis客户端工具有哪些
    小编给大家分享一下redis客户端工具有哪些,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!下面给大家推荐两款redis客户端:一...
    99+
    2024-04-02
  • MongoDB客户端工具NoSQL Manager for MongoDB怎么使用
    这篇文章主要讲解了“MongoDB客户端工具NoSQL Manager for MongoDB怎么使用”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“MongoD...
    99+
    2023-07-02
  • PHP8.0中的HTTP客户端库
    PHP8.0中的HTTP客户端库PHP8.0的发布带来了很多新特性和改进,其中一个最引人注目的是内置的HTTP客户端库的加入。这个库提供了一个简单的方法来发送HTTP请求并处理返回的响应。在本文中,我们将探讨这个库的主要功能和用法。发送HT...
    99+
    2023-05-14
    编程 PHP HTTP客户端库
  • 常用的MySQL客户端工具有哪些
    这篇文章主要介绍“常用的MySQL客户端工具有哪些”,在日常操作中,相信很多人在常用的MySQL客户端工具有哪些问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”常用的MySQL...
    99+
    2024-04-02
  • Git工具客户端Sublime Merge for Mac
    Sublime Merge for Mac是由Sublime Text知名文本编辑器开发商所推出的一款Git工具客户端。Sublime Merge Mac版融合了Sublime Text的UI引擎和从零开始的Git,界面简洁,操作非常的方便...
    99+
    2023-06-05
  • Docker客户端管理工具docui怎么用
    这篇文章给大家分享的是有关Docker客户端管理工具docui怎么用的内容。小编觉得挺实用的,因此分享给大家做个参考,一起跟随小编过来看看吧。docui终端 Docker 管理工具,自带一个终端界面。使用该工具可以方便的通过界面管理 doc...
    99+
    2023-06-16
  • SpringBoot和redis中怎么使用Lettuce客户端
    这篇文章给大家介绍SpringBoot和redis中怎么使用Lettuce客户端,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。重写连接工厂实例,更改其LettuceClientConfiguration 为开启拓扑更新...
    99+
    2023-06-20
  • Git工具客户端Sublime Merge Mac有什么用
    这篇文章将为大家详细讲解有关Git工具客户端Sublime Merge Mac有什么用,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。Sublime Merge for Mac是由Sublime Text知...
    99+
    2023-06-06
  • Java的MD5工具类和客户端测试类怎么使用
    这篇文章主要讲解了“Java的MD5工具类和客户端测试类怎么使用”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“Java的MD5工具类和客户端测试类怎么使用”吧!什么是MD5?Message ...
    99+
    2023-06-22
  • MongoDB客户端工具NoSQL Manager for MongoDB介绍
    目录一、安装二、连接客户端三、基本的日常操作1、shell2、日常数据增删改查① 可以在shell命令行执行。② 也可以直接通过GUI来实现。3、表复制① 数据库内复制表。② 跨数据...
    99+
    2024-04-02
  • OPC UA服务端(Prosys OPC UA Simulation Server)和客户端(OPC UA Explorer)工具使用
    OPC UA服务端(Prosys OPC UA Simulation Server) Prosys OPC UA Simulation Server下载地址 https://downloads.pro...
    99+
    2023-08-31
    经验分享
  • Java的MD5工具类和客户端测试类
    什么是MD5? Message Digest Algorithm MD5(中文名为消息摘要算法第五版)为计算机安全领域广泛使用的一种散列函数,用以提供消息的完整性保护。该算法的文件号...
    99+
    2024-04-02
  • redis的可视化客户端工具有哪些
    小编给大家分享一下redis的可视化客户端工具有哪些,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!Redis是一个超精简的基于内...
    99+
    2024-04-02
  • 免费的Linux FTP客户端工具有哪些
    本篇文章给大家分享的是有关免费的Linux FTP客户端工具有哪些,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。在Dropbox、YouSen...
    99+
    2024-04-02
  • mysql客户端及服务端常用实用工具功能有哪些
    这篇文章主要为大家展示了“mysql客户端及服务端常用实用工具功能有哪些”,内容简而易懂,条理清晰,希望能够帮助大家解决疑惑,下面让小编带领大家一起研究并学习一下“mysql客户端及服务端常用实用工具功能有...
    99+
    2024-04-02
  • Node.js中怎么实现http请求客户端
    这期内容当中小编将会给大家带来有关Node.js中怎么实现http请求客户端,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。Node.JS有一个request模块,可以很方...
    99+
    2024-04-02
  • 为什么HTTP客户端强制使用Accept-Encoding标头
    HTTP客户端强制使用Accept-Encoding标头是为了告诉服务器它所能接受的内容编码方式(例如gzip、deflate等)。...
    99+
    2023-09-26
    HTTP
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作