使用Consul接入

背景说明

Shenyu提供了Shenyu-Sdk方便让服务能够快速接入shenyu网关， 客户端服务只需要依赖该sdk， 并做些简单配置， 即可类似调用本地接口一样调用网关暴露的API。

使用Consul接入 - 图1

客户端接入网关的注册中心支持(nacos、eureka、etcd、zookeeper、consul)，下面为shenyu-bootstrap及应用客户端使用Zookeeper注册中心时的相关指引。

环境准备

需要参考 运维部署 , 选择一种方式启动shenyu-admin及shenyu-bootstrap.

shenyu-bootstrap

添加Maven依赖

在网关的pom.xml文件中引入如下依赖.

  1. <dependency>
  2.     <groupId>org.apache.shenyu</groupId>
  3.     <artifactId>shenyu-spring-boot-starter-instance</artifactId>
  4.     <version>${project.version}</version>
  5. </dependency>

配置文件调整

在网关的yml配置文件中添加如下配置.

  1. shenyu:
  2.   register:
  3.     enabled: true
  4.     registerType: consul
  5.     serverLists: localhost
  6.     props:
  7.       delay: 1
  8.       wait-time: 55
  9.       instanceId: shenyu-gateway
  10.       hostName: localhost
  11.       tags: test1,test2
  12.       preferAgentAddress: false
  13.       enableTagOverride: false
  16. # registerType: 服务注册类型，填写 consul
  17. # serverLists: consul client agent地址(sidecar模式部署(单机或者集群)，也可以是consul server agent的地址(只能连接一个consul server agent节点，如果是集群，那么会存在单点故障问题))
  18. # delay: 对Metadata的监控每次轮询的间隔时长，单位为秒，默认1秒
  19. # wait-time: 对Metadata的监控单次请求的等待时间（长轮询机制），单位为秒，默认55秒
  20. # instanceId: consul服务必填，consul需要通过instance-id找到具体服务
  21. # name 服务注册到consul时所在的组名
  22. # hostName: 为 consul 注册类型时，填写 注册服务实例的 地址， 该注册中心注册的服务实例地址，并不会用于客户端的调用，所以该配置可以不填，port，preferAgentAddress同理
  23. # port: 为 consul 注册类型时，填写 注册服务实例的 端口
  24. # tags: 对应consul配置中的tags配置
  25. # preferAgentAddress：使用consul客户端侧的agent对应的address作为注册服务实例的address，会覆盖hostName的手动配置
  26. # enableTagOverride：对应consul配置中的enableTagOverride配置
  29. # 详细参考`用户指南>属性配置>客户端接入配置`文档

应用客户端

添加Maven依赖

在应用客户端的pom.xml文件中引入如下依赖.

  • Shenyu-Sdk 核心包
  1. <dependencies>
  2.     <dependency>
  3.         <groupId>org.apache.shenyu</groupId>
  4.         <artifactId>shenyu-sdk-core</artifactId>
  5.         <version>2.5.1-SNAPSHOT</version>
  6.     </dependency>
  9.     <dependency>
  10.         <groupId>org.apache.shenyu</groupId>
  11.         <artifactId>shenyu-spring-boot-starter-sdk</artifactId>
  12.         <version>2.5.1-SNAPSHOT</version>
  13.     </dependency>
  14. </dependencies>
  • Shenyu-Sdk http实现包

http客户端实现， 目前提供实现okhttp, httpclient. 其他客户端实现可继承AbstractShenyuSdkClient实现。

  1. <!-- httpclient -->
  2. <dependency>
  3.     <groupId>org.apache.shenyu</groupId>
  4.     <artifactId>shenyu-sdk-httpclient</artifactId>
  5.     <version>2.5.1-SNAPSHOT</version>
  6. </dependency>
  9. <!-- okhttp -->
  10. <!-- 
  11. <dependency>
  12.     <groupId>org.apache.shenyu</groupId>
  13.     <artifactId>shenyu-sdk-okhttp</artifactId>
  14.     <version>2.5.1-SNAPSHOT</version>
  15. </dependency>
  16. -->

配置文件调整

在应用客户端的yml配置文件中添加如下配置.

  1. shenyu:
  2.   sdk:
  3.     enabled: true
  4.     register-type: consul #zookeeper #local #etcd #nacos #consul
  5.     server-lists: localhost #localhost:2181 #http://localhost:9095 #http://localhost:2379 #localhost:8848
  6.     props:
  7.       checkTtl: 5
  8.       token: ""
  9.       waitTime: 30
  10.       watchDelay: 5
  11.       tags: ""
  12.       port: 8500
  13.       retry:
  14.         enable: true
  15.         period: 100
  16.         maxPeriod: 1000
  17.         maxAttempts: 5
  18.       scheme: http
  19. # register-type : 服务注册类型，填写 consul
  20. # server-lists: 为consul注册类型时，填写consul地址，多个地址用英文逗号分隔
  21. # checkTtl: TTL, 默认5秒
  22. # token: ""
  23. # waitTime: 对Metadata的监控单次请求的等待时间（长轮询机制），单位为秒，默认55秒
  24. # watchDelay: 对Metadata的监控每次轮询的间隔时长，单位为秒，默认1秒
  25. # tags: 对应consul配置中的tags配置
  26. # port: consul 服务端口
  27. # retry 失败重试相关配置
  28. # retry.period: 重试等待时间
  29. # retry.maxPeriod: 最大重试等待时间 
  30. # retry.maxAttempts: 最大重试次数
  31. # scheme: 请求协议头

本地接口配置

  1. 在项目启动类上标注@EnableShenyuClients(basePackages = "org.apache.shenyu.examples.sdk.http.api"), 其中basePackages中维护的是Shenyu-Sdk对应维护网关API接口的所在包位置.

  2. 创建interface并使用@ShenyuClient(name = "xxx", contextId = "ShenyuSdkApiName")注解标注, 其中name表示网关服务名.假如你需要定义多个bean来维护网关的API, 可以使用contextId作为对应的bean别名.

  3. 在定义接口中添加所要映射shenyu网关中的接口方法， 其中@xxMapping中的value对应值是网关中对应请求的路径。

示例

项目启动类

  1. @SpringBootApplication
  2. @EnableShenyuClients(basePackages = "org.apache.shenyu.examples.sdk.http.api")
  3. public class ShenyuSdkHttpExampleApplication {
  6.     /**
  7.      * main.
  8.      *
  9.      * @param args args
  10.      */
  11.     public static void main(final String[] args) {
  12.         SpringApplication.run(ShenyuSdkHttpExampleApplication.class, args);
  13.     }
  14. }

网关API接口

  1. @ShenyuClient(name = "shenyu-gateway", contextId = "ShenyuSdkApiName")
  2. public interface ShenyuHttpClientApi {
  5.     /**
  6.      * findById.
  7.      * test Get.
  8.      *
  9.      * @param id id
  10.      * @return SdkTestDto
  11.      */
  12.     @GetMapping("/http/shenyu/client/findById")
  13.     SdkTestDto findById(@RequestParam("id") String id);
  14. }

更多可参考示例工程 shenyu-examples-sdk