将 MyBatis 应用接入 AHAS 应用防护后,可以对其配置流控、降级和系统规则来保证系统稳定性。本文将帮助您了解如何使用 SDK 方式将 MyBatis 应用接入应用防护。

操作步骤

  1. 通过以下任意一种方式,为应用添加依赖。
    • 方式一:在 Pom 文件中添加依赖:
      <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>spring-boot-starter-ahas-sentinel-client</artifactId>
        <!-- 可指定版本号,最新版本见 AHAS 控制台应用防护应用接入页。 -->
        <version>x.y.z</version>
      </dependency>
      说明 在 AHAS 控制台流量防护 > 应用防护 > SDK 应用接入页签查看 Pom 依赖最新版本,将 x.y.z 替换为新版本的版本号。
    • 方式二:添加 JAR 包依赖。
      1. 下载 ahas-sentinel 依赖包
      2. 解压依赖包,并将依赖包中的所有 JAR 包放置在 classpath 下。
  2. 添加拦截器。
    • 若您使用了 MyBatis Spring Boot Starter,则引入 AHAS 依赖后会自动接入(需要 spring-boot-starter-ahas-sentinel-client 1.5.1 及以上版本)。
    • 若您未使用 MyBatis Spring Boot Starter ,则需在 MyBatis 应用的 XML 配置文件中引入 SentinelMyBatisInterceptor 拦截器依赖:
      <?xml version="1.0" encoding="UTF-8" ?>
      <!DOCTYPE configuration
              PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
              "http://mybatis.org/dtd/mybatis-3-config.dtd">
      <configuration>
          <plugins>
            <!-- 引入 AHAS Sentinel 拦截器 -->
              <plugin interceptor="com.alibaba.csp.sentinel.adapter.mybatis.SentinelMyBatisInterceptor"/>
          </plugins>
      </configuration>
  3. 通过以下任意一种方式,配置应用的启动参数。
    • 添加 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>

结果验证

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

后续操作

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

当 MyBatis 应用触发配置的流控、降级或系统保护规则时,会抛出 MyBatisSentinelBlockException 类型的异常,您可以自行捕获该异常并进行处理。