From 5d884f3ba7340d34891a5e50d2e8b7fa83c84c73 Mon Sep 17 00:00:00 2001
From: Administrator <15274802129@163.com>
Date: Mon, 11 May 2026 14:11:18 +0800
Subject: [PATCH] docs(gateApi): 更新代码注释和文档说明
---
src/main/java/com/xcong/excoin/modules/gateApi/GateGridTradeService.java | 135 ++++++++++++++++++++++++++++++++++++++++++--
1 files changed, 128 insertions(+), 7 deletions(-)
diff --git a/src/main/java/com/xcong/excoin/modules/gateApi/GateGridTradeService.java b/src/main/java/com/xcong/excoin/modules/gateApi/GateGridTradeService.java
index a09714d..ee9b68d 100644
--- a/src/main/java/com/xcong/excoin/modules/gateApi/GateGridTradeService.java
+++ b/src/main/java/com/xcong/excoin/modules/gateApi/GateGridTradeService.java
@@ -139,6 +139,20 @@
// ---- 初始化 ----
+ /**
+ * 初始化策略环境。
+ *
+ * <h3>执行顺序</h3>
+ * <ol>
+ * <li>获取用户 ID（用于私有频道订阅 payload）</li>
+ * <li>获取账户信息 → 记录初始本金</li>
+ * <li>如需要，切换为双向持仓模式</li>
+ * <li>如需要，调整持仓模式（single/dual）</li>
+ * <li>清除旧的止盈止损条件单</li>
+ * <li>平掉所有已有仓位</li>
+ * <li>设置杠杆倍数</li>
+ * </ol>
+ */
public void init() {
try {
ApiClient detailClient = new ApiClient();
@@ -194,6 +208,19 @@
}
}
+ /**
+ * 平掉当前合约的所有已有仓位。
+ *
+ * <h3>平仓策略</h3>
+ * <ul>
+ * <li>单向持仓：size=相反数，reduceOnly=true，市价 IOC 平仓</li>
+ * <li>双向持仓：size=0，close=false，autoSize=LONG/SHORT，reduceOnly=true，市价 IOC 全平</li>
+ * </ul>
+ *
+ * <h3>注意事项</h3>
+ * 双向持仓模式下必须使用 autoSize 参数，不能直接传负数 size，
+ * 否则 Gate API 会拒绝（双向模式下空头 size 为负是正常的持仓方向）。
+ */
private void closeExistingPositions() {
try {
List<Position> positions = futuresApi.listPositions(SETTLE).execute();
@@ -234,6 +261,10 @@
// ---- 启动/停止 ----
+ /**
+ * 启动网格策略。重置所有状态变量和队列，进入 WAITING_KLINE 等待首根 K 线。
+ * 仅当当前状态为 WAITING_KLINE 或 STOPPED 时才允许启动。
+ */
public void startGrid() {
if (state != StrategyState.WAITING_KLINE && state != StrategyState.STOPPED) {
log.warn("[Gate] 策略已在运行中, state:{}", state);
@@ -256,6 +287,10 @@
log.info("[Gate] 网格策略已启动");
}
+ /**
+ * 停止网格策略。取消所有条件单 → 关闭交易线程池。
+ * 状态设为 STOPPED，K 线回调将直接返回不再处理。
+ */
public void stopGrid() {
state = StrategyState.STOPPED;
executor.cancelAllPriceTriggeredOrders();
@@ -265,6 +300,24 @@
// ---- K线回调 ----
+ /**
+ * K 线回调入口。由 {@link CandlestickChannelHandler} 在收到 WebSocket K 线推送时调用。
+ *
+ * <h3>处理流程</h3>
+ * <ol>
+ * <li>更新 lastKlinePrice → 计算 unrealizedPnl（浮动盈亏）</li>
+ * <li>STOPPED → 直接返回（仅保留盈亏更新）</li>
+ * <li>WAITING_KLINE → 切换为 OPENING → 异步提交基底双开（开多+开空）</li>
+ * <li>OPENING → 等待仓位推送回调生成队列，此处返回</li>
+ * <li>ACTIVE → 执行 processShortGrid + processLongGrid</li>
+ * </ol>
+ *
+ * <h3>注意</h3>
+ * 基底双开下单提交到 GateTradeExecutor 的独立线程池中异步执行，
+ * 成交状态由 onPositionUpdate 回调驱动，不阻塞 WS 回调线程。
+ *
+ * @param closePrice K 线收盘价（即当前最新成交价）
+ */
public void onKline(BigDecimal closePrice) {
lastKlinePrice = closePrice;
updateUnrealizedPnl();
@@ -293,6 +346,26 @@
// ---- 仓位推送回调 ----
+ /**
+ * 仓位推送回调。由 {@link PositionsChannelHandler} 在收到 WebSocket 仓位更新时调用。
+ *
+ * <h3>处理逻辑</h3>
+ * <ul>
+ * <li><b>有仓位 (size ≠ 0)</b>：
+ * <ul>
+ * <li>首次开仓（基底）：标记 baseOpened=true，记录基底入场价，双基底都成交后生成网格队列</li>
+ * <li>仓位净增加（size > 之前记录值）：说明网格触发了新开仓 → 设止盈条件单</li>
+ * <li>仓位减少或不变（止盈平仓后）：仅更新 positionSize，不重复设止盈</li>
+ * </ul>
+ * </li>
+ * <li><b>无仓位 (size = 0)</b>：清空活跃标记和持仓量</li>
+ * </ul>
+ *
+ * @param contract 合约名称
+ * @param mode 持仓模式（DUAL_LONG / DUAL_SHORT）
+ * @param size 持仓张数（多头为正、空头为负）
+ * @param entryPrice 当前持仓加权均价（交易所计算）
+ */
public void onPositionUpdate(String contract, Position.ModeEnum mode, BigDecimal size,
BigDecimal entryPrice) {
if (state == StrategyState.STOPPED || state == StrategyState.WAITING_KLINE) {
@@ -352,6 +425,17 @@
// ---- 平仓推送回调 ----
+ /**
+ * 平仓推送回调。由 {@link PositionClosesChannelHandler} 在收到平仓推送时调用。
+ *
+ * <h3>累加规则</h3>
+ * cumulativePnl += pnl。止盈平仓时 pnl > 0，止损平仓时 pnl < 0。
+ * 累加后检查停止条件：≥ overallTp 或 ≤ -maxLoss。
+ *
+ * @param contract 合约名称
+ * @param side 平仓方向（"long" / "short"）
+ * @param pnl 本次平仓的盈亏金额
+ */
public void onPositionClose(String contract, String side, BigDecimal pnl) {
if (state == StrategyState.STOPPED) {
return;
@@ -370,6 +454,10 @@
// ---- 网格队列处理 ----
+ /**
+ * 尝试生成网格队列。双基底（多+空）都成交后才触发：
+ * 生成空仓队列 + 多仓队列 → 状态切换为 ACTIVE。
+ */
private void tryGenerateQueues() {
if (baseLongOpened && baseShortOpened) {
generateShortQueue();
@@ -381,6 +469,12 @@
}
}
+ /**
+ * 生成空仓价格队列。
+ * 以空头基底入场价 shortBaseEntryPrice 为基准，按 gridRate 递减生成 gridQueueSize 个价格元素：
+ * <pre>shortBaseEntryPrice × (1 − gridRate × i), i=1..gridQueueSize</pre>
+ * 队列降序排列（大→小），方便 processShortGrid 中从头遍历。
+ */
private void generateShortQueue() {
shortPriceQueue.clear();
BigDecimal step = config.getGridRate();
@@ -392,6 +486,12 @@
log.info("[Gate] 空队列:{}", shortPriceQueue);
}
+ /**
+ * 生成多仓价格队列。
+ * 以多头基底入场价 longBaseEntryPrice 为基准，按 gridRate 递增生成 gridQueueSize 个价格元素：
+ * <pre>longBaseEntryPrice × (1 + gridRate × i), i=1..gridQueueSize</pre>
+ * 队列升序排列（小→大），方便 processLongGrid 中从头遍历。
+ */
private void generateLongQueue() {
longPriceQueue.clear();
BigDecimal step = config.getGridRate();
@@ -473,12 +573,11 @@
for (int i = 1; i <= matched.size(); i++) {
BigDecimal elem = first.multiply(BigDecimal.ONE.subtract(step.multiply(BigDecimal.valueOf(i)))).setScale(1, RoundingMode.HALF_UP);
if (longEntryPrice.compareTo(BigDecimal.ZERO) > 0
- && elem.subtract(longEntryPrice).abs().compareTo(longEntryPrice.multiply(step)) < 0) {
- log.info("[Gate] 多队列跳过:{}", elem);
+ && currentPrice.subtract(longEntryPrice).abs().compareTo(longEntryPrice.multiply(step)) < 0) {
+ log.info("[Gate] 多队列跳过(price≈longEntry):{}", elem);
continue;
}
longPriceQueue.add(elem);
-
log.info("[Gate] 多队列增加:{}", elem);
}
longPriceQueue.sort(BigDecimal::compareTo);
@@ -561,13 +660,11 @@
for (int i = 1; i <= matched.size(); i++) {
BigDecimal elem = first.multiply(BigDecimal.ONE.add(step.multiply(BigDecimal.valueOf(i)))).setScale(1, RoundingMode.HALF_UP);
if (shortEntryPrice.compareTo(BigDecimal.ZERO) > 0
- && elem.subtract(shortEntryPrice).abs().compareTo(shortEntryPrice.multiply(step)) < 0) {
-
- log.info("[Gate] 空队列跳过:{}", elem);
+ && currentPrice.subtract(shortEntryPrice).abs().compareTo(shortEntryPrice.multiply(step)) < 0) {
+ log.info("[Gate] 空队列跳过(price≈shortEntry):{}", elem);
continue;
}
shortPriceQueue.add(elem);
-
log.info("[Gate] 空队列增加:{}", elem);
}
shortPriceQueue.sort((a, b) -> b.compareTo(a));
@@ -580,6 +677,16 @@
// ---- 保证金安全阀 ----
+ /**
+ * 保证金安全阀检查。
+ *
+ * <p>实时查询当前保证金占用额（positionInitialMargin），计算其占初始本金的比例。
+ * 比例 ≥ marginRatioLimit（默认 20%）时拒绝开仓，但仍照常更新队列。
+ *
+ * <p>查询失败时默认放行（返回 true），避免因 REST API 异常导致策略完全停滞。
+ *
+ * @return true=安全可开仓 / false=保证金超限跳过开仓
+ */
private boolean isMarginSafe() {
try {
FuturesAccount account = futuresApi.listFuturesAccounts(SETTLE);
@@ -595,6 +702,10 @@
// ---- 工具 ----
+ /**
+ * 取反字符串数字。如 "1" → "-1"，"-2" → "2"。
+ * 用于开空单时将正数张数转为负数。
+ */
private String negate(String qty) {
return qty.startsWith("-") ? qty.substring(1) : "-" + qty;
}
@@ -630,6 +741,9 @@
/**
* 根据配置的 PnLPriceMode 返回计价价格。
+ * MARK_PRICE 模式优先使用标记价格（外部注入），未注入时回退到最新成交价。
+ *
+ * @return 计价价格，可能为 null
*/
private BigDecimal resolvePnlPrice() {
if (config.getUnrealizedPnlPriceMode() == GateConfig.PnLPriceMode.MARK_PRICE
@@ -639,11 +753,18 @@
return lastKlinePrice;
}
+ /** @return 最新 K 线价格（每次 onKline 更新） */
public BigDecimal getLastKlinePrice() { return lastKlinePrice; }
+ /** 设置标记价格（外部注入，MARK_PRICE 模式时用于盈亏计算） */
public void setMarkPrice(BigDecimal markPrice) { this.markPrice = markPrice; }
+ /** @return 策略是否处于活跃状态（非 STOPPED 且非 WAITING_KLINE） */
public boolean isStrategyActive() { return state != StrategyState.STOPPED && state != StrategyState.WAITING_KLINE; }
+ /** @return 累计已实现盈亏（平仓推送驱动累加） */
public BigDecimal getCumulativePnl() { return cumulativePnl; }
+ /** @return 当前未实现盈亏（每根 K 线实时计算） */
public BigDecimal getUnrealizedPnl() { return unrealizedPnl; }
+ /** @return Gate 用户 ID（用于私有频道订阅 payload） */
public Long getUserId() { return userId; }
+ /** @return 当前策略状态 */
public StrategyState getState() { return state; }
}
--
Gitblit v1.9.1