需求描述

动态URL的需求场景：

有一个异步服务S，它为其他业务（业务A，业务B...）提供异步服务接口，在这些异步接口中执行完指定逻辑之后需要回调相应业务方的接口。

这在诸如风控审核，支付回调等场景中挺常见的。

那么，这个回调业务方接口该怎么实现呢？

首先，需要约定好回调这些业务方接口时的请求方法（通常为POST请求），请求参数格式（通常为JSON格式，方便扩展）和响应消息格式（通常为JSON格式）。

具体调用业务方接口时有2种办法来实现：

1.在服务S的每一个异步接口中都独立写一套回调的逻辑

2.因为回调的方法类型和参数格式是约定好的，所以可以写一个统一的公共回调方法即可

方法1显然不是最优选择，这样做会带来大量重复的代码逻辑，而且非常不利用后期维护和升级。

方法2的实现更加灵活一些，便于扩展。

如下将阐述如何使用Feign框架定义一个公共的回调方法。

具体实现

在Feign中能实现动态URL的基础是框架本身就支持，只需要在接口方法中包含一个java.net.URI参数，Feign就会将该参数值作为目标主机地址，详见Interface Annotations一节中的“Overriding the Request Line”部分。

如下将分别阐述独立使用Feign和使用Spring Cloud OpenFeign实现定义统一的回调方法。

使用Feign定义统一回调方法

定义统一回调方法：

  1. public interface CallbackAPI {
  2.     /**
  3.      * 统一回调接口方法，请求消息体格式为JSON，响应消息体格式也为JSON
  4.      * @param host 接口主机地址，如：http://localhost:8080，该参数是实现动态URL的关键
  5.      * @param path 接口路径，如：/test/hello
  6.      * @param queryMap 动态URL参数集合
  7.      * @param body 请求消息体对象
  8.      * @return
  9.      */
  10.     @RequestLine("POST {path}")
  11.     @Headers({
  12.         "Content-Type: application/json",
  13.         "Accept: application/json"
  14.     })
  15.     Object callback(URI host, @Param("path") String path, @QueryMap Map<String, Object> queryMap, Subject body);
  16. }

调用回调方法：

  1. CallbackAPI callbackAPI = Feign.builder()
  2.         .encoder(new GsonEncoder())
  3.         .decoder(new GsonDecoder())
  4.         .logger(new Slf4jLogger())
  5.         .logLevel(Logger.Level.FULL)
  6.         .target(CallbackAPI.class, "EMPTY"); // 注意：这里的url参数不能为空字符串，但是可以设置为任意字符串值，在这里设置为“EMPTY”
  7. String uri = "http://localhost:8080";
  8. Map<String, Object> queryMap = new HashMap<>(0);
  9. queryMap.put("k", "v");
  10. Subject body = Subject.builder().id(10).build();
  11. Object result = callbackAPI.callback(URI.create(uri), "/test/simple/post/json", queryMap, body);
  12. System.out.println(result);

详细请求日志如下：

  1. 2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] ---> POST http://localhost:8080/test/simple/post/json?k=v HTTP/1.1
  2. 2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] Accept: application/json
  3. 2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] Content-Length: 14
  4. 2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] Content-Type: application/json
  5. 2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback]
  6. 2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] {
  7.   "id": 10
  8. }
  9. 2022-02-14 15:32:13,118 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] ---> END HTTP (14-byte body)
  10. 2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] <--- HTTP/1.1 200 (32ms)
  11. 2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] connection: keep-alive
  12. 2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] content-length: 9
  13. 2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] content-type: application/json
  14. 2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] date: Mon, 14 Feb 2022 07:32:13 GMT
  15. 2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] keep-alive: timeout=60
  16. 2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback]
  17. 2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] {"id":10}
  18. 2022-02-14 15:32:13,153 DEBUG [main] f.Logger [Slf4jLogger.java:72] [CallbackAPI#callback] <--- END HTTP (9-byte body)

显然，动态设置目标主机和接口路径已经成功了。

使用Spring Cloud Feign定义统一回调方法

在Spring Cloud Feign中实现定义统一回调接口方法可以直接使用注解进行标注，非常简洁。

定义统一回调方法：

  1. // 注意：这里的url属性值不能为空字符串，但是可以设置为任意字符串值，在这里设置为“EMPTY”
  2. @FeignClient(value = "CallbackAPI", url = "EMPTY", configuration = CallbackConfiguration.class)
  3. public interface CallbackAPI {
  4.     /**
  5.      * 统一回调接口方法，请求消息体格式为JSON，响应消息体格式也为JSON
  6.      * @param host 接口主机地址，如：http://localhost:8080
  7.      * @param path 接口路径，如：/test/hello
  8.      * @param queryMap 动态URL参数集合
  9.      * @param body 请求消息体对象
  10.      * @return
  11.      */
  12.     @RequestMapping(value = "{path}", method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
  13.     Object callback(URI host,
  14.                     @PathVariable("path") String path,
  15.                     @SpringQueryMap Map<String, Object> queryMap,
  16.                     @RequestBody Object body);
  17. }
  19. // 回调接口配置
  20. public class CallbackConfiguration {
  21.     @Bean
  22.     public Encoder feignEncoder() {
  23.         return new GsonEncoder();
  24.     }
  26.     @Bean
  27.     public Decoder feignDecoder() {
  28.         return new GsonDecoder();
  29.     }
  31.     @Bean
  32.     public Retryer feignRetryer() {
  33.         return new Retryer.Default();
  34.     }
  36.     @Bean
  37.     public Logger feignLogger() {
  38.         return new Slf4jLogger();
  39.     }
  41.     @Bean
  42.     public Logger.Level feignLoggerLevel() {
  43.         return Logger.Level.FULL;
  44.     }
  45. }

调用回调方法：

  1. @Autowired
  2. CallbackAPI callbackAPI;
  4. String uri = "http://localhost:8080";
  5. Map<String, Object> queryMap = new HashMap<>(0);
  6. queryMap.put("k", "v");
  7. Subject subject = Subject.builder().id(10).build();
  8. Object result = this.callbackAPI.callback(URI.create(uri), "/test/simple/post/json", queryMap, subject);

详细请求日志如下：

  1. 2022-02-14 15:38:38.908 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] ---> POST http://localhost:8080/test/simple/post/json?k=v HTTP/1.1
  2. 2022-02-14 15:38:38.908 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] Accept: application/json
  3. 2022-02-14 15:38:38.908 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] Content-Length: 14
  4. 2022-02-14 15:38:38.908 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] Content-Type: application/json
  5. 2022-02-14 15:38:38.908 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback]
  6. 2022-02-14 15:38:38.908 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] {
  7.   "id": 10
  8. }
  9. 2022-02-14 15:38:38.908 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] ---> END HTTP (14-byte body)
  10. 2022-02-14 15:38:38.924 DEBUG 20184 --- [           main] s.n.www.protocol.http.HttpURLConnection  : sun.net.www.MessageHeader@539c48307 pairs: {POST /test/simple/post/json?k=v HTTP/1.1: null}{Accept: application/json}{Content-Type: application/json}{User-Agent: Java/1.8.0_271}{Host: localhost:8080}{Connection: keep-alive}{Content-Length: 14}
  11. 2022-02-14 15:38:38.945 DEBUG 20184 --- [           main] s.n.www.protocol.http.HttpURLConnection  : sun.net.www.MessageHeader@681e913c6 pairs: {null: HTTP/1.1 200}{Content-Type: application/json}{Content-Length: 9}{Date: Mon, 14 Feb 2022 07:38:38 GMT}{Keep-Alive: timeout=60}{Connection: keep-alive}
  12. 2022-02-14 15:38:38.952 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] <--- HTTP/1.1 200 (37ms)
  13. 2022-02-14 15:38:38.952 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] connection: keep-alive
  14. 2022-02-14 15:38:38.952 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] content-length: 9
  15. 2022-02-14 15:38:38.952 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] content-type: application/json
  16. 2022-02-14 15:38:38.952 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] date: Mon, 14 Feb 2022 07:38:38 GMT
  17. 2022-02-14 15:38:38.953 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] keep-alive: timeout=60
  18. 2022-02-14 15:38:38.953 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback]
  19. 2022-02-14 15:38:38.955 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] {"id":10}
  20. 2022-02-14 15:38:38.955 DEBUG 20184 --- [           main] feign.Logger                             : [CallbackAPI#callback] <--- END HTTP (9-byte body)

从日志详情看，在Spring Cloud Feign中同样实现动态URL的效果。

总结

在Feign中实现动态URL的关键在于2点：

1.使用URI类型的参数作为请求目标主机地址

2.将请求路径部分使用表达式进行替换

【参考】

https://www.cnblogs.com/syui-terra/p/14386188.html Feign 动态URL 解决记录

https://blog.csdn.net/kysmkj/article/details/89672952 Feign 访问远程api，动态指定url

Feign实现动态URL的更多相关文章

  1. Feign 动态URL 解决记录

    Feign中使用动态URL请求 (应当是spring-cloud-starter-openfeign,不知道和一般的feign有何差别) 在spring项目下,假设有这样个Feign的消费接口,原来写 ...

  2. 关于动态URL地址设置静态形式

    动态URL地址:http://station.com/index.php?c=play&a=index&id=12345 静态URL地址:http://station.com/play ...

  3. django"动态网页","动态url","调试方法"

    一.动态网页 其实只是每次刷新时,获取最新时间而已 1.urls.py from django.conf.urls import patterns, url, include urlpatterns ...

  4. 如何利用动态URL提升SEO及处理业务逻辑

    如果你正在建设一个新网站或者对现有网站重新设计,我们认为应该将网站的 URL 转换为用户友好的 URL,或搜索引擎友好的 URL,这类 URL 也称为语义 URL(Semantic URL).哪些UR ...

  5. flask动态url规则

    动态URL规则 URL规则可以添加变量部分,也就是件更符合同规则的URL抽象成一个URL模式. @app.route('/item/<id>') def item(id): return ...

  6. springboot集成shiro和开涛的动态url问题

    我出现的问题就是一旦/**=authc不管放到前面还是后面都会把所有的资源全部拦截,css和js都访问不到,只需要把开涛的动态url代码改一下就行了(如上图)

  7. stark组件之处理函数动态url构造（五）

    在这个组件中有内置的4个处理函数,它们都有自己对应的url,那么它们的url是怎么构造的呢? ... urlpatterns = [ re_path('list/$', self.wrapper(se ...

  8. flask之配置文件的加载和动态url的使用

    七行代码实现一个flask app from flask import Flask app = Flask(__name__) @app.route('/') def helloworld(): re ...

  9. Spring Security 动态url权限控制（三）

    一.前言 本篇文章将讲述Spring Security 动态分配url权限,未登录权限控制,登录过后根据登录用户角色授予访问url权限 基本环境 spring-boot 2.1.8 mybatis-p ...

随机推荐

  1. update sql时，常记错同时更新多个参数用and，正确是用逗号

    记录一下,经常记错的一个点,在update多个参数时,多个参数之间用and连接,这个时候,语句就会报错了 其实,正确的是用逗号隔开, 使用SQL中的update更新多个字段值,set后面的条件要用逗号 ...

  2. MySQL删除数据库或表（DROP DATABASE/table语句）

    DROP DATABASE [ IF EXISTS ] <数据库名> DROP table[ IF EXISTS ] <数据库表名> 语法说明如下: <数据库名>: ...

  3. 如何检入空文件夹到GitHub

    Git 有一个古怪的特性,就是会忽略本地的空文件夹,而不予以检入(check in). 怎样解决呢?办法就是在空文件夹下放置一个 .gitignore 文件.该文件内容以下: # Ignore eve ...

  4. js知识框架图

  5. 为 MySQL 的 root 用户设置一个密码。

    shell> mysqladmin --user=root password somepasswordshell> mysqladmin --user=root --password re ...

  6. Kube-OVN 0.6.0 发布，支持 IPv6、流量镜像及更多功能

    Kube-OVN 是一个基于 OVN 的 Kubernetes 开源网络系统. 本次更新主要包含了以下内容: 1. 支持流量镜像 在安装 Kube-OVN 时可以开启 mirror 选项,会自动在每个 ...

  7. py3nvml实现GPU相关信息读取

    技术背景 随着模型运算量的增长和硬件技术的发展,使用GPU来完成各种任务的计算已经渐渐成为算法实现的主流手段.而对于运行期间的一些GPU的占用,比如每一步的显存使用率等诸如此类的信息,就需要一些比较细 ...

  8. [Android测试] Appium的一些坑问题错误解决 与 技巧集锦

    转:https://blog.csdn.net/niubitianping/article/details/52624417 1. error: Failed to start an Appium s ...

  9. Spring Security源码解析一：UsernamePasswordAuthenticationFilter之登录流程

    一.前言 spring security安全框架作为spring系列组件中的一个,被广泛的运用在各项目中,那么spring security在程序中的工作流程是个什么样的呢,它是如何进行一系列的鉴权和 ...

  10. Mybatis 学习记录

    1.先放上mybatis官网地址: https://mybatis.org/mybatis-3/zh/index.html 2.mybatis源码和有关包下载地址(GitHub): https://g ...