Files
qlib/frontend/web/lib/strategy.ts
T
Simon 23972e7063 feat: 股息率案例口径 + 策略库与图表统一 + 回测存档完整化
汇总三轮未提交的开发(每轮均在本机 MariaDB + 真实浏览器上验证):

1) 股息率案例(全市场股息率最高 n 只,默认 20,每 m 月择股)
   - 新增日频估值表 daily_basic + 迁移;股息率因子(dv_ratio / dividend_yield / TTM)
   - 名称历史表 stock_name_history:剔除 ST 按**择股日当时名称**判定,消除
     「曾高股息后 ST」的股息陷阱(实测 3.70pp 偏差)
   - 区间择股/调仓双周期(m 择股 / y 调仓)、指数成分与白名单、停牌近似剔除
   - 复权因子口径核对(4,164,742 行、缺失 0.0%)、收盘价成交与涨跌停拦单
   - 案例实测:2020-01-01~2026-09-04 总收益 +24.86%(年化 3.52%、回撤 -28.58%)

2) 策略库与前端统一
   - strategy 表 + CRUD/PUT 原地更新 + `describe_strategy` 按 spec 真实推导
     「一句话说明 + 计算公式 + 执行步骤 + 注意事项」(与引擎实执行规则同源)
   - 任何出现股票代码处都成对显示名称且可点击进个股页
   - 全站图表基座统一 TradingView Lightweight Charts(ECharts 依赖、
     锁文件、组件与文档标注一并清除),买卖点标记只落在真实交易日上

3) 回测存档完整化(可往复查看)
   - 同步端点(POST /api/backtests、/api/factor-tests)此前完全不落库 → 现在同样归档,
     归档 id 经响应头 X-Experiment-Id 返回(不破坏 response_model)
   - data_version 首次真实写入(数据快照指纹:最新交易日 + 各表规模)
   - 个股收益曲线默认**全量保存**(此前硬截断 60 只);超出体积预算才裁剪,
     并写 archive_meta(机器可读)+ unimplemented(人可读)如实标注
   - 列表 kind/q 过滤 + X-Total-Count(此前 limit=50 静默截断)、DELETE 归档
   - 只读归档页 /experiments/{id}(Server Component,SSR 直出**选股条件**与
     **交易执行依据**);结果视图按 kind 分发(backtest/factor_test/selection),
     非回测归档不套用回测口径
   - 新增 CLI:prune_experiments(保留策略,默认 dry-run)、
     restore_experiment_from_job(从 Job 副本按原 id 重建被删的历史归档,默认 dry-run)

门禁:pytest 388 passed、ruff All checks passed、tsc 0 错误、图表单测 7 passed、
next build 成功、契约脚本 verify_strategy_workspace 59/59(含按 kind 逐类验证归档页)。
2026-09-20 07:31:04 +08:00

94 lines
3.2 KiB
TypeScript

"use client";
/**
* 策略说明的获取钩子。
*
* 说明/公式由后端 `describe_strategy` 从 spec **真实推导**(不是前端拼字符串):
* 这样「页面显示的公式」与「引擎实际执行的规则」只有一个来源,
* 不会出现文案与实现漂移(本平台最怕的问题)。
*
* 两个入口:
* - `useStrategyDoc(params)`:未保存的参数也能实时预览(POST /strategies/describe),
* 带去抖,避免每次按键都请求。
* - `useStrategyDocById(id)`:已保存策略(GET /strategies/{id}/describe)。
*/
import { useEffect, useMemo, useRef, useState } from "react";
import { apiGet, apiPost } from "@/lib/api";
import type { StrategyDoc } from "@/lib/types";
import { paramsToSpec, type StrategyParams } from "@/components/StrategyParamsForm";
export interface DocState {
doc: StrategyDoc | null;
loading: boolean;
error: string;
}
const EMPTY: DocState = { doc: null, loading: false, error: "" };
/** 未保存参数 → 说明(去抖 500ms) */
export function useStrategyDoc(params: StrategyParams | null, enabled = true): DocState {
const [state, setState] = useState<DocState>(EMPTY);
const timer = useRef<ReturnType<typeof setTimeout> | null>(null);
// 只依赖会改变说明的字段,避免改「初始资金」也重新请求
const key = useMemo(() => {
if (!params) return "";
return JSON.stringify({
f: params.factors,
a: params.priceAdjustment,
n: params.topN,
x: params.holdX,
m: params.mMonths,
y: params.yMonths,
r: params.rebalance,
fp: params.fillPolicy,
c: params.conditions,
s: params.excludeSt,
l: params.minListingDays,
cost: [params.commission, params.stamp, params.slippage, params.minCommission],
});
}, [params]);
useEffect(() => {
if (!params || !enabled || !key) {
setState(EMPTY);
return;
}
let alive = true;
if (timer.current) clearTimeout(timer.current);
setState((s) => ({ ...s, loading: true }));
timer.current = setTimeout(() => {
apiPost<StrategyDoc>("/strategies/describe", paramsToSpec(params))
.then((doc) => alive && setState({ doc, loading: false, error: "" }))
.catch((e: Error) => alive && setState({ doc: null, loading: false, error: e.message }));
}, 500);
return () => {
alive = false;
if (timer.current) clearTimeout(timer.current);
};
// key 已覆盖所有影响说明的字段
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [key, enabled]);
return state;
}
/** 已保存策略 → 说明 */
export function useStrategyDocById(id: string | null): DocState {
const [state, setState] = useState<DocState>(EMPTY);
useEffect(() => {
if (!id) {
setState(EMPTY);
return;
}
let alive = true;
setState({ doc: null, loading: true, error: "" });
apiGet<StrategyDoc>(`/strategies/${encodeURIComponent(id)}/describe`)
.then((doc) => alive && setState({ doc, loading: false, error: "" }))
.catch((e: Error) => alive && setState({ doc: null, loading: false, error: e.message }));
return () => {
alive = false;
};
}, [id]);
return state;
}