Skip to main content
Version: 2.5.1

使用Nacos接入

背景说明#

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

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

环境准备#

需要参考 运维部署 , 选择一种方式启动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配置文件中添加如下配置.

spring:  application:    name: shenyu-bootstrap  cloud:    discovery:      enabled: true    nacos:      discovery:        server-addr: 127.0.0.1:8848 # 此处填你的nacos服务地址        enabled: true        namespace: ShenyuRegisterCenter # nacos命名空间        # 如开启nacos鉴权需配置如下参数        username: nacos # 鉴权用户名        password: nacos # 鉴权密码

应用客户端#

添加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: nacos     server-lists: localhost:2181    props:      nacosNameSpace: ShenyuRegisterCenter      username: nacos      password: nacos      retry:        enable: true        period: 100        maxPeriod: 1000        maxAttempts: 5      algorithm: roundRobin      scheme: http
# registerType : 服务注册类型，填写 nacos# serverList: 为nacos注册类型时，配置成你的nacos地址，集群环境请使用（,）分隔# nacosNameSpace: nacos命名空间ID# username: nacos鉴权用户名# password: nacos鉴权密码# retry 失败重试相关配置# retry.period: 重试等待时间# retry.maxPeriod: 最大重试等待时间 # retry.maxAttempts: 最大重试次数# algorithm: 负载均衡# 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对应值是网关中对应请求的路径。

示例

项目启动类

@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-bootstrap", 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