Sentinel 提供了一套基于注解的 API,允许开发者以声明式的方式使用 Sentinel 的功能,包括流量控制、熔断降级等。以下是 Sentinel 注解支持的主要功能及其使用方法:
1. @SentinelResource
注解
@SentinelResource
注解是最基础的注解,用于标记一个方法作为 Sentinel 的资源,可以为其配置流量控制和熔断规则。
示例:
import com.alibaba.csp.sentinel.annotation.SentinelResource;
public class ExampleService {
@SentinelResource(value = "hello", exceptionsToIgnore = {NullPointerException.class})
public String hello(String name) {
if (name == null) {
throw new NullPointerException("name is null");
}
return "Hello, " + name;
}
}
在这个例子中,hello
方法被标记为 Sentinel 资源,value
属性指定了资源名称,exceptionsToIgnore
属性指定了忽略哪些异常类型。
2. @SentinelParam
注解
@SentinelParam
注解用于指定方法参数作为流量控制或熔断规则的一部分,特别适用于热点参数限流。
示例:
import com.alibaba.csp.sentinel.annotation.SentinelParam;
public class ExampleService {
@SentinelResource(value = "greet")
public String greet(@SentinelParam(name = "userId") Long userId) {
// 方法体...
}
}
这里,greet
方法的 userId
参数被标记为 Sentinel 参数,可以用来做基于用户 ID 的限流。
3. @SentinelFallBack
注解
@SentinelFallBack
注解用于指定方法的降级逻辑,即当被监控的方法触发熔断或降级策略时,将调用该注解标记的方法。
示例:
public class ExampleService {
@SentinelResource(value = "hello", fallback = "helloFallback")
public String hello(String name) {
// 方法体...
}
public String helloFallback(String name, Throwable e) {
return "Oops, something went wrong!";
}
}
在上面的例子中,hello
方法设置了 fallback
方法 helloFallback
,当 hello
方法触发熔断时,将调用 helloFallback
方法。
4. @SentinelBlockHandler
注解
@SentinelBlockHandler
注解用于处理 Sentinel 抛出的异常,通常是在触发限流或熔断时调用。
示例:
public class ExampleService {
@SentinelResource(value = "hello", fallback = "helloFallback")
public String hello(String name) {
// 方法体...
}
@SentinelBlockHandler
public String handleBlock(String name, BlockException ex) {
return "Sorry, too many requests!";
}
}
在上面的示例中,handleBlock
方法将在 hello
方法触发限流或熔断时被调用。
使用步骤
- 引入依赖:确保项目中引入了 Sentinel 的核心库和注解驱动。
- 定义资源:使用
@SentinelResource
标记需要保护的方法。 - 配置规则:通过 Sentinel 控制台或其他方式配置具体的限流和熔断规则。
- 处理异常:可选地,使用
@SentinelBlockHandler
和@SentinelFallBack
处理异常情况。
这些注解的使用可以帮助开发者以更加简洁、声明式的方式来应用 Sentinel 的功能,而不需要在代码中显式地进行流量控制和异常处理。