阿里云应用高可用服务 AHAS接入 MyBatis 应用

操作步骤

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. 在 MyBatis 应用的 Pom 文件中引入 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.demo.db.mybatis.interceptor.SentinelMyBatisInterceptor"/>
       </plugins>
   </configuration>

3. 通过以下任意一种方式，配置应用的启动参数。
   • 添加 JVM -D 参数。

     非公网

     公网

     //将 AppName 替换为自定义的应用名称
     -Dproject.name=AppName

     //将 AppName 替换为自定义的应用名称，将 <license> 替换为真实值。
     -Dproject.name=AppName
     -Dahas.license=<license>

   • 修改 Spring Property 配置文件。

     如果您已使用 Spring 框架，且希望将配置写入 Spring Property 文件中，请参见以下步骤：

     1. 在 Pom 文件中引入以下依赖：

        <dependency> 
          <groupId>com.alibaba.csp</groupId>
          <artifactId>spring-boot-starter-ahas-sentinel-client</artifactId>
          <!-- 可指定版本号，最新版本见 AHAS 控制台流控降级应用接入页引导。 -->
          <version>x.y.z</version>
        </dependency>

        
        说明 在Dubbo 应用接入页签查看 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>

结果验证

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

后续操作

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

• 流控规则
• 降级规则
• 系统规则

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