使用Etcd接入

背景说明

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

使用Etcd接入 - 图1

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

环境准备

需要参考 运维部署 , 选择一种方式启动shenyu-adminshenyu-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: etcd
  5. serverLists: http://localhost:2379
  6. props:
  7. contextPath: /http
  8. appName: http
  9. port: 8189
  10. isFull: false
  11. # registerType : 服务注册类型,填写 etcd
  12. # serverList: 为etcd注册类型时,填写etcd地址,多个地址用英文逗号分隔
  13. # port: 你本项目的启动端口,目前springmvc/tars/grpc需要进行填写
  14. # contextPath: 为你的这个mvc项目在shenyu网关的路由前缀, 比如/order ,/product 等等,网关会根据你的这个前缀来进行路由.
  15. # appName:你的应用名称,不配置的话,会默认取 `spring.application.name` 的值
  16. # isFull: 设置true 代表代理你的整个服务,false表示代理你其中某几个controller;目前适用于springmvc/springcloud
  17. # 详细参考`用户指南>属性配置>客户端接入配置`文档

应用客户端

添加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>
  7. <dependency>
  8. <groupId>org.apache.shenyu</groupId>
  9. <artifactId>shenyu-spring-boot-starter-sdk</artifactId>
  10. <version>2.5.1-SNAPSHOT</version>
  11. </dependency>
  12. </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>
  7. <!-- okhttp -->
  8. <!--
  9. <dependency>
  10. <groupId>org.apache.shenyu</groupId>
  11. <artifactId>shenyu-sdk-okhttp</artifactId>
  12. <version>2.5.1-SNAPSHOT</version>
  13. </dependency>
  14. -->

配置文件调整

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

  1. shenyu:
  2. sdk:
  3. enabled: true
  4. register-type: etcd
  5. server-lists: http://localhost:2379
  6. props:
  7. etcdTimeout: 3000
  8. etcdTTL: 5
  9. retry:
  10. enable: true
  11. period: 100
  12. maxPeriod: 1000
  13. maxAttempts: 5
  14. algorithm: roundRobin
  15. scheme: http
  16. # register-type : 服务注册类型,填写 etcd
  17. # server-lists: 为etcd注册类型时,填写etcd地址,多个地址用英文逗号分隔
  18. # etcdTimeout: 请求超时时间, 单位毫秒, 默认3000
  19. # etcdTTL: 租约TTL, 默认5秒
  20. # retry 失败重试相关配置
  21. # retry.period: 重试等待时间
  22. # retry.maxPeriod: 最大重试等待时间
  23. # retry.maxAttempts: 最大重试次数
  24. # algorithm: 负载均衡
  25. # 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 {
  4. /**
  5. * main.
  6. *
  7. * @param args args
  8. */
  9. public static void main(final String[] args) {
  10. SpringApplication.run(ShenyuSdkHttpExampleApplication.class, args);
  11. }
  12. }

网关API接口

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

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