【Sentinel】sentinel 集成 apollo 最佳实践，apollo
【Sentinel】sentinel 集成 apollo 最佳实践，apollo
【Sentinel】sentinel 集成 apollo 最佳实践
前言
在 sentinel 的控制台设置的规则信息默认都是存在内存当中的。所以无论你是重启了 sentinel 的客户端还是 sentinel 的控制台。你所设置的规则都会丢失。如果想要 sentinel 在线上环境使用，要么花钱用阿里云上的付费版本，要么自己去实现规则的持久化，如果你或你所在的公司不差钱，那么关掉这篇文章，直接用付费版吧，省掉了一大堆坑要踩。或者你是一个特立独行的人，那么我们接着往下说。
首先说一下写这篇文章的原因，因为真得在与 apllo 集成时，踩坑踩到怀疑人生。另一点是，找了一大堆关于集成的 apollo 的文章，都清一色的都是仿照官方给的限流规则的 DEMO 做的。 但是 sentinel 规则还有熔断规则、参数限流、系统限流、黑白名单等很多规则，每个规则还有细节上的不一致，这些都没有提，还有一些客户端的坑就更没有了。踩了这么多坑，有了一点心得与体会，梳理与此，希望能帮助到读者。
拉取 sentinel 控制台源码进行修改
因为修改内容过多，本文不会详述，下面的截图是所有修改内容，并且因为写这篇文章时，1.7版本在 master 开发，有大量快照版本。所以是切到当前稳定的 1.6 分支进行修改的。我已经 fork sentinel 到我的 github，下面是修改的内容 地址
修改点1：实现所有规则的拉取与推送接口
添加与实现了所有的规则的 Provider 与 Publisher 的配置拉取的与推送。
修改点2：修改控制台使用的规则操作 api
规则在控制台的操作 controller 进行大量改造。
修改点3：修改 xxEntity
最后一点也是最坑的修改了大量的 xxEntity 类，这些类是规则的实体类，本身没什么，源码是直接 json 化保存的，但是用于客户端集成的 spring-cloud-alibaba 使用了 json 校验，如果 apollo 保存的 json 与客户端的实体类有一丁点不一样就报 convert 0 rules but there are 1 rules from datasource . RuleCLass: FlowRule 。 是不是觉得很摸不着头脑，这报错跟 json 格式转换错误有什么，下面是 spring-cloud-alibaba json 转换的代码。
写这段代码的老哥，把这个异常吃了，并补上了一个 // won't be happen 的注释，你能理解我当时被这个报错坑的死去活来，后来发现是这里的问题吗？后来在 github 上找到两个同样的问题问题1、问题2，按照方法把 xxEntity 中用不到的字段全部加上 @JSONField(serialize = false) 解决。
修改点4：抽离配置使得可以在启动的时传入
添加的配置在下面
使用修改的控制台版本
自定义配置
| 配置名称 | 是否必填 | 默认值 | 作用 |
|---|---|---|---|
| env | 否 | DEV | 指定 apollo 使用的环境 |
| app.id | 否 | sentinel-apollo | 指定保存 sentinel 规则的 apollo 应用 ID |
| cluster.name | 否 | default | 指定保存 sentinel 使用的 apollo 集群 |
| namespace.name | 否 | application | 指定保存 sentinel 使用的 apollo 命名空间 |
| modify.user | 是 | apollo 控制台显示的修改人账号，此账号务必要有此应用的权限 | |
| modify.comment | 否 | modify by sentinel-dashboard | apollo 控制台显示的修改备注 |
| release.user | 是 | apollo 控制台显示的发布人账号，此账号务必要有此应用的权限 | |
| release.comment | 否 | release by sentinel-dashboard | apollo 控制台显示的发布备注 |
| apollo.portal.url | 是 | apollo 控制台的地址 | |
| apollo.application.token | 是 | 指定保存 sentinel 规则的 apollo 应用 openapi 的 token | |
| authority.key.suffix | 否 | authority | 认证规则保存在 apollo 中的 key 的后缀 |
| degrade.key.suffix | 否 | degrade | 熔断规则保存在 apollo 中的 key 的后缀 |
| flow.key.suffix | 否 | flow | 限流规则保存在 apollo 中的 key 的后缀 |
| param.key.suffix | 否 | param_flow | 参数限流规则保存在 apollo 中的 key 的后缀 |
| system.key.suffix | 否 | system | 系统限流规则保存在 apollo 中的 key 的后缀 |
| auth.username | 否 | sentinel | sentinel 控制台的登录用户名 |
| auth.password | 否 | sentinel | sentinel 控制台的登录密码 |
| server.port | 否 | 8080 | sentinel 控制台的启动端口 |
Apollo 配置
创建用于保存 sentinel 的项目
spring boot 集成 sentinel
源码地址
引入依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
<version>0.9.0.RELEASE</version>
</dependency>
<dependency>
<groupId>com.alibaba.csp</groupId>
<artifactId>sentinel-datasource-apollo</artifactId>
<version>1.5.2</version>
</dependency>测试 controller
package cn.coder4j.study.example.sentinel;
import com.alibaba.csp.sentinel.annotation.SentinelResource;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* @author buhao
* @version TestController.java, v 0.1 2019-09-19 20:53 buhao
*/
@RequestMapping("/test")
@Controller
public class TestController {
/**
* 没有注解通过自适应的限流
* @return
*/
@GetMapping("/flowRule")
@ResponseBody
public String flowRule(){
return "success";
}
/**
* 通过手动注解的限流
* @return
*/
@GetMapping("/flowRuleWithAnno")
@ResponseBody
@SentinelResource("flowRuleWithAnno")
public String flowRuleWithAnno(){
return "success";
}
/**
* 参数限流规则测试
* @param param
* @return
*/
@GetMapping("/paramFlowRule")
@ResponseBody
@SentinelResource("paramFlowRule")
public String paramFlowRule(String param){
return "success";
}
/**
* 熔断规则测试
* @return
*/
@GetMapping("/degradeRule")
@ResponseBody
@SentinelResource("degradeRule")
public String degradeRule(){
throw new RuntimeException("服务器异常");
}
}配置 application.yml
apollo:
bootstrap:
enabled: true # 开启 apollo
meta: xxx # 指定 apollo 注册地址
app:
id: sentinel-apollo # 指定规则项目在 apollo 的app.id，要与 sentinel 控制台启动参数一致
spring:
application:
name: study-sentinel-example # 应用名称，不同项目要唯一，会把他做为规则 Key 的前缀
cloud:
sentinel:
transport:
dashboard: localhost:8989 # sentinel 控制台的地址
datasource:
ds1:
apollo:
namespace-name: {部门名}.sentinel-rule # 保存规则的 apollo 应用的公共 namespace， 要与 sentinel 控制台启动参数一致
rule-type: flow # 指定该数据源是限流规则
flow-rules-key: ${spring.application.name}-${spring.cloud.sentinel.datasource.ds1.apollo.rule-type} # 指定该规则在 apollo 应用中 key 名称
ds2:
apollo:
namespace-name: {部门名}.sentinel-rule
rule-type: degrade # 指定该数据源是熔断规则
flow-rules-key: ${spring.application.name}-${spring.cloud.sentinel.datasource.ds2.apollo.rule-type} # 指定该规则在 apollo 应用中 key 名称
ds3:
apollo:
namespace-name: {部门名}.sentinel-rule
rule-type: param_flow # 指定该数据源是参数限流规则
flow-rules-key: ${spring.application.name}-${spring.cloud.sentinel.datasource.ds3.apollo.rule-type} # 指定该规则在 apollo 应用中 key 名称
ds4:
apollo:
namespace-name: {部门名}.sentinel-rule
rule-type: system # 指定该数据源是系统限流规则
flow-rules-key: ${spring.application.name}-${spring.cloud.sentinel.datasource.ds4.apollo.rule-type} # 指定该规则在 apollo 应用中 key 名称
ds5:
apollo:
namespace-name: {部门名}.sentinel-rule
rule-type: authority # 指定该数据源是认证限流(黑白名单)规则
flow-rules-key: ${spring.application.name}-${spring.cloud.sentinel.datasource.ds5.apollo.rule-type} # 指定该规则在 apollo 应用中 key 名称
sentinel 控制台配置
jmeter 配置
jmeter 是用于测试与验证规则使用的，因为可以设置线程数，所以可以很好的测试限流情况。测试脚本下载
测试步骤
欢迎关注我的公众号「KIWI的碎碎念」，也可以收藏 我的博客
相关文章
- 暂无相关文章
用户点评