feat(版本硬地板): ClientVersionGuardFilter 双模式闸门,默认惰性+只记账
口径出处:四面 9 分文档 §2 后端最后一项。此前全仓唯一的 minClientVersion 在 digitalhuman
里,且 DigitalHumanVersionService:86 写入、:258 读出两处都是**透传**,全树没有一处比较过它
(grep getMinClientVersion 只有这两处命中)——对桌面客户端 API 面零约束。
新增 backend-java/src/main/java/com/nanri/aiimage/config/ClientVersionGuardFilter.java:
读 X-Client-Version,与 aiimage.client-version.min-supported-version 比较,三档开关:
- min 留空(默认)= 闸门整条惰性,逐请求等价于没装;
- enforce=false(默认)= 只记账:Counter aiimage.client.version.floor{verdict,version,enforce}
+ 每个 (verdict,version) 至多一条 [版本地板] WARN(日志去重不吞计数,与 10-06 通知放大同口径);
- enforce=true 才拒,响应体沿用项目约定 HTTP 200 + {success:false, code:4012, message, data}。
另有一条 reject-unreported=false:4.0.46 及更早的装机不知道有这个头,光翻 enforce 就把它们
判死等于用一次配置变更打停全线存量,所以"未上报"默认只进 unreported 桶;报不出格式的
(4.x.6)永不拒。
受管前缀**复用** AdminApiGuardFilter.USER_TOOL_PREFIXES(同一份"桌面客户端直连的用户态前缀"
口径,改成包级可见,不复制清单),另补 /api/client(取凭据第一跳)。/api/version/** 明确不在
名单内——被拒的老客户端必须永远能拿到升级信息,否则闸门把自己变成砖。
ClientVersionGuardFilterTest 12 例(mvn -o test -Dtest=ClientVersionGuardFilterTest:
Tests run: 12, Failures: 0, Errors: 0):两种模式各钉一条正断言(记账必须"响应体一个字节都
不许多"、执法必须"chain 不前进"),另钉默认态零行为、三类非客户端面零判定、unreported 与
unparsable 分桶、名单逐条继承 + 三个排除项、版本解析/比较边界(4.0==4.0.0、4.0<4.0.1、
4.0.46.2>4.0.46、v4.0.6/4..6/4.x.6 判不出)、WARN 去重与计数不相干、min 配置写坏时不拒任何人。
不出包、不重启、不改任何 yml(默认值即现网态)。
This commit is contained in:
@@ -72,8 +72,11 @@ public class AdminApiGuardFilter extends OncePerRequestFilter {
|
||||
* <p>原因:桌面客户端(Python)直连这些接口且不带任何认证头,先于客户端发布开启会
|
||||
* 让线上集采/跟价全线 401。待携带 X-Internal-Token 的新客户端铺开后,把开关置 true
|
||||
* (或把这些前缀从 USER_TOOL_PREFIXES 移除、直接无条件纳入)即可完成收紧。
|
||||
*
|
||||
* <p>包级可见(不是 private):{@code ClientVersionGuardFilter} 复用同一份"桌面客户端直连的
|
||||
* 用户态前缀"口径。**这份清单改动会同时改动两个闸门的覆盖面**,改前先想清楚版本地板是否也该跟着变。
|
||||
*/
|
||||
private static final String[] USER_TOOL_PREFIXES = {
|
||||
static final String[] USER_TOOL_PREFIXES = {
|
||||
"/api/collect-data",
|
||||
"/api/price-track",
|
||||
// 2026-09 全维度审查补:以下前缀此前完全在守卫范围之外。
|
||||
|
||||
@@ -0,0 +1,291 @@
|
||||
package com.nanri.aiimage.config;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.nanri.aiimage.common.api.ApiResponse;
|
||||
import io.micrometer.core.instrument.Counter;
|
||||
import io.micrometer.core.instrument.MeterRegistry;
|
||||
import jakarta.servlet.FilterChain;
|
||||
import jakarta.servlet.ServletException;
|
||||
import jakarta.servlet.http.HttpServletRequest;
|
||||
import jakarta.servlet.http.HttpServletResponse;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.springframework.beans.factory.ObjectProvider;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.core.Ordered;
|
||||
import org.springframework.core.annotation.Order;
|
||||
import org.springframework.stereotype.Component;
|
||||
import org.springframework.web.filter.OncePerRequestFilter;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.LinkedHashMap;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
|
||||
/**
|
||||
* 客户端版本硬地板:桌面客户端(ShuFuAI)上报的 {@value #HEADER} 低于服务端最低支持版本时的判定点。
|
||||
*
|
||||
* <p>此前全仓唯一的 {@code minClientVersion} 在 digitalhuman 模块里,而且只是个**存进库又原样
|
||||
* 吐回 VO 的字段**({@code DigitalHumanVersionService:86} 写入、{@code :258} 读出,两处都是透传,
|
||||
* 全树没有一处比较过它),对桌面客户端的 API 面零约束。本类是那个缺口的真闸门。
|
||||
*
|
||||
* <p>三档开关,默认态 = **现网零行为变更**:
|
||||
* <ul>
|
||||
* <li>{@code aiimage.client-version.min-supported-version}(默认空):留空即整个闸门惰性
|
||||
* ({@link #shouldNotFilter} 直接跳过),与"没装这个过滤器"逐请求等价;</li>
|
||||
* <li>{@code aiimage.client-version.enforce}(默认 false):只**记账**不拒绝——计指标 +
|
||||
* 每个版本号至多一条 WARN,业务响应照常放行。这一档用来在真实装机分布上量"翻 true 会打到
|
||||
* 多少台",量完再决定;</li>
|
||||
* <li>{@code aiimage.client-version.reject-unreported}(默认 false):翻 true 时,
|
||||
* **不报版本**的老客户端要不要一起拒。这一条单独成开关,是因为 4.0.46 及更早的装机根本不知道
|
||||
* 有这个头——把它们算成"低于地板"等于用一次配置变更把存量装机全线打停;默认 false 时它们只进
|
||||
* {@code unreported} 计数,不挨拒。</li>
|
||||
* </ul>
|
||||
* 判不出来的头({@code "abc"}、{@code "4.x.6"})永不被拒,只进 {@code unparsable} 计数:
|
||||
* 一次格式异常不该由客户端承担断服代价。
|
||||
*
|
||||
* <p>受管前缀取自 {@link AdminApiGuardFilter#USER_TOOL_PREFIXES}(**同一份出处**,不复制清单:
|
||||
* 那份常量记的正是"桌面客户端直连的用户态接口"),另加 {@value #CLIENT_ENTRY_PREFIX}
|
||||
* ({@code /api/client}——客户端取凭据的第一跳,不在那份名单里,但它同样得能被地板挡住)。
|
||||
* {@code /api/version/**}(更新检查)与 {@code /api/admin/**}、{@code /api/internal/**} 一律**不在**
|
||||
* 受管集合内:被拒的老客户端必须永远能拿到升级信息,否则闸门把自己变成砖。
|
||||
*
|
||||
* <p>响应体沿用项目约定(HTTP 200 + {@code {success:false, code, message, data}},与
|
||||
* {@code GlobalExceptionHandler} 同形),业务码 {@value #CODE_TOO_OLD}:401/403 已被鉴权与
|
||||
* 越权占用,4011 是被顶下线,这里取同一族的 4012。
|
||||
*
|
||||
* <p>紧急回退:把 {@code min-supported-version} 置空即可(无需重启改代码),或
|
||||
* {@code aiimage.client-version.enforce=false} 退回纯记账。
|
||||
*/
|
||||
@Slf4j
|
||||
@Component
|
||||
@Order(Ordered.LOWEST_PRECEDENCE)
|
||||
public class ClientVersionGuardFilter extends OncePerRequestFilter {
|
||||
|
||||
/** 客户端自报版本的请求头(由 app_client 的 user_token 出口钩子注入,只对自家后端基址生效)。 */
|
||||
public static final String HEADER = "X-Client-Version";
|
||||
|
||||
/** 低于地板时的业务码;与 {@code DeviceSessionPolicy.CODE_KICKED=4011} 同族。 */
|
||||
public static final int CODE_TOO_OLD = 4012;
|
||||
|
||||
/** 取凭据那一跳:桌面端入口,不在 {@link AdminApiGuardFilter#USER_TOOL_PREFIXES} 里,单独补上。 */
|
||||
static final String CLIENT_ENTRY_PREFIX = "/api/client";
|
||||
|
||||
/** 指标名:按 verdict(below/unreported/unparsable)与是否 enforce 打标签,装机分布由 version 标签给出。 */
|
||||
static final String METRIC = "aiimage.client.version.floor";
|
||||
|
||||
private static final String VERDICT_BELOW = "below";
|
||||
private static final String VERDICT_UNREPORTED = "unreported";
|
||||
private static final String VERDICT_UNPARSABLE = "unparsable";
|
||||
|
||||
/** WARN 去重上限:版本号是有限集合,超上限后不再新增键(只继续计数),防无界增长。 */
|
||||
private static final int WARN_KEYS_MAX = 64;
|
||||
|
||||
private final ObjectMapper objectMapper;
|
||||
private final MeterRegistry meterRegistry;
|
||||
private final Set<String> warned = ConcurrentHashMap.newKeySet();
|
||||
|
||||
@Value("${aiimage.client-version.min-supported-version:}")
|
||||
private String minSupportedVersion;
|
||||
|
||||
@Value("${aiimage.client-version.enforce:false}")
|
||||
private boolean enforce;
|
||||
|
||||
@Value("${aiimage.client-version.reject-unreported:false}")
|
||||
private boolean rejectUnreported;
|
||||
|
||||
public ClientVersionGuardFilter(ObjectMapper objectMapper) {
|
||||
this(objectMapper, (MeterRegistry) null);
|
||||
}
|
||||
|
||||
public ClientVersionGuardFilter(ObjectMapper objectMapper, MeterRegistry meterRegistry) {
|
||||
this.objectMapper = objectMapper;
|
||||
this.meterRegistry = meterRegistry;
|
||||
}
|
||||
|
||||
/** 生产构造:Micrometer 注册表可选(无注册表时只留日志,与 {@code IdempotentRetryGuard} 同口径)。 */
|
||||
@Autowired
|
||||
public ClientVersionGuardFilter(ObjectMapper objectMapper,
|
||||
ObjectProvider<MeterRegistry> meterRegistryProvider) {
|
||||
this(objectMapper, meterRegistryProvider == null ? null : meterRegistryProvider.getIfAvailable());
|
||||
}
|
||||
|
||||
/** 闸门是否已配置(最低版本非空)。空 = 惰性,现网默认态。 */
|
||||
public boolean isConfigured() {
|
||||
return minSupportedVersion != null && !minSupportedVersion.trim().isEmpty();
|
||||
}
|
||||
|
||||
@Override
|
||||
protected boolean shouldNotFilter(HttpServletRequest request) {
|
||||
return !isConfigured() || !isClientFacing(request.getRequestURI());
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
|
||||
throws IOException, ServletException {
|
||||
String uri = request.getRequestURI();
|
||||
String reported = headerValue(request);
|
||||
String verdict = verdictOf(reported);
|
||||
if (verdict == null) {
|
||||
chain.doFilter(request, response);
|
||||
return;
|
||||
}
|
||||
count(verdict, reported);
|
||||
if (firstWitness(verdict, reported)) {
|
||||
// 一次配置变更会被每个在跑的客户端逐请求命中:这里按 (verdict, version) 去重,
|
||||
// 量交给指标,日志只留第一条(与 10-06 通知放大的处置同一口径)。
|
||||
log.warn("[版本地板] {} {} 自报版本={} 最低支持={} verdict={} enforce={} —— {}",
|
||||
request.getMethod(), uri, reported, minSupportedVersion.trim(), verdict, enforce,
|
||||
enforce ? "本次已拒绝" : "记账模式,暂不拒绝");
|
||||
}
|
||||
if (shouldReject(verdict)) {
|
||||
writeTooOld(request, response, reported, verdict);
|
||||
return;
|
||||
}
|
||||
chain.doFilter(request, response);
|
||||
}
|
||||
|
||||
/**
|
||||
* 归类:{@value #VERDICT_BELOW}/{@value #VERDICT_UNREPORTED}/{@value #VERDICT_UNPARSABLE};
|
||||
* 达标返回 null(什么都不做)。
|
||||
*/
|
||||
private String verdictOf(String reported) {
|
||||
long[] floor = parse(minSupportedVersion);
|
||||
if (floor == null) {
|
||||
// 配置本身写坏了(比如塞了个 "v4.0"):不猜、不拒,只记一条,等人工把配置改对。
|
||||
return isBlank(reported) ? null : VERDICT_UNPARSABLE;
|
||||
}
|
||||
if (isBlank(reported)) {
|
||||
return VERDICT_UNREPORTED;
|
||||
}
|
||||
long[] actual = parse(reported);
|
||||
if (actual == null) {
|
||||
return VERDICT_UNPARSABLE;
|
||||
}
|
||||
return compare(actual, floor) < 0 ? VERDICT_BELOW : null;
|
||||
}
|
||||
|
||||
/** 只有"确实低于地板"(以及显式打开的 unreported)才拒;unparsable 永不被拒。 */
|
||||
private boolean shouldReject(String verdict) {
|
||||
if (!enforce) {
|
||||
return false;
|
||||
}
|
||||
if (VERDICT_BELOW.equals(verdict)) {
|
||||
return true;
|
||||
}
|
||||
return VERDICT_UNREPORTED.equals(verdict) && rejectUnreported;
|
||||
}
|
||||
|
||||
/** 桌面客户端会走的入口前缀(含取凭据那一跳)。 */
|
||||
static boolean isClientFacing(String uri) {
|
||||
if (uri == null) {
|
||||
return false;
|
||||
}
|
||||
for (String prefix : AdminApiGuardFilter.USER_TOOL_PREFIXES) {
|
||||
if (uri.startsWith(prefix)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return uri.startsWith(CLIENT_ENTRY_PREFIX);
|
||||
}
|
||||
|
||||
private static String headerValue(HttpServletRequest request) {
|
||||
String raw = request.getHeader(HEADER);
|
||||
return raw == null ? "" : raw.trim();
|
||||
}
|
||||
|
||||
private static boolean isBlank(String value) {
|
||||
return value == null || value.isEmpty();
|
||||
}
|
||||
|
||||
/**
|
||||
* 解析点分数字版本:{@code 4.0.46} → {@code [4,0,46]};任何一段非数字(含空串、{@code 4.x})返回 null。
|
||||
* 故意不做"取前缀数字"这类容错:猜出来的版本号会被当成合法装机统计进去。
|
||||
*/
|
||||
static long[] parse(String version) {
|
||||
if (version == null) {
|
||||
return null;
|
||||
}
|
||||
String text = version.trim();
|
||||
if (text.isEmpty()) {
|
||||
return null;
|
||||
}
|
||||
String[] parts = text.split("\\.", -1);
|
||||
long[] segments = new long[parts.length];
|
||||
for (int i = 0; i < parts.length; i++) {
|
||||
String part = parts[i].trim();
|
||||
if (part.isEmpty() || !isAllDigits(part)) {
|
||||
return null;
|
||||
}
|
||||
try {
|
||||
segments[i] = Long.parseLong(part);
|
||||
} catch (NumberFormatException overflow) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
return segments;
|
||||
}
|
||||
|
||||
private static boolean isAllDigits(String text) {
|
||||
for (int i = 0; i < text.length(); i++) {
|
||||
if (text.charAt(i) < '0' || text.charAt(i) > '9') {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/** 逐段比较,短的一方缺段按 0 补:{@code 4.0 == 4.0.0},{@code 4.0 < 4.0.1},{@code 4.0.46.2 > 4.0.46}。 */
|
||||
static int compare(long[] left, long[] right) {
|
||||
int length = Math.max(left.length, right.length);
|
||||
for (int i = 0; i < length; i++) {
|
||||
long a = i < left.length ? left[i] : 0L;
|
||||
long b = i < right.length ? right[i] : 0L;
|
||||
if (a != b) {
|
||||
return Long.compare(a, b);
|
||||
}
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
/** 每个 (verdict, version) 组合只许第一条 WARN 通过;返回 true 表示"这次是第一条"。 */
|
||||
boolean firstWitness(String verdict, String version) {
|
||||
String key = verdict + "@" + version;
|
||||
if (warned.contains(key)) {
|
||||
return false;
|
||||
}
|
||||
if (warned.size() >= WARN_KEYS_MAX) {
|
||||
return false;
|
||||
}
|
||||
return warned.add(key);
|
||||
}
|
||||
|
||||
private void count(String verdict, String version) {
|
||||
if (meterRegistry == null) {
|
||||
return;
|
||||
}
|
||||
Counter.builder(METRIC)
|
||||
.tag("verdict", verdict)
|
||||
.tag("version", isBlank(version) ? "unknown" : version)
|
||||
.tag("enforce", String.valueOf(enforce))
|
||||
.register(meterRegistry)
|
||||
.increment();
|
||||
}
|
||||
|
||||
private void writeTooOld(HttpServletRequest request, HttpServletResponse response,
|
||||
String reported, String verdict) throws IOException {
|
||||
Map<String, String> data = new LinkedHashMap<>();
|
||||
data.put("minSupportedVersion", minSupportedVersion.trim());
|
||||
data.put("reportedVersion", reported);
|
||||
data.put("verdict", verdict);
|
||||
data.put("uri", request.getRequestURI());
|
||||
String message = VERDICT_UNREPORTED.equals(verdict)
|
||||
? "客户端版本未知(未上报 " + HEADER + "),请升级到 " + minSupportedVersion.trim() + " 及以上"
|
||||
: "客户端版本过低(" + reported + "),请升级到 " + minSupportedVersion.trim() + " 及以上";
|
||||
response.setStatus(HttpServletResponse.SC_OK);
|
||||
response.setContentType("application/json;charset=UTF-8");
|
||||
response.getWriter().write(objectMapper.writeValueAsString(
|
||||
new ApiResponse<>(false, message, data, CODE_TOO_OLD)));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user