草庐IT

Spring Boot调用Http接口的简单方法

九天银河聊编程 2023-03-28 原文

前言

在项目开发中，后端会经常去请求一些已经开发好的服务接口获取数据。直接使用okhttp、httpClient发起http请求，既繁琐又不方便统一管理。在这里推荐一个适用于Spring Boot项目的轻量级HTTP客户端框架retrofit，使用非常简单方便。retrofit是一款类型安全的HTTP客户端，其最大的特性的是支持通过接口的方式发起HTTP请求 。

准备

使用前期讲到的Spring Boot可视化接口开发工具magic-api部署两个http服务接口，不知道可视化接口开发工具的可以翻看前期的文章，这里不再过多说明。

get接口

http://127.0.0.1:9999/user/select?id=15

post接口

http://127.0.0.1:9999/user/update

{
"id":15,
"name": "九天银河聊编程",
"age": 35,
"address": "天津"
}

retrofit开发

引入依赖

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>

配置文件

server:
port: 8080

retrofit:
global-log:
enable: true
log-level: info

HttpClient:
BaseUrl: "http://127.0.0.1:9999/"

编写参数实体

根据接口的输入参数编写相关实体，代码略！

http接口定义

@RetrofitClient(baseUrl = "${HttpClient.BaseUrl}")
public interface Api {
@GET("user/select")
Result1 getUser(@Query("id") Integer id);

@POST("user/update")
Result2 updateUser(@Body User user);
}

使用

@RestController
@RequestMapping("user/")
public class RetrofitController {
@Autowired
private Api api;

@GetMapping("/select")
public User[] select() {
Result1 result = api.getUser(15);
return result.getData();
}

@GetMapping("/update")
public String update() {
User user = new User();
user.setId(15);
user.setAge(35);
user.setName("九天银河聊编程");
user.setAddress("天津");
Result2 result = api.updateUser(user);
return result.getData();
}
}

调用服务

控制台输出:

控制台输出:

大功告成，是不是很简单？

常用注解说明

方法注解

@GET

GET请求

@POST

POST请求

@HTTP

作用于方法,用于发送一个

自定义的HTTP请求

标记注解

@FormUrlEncoded：

请求体是 From 表单 @POST比起@GET多了一个@FromUrlEncoded的注解。

@Multipart：

请求体是支持文件上传的 From 表单

@Streaming：

响应体的数据用流的形式返回，未使用该注解，默认会把数据全部载入内存，之后通过流获取数据也是读取内存中数据，所以返回数据较大时，需要使用该注解。

参数注解

@Query：

用于Get请求数据，用于拼接在拼接在Url路径后面的查询参数，一个@Query相当于拼接一个参数，多个参数中间用，隔开

@Body：

非表单请求体，是结合post请求的

@Field：

表单字段，@Field的用法类似于@Query，不同的是@Field主要用于Post请求数据。

@Part：

表单字段，与 PartMap 配合，适合文件上传情况

@PartMap：

表单字段，与 Part 配合，适合文件上传情况；默认接受 Map<String, RequestBody> 类型，非 RequestBody 会通过 Converter 转换

其它注解

@Url：

@Url是动态的Url请求数据的注解。需要注意的是使用@Url时，path对应的路径不能包含”/”，不然每个加到host Url后面的东西都会被省略掉。千万注意了

@Path：

@Path主要用于Get请求，用于替换Url路径中的变量字符。

踩坑记录

当POST请求时，@FormUrlEncoded和@Field简单的表单键值对。两个需要结合使用，否则会报错。

其它调用例子

RestFul方式请求：

@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort);
map作为请求体：

@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);
表单提交：

@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);
Multipart请求：

@Multipart
@PUT("user/photo")
Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);

高级应用

注解式拦截器

对http请求执行统一的拦截处理逻辑，基于url路径的匹配拦截 。使用的步骤主要分为2步：

  1. 继承BasePathMatchInterceptor编写拦截处理器；
  2. 接口上使用@Intercept进行标注。如需配置多个拦截器，在接口上标注多个@Intercept注解即可！

扩展注解式拦截器

对拦截注解动态传入一些参数，然后再执行拦截的时候需要使用这个参数。自定义拦截注解必须使用@InterceptMark标记，并且注解中必须包括include()、exclude()、handler()属性信息 。使用的步骤主要分为3步：

  1. 自定义拦截注解
  2. 继承BasePathMatchInterceptor编写拦截处理器
  3. 接口上使用自定义拦截注解；
例如我们需要在请求头里面动态加入accessKeyId、accessKeySecret签名信息才能正常发起http请求 ，这个时候可以自定义一个加签拦截器注解@Sign来实现

请求重试

在接口或者方法上加上@Retry注解即可。@Retry支持重试次数maxRetries、重试时间间隔intervalMs以及重试规则retryRules配置

错误解码器

在HTTP发生请求错误(包括发生异常或者响应数据不符合预期)的时候，错误解码器可将HTTP相关信息解码到自定义异常中。你可以在@RetrofitClient注解的errorDecoder()指定当前接口的错误解码器，自定义错误解码器需要实现ErrorDecoder接口。

SpringBootspanstylecolor开发架构$HTTP客户端Retrofit

有关Spring Boot调用Http接口的简单方法的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

    总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  4. ruby - Facter::Util::Uptime:Module 的未定义方法 get_uptime (NoMethodError) - 2

    我正在尝试设置一个puppet节点，但ruby​​gems似乎不正常。如果我通过它自己的二进制文件(/usr/lib/ruby/gems/1.8/gems/facter-1.5.8/bin/facter)在cli上运行facter，它工作正常，但如果我通过由ruby​​gems(/usr/bin/facter)安装的二进制文件，它抛出:/usr/lib/ruby/1.8/facter/uptime.rb:11:undefinedmethod`get_uptime'forFacter::Util::Uptime:Module(NoMethodError)from/usr/lib/ruby

  5. Ruby 方法() 方法 - 2

    我想了解Ruby方法methods()是如何工作的。我尝试使用“ruby方法”在Google上搜索，但这不是我需要的。我也看过ruby​​-doc.org，但我没有找到这种方法。你能详细解释一下它是如何工作的或者给我一个链接吗？更新我用methods()方法做了实验，得到了这样的结果:'labrat'代码classFirstdeffirst_instance_mymethodenddefself.first_class_mymethodendendclassSecond使用类#returnsavailablemethodslistforclassandancestorsputsSeco

  6. ruby-on-rails - Rails 3.2.1 中 ActionMailer 中的未定义方法 'default_content_type=' - 2

    我在我的项目中添加了一个系统来重置用户密码并通过电子邮件将密码发送给他，以防他忘记密码。昨天它运行良好(当我实现它时)。当我今天尝试启动服务器时，出现以下错误。=>BootingWEBrick=>Rails3.2.1applicationstartingindevelopmentonhttp://0.0.0.0:3000=>Callwith-dtodetach=>Ctrl-CtoshutdownserverExiting/Users/vinayshenoy/.rvm/gems/ruby-1.9.3-p0/gems/actionmailer-3.2.1/lib/action_mailer

  7. ruby - Highline 询问方法不会使用同一行 - 2

    设置:狂欢ruby1.9.2高线(1.6.13)描述:我已经相当习惯在其他一些项目中使用highline，但已经有几个月没有使用它了。现在，在Ruby1.9.2上全新安装时，它似乎不允许在同一行回答提示。所以以前我会看到类似的东西:require"highline/import"ask"Whatisyourfavoritecolor?"并得到:Whatisyourfavoritecolor?|现在我看到类似的东西:Whatisyourfavoritecolor?|竖线(|)符号是我的终端光标。知道为什么会发生这种变化吗？ 最佳答案

  8. ruby - 如何模拟 Net::HTTP::Post？ - 2

    是的，我知道最好使用webmock，但我想知道如何在RSpec中模拟此方法:defmethod_to_testurl=URI.parseurireq=Net::HTTP::Post.newurl.pathres=Net::HTTP.start(url.host,url.port)do|http|http.requestreq,foo:1endresend这是RSpec:let(:uri){'http://example.com'}specify'HTTPcall'dohttp=mock:httpNet::HTTP.stub!(:start).and_yieldhttphttp.shou

  9. ruby - 主要 :Object when running build from sublime 的未定义方法 `require_relative' - 2

    我已经从我的命令行中获得了一切，所以我可以运行rubymyfile并且它可以正常工作。但是当我尝试从sublime中运行它时，我得到了undefinedmethod`require_relative'formain:Object有人知道我的sublime设置中缺少什么吗？我正在使用OSX并安装了rvm。 最佳答案 或者，您可以只使用“require”，它应该可以正常工作。我认为“require_relative”仅适用于ruby​​1.9+ 关于ruby-主要:Objectwhenrun

  10. ruby - 多个属性的 update_column 方法 - 2

    我有一个具有一些属性的模型:attr1、attr2和attr3。我需要在不执行回调和验证的情况下更新此属性。我找到了update_column方法，但我想同时更新三个属性。我需要这样的东西:update_columns({attr1:val1,attr2:val2,attr3:val3})代替update_column(attr1,val1)update_column(attr2,val2)update_column(attr3,val3) 最佳答案 您可以使用update_columns(attr1:val1,attr2:val2

随机推荐