操作场景
本文介绍在本地开发 Java 应用,通过 polaris-sdk 的方式接入 TSE 治理中心(北极星网格),并实现服务的服务限流功能。
前提条件
在开发前,请确保您已经下载并安装了 Java 和 Maven。
操作步骤
步骤1:引入北极星依赖
1. 引入 polaris sdk 依赖
修改应用根目录下的
pom.xml
,为polaris-java
添加dependencyManagement
:<dependencyManagement><dependencies><dependency><groupId>com.tencent.polaris</groupId><artifactId>polaris-dependencies</artifactId><version>${version}</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement>
说明:
2. 引入 polaris starter
<dependencies><dependency><groupId>com.tencent.polaris</groupId><artifactId>polaris-all</artifactId></dependency></dependencies>
步骤2:添加北极星配置文件 polaris.yml
1. 在项目的 main/resources 目录下创建 polaris.yml 文件用于初始化 polaris-java SDK。
2. 在 polaris.yml 文件中配置应用名、polaris(北极星)服务端地址等信息。服务端地址详细参见:引擎管理 > 客户端访问地址。
global:serverConnectors:- id: polarisprotocol: grpcaddresses:# 地址需要替换成您创建的北极星引擎的客户端访问地址。- 127.0.0.1:8091#描述: 监控及日志数据上报相关配置statReporter:#描述: 是否启用上报enable: trueplugin:prometheus:type: push# 描述: 设置 pushgateway 的地址, 仅 type == push 时生效# 地址需要替换成您创建的北极星引擎的客户端访问地址。address: 127.0.0.1:9091#描述:设置metric数据推送到pushgateway的执行周期#范围:[1s:...],默认值:10spushInterval: 10s
步骤3:应用开发
1.初始化 LimitAPI 实例:
import com.tencent.polaris.ratelimit.factory.LimitAPIFactory;public static void main(String[] args) throws Exception {LimitAPI limitAPI = LimitAPIFactory.createLimitAPI();}
2.请求配额
QuotaRequest quotaRequest = new QuotaRequest();// 设置需要进行限流的服务信息:设置命名空间信息quotaRequest.setNamespace(String namespace);// 设置需要进行限流的服务信息:设置服务名称信息quotaRequest.setService(String service);// 设置本次被调用的方法信息quotaRequest.setMethod(String method);// 设置本次的请求标签quotaRequest.setArguments(Set<Argument> arguments)// 设置需要申请的请求配额数量quotaRequest.setCount(1);
说明:
如果当前 QuotaRequest 还不支持 AddArgument 方法,同时服务端版本 >= 1.11.0,SetLabels 对应的 key 名称如下:
路径: $path
方法: $method
请求头: $header.{标签键}
请求参数: $query.{标签键}
主调服务: $caller_service
主调IP: $caller_ip
自定义: {标签键}
2.发起配额申请请求
在接收到请求之后对 QuotaRequest 结构体完成初始化后,只需要调用 LimitAPI.GetQuota 方法即可完成本次请求配额的申请。
QuotaResponse resp = limitAPI.getQuota(registerRequest);