将 Spring Boot 应用接入 AHAS 应用流控降级后，可以对其配置流控、隔离、降级、系统或热点规则来保证系统稳定性。本文将帮助您了解如何使用 SDK 方式将 Spring Boot 应用接入应用流控降级。

操作步骤

  1. 登录 AHAS 控制台，然后在页面左上角选择地域。
  2. 在左侧导航栏中选择流控降级 > 应用流控。
  3. 在应用列表页面右上角单击新应用接入，然后选择 Java SDK 接入 > Spring Boot 应用接入页签。
    在Spring Boot 应用接入 页面查看 Pom 依赖最新版本和 License 信息（非公网地域不需要）。
    图 1. Spring Boot 应用接入
    spring boot 应用接入
  4. 在 Spring Boot 应用的 Pom 文件中引入依赖： 
    <dependency>
  <groupId>com.alibaba.csp</groupId>
  <artifactId>spring-boot-starter-ahas-sentinel-client</artifactId>
  <!-- 可指定版本号，最新版本见 AHAS 控制台流控降级应用接入页。 -->
  <version>x.y.z</version>
</dependency>
    说明 在Spring Boot 应用接入页签查看 Pom 依赖最新版本，将 x.y.z 替换为新版本的版本号。
  5. 在应用工程中添加埋点
    • 添加 HTTP 埋点： 引入 spring-boot-starter-ahas-sentinel-client 依赖后，应用会自动添加 Web 接口埋点。
    • 添加自定义埋点：
      1. 引入spring-boot-starter-aop。
        说明 若您的工程中已引入此依赖，则跳过此步骤。
      2. 在业务方法使用注解作为埋点。

        若不配置 BlockHandler，则被流控降级时方法会直接抛出 BlockException，若方法未定义 Throws BlockException 则会被 JVM 包装一层 UndeclaredThrowableException。BlockHandler 和 Fallback 函数的方法签名有限制，详情请参见配置触发规则后的逻辑。 

        @SentinelResource(value = "getUserById")
public User getUserById(String id) {
  return new User(id);
}
        说明 若您从 1.5.1 之前的版本升级到 1.5.1，或自己额外引入了 Web filter 等的 bean，需要先将之前注册 bean 的相关代码去掉，否则可能会导致重复统计。
  6. 通过以下任意一种方式，配置应用的启动参数。
    • 添加 JVM -D 参数。 
      ahas.namespace=default
project.name=AppName
      //将 AppName 替换为自定义的应用名称，将 <license> 替换为真实值。
-Dproject.name=AppName
-Dahas.license=<license>
    • 在 application.properties 文件中添加以下内容： 
      #指定您要接入的特定的 AHAS 环境
ahas.namespace=default
#自定义您的应用名称
project.name=AppName
      #指定您要接入的特定的 AHAS 环境
ahas.namespace=default
#自定义您的应用名称
project.name=AppName
#配置 license 信息
ahas.license=<license>
  7. （可选）您可以自定义 Spring Boot 应用触发限流、降级或系统保护规则时的处理逻辑。
    • 若添加 HTTP 埋点，则使用 Web Servlet Filter 方式配置处理逻辑，参见 Web Servlet Filter。
    • 若添加自定义埋点，则使用注解方式配置处理逻辑，参见注解方式。
    说明 若未执行此步骤，当 Web 接口触发流控降级规则时，返回默认的提示信息（状态码为 429）；注解方式接口默认抛出 BlockException 异常类的子类（触发流控规则，则抛出流控异常 FlowException；触发降级规则，则抛出降级异常 DegradeException），若方法未定义 throws BlockException 则会被 JVM 包装一层 UndeclaredThrowableException。

结果验证

启动应用并调用配置埋点的方法，该应用将出现在 AHAS 控制台流控降级 > 应用流控页面，若有用户访问该应用，该应用的监控详情页面有能看到配置埋点的方法。

后续操作

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