From 31cc693c228f2f2feb23bbda6da43f0f8db5fbe4 Mon Sep 17 00:00:00 2001
From: Administrator <15274802129@163.com>
Date: Mon, 11 May 2026 14:20:34 +0800
Subject: [PATCH] docs(gateApi): 更新代码注释和文档说明
---
src/main/java/com/xcong/excoin/modules/gateApi/GateTradeExecutor.java | 165 ++++++++++++++++++++++++++++++++----------------------
1 files changed, 97 insertions(+), 68 deletions(-)
diff --git a/src/main/java/com/xcong/excoin/modules/gateApi/GateTradeExecutor.java b/src/main/java/com/xcong/excoin/modules/gateApi/GateTradeExecutor.java
index 40b49c1..6de0e63 100644
--- a/src/main/java/com/xcong/excoin/modules/gateApi/GateTradeExecutor.java
+++ b/src/main/java/com/xcong/excoin/modules/gateApi/GateTradeExecutor.java
@@ -1,7 +1,6 @@
package com.xcong.excoin.modules.gateApi;
import io.gate.gateapi.ApiClient;
-import io.gate.gateapi.GateApiException;
import io.gate.gateapi.api.FuturesApi;
import io.gate.gateapi.models.FuturesInitialOrder;
import io.gate.gateapi.models.FuturesOrder;
@@ -24,8 +23,11 @@
* 下单 REST API 调用可能耗时数百毫秒，若同步执行会阻塞 WS 回调线程，导致心跳超时误判。
* 本类将所有 REST 调用提交到独立线程池异步执行。
*
+ * <h3>回调设计</h3>
+ * 每个下单方法接受 onSuccess/onFailure 两个 Runnable。
+ * 基底开仓时 onSuccess 用于标记基底已开，网格触发时通常为 null（成交状态由仓位推送驱动）。
+ *
* <h3>线程模型</h3>
- * 单线程 ThreadPoolExecutor + 有界队列 64 + CallerRunsPolicy：
* <ul>
* <li><b>单线程</b>：保证下单顺序（开多→开空→止盈单），避免并发竞争</li>
* <li><b>有界队列 64</b>：防止堆积。极端行情下最多累积 64 个任务</li>
@@ -35,9 +37,9 @@
*
* <h3>调用链</h3>
* <pre>
- * GateGridTradeService.onKline → executor.openLong/openShort → REST API
- * GateGridTradeService.onPositionUpdate → executor.openLong/openShort → REST API
- * (每一次开仓后) → executor.placeTakeProfit → REST API
+ * GateGridTradeService.onKline → executor.openLong/openShort (基底双开 + 网格触发)
+ * GateGridTradeService.onPositionUpdate → executor.placeTakeProfit (开仓成交后设止盈)
+ * GateGridTradeService.stopGrid → executor.cancelAllPriceTriggeredOrders
* </pre>
*
* @author Administrator
@@ -71,7 +73,8 @@
}
/**
- * 优雅关闭：等待 10 秒，超时则强制中断。
+ * 优雅关闭：等待 10 秒让队列中的任务执行完毕，超时则强制中断。
+ * 关闭后的 REST 调用将通过 CallerRunsPolicy 直接在提交线程执行。
*/
public void shutdown() {
executor.shutdown();
@@ -84,92 +87,111 @@
}
/**
- * 异步市价开多。
- * <p>创建 IOC 市价单（price=0），数量为正数。成功后调用 onSuccess 回调。
+ * 异步 IOC 市价开多。quantity 为正数（如 "1"）。
*
- * @param quantity 数量（正数，如 "10"）
- * @param onSuccess 成功后回调，在交易线程中执行
+ * @param quantity 开仓张数（正数）
+ * @param onSuccess 成交成功回调（可为 null）
+ * @param onFailure 成交失败回调（可为 null）
*/
- public void openLong(String quantity, Runnable onSuccess) {
+ public void openLong(String quantity, Runnable onSuccess, Runnable onFailure) {
+ openPosition(quantity, "t-grid-long", "开多", onSuccess, onFailure);
+ }
+
+ /**
+ * 异步 IOC 市价开空。quantity 为负数（如 "-1"）。
+ *
+ * @param quantity 开仓张数（负数）
+ * @param onSuccess 成交成功回调（可为 null）
+ * @param onFailure 成交失败回调（可为 null）
+ */
+ public void openShort(String quantity, Runnable onSuccess, Runnable onFailure) {
+ openPosition(quantity, "t-grid-short", "开空", onSuccess, onFailure);
+ }
+
+ /**
+ * 通用异步 IOC 市价下单。
+ *
+ * @param size 下单张数（正=开多 / 负=开空）
+ * @param text 订单标记文本（如 "t-grid-long"），用于区分订单来源
+ * @param label 日志标签（如 "开多"/"开空"）
+ * @param onSuccess 成功回调
+ * @param onFailure 失败回调
+ */
+ private void openPosition(String size, String text, String label, Runnable onSuccess, Runnable onFailure) {
executor.execute(() -> {
try {
FuturesOrder order = new FuturesOrder();
order.setContract(contract);
- order.setSize(quantity);
+ order.setSize(size);
order.setPrice("0");
order.setTif(FuturesOrder.TifEnum.IOC);
- order.setText("t-grid-long");
+ order.setText(text);
FuturesOrder result = futuresApi.createFuturesOrder(SETTLE, order, null);
- log.info("[TradeExec] 开多成功, price:{}, id:{}", result.getFillPrice(), result.getId());
- if (onSuccess != null) onSuccess.run();
+ log.info("[TradeExec] {}成功, 价格:{}, id:{}", label, result.getFillPrice(), result.getId());
+ if (onSuccess != null) {
+ onSuccess.run();
+ }
} catch (Exception e) {
- log.error("[TradeExec] 开多失败", e);
+ log.error("[TradeExec] {}失败", label, e);
+ if (onFailure != null) {
+ onFailure.run();
+ }
}
});
}
/**
- * 异步市价开空。
- * <p>创建 IOC 市价单（price=0），size 需为负数。
+ * 异步创建止盈条件单（仓位计划止盈止损）。
*
- * @param negQuantity 负数数量（如 "-10"）
- * @param onSuccess 成功后回调
- */
- public void openShort(String negQuantity, Runnable onSuccess) {
- executor.execute(() -> {
- try {
- FuturesOrder order = new FuturesOrder();
- order.setContract(contract);
- order.setSize(negQuantity);
- order.setPrice("0");
- order.setTif(FuturesOrder.TifEnum.IOC);
- order.setText("t-grid-short");
- FuturesOrder result = futuresApi.createFuturesOrder(SETTLE, order, null);
- log.info("[TradeExec] 开空成功, price:{}, id:{}", result.getFillPrice(), result.getId());
- if (onSuccess != null) onSuccess.run();
- } catch (Exception e) {
- log.error("[TradeExec] 开空失败", e);
- }
- });
- }
-
- /**
- * 异步创建止盈条件单。
- * <p>使用 Gate 的 PriceTriggeredOrder：服务器监控价格，达到触发价后自动平仓。
- * 如果账户已有同方向同规则的条件单（label=UNIQUE），自动清除后重试一次。
+ * <p>使用 Gate 的 {@code PriceTriggeredOrder} API：服务器监控价格，达到触发价后自动平指定张数。
+ * order_type 使用 {@code plan-close-*-position}（仓位计划止盈止损），
+ * 支持指定 size 部分平仓，多次触发的止盈单互不影响。
+ *
+ * <h3>为何不用 close-*-position</h3>
+ * {@code close-long-position} / {@code close-short-position} 仅支持全部平仓（size=0），
+ * 且双仓模式还需额外设置 {@code auto_size}。网格策略需要指定张数部分平仓，
+ * 因此必须使用 {@code plan-close-long-position} / {@code plan-close-short-position}。
*
* @param triggerPrice 触发价格
* @param rule 触发规则（NUMBER_1: ≥ 触发价，NUMBER_2: ≤ 触发价）
- * @param orderType stop 类型（close-long-position / close-short-position）
- * @param autoSize 双仓平仓方向（close_long / close_short）
+ * @param orderType stop 类型（plan-close-long-position / plan-close-short-position）
+ * @param size 平仓张数（正=平空，负=平多）
*/
public void placeTakeProfit(BigDecimal triggerPrice,
FuturesPriceTrigger.RuleEnum rule,
String orderType,
- String autoSize) {
+ String size) {
executor.execute(() -> {
- FuturesPriceTriggeredOrder order = buildTriggeredOrder(triggerPrice, rule, orderType, autoSize);
+ FuturesPriceTriggeredOrder order = buildTriggeredOrder(triggerPrice, rule, orderType, size);
try {
TriggerOrderResponse response = futuresApi.createPriceTriggeredOrder(SETTLE, order);
- log.info("[TradeExec] 止盈单已创建, tp:{}, orderType:{}, id:{}",
- triggerPrice, orderType, response.getId());
- } catch (GateApiException e) {
- if ("AUTO_USER_EXIST_POSITION_ORDER".equals(e.getErrorLabel())) {
- log.warn("[TradeExec] 止盈单已存在，清除后重试");
- try {
- futuresApi.cancelPriceTriggeredOrderList(SETTLE, contract);
- TriggerOrderResponse response = futuresApi.createPriceTriggeredOrder(SETTLE, order);
- log.info("[TradeExec] 止盈单重试成功, tp:{}, id:{}", triggerPrice, response.getId());
- } catch (Exception retryEx) {
- log.error("[TradeExec] 止盈单重试失败", retryEx);
- }
- } else {
- log.error("[TradeExec] 止盈单创建失败, tp:{}", triggerPrice, e);
- }
+ log.info("[TradeExec] 止盈单已创建, 触发价:{}, 类型:{}, size:{}, id:{}",
+ triggerPrice, orderType, size, response.getId());
} catch (Exception e) {
- log.error("[TradeExec] 止盈单创建失败, tp:{}", triggerPrice, e);
+ log.error("[TradeExec] 止盈单创建失败, 触发价:{}, size:{}, 立即市价止盈", triggerPrice, size, e);
+ marketClose(size);
}
});
+ }
+
+ /**
+ * 市价止盈：在止盈条件单创建失败时立即市价平仓。
+ * size 与止盈单保持一致（负=平多，正=平空）。
+ */
+ private void marketClose(String size) {
+ try {
+ FuturesOrder order = new FuturesOrder();
+ order.setContract(contract);
+ order.setSize(size);
+ order.setPrice("0");
+ order.setTif(FuturesOrder.TifEnum.IOC);
+ order.setReduceOnly(true);
+ order.setText("t-grid-mkt-close");
+ FuturesOrder result = futuresApi.createFuturesOrder(SETTLE, order, null);
+ log.info("[TradeExec] 市价止盈成功, 价格:{}, size:{}, id:{}", result.getFillPrice(), size, result.getId());
+ } catch (Exception e) {
+ log.error("[TradeExec] 市价止盈也失败, size:{}", size, e);
+ }
}
/**
@@ -179,22 +201,30 @@
executor.execute(() -> {
try {
futuresApi.cancelPriceTriggeredOrderList(SETTLE, contract);
- log.info("[TradeExec] 已清除所有止盈止损单");
+ log.info("[TradeExec] 已清除所有止盈止损条件单");
} catch (Exception e) {
- log.error("[TradeExec] 清除止盈止损单失败", e);
+ log.error("[TradeExec] 清除止盈止损条件单失败", e);
}
});
}
/**
* 构建 FuturesPriceTriggeredOrder 对象。
+ *
* <p>策略=0（价格触发），price_type=0（最新价），expiration=0（永不过期），
* tif=IOC（立即成交或取消），reduce_only=true（只减仓不开新仓）。
+ *
+ * <h3>size 参数说明</h3>
+ * <ul>
+ * <li>plan-close-long-position：size 为负，表示平多仓多少张</li>
+ * <li>plan-close-short-position：size 为正，表示平空仓多少张</li>
+ * </ul>
+ * 每次只平指定张数，不会全平仓位，多个止盈单可并存且互不影响。
*/
private FuturesPriceTriggeredOrder buildTriggeredOrder(BigDecimal triggerPrice,
FuturesPriceTrigger.RuleEnum rule,
String orderType,
- String autoSize) {
+ String size) {
FuturesPriceTrigger trigger = new FuturesPriceTrigger();
trigger.setStrategyType(FuturesPriceTrigger.StrategyTypeEnum.NUMBER_0);
trigger.setPriceType(FuturesPriceTrigger.PriceTypeEnum.NUMBER_0);
@@ -204,11 +234,10 @@
FuturesInitialOrder initial = new FuturesInitialOrder();
initial.setContract(contract);
- initial.setSize(0L);
+ initial.setSize(Long.parseLong(size));
initial.setPrice("0");
initial.setTif(FuturesInitialOrder.TifEnum.IOC);
initial.setReduceOnly(true);
- initial.setAutoSize(autoSize);
FuturesPriceTriggeredOrder order = new FuturesPriceTriggeredOrder();
order.setTrigger(trigger);
--
Gitblit v1.9.1