• Apache ShenYu网关初体验


    前言

    Apache ShenYu(神禹)是采用Java WebFlux编写的响应式API网关,具有异步、高性能、跨语言的特点。

    • 支持HTTP、Dubbo、 Spring Cloud、 gRPC、 Motan、 Sofa、 Tars 等协议
    • 采用插件化设计思想,插件热插拔,易扩展
    • 灵活的流量筛选,能满足各种流量控制
    • 内置鉴权、限流、熔断、防火墙等插件
    • 流量配置动态化,性能极高
    • 支持集群部署,支持A/B测试、蓝绿发布

    架构图

    image.png

    快速部署

    Apache Shenyu 支持本地部署、单机快速部署、二进制包部署、Docker部署、K8s部署、集群部署等,为了能够快速体验,我们使用本地部署,同时也为了方便后期看源码。

    环境准备

    • 本地正确安装JDK1.8+
    • 本地正确安装Git
    • 本地正确安装Maven
    • 选择一款开发工具,比如IDEA

    下载编译代码

    1. https://github.com/apache/shenyu.git下载最新仓库,下载完成后使用mvn clean install -Dmaven.javadoc.skip=true -B -Drat.skip=true -Djacoco.skip=true -DskipITs -DskipTests编译打包一下。
    2. 导入IDEA,切换分支到最小的release版本,我这目前为 2.5.0-release
    3. 使用开发工具启动 org.apache.shenyu.admin.ShenyuAdminBootstrap,访问 http://localhost:9095 , 默认用户名和密码分别为: admin123456(默认使用H2数据库),这是Shenyu运维管理后台。
    4. 使用开发工具启动 org.apache.shenyu.bootstrap.ShenyuBootstrapApplication,这就相当于微服务网关

    如下是管理后台截图:

    image.png

    官网的git地址有误:https://github.com/apache/incubator-shenyu.git

    微服务集成

    前期准备:nacos服务,搭建步骤看nacos官网
    版本关系:

    <shenyu.version>2.4.3shenyu.version>
    <boot.version>2.2.2.RELEASEboot.version>
    <cloud.version>Hoxton.SR8cloud.version>
    <nacos.version>2.2.6.RELEASEnacos.version>
    
    • 1
    • 2
    • 3
    • 4

    版本管理(统一加到父级pom中):

    <dependencyManagement>
        <dependencies>
            <dependency>
                
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-dependenciesartifactId>
                <version>${boot.version}version>
                <type>pomtype>
                <scope>importscope>
            dependency>
    
            <dependency>
                <groupId>org.springframework.cloudgroupId>
                <artifactId>spring-cloud-dependenciesartifactId>
                <version>${cloud.version}version>
                <type>pomtype>
                <scope>importscope>
            dependency>
        dependencies>
    dependencyManagement>
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20

    创建网关

    1. 创建网关服务shenyu-gateway,依赖的pom.xml如下
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-webfluxartifactId>
    dependency>
    
    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-actuatorartifactId>
    dependency>
    
    
    
    <dependency>
        <groupId>org.apache.shenyugroupId>
        <artifactId>shenyu-spring-boot-starter-gatewayartifactId>
        <version>${shenyu.version}version>
    dependency>
    
    <dependency>
        <groupId>org.apache.shenyugroupId>
        <artifactId>shenyu-spring-boot-starter-plugin-springcloudartifactId>
        <version>${shenyu.version}version>
    dependency>
    
    <dependency>
        <groupId>org.springframework.cloudgroupId>
        <artifactId>spring-cloud-commonsartifactId>
        <version>2.2.5.RELEASEversion>
    dependency>
    
    <dependency>
        <groupId>org.apache.shenyugroupId>
        <artifactId>shenyu-spring-boot-starter-plugin-httpclientartifactId>
        <version>${shenyu.version}version>
    dependency>
    
    <dependency>
        <groupId>org.apache.shenyugroupId>
        <artifactId>shenyu-spring-boot-starter-instanceartifactId>
        <version>${shenyu.version}version>
    dependency>
    
    
    <dependency>
        <groupId>com.alibaba.cloudgroupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
        <version>${nacos.version}version>
    dependency>
    
    
    <dependency>
        <groupId>org.apache.shenyugroupId>
        <artifactId>shenyu-spring-boot-starter-sync-data-nacosartifactId>
        <version>${shenyu.version}version>
    dependency>
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    1. application.yml配置如下:
    server:
      port: 7000
    
    spring:
      cloud:
        nacos:
          server-addr: 127.0.0.1:8848
        discovery:
          enabled: true
      main:
        allow-bean-definition-overriding: true
        allow-circular-references: true
      codec:
          max-in-memory-size: 2MB
      application:
        name: shenyu-gateway
    
    shenyu:
      sync:
        nacos:
          url: ${spring.cloud.nacos.server-addr}
          # url: 配置成你的 nacos地址,集群环境请使用(,)分隔。
          namespace: sync-data
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    1. GatewayApplication代码
    @EnableDiscoveryClient
    @SpringBootApplication
    public class GatewayApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(GatewayApplication.class, args);
        }
    
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9

    通常如上三步,已经集成了shenyu-gateway服务。
    启动完成日志,可以清楚的看到Shenyu的Logo:

    2022-08-26 00:42:11.706  INFO 2300 --- [           main] org.apache.shenyu.web.logo.ShenyuLogo    : 
    
    
       _____ _                            
      / ____| |                           
     | (___ | |__   ___ _ __  _   _ _   _ 
      \___ \| '_ \ / _ \ '_ \| | | | | | |
      ____) | | | |  __/ | | | |_| | |_| |
     |_____/|_| |_|\___|_| |_|\__, |\__,_|
                               __/ |      
                              |___/       
     :: Shenyu :: (v2.4.3)
    
    
      .   ____          _            __ _ _
     /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
    ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
     \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
      '  |____| .__|_| |_|_| |_\__, | / / / /
     =========|_|==============|___/=/_/_/_/
     :: Spring Boot ::        (v2.2.2.RELEASE)
    
    2022-08-26 00:42:13.111  INFO 2300 --- [           main] c.s.demo.gateway.GatewayApplication      : No active profile set, falling back to default profiles: default
    ...省略
    2022-08-26 00:42:21.644  INFO 2300 --- [           main] o.s.b.web.embedded.netty.NettyWebServer  : Netty started on port(s): 7000
    2022-08-26 00:42:22.363  INFO 2300 --- [           main] c.a.c.n.registry.NacosServiceRegistry    : nacos registry, DEFAULT_GROUP shenyu-gateway 192.168.0.115:7000 register finished
    2022-08-26 00:42:23.104  INFO 2300 --- [           main] c.s.demo.gateway.GatewayApplication      : Started GatewayApplication in 12.584 seconds (JVM running for 13.613)
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27

    💡 配置依赖的坑,已经给你踩好了,务必按照如上配置

    移植ShenYu管理后台

    1. 从Apache ShenYu源码复制一份
    2. 修改application.yml的注册地址和同步地址,完整配置如下
    server:
      port: 9095
      address: 0.0.0.0
    
    spring:
      profiles:
        active: h2
      thymeleaf:
        cache: true
        encoding: utf-8
        enabled: true
        prefix: classpath:/static/
        suffix: .html
    
    mybatis:
      config-location: classpath:/mybatis/mybatis-config.xml
      mapper-locations: classpath:/mappers/*.xml
    
    shenyu:
      register:
        registerType: nacos #http #zookeeper #etcd #nacos #consul
        serverLists: 127.0.0.1:8848 #localhost:2181 #http://localhost:2379 localhost:8848
        props:
          sessionTimeout: 5000
          connectionTimeout: 2000
          checked: true
          zombieCheckTimes: 5
          scheduledTime: 10
          nacosNameSpace: ShenyuRegisterCenter
      sync:
    #    websocket:
    #      enabled: true
    #      messageMaxSize: 10240
    #      zookeeper:
    #        url: localhost:2181
    #        sessionTimeout: 5000
    #        connectionTimeout: 2000
    #      http:
    #        enabled: true
          nacos:
            url: 127.0.0.1:8848
            namespace: sync-data
    #        username:
    #        password:
    #        acm:
    #          enabled: false
    #          endpoint: acm.aliyun.com
    #          namespace:
    #          accessKey:
    #          secretKey:
    #    etcd:
    #      url: http://localhost:2379
    #    consul:
    #      url: http://localhost:8500
      ldap:
        enabled: false
        url: ldap://xxxx:xxx
        bind-dn: cn=xxx,dc=xxx,dc=xxx
        password: xxxx
        base-dn: ou=xxx,dc=xxx,dc=xxx
        object-class: person
        login-field: cn
      jwt:
        expired-seconds: 86400000
      shiro:
        white-list:
          - /
          - /favicon.*
          - /static/**
          - /index**
          - /platform/login
          - /websocket
          - /error
          - /actuator/health
          - /swagger-ui.html
          - /webjars/**
          - /swagger-resources/**
          - /v2/api-docs
          - /csrf
      swagger:
        enable: true
    
    logging:
      level:
        root: info
        org.springframework.boot: info
        org.apache.ibatis: info
        org.apache.shenyu.bonuspoint: info
        org.apache.shenyu.lottery: info
        org.apache.shenyu: info
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
    • 67
    • 68
    • 69
    • 70
    • 71
    • 72
    • 73
    • 74
    • 75
    • 76
    • 77
    • 78
    • 79
    • 80
    • 81
    • 82
    • 83
    • 84
    • 85
    • 86
    • 87
    • 88
    • 89
    • 90

    💡 ShenYu的管理后台不需要做什么修改,只要调整配置即可

    创建服务

    为了测试效果,我们创建一个server1的服务,一会在Docker中多实例部署

    1. pom.xml依赖
    <dependencies>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-webartifactId>
        dependency>
    
        <dependency>
            <groupId>org.apache.shenyugroupId>
            <artifactId>shenyu-spring-boot-starter-client-springcloudartifactId>
            <version>${shenyu.version}version>
        dependency>
    
        
        <dependency>
            <groupId>com.alibaba.cloudgroupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
            <version>${nacos.version}version>
        dependency>
    
        <dependency>
            <groupId>org.springframework.cloudgroupId>
            <artifactId>spring-cloud-commonsartifactId>
            <version>2.2.5.RELEASEversion>
        dependency>
    dependencies>
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    1. application.yml配置
    server:
      port: 8080
    
    spring:
      cloud:
        nacos:
          server-addr: 127.0.0.1:8848
        discovery:
          enabled: true
      main:
        #允许覆盖bean
        allow-bean-definition-overriding: true
      codec:
        #编码器缓存限制
        max-in-memory-size: 2MB
      application:
        name: server1
    
    shenyu:
      register:
        registerType: nacos #zookeeper #etcd #nacos #consul
        serverLists: ${spring.cloud.nacos.server-addr} #localhost:2181 #http://localhost:2379 #localhost:8848
        props:
          nacosNameSpace: ShenyuRegisterCenter
      client:
        springCloud:
          props:
            contextPath: /server1
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    1. 创建一个测试接口
    @RestController
    public class HelloController {
    
        @PostMapping("/hello")
        public String hello() {
            log.info("ip:{}", InetAddress.getLocalHost().getHostAddress());
            return "Server1 Hello ShenYu";
        }
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    1. Docker配置
    # 指定 java 环境镜像
    FROM java:8
    # 复制文件到容器
    COPY target/*.jar /application.jar
    
    RUN /bin/cp /usr/share/zoneinfo/Asia/Shanghai /etc/localtime && echo 'Asia/Shanghai' > /etc/timezone
    
    ENTRYPOINT ["java", "-jar", "-Xms256m", "-Xmx256m", "/application.jar"]
    
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9

    体验

    1.分别启动shenyu-gatewayshenyu-admin、docker部署两个server1实例
    image.png

    1. 配置路由测试

    image.png

    配置意思是:当请求头server=server1时,会请求到172.17.0.4 这个服务上
    同理配置server2

    image.png
    配置rule,ruel的规则我们配置为都通过,使用or

    image.png
    使用Postman请求网关地址[http://localhost:7000/hello](http://localhost:63193/hello),成功返回了结果Server1 Hello ShenYu

    image.png
    同时shenyu-gateway打印了路由日志

    INFO 1 --- [u-netty-epoll-3] o.a.s.plugin.base.AbstractShenyuPlugin   : divide selector success match , selector name :server1
    INFO 1 --- [u-netty-epoll-3] o.a.s.plugin.base.AbstractShenyuPlugin   : divide rule success match , rule name :full rule
    INFO 1 --- [u-netty-epoll-3] o.a.s.p.h.AbstractHttpClientPlugin       : The request urlPath is http://172.17.0.4:8080/hello, retryTimes is 3, retryStrategy is current
    
    • 1
    • 2
    • 3

    Apache ShenYu体验完毕,后面将继续推出选择器、规则相关文章,敬请期待。

    💡 项目源码地址:https://github.com/jujunchen/shenyu-demo.git

  • 相关阅读:
    docker搭建ELK
    鸿蒙开发套件全面升级,助力鸿蒙生态蓬勃发展
    vue前端开发ios系统:https发http请求 网络通讯之间的安全问题
    安卓USB模块源码分析(一)- 准备
    mysql查看连接池的命令
    对 Android APK 进行反编译
    基于网络爬虫的购物平台价格监测系统的设计与实现
    深度学习框架安装与配置指南:PyTorch和TensorFlow详细教程
    解决ModuleNotFoundError: No module named ‘caffe‘
    全局异常处理器无法处理sql报错
  • 原文地址:https://blog.csdn.net/weixin_40972073/article/details/126535531