使用Etcd接入

使用Etcd接入

背景说明

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

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

环境准备

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

shenyu-bootstrap

添加Maven依赖

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

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

配置文件调整

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

shenyu:
  register:
    enabled: true
    registerType: etcd
    serverLists: http://localhost:2379
    props:
      contextPath: /http
      appName: http
      port: 8189
      isFull: false
# registerType : 服务注册类型，填写 etcd
# serverList: 为etcd注册类型时，填写etcd地址，多个地址用英文逗号分隔
# port: 你本项目的启动端口,目前springmvc/tars/grpc需要进行填写
# contextPath: 为你的这个mvc项目在shenyu网关的路由前缀， 比如/order ，/product 等等，网关会根据你的这个前缀来进行路由.
# appName：你的应用名称，不配置的话，会默认取 `spring.application.name` 的值
# isFull: 设置true 代表代理你的整个服务，false表示代理你其中某几个controller；目前适用于springmvc/springcloud
# 详细参考`用户指南>属性配置>客户端接入配置`文档

应用客户端

添加Maven依赖

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

Shenyu-Sdk 核心包

<dependencies>
    <dependency>
        <groupId>org.apache.shenyu</groupId>
        <artifactId>shenyu-sdk-core</artifactId>
        <version>2.5.1-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>org.apache.shenyu</groupId>
        <artifactId>shenyu-spring-boot-starter-sdk</artifactId>
        <version>2.5.1-SNAPSHOT</version>
    </dependency>
</dependencies>

Shenyu-Sdk http实现包

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

<!-- httpclient -->
<dependency>
    <groupId>org.apache.shenyu</groupId>
    <artifactId>shenyu-sdk-httpclient</artifactId>
    <version>2.5.1-SNAPSHOT</version>
</dependency>
<!-- okhttp -->
<!-- 
<dependency>
    <groupId>org.apache.shenyu</groupId>
    <artifactId>shenyu-sdk-okhttp</artifactId>
    <version>2.5.1-SNAPSHOT</version>
</dependency>
-->

配置文件调整

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

shenyu:
  sdk:
    enabled: true
    register-type: etcd
    server-lists: http://localhost:2379
    props:
      etcdTimeout: 3000
      etcdTTL: 5
      retry:
        enable: true
        period: 100
        maxPeriod: 1000
        maxAttempts: 5
      algorithm: roundRobin
      scheme: http
# register-type : 服务注册类型，填写 etcd
# server-lists: 为etcd注册类型时，填写etcd地址，多个地址用英文逗号分隔
# etcdTimeout: 请求超时时间, 单位毫秒, 默认3000
# etcdTTL: 租约TTL, 默认5秒
# retry 失败重试相关配置
# retry.period: 重试等待时间
# retry.maxPeriod: 最大重试等待时间 
# retry.maxAttempts: 最大重试次数
# algorithm: 负载均衡
# scheme: 请求协议头

本地接口配置

在项目启动类上标注@EnableShenyuClients(basePackages = "org.apache.shenyu.examples.sdk.http.api"), 其中basePackages中维护的是Shenyu-Sdk对应维护网关API接口的所在包位置.
创建interface并使用@ShenyuClient(name = "xxx", contextId = "ShenyuSdkApiName")注解标注, 其中name表示网关服务名.假如你需要定义多个bean来维护网关的API, 可以使用contextId作为对应的bean别名.
在定义接口中添加所要映射shenyu网关中的接口方法，其中@xxMapping中的value对应值是网关中对应请求的路径。

示例

项目启动类

@SpringBootApplication
@EnableShenyuClients(basePackages = "org.apache.shenyu.examples.sdk.http.api")
public class ShenyuSdkHttpExampleApplication {
    /**
     * main.
     *
     * @param args args
     */
    public static void main(final String[] args) {
        SpringApplication.run(ShenyuSdkHttpExampleApplication.class, args);
    }
}

网关API接口

@ShenyuClient(name = "shenyu-gateway", contextId = "ShenyuSdkApiName")
public interface ShenyuHttpClientApi {
    /**
     * findById.
     * test Get.
     *
     * @param id id
     * @return SdkTestDto
     */
    @GetMapping("/http/shenyu/client/findById")
    SdkTestDto findById(@RequestParam("id") String id);
}

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