Sentinel是阿里巴巴开源的一款分布式系统的流量控制框架,它基于AOP和注解,提供了流量控制、熔断降级、系统负载保护等功能,可以有效地保护系统的稳定性和可用性。本文将从源码角度分析Sentinel的实现原理和代码结构,并提供相关的代码示例。
一、Sentinel的基本原理
Sentinel的基本原理是通过拦截器和切面的方式对请求进行拦截和处理,实现流量控制、熔断降级等功能。具体来说,Sentinel主要包括以下几个核心组件:
Sentinel的流程如下:
二、Sentinel的代码结构
Sentinel的代码结构比较清晰,主要包括以下几个模块:
Sentinel的核心代码结构如下:
sentinel-core
├── entry
│ ├── Entry
│ ├── EntryType
│ ├── Node
│ ├── NodeBuilder
│ ├── ResourceWrapper
│ └── StatisticNode
├── flow
│ ├── FlowRule
│ ├── FlowRuleChecker
│ ├── FlowRuleManager
│ ├── FlowRuleProperty
│ ├── FlowRulePropertyListener
│ ├── FlowRuleProvider
│ ├── FlowRulePublisher
│ ├── FlowRuleZookeeperProvider
│ └── Slot
├── init
│ ├── DefaultSlotChainBuilder
│ ├── SlotChainBuilder
│ └── SlotChainBuilderProvider
├── slot
│ ├── ProcessorSlot
│ ├── SlotChain
│ ├── SlotChainBuilder
│ └── SlotChainBuilderProvider
├── tracing
│ ├── EntryType
│ ├── TraceContext
│ ├── TraceEntry
│ ├── TraceIdGenerator
│ ├── TraceManager
│ ├── Tracer
│ ├── TracerCallback
│ ├── TracerContext
│ ├── TracerSlot
│ └── TracingStatus
├── utils
│ ├── TimeUtil
│ ├── UniqueIdGenerator
│ └── UuidUtil
├── SphU
├── Constants
├── SentinelConfig
├── SentinelContextHolder
├── SentinelProperty
├── SentinelPropertyListener
├── SentinelPropertyRegistry
└── SlotChainProvider
sentinel-extension
├── adapter
│ ├── AbstractCommandHandler
│ ├── CommandConstants
│ ├── CommandHandler
│ ├── CommandHandlerProvider
│ ├── DubboAdapterGlobalConfig
│ ├── DubboConfig
│ ├── DubboUtils
│ ├── EntryWrapper
│ ├── HttpAdapterGlobalConfig
│ ├── HttpCommandHandler
│ ├── HttpInvocation
│ ├── HttpInvocationContext
│ ├── HttpInvocationHandler
│ ├── HttpParamParser
│ ├── HttpResourceWrapper
│ ├── JaxrsResourceWrapper
│ ├── RestTemplateCommandHandler
│ ├── SentinelRpcFilter
│ ├── SentinelRpcProviderFilter
│ ├── SentinelRpcServiceInterceptor
│ ├── SentinelWebFluxFilter
│ ├── SentinelWebFluxProviderFilter
│ ├── SentinelWebFilter
│ ├── SentinelWebProviderFilter
│ ├── SpringMvcAdapterGlobalConfig
│ ├── SpringMvcUtils
│ ├── SpringWebFluxUtils
│ ├── WsResourceWrapper
│ ├── WsSessionContext
│ ├── WsSessionHolder
│ ├── WsSessionStat
│ ├── WsSessionStatCallback
│ └── WsStreamWrapper
├── command
│ ├── AddFlowCommand
│ ├── ClearFlowCommand
│ ├── CommandHandler
│ ├── CommandHandlerProvider
│ ├── CommandRequest
│ ├── CommandResponse
│ ├── CommandUpdateGroup
│ ├── CommandUpdateParamFlowRules
│ ├── CommandUpdateResult
│ ├── CommandUpdateStatInterval
│ ├── CommandUpdateSystemRules
│ ├── CommandUpdateVersion
│ ├── CommandUtils
│ ├── FetchMachineRulesCommand
│ ├── FetchParamFlowRulesCommand
│ ├── FetchRuleCommand
│ ├── FetchSystemRulesCommand
│ ├── RemoveFlowCommand
│ ├── RemoveRuleCommand
│ └── RuleCheckRequest
├── config
│ ├── AbstractConfig
│ ├── AbstractReadableDataSource
│ ├── AbstractWritableDataSource
│ ├── ApolloDataSource
│ ├── ClusterClientConfig
│ ├── ConsulDataSource
│ ├── DataSourceProperties
│ ├── EtcdConfig
│ ├── EtcdDataSource
│ ├── FileRefreshableDataSource
│ ├── FileRefreshableDataSourceProperties
│ ├── FileRefreshableDataSourceRegistry
│ ├── FileRefreshableRuleDataSource
│ ├── HttpDataSource
│ ├── HttpSimpleClient
│ ├── HttpSimpleClientProvider
│ ├── JdbcDataSource
│ ├── NacosDataSource
│ ├── ReadableDataSource
│ ├── ReadableDataSourceRegistry
│ ├── SimpleProperty
│ ├── SimplePropertyListener
│ ├── SimplePropertyRegistry
│ ├── SystemRuleDataSource
│ ├── WritableDataSource
│ └── WritableDataSourceRegistry
├── flow
│ ├── AbstractFlowSlot
│ ├── ClusterBuilderSlot
│ ├── ClusterBuilderSlotChainBuilder
│ ├── ClusterClientConfig
│ ├── ClusterConstants
│ ├── ClusterStateManager
│ ├── Constants
│ ├── ControlBehavior
│ ├── DefaultClusterBuilderSlotChainBuilder
│ ├── DefaultFlowRuleChecker
│ ├── FlowException
│ ├── FlowSlot
│ ├── FlowSlotChainBuilder
│ ├── FlowSlotChainProvider
│ ├── FlowSlotContext
│ ├── FlowSlotUtil
│ ├── FlowStatistic
│ ├── FlowStatisticNode
│ ├── FlowStatisticSlot
│ ├── FlowRule
│ ├── FlowRuleChecker
│ ├── FlowRuleManager
│ ├── FlowRuleProperty
│ ├── FlowRulePropertyListener
│ ├── FlowRuleProvider
│ ├── FlowRulePublisher
│ ├── FlowRuleZookeeperProvider
│ ├── Grade
│ ├── HotParamFlowRuleManager
│ ├── HotParamFlowRuleProperty
│ ├── HotParamFlowRulePropertyListener
│ ├── HotParamFlowRulePublisher
│ ├── HotParamFlowRuleZookeeperProvider
│ ├── ParamFlowRule
│ ├── ParamFlowRuleChecker
│ ├── ParamFlowRuleManager
│ ├── ParamFlowRuleProperty
│ ├── ParamFlowRulePropertyListener
│ ├── ParamFlowRulePublisher
│ ├── ParamFlowRuleZookeeperProvider
│ ├── Slot
│ ├── ThresholdProperty
│ ├── WarmUpProperty
│ ├── WarmUpRule
│ ├── WarmUpRuleManager
│ └── WarmUpRulePropertyListener
├── logger
│ ├── ConsoleLogConfigurator
│ ├── LogBase
│ ├── LoggerFactory
│ ├── SentinelLogger
│ └── SentinelLoggerImpl
├── slot
│ ├── AbstractLinkedProcessorSlot
│ ├── AuthoritySlot
│ ├── AuthoritySlotChainBuilder
│ ├── AuthoritySlotChainProvider
│ ├── DegradeExceptionHandler
│ ├── DegradeExceptionSlot
│ ├── DegradeRule
│ ├── DegradeRuleChecker
│ ├── DegradeRuleManager
│ ├── DegradeRuleProperty
│ ├── DegradeRulePropertyListener
│ ├── DegradeRuleProvider
│ ├── DegradeRulePublisher
│ ├── DegradeRuleZookeeperProvider
│ ├── ExceptionProcessorSlot
│ ├── Slot
│ ├── SlotChain
│ ├── SlotChainBuilder
│ ├── SlotChainBuilderProvider
│ ├── SlotChainProvider
│ ├── StatisticSlot
│ ├── SystemSlot
│ └── SystemSlotChainBuilder
├── stat
│ ├── AbstractStat
│ ├── ClusterClientStat
│ ├── ClusterClientStatCallback
│ ├── ClusterClientStatCallbackRegistry
│ ├── ClusterClientStatException
│ ├── ClusterClientStatExceptionListener
│ ├── ClusterClientStatExceptionPublisher
│ ├── ClusterClientStatExceptionPublisherAutoConfiguration
│ ├── Constants
│ ├── HotSpotParamStat
│ ├── HotSpotParamStatCallback
│ ├── HotSpotParamStatCallbackRegistry
│ ├── HotSpotParamStatException
│ ├── HotSpotParamStatExceptionListener
│ ├── HotSpotParamStatExceptionPublisher
│ ├── HotSpotParamStatExceptionPublisherAutoConfiguration
│ ├── HotSpotParamStatPublisher
│ ├── HotSpotParamStatPublisherAutoConfiguration
│ ├── MetricCallback
│ ├── MetricEvent
│ ├── MetricWriter
│ ├── MetricWriterAutoConfiguration
│ ├── MetricWriterHolder
│ ├── StatCallback
│ ├── StatCallbackRegistry
│ ├── StatException
│ ├── StatExceptionListener
│ ├── StatExceptionPublisher
│ ├── StatExceptionPublisherAutoConfiguration
│ ├── StatFilter
│ ├── StatFilterAutoConfiguration
│ ├── StatPublisher
│ ├── StatPublisherAutoConfiguration
│ ├── StatPublisherHolder
│ ├── StatisticData
│ ├── StatisticFilter
│ ├── StatisticFilterCallback
│ ├── StatisticFilterCallbackRegistry
│ ├── StatisticFilterException
│ ├── StatisticFilterExceptionListener
│ ├── StatisticFilterExceptionPublisher
│ ├── StatisticFilterExceptionPublisherAutoConfiguration
│ ├── StatisticFilterPublisher
│ ├── StatisticFilterPublisherAutoConfiguration
│ ├── StatisticNode
│ ├── StatisticSlot
│ ├── StatisticSlotCallback
│ ├── StatisticSlotCallbackRegistry
│ ├── StatisticSlotException
│ ├── StatisticSlotExceptionListener
│ ├── StatisticSlotExceptionPublisher
│ ├── StatisticSlotExceptionPublisherAutoConfiguration
│ ├── StatisticSlotPublisher
│ ├── StatisticSlotPublisherAutoConfiguration
│ ├── StatisticSummary
│ ├── StatisticSummaryCallback
│ ├── StatisticSummaryCallbackRegistry
│ ├── StatisticSummaryException
│ ├── StatisticSummaryExceptionListener
│ ├── StatisticSummaryExceptionPublisher
│ ├── StatisticSummaryExceptionPublisherAutoConfiguration
│ ├── StatisticSummaryPublisher
│ ├── StatisticSummaryPublisherAutoConfiguration
│ ├── StatisticTask
│ ├── StatisticTaskCallback
│ ├── StatisticTaskCallbackRegistry
│ ├── StatisticTaskException
│ ├── StatisticTaskExceptionListener
│ ├── StatisticTaskExceptionPublisher
│ ├── StatisticTaskExceptionPublisherAutoConfiguration
│ ├── StatisticTaskPublisher
│ ├── StatisticTaskPublisherAutoConfiguration
│ ├── SystemRuleManager
│ └── SystemRulePropertyListener
├── transport
│ ├── AbstractCommandCenter
│ ├── CommandCenter
│ ├── CommandCenterProvider
│ ├── CommandHandler
│ ├── CommandHandlerProvider
│ ├── CommandRequest
│ ├── CommandResponse
│ ├── CommandUpdateGroup
│ ├── CommandUpdateParamFlowRules
│ ├── CommandUpdateResult
│ ├── CommandUpdateStatInterval
│ ├── CommandUpdateSystemRules
│ ├── CommandUpdateVersion
│ ├── CommandUtils
│ ├── HeartbeatSender
│ ├── HeartbeatSenderAutoConfiguration
│ ├── HeartbeatSenderProvider
│ ├── HeartbeatSenderTask
│ ├── HeartbeatSenderTaskCallback
│ ├── HeartbeatSenderTaskCallbackRegistry
│ ├── HeartbeatSenderTaskException
│ ├── HeartbeatSenderTaskExceptionListener
│ ├── HeartbeatSenderTaskExceptionPublisher
│ ├── HeartbeatSenderTaskExceptionPublisherAutoConfiguration
│ ├── HeartbeatSenderTaskPublisher
│ ├── HeartbeatSenderTaskPublisherAutoConfiguration
│ ├── InMemoryCommandCenter
│ ├── InMemoryCommandCenterProvider
│ ├── SentinelApiClient
│ ├── SentinelApiClientProvider
│ ├── SentinelConfig
│ ├── SentinelConfigChangedEvent
│ ├── SentinelConfigProvider
│ ├── SentinelConfigUpdateCallback
│ ├── SentinelConfigUpdateCallbackRegistry
│ ├── SentinelConfigUpdateException
│ ├── SentinelConfigUpdateExceptionListener
│ ├── SentinelConfigUpdateExceptionPublisher
│ ├── SentinelConfigUpdateExceptionPublisherAutoConfiguration
│ ├── SentinelConfigUpdatePublisher
│ ├── SentinelConfigUpdatePublisherAutoConfiguration
│ ├── SentinelConfigWatcher
│ ├── SentinelConfigWatcherAutoConfiguration
│ ├── SentinelConfigWatcherProvider
│ ├── SentinelTransportConfig
│ ├── TransportConfig
│ ├── ZookeeperConfig
│ ├── ZookeeperRegistry
│ ├── ZookeeperRegistryProvider
│ ├── ZookeeperTransportConfig
│ └── ZookeeperUtils
└── utils
├── CollectionUtils
├── ConfigUtils
├── FunctionUtils
├── IpUtils
├── ReflectUtil
├── StringUtils
├── ThreadUtil
├── TimeUtil
└── UuidUtils
三、Sentinel的代码示例
下面是一个简单的Sentinel示例,用于限制某个方法的QPS:
在pom.xml中添加以下依赖:
<dependency>
<groupId>com.alibaba.csp</groupId>
<artifactId>sentinel-core</artifactId>
<version>1.8.2</version>
</dependency>
在应用启动时,创建一个FlowRule对象,表示对某个方法进行限流控制:
FlowRule rule = new FlowRule();
rule.setResource("com.example.service.UserService#getUserById");
rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
rule.setCount(10);
FlowRuleManager.loadRules(Collections.singletonList(rule));
在业务逻辑中,调用需要限流的方法:
public User getUserById(Long id) {
Entry entry = null;
try {
entry = SphU.entry("com.example.service.UserService#getUserById");
// 执行方法
...
} catch (BlockException e) {
// 处理限流
...
} finally {
if (entry != null) {
entry.exit();
}
}
}
以上代码将对com.example.service.UserService#getUserById
方法进行限流,每秒最多只能处理10个请求。
四、总结
Sentinel是一款功能强大的流量控制框架,它通过拦截器和切面的方式实现流量控制、熔断降级等功能,可以有效地保护系统的稳定性和可用性。本文从源码角度分析了Sentinel的实现原理和代码结构,并提供了相关的代码示例,希望对读者有所帮助。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。