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/wsHandler/handler/PositionClosesChannelHandler.java | 40 ++++++++++++++++++++++++++++++++--------
1 files changed, 32 insertions(+), 8 deletions(-)
diff --git a/src/main/java/com/xcong/excoin/modules/gateApi/wsHandler/handler/PositionClosesChannelHandler.java b/src/main/java/com/xcong/excoin/modules/gateApi/wsHandler/handler/PositionClosesChannelHandler.java
index deefcdb..3ca98ff 100644
--- a/src/main/java/com/xcong/excoin/modules/gateApi/wsHandler/handler/PositionClosesChannelHandler.java
+++ b/src/main/java/com/xcong/excoin/modules/gateApi/wsHandler/handler/PositionClosesChannelHandler.java
@@ -10,7 +10,17 @@
/**
* 平仓频道处理器。
- * 私有频道，需认证。解析平仓推送后回调 {@link GateGridTradeService#onPositionClose}。
+ *
+ * <h3>数据用途</h3>
+ * 每笔平仓发生时推送 pnl（盈亏金额），累加到 {@code cumulativePnl} 用于判断策略停止条件：
+ * cumulativePnl ≥ overallTp（达到止盈目标）或 ≤ -maxLoss（超过亏损上限）。
+ * 止盈由 Gate 服务端条件单自动触发，平仓后仓位变为 0，盈亏通过本频道推送。
+ *
+ * <h3>推送字段</h3>
+ * contract, side（long / short）, pnl（该次平仓的盈亏，如 "+0.2" 或 "-0.1"）
+ *
+ * <h3>注意</h3>
+ * 平仓盈亏来自服务器端，不受本地计算误差影响。这是策略停止的唯一盈亏判断来源。
*
* @author Administrator
*/
@@ -25,10 +35,27 @@
super(CHANNEL_NAME, apiKey, apiSecret, contract, gridTradeService);
}
+ /**
+ * 处理平仓推送消息。
+ *
+ * <h3>数据提取</h3>
+ * result 数组中每个元素包含：
+ * <ul>
+ * <li>contract：合约名称</li>
+ * <li>side：平仓方向（"long" / "short"）</li>
+ * <li>pnl：本次平仓的盈亏金额（字符串格式，如 "+0.2" / "-0.1"）</li>
+ * </ul>
+ *
+ * <h3>数据处理</h3>
+ * 按合约名称过滤 → 提取 pnl 和 side → 调用 gridTradeService.onPositionClose() 累加盈亏。
+ * pnl 来自服务端，不受本地计算误差影响。
+ *
+ * @param response WebSocket 推送的完整 JSON
+ * @return true 表示已处理（匹配成功）
+ */
@Override
public boolean handleMessage(JSONObject response) {
- String channel = response.getString("channel");
- if (!CHANNEL_NAME.equals(channel)) {
+ if (!CHANNEL_NAME.equals(response.getString("channel"))) {
return false;
}
try {
@@ -43,15 +70,12 @@
}
BigDecimal pnl = new BigDecimal(item.getString("pnl"));
String side = item.getString("side");
- log.info("[{}] 推送: contract={}, side={}, pnl={}",
- CHANNEL_NAME, getContract(), side, pnl);
+ log.info("[{}] 平仓更新, 方向:{}, 盈亏:{}", CHANNEL_NAME, side, pnl);
if (getGridTradeService() != null) {
getGridTradeService().onPositionClose(getContract(), side, pnl);
}
}
- } catch (Exception e) {
- log.error("[{}] 处理数据失败", CHANNEL_NAME, e);
- }
+ } catch (Exception e) { log.error("[{}] 处理数据失败", CHANNEL_NAME, e); }
return true;
}
}
--
Gitblit v1.9.1