Soul源码阅读 搭建环境【第一天】

了解自己阅读源码最后达成的目标

1、学会使用Soul框架

2、学习Soul框架里面功能的实现，应用到以后的开发中

3、之后Soul开发其他的时候能够着手进行开发

Soul官网链接

Soul的背景

异步的，高性能的，跨语言的，响应式的API网关【参考了Kong，Spring-Cloud-Gateway等优秀的网关后的实现】

Soul的特性【以下内容的使用以及如何实现都可以进行查看】

• 支持各种语言(Http协议)，支持 Dubbo，SpringCloud协议。【支持多种协议是如何实现的？】
• 插件化设计思想，插件热插拔，易扩展
• 灵活的流量筛选，能满足各种流量控制。
• 内置丰富的插件支持，鉴权，限流，熔断，防火墙等等。
• 流量配置动态化，性能极高，网关消耗在 1~2ms。
• 支持集群部署，支持 A/B Test，蓝绿发布。

上面A/B Test和蓝绿发布是没有接触过的，下面的链接扫下盲

什么是蓝绿部署、滚动发布和灰度发布？

蓝绿部署、红黑部署、AB测试、灰度发布、金丝雀发布、滚动发布的概念与区别

Soul的架构设计

image.png

SoulAdmin

• Plugin-in configuration
• Selector configuration
• Rule configuration
• User managerment
• Event Bus (write data)
• SPI
  • Http
  • Zookeeper
  • Websocket

SoulCluster

• SPI
• Cache Data & Local Cache

Git & Automated deployment

• DCS(Distributed control system) Automated build & Docker

Plugins

• Monitor
• Sign
• Limiting
• Divide
• Dubbo
• SpringCloud

Monitor-Dashboard

• Grafana
• Prometheus

Soul代码结构

下载代码

image.png

编译安装代码（大概1~2分钟编译完毕）

mvn clean package install -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Drat.skip=true -Dcheckstyle.skip=true

我们先观察下上面的代码结构

从上到下分别是

soul-admin
负责维护网关的元数据、配置等等，插件和其他信息配置的管理后台，并提供给 Soul Bootstrap 网关服务配置读取

soul-bootstrap
用于启动项目，用户可以参考

soul-client
用户可以使用 Spring MVC，Dubbo，Spring Cloud 快速访问

soul-common
框架的通用类

soul-dashboard
控制面板

soul-dist
构建项目

soul-example
RPC 示例项目

soul-metric
prometheus（普罗米修斯）实现的 metrics，指标，暂时不知道是做什么用的

soul-plugin
Soul 支持的插件集合

soul-register-center
注册中心

soul-spi
提供spi支持

soul-springboot-starter
支持 spring boot starter

soul-sync-data-center
提供 ZooKeeper，HTTP，WebSocket，Nacos 的方式同步数据

soul-web
包括插件、请求路由和转发等的核心处理包

运行soul-admin

1、需要安装mysql，使用5.X版本，8.X版本据说报错

2、修改配置文件下的数据库密码

image.png

标注红色的三个需要进行修改，连接mysql

spring:
  #profiles:
  #  active: h2
  thymeleaf:
    cache: true
    encoding: utf-8
    enabled: true
    prefix: classpath:/static/
    suffix: .html
  datasource:
    url: jdbc:mysql://localhost:3306/soul?useUnicode=true&characterEncoding=utf-8
    username: root
    password: 
    driver-class-name: com.mysql.jdbc.Driver

3、启动soul-admin

运行 SoulAdminBootstrap

4、首次运行，会在mysql数据库中创建soul库，并创建soul需要使用的数据库表

image.png

5、服务运行成功，查看本地运行的控制台 http://localhost:9095/ ，用户名 admin，密码 123456

image.png

菜单一览

image.png image.png

运行 soul-bootstrap

1、修改application下面的配置，默认不需要修改

image.png

该url为admin启动的地址，作用为同步获取配置信息用

image.png

2、运行 SoulBootstrapApplication

3、启动完成，服务运行在9195端口，访问 http://127.0.0.1:9195/

访问返回下图，说明启动成功

{
    "code": -107,
    "message": "Can not find selector, please check your configuration!",
    "data": null
}

运行起来了，查看下Soul首页的

数据库设计

存储插件，选择器，规则配置数据，以及对应关系

数据配置流程

同步更新配置文件

数据同步原理

Zookeeper同步，WebSocket同步，Http长轮询同步

元数据概念介绍

针对Dubbo每个接口会有一条元数据

大致了解下数据的接口以及配置文件这块是怎么流转的