通过在业务逻辑上添加注解的方式将应用接入应用流控降级,可以对调用方法进行注解埋点,减小对代码的入侵。本文将介绍如何添加注解将应用接入 AHAS 应用流控降级。

操作步骤

  1. 通过以下任意一种方式,为应用添加依赖。
    • 方式一:在 Pom 文件中添加依赖:
      <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>ahas-sentinel-client</artifactId>
        <version>x.y.x</version>
      </dependency>
      说明 在 AHAS 控制台流控降级 > 应用接入 > SDK 应用接入页签查看 Pom 依赖最新版本,将 x.y.z 替换为新版本的版本号。
    • 方式二:添加 JAR 包依赖。
      1. 下载 ahas-sentinel 依赖包
      2. 解压依赖包,将依赖包中的所有 JAR 包放置在 classpath 下。
  2. 引入 Spring AOP 的相关依赖。
    • 非 Spring Boot 应用需引入 spring-aop 依赖,选择版本后可查看对应的引入代码示例。
    • Spring Boot 或 Spring Cloud 应用需引入 spring-boot-starter-aop 依赖,选择版本后可查看对应的引入代码示例。
  3. 将 SentinelResourceAspect 注册为一个 Spring Bean:
    @Configuration
    public class SentinelAspectConfiguration {
      @Bean
      public SentinelResourceAspect sentinelResourceAspect() {
        return new SentinelResourceAspect();
      }
    }
  4. 在业务方法上添加 @SentinelResource 注解:
    // 原本的业务方法
    @SentinelResource(value = "getUserById")
    public User getUserById(String id) {
      return new User(id);
    }
  5. 通过以下任意一种方式,配置应用的启动参数。
    • 添加 JVM -D 参数。
      //将 AppName 替换为自定义的应用名称
      -Dproject.name=AppName
      //将 AppName 替换为自定义的应用名称,将 <license> 替换为真实值。
      -Dproject.name=AppName
      -Dahas.license=<license>
    • 修改 Spring Property 配置文件。

      如果您正在使用 Spring,并且希望将配置写入 Spring Property 文件中,参照以下步骤:

      1. 在 pom.xml 中引入以下依赖:
        <dependency>
          <groupId>com.alibaba.csp</groupId>
          <artifactId>spring-boot-starter-ahas-sentinel-client</artifactId>
          <!-- 可指定版本号,最新版本见 AHAS 控制台流控降级应用接入页引导。 -->
          <version>x.y.z</version>
        </dependency>
        说明自定义埋点页签查看 Pom 依赖最新版本,将 x.y.z 替换为新版本的版本号。
      2. 在 application.properties 配置文件中,配置如下:
        #指定您要接入的特定的 AHAS 环境
        ahas.namespace=default
        #自定义您的应用名称
        project.name=AppName
        #指定您要接入的特定的 AHAS 环境
        ahas.namespace=default
        #自定义您的应用名称
        project.name=AppName
        #配置 license 信息
        ahas.license=<license>
  6. (可选)使用注解方式配置应用触发限流、降级或系统保护规则时的处理逻辑。 参见注解方式
    说明 若未执行此步骤,当应用触发流控降级规则时,默认抛出 BlockException 异常类的子类(触发流控规则,则抛出流控异常 FlowException;触发降级规则,则抛出降级异常 DegradeException)。

结果验证

启动应用并调用配置埋点的方法。若应用出现在 AHAS 控制台流控降级 > 应用流控页面,且在该应用的监控详情页面有能看到配置埋点的方法,则说明接入成功。

后续操作

为应用配置流控降级规则请参见以下文档: