一、源码结构
如图:
目录结构
1、pom.xml
首先我们看下pom.xml,这也是我看源码的习惯,看完目录结构再看pom文件。
通过pom文件,可以理解到该项目:
- 基于Spring boot快速开发的,且spring boot版本为2.0.5.RELEASE
- 基于JDK8编译开发的
- 引用了sentinel-web-servlet、sentinel-transport-simple-http等依赖,sentinel-web-servlet是一个sentinel的适配器,因而该项目可能也可以进行限流降级控制
2、client
主要可以看到SentinelApiClient,这个类的功能是通过http获取引用的监控指标以及设置限流、降级、熔断的规则并发送到对应的应用中。
可以看到大致有以下方法:
fetch拉取方法
- fetchResourceOfMachine: 获取应用的资源
- fetchFlowRuleOfMachine: 获取应用限流规则
- fetchDegradeRuleOfMachine: 获取应用降级规则
- fetchSystemRuleOfMachine: 获取应用的系统保护规则
- fetchParamFlowRulesOfMachine:获取获取应用限流参数
- fetchAuthorityRulesOfMachine: 获取机器的受权规则
set设置方法
- setFlowRuleOfMachine: 设置限流规则
- setDegradeRuleOfMachine:设置降级规则
- setSystemRuleOfMachine:设置系统规则
- setAuthorityRuleOfMachine:设置受权规则
- setParamFlowRuleOfMachine:设置限流参数规则
而后通过httpGetContent方法调用。
这里只是简单详情了有哪些调用方法,具体调用调用方法会请求到哪,其实会到sentinel-transpor板块中,其中有个CommandHandler接口,通过SPI的形式实现了很多Handler解决器。具体调用链后续文章会讲解。
3、config
只有一个文件WebConfig:
- 继承了WebMvcConfigurerAdapter,用来设置web的资源目录、控制器、过滤器等
- 添加@Configuration,表示该项目启动时加载
- 添加了CommonFilter,用设置可以限流、降级的资源,可以看到设置资源为/*
4、datasource.entity
不用说,这里放的是实体对象地方,主要有服务实体、指标实体、各种监控规则实体等
5、discovery
这个包下主要是sentinel用户端信息,也就是使用sentinel框架的用户端信息
- 主要可以看下SimpleMachineDiscovery这个方法,应用的信息会被保存在apps这个Map中。
- dashboard应用在启动后,用户端会调用/registry/machine(view包下的MachineRegistryController类)这个接口把服务信息写到Map中
- dashborad应用获取应用就是从map中拿的
6、domain
只有一个类ResourceTreeNode,就是监控指标的对象实体,主要包括qps,异常信息等信息。
7、metirc
只有个MetricFetcher类,表示获取应用的统计信息,也就是拉取实时监控信息
- 启动是通过构造函数调用start方法进行定时拉取所有用户端指标信息。执行周期是10+n1(秒)*
- fetchService线程池用来拉取该APP所有机器的metric
- fetchWorker工作线程池用来调用http获取实时指标信息
- 最后通过writeMetric方法调用的MetricsRepository的saveAll方法保存所有指标信息
8、repository
主要是metric和rule的信息保存
- metric的信息来源已经说过了,通过InMemoryMetricsRepository的save方法可以看到用户端实时指标信息在dashboard中保留5分钟
- rule包下的类主要是获取下一个为使用的id
9、util
- RuleUtils用来解析Rule的JSON对象
- VersionUtils解析Sentinel版本
10 view
这个包下就是少量资源控制器了,主要是前台提供接口
- AppController:应用列表控制器
- AuthorityRuleController:受权规则控制器
- DegradeController:降级控制器
- FlowController:降流控制器
- MachineRegistryController:应用注册控制,这个控制器比较特殊并不是给前台的,而是用户端注册使用的
- MetricController :实时监控控制器
- ParamFlowRuleController:参数规则
- ResourceController :机器资源
- SystemController :系统规则控制
11、DashboardApplication
应用启动类,可以直接启动,默认端口号8080
12、resources
资源配置文件:application.properties
13、webapp
这个就是前台资源目录,前台使用的是angularjs开发的,二次开发需要搭建前台环境,可以见目录下的README_zh.md文件。
二、分析
1、dashborad板块代码比较简单,主要数据都是从内存获取的
2、在面向生产使用时,还是缺少少量内容的,比方权限控制,数据持久化,登录功能等
3、前台使用angularjs开发,对未接触过人来说,二次开发前台页面难度较大
三、我的小结
1、sentinel系列通过先分享dashboard板块,主要考虑在一个可视化的界面中设置规则,方便后续板块的调试跟踪
2、大致分析了dashboard每个包下的内容
3、针对面向生产时,面对dashbord的痛点。下篇文章会详情如何扩展一个生产使用的控制台,主要扩展以下功能:
A: 登录功能、设置统一阻拦器
B: 系统权限功能,就是客户只能看到客户权限的系统
C: 核心数据持久化
4、以上内容,若有不当之处,谢谢指正。