一、本机服务(桌面端)
- 删除 GET /api/health(说明页同步)。
- GET /api/query/{code} 合并状态,一次请求就能决定「展示结果」还是「提示唤起」:
200 { ok, state:"ok", code, loggedIn, user, env, server, data }
401 { ok:false, state:"need-login", ... } / 400 "bad-request" / 404 "not-found" / 500 "error"
不论成败都带 loggedIn/user/env/server;只有网络层失败才代表「软件没启动」。
原因:探活通过 ≠ 查询时软件还在(用户可能中途退出),两次请求之间状态会错位。
二、前端 /local
- api/local.ts:删 localHealth / checkLocalHealth / waitForHealth / waitForLoggedIn;
新增 queryLocal()(非 2xx 但带 state 的 JSON 也正常返回)与 waitForQuery()(轮询同一接口)。
request() 改为先读 body,这样 401 能拿到 state 而不只是状态码。
- LocalServiceView.vue:状态机改为单接口驱动
连不上 → offline(下载/启动提示);need-login → 自动 activate-login + 轮询 query 等登录;
ok → 展示;其它 → 展示错误。
「重新查询」也走同一逻辑:用户中途退掉软件时点重查会**直接落到「服务暂不可用 + 可唤起」提示**,
不再是一个莫名其妙的失败。
- 空 code 也发一次请求(服务端回 400 bad-request + 登录状态),所以没有 code 时同样能驱动页面状态。
三、Chrome 插件(extension/,工作区改动,暂未提交 —— 与另一会话的 WIP 混在同几个文件里)
- 默认目标模板改为 yuncang://open?code={code}:点击「查看打包视频」**直接唤起本机软件并带参**,
不再先开网页;旧的 http 默认模板在配置升级(v2→v3)时自动换成协议模板,用户自定义的不动。
- content.js:按协议分流(http(s) → background 开标签页;其它 → 本页用户手势内用隐藏 iframe 触发)。
- 唤不起的兜底(浏览器不会告诉网页协议是否成功,必须超时猜):
4 秒内页面没失焦 → 右下角卡片「没打开本机软件?」+「在网页中查看」(fallbackUrl)+「下载安装」
(downloadUrl)+ 关闭。
- 新增配置:fallbackUrl(默认 http://localhost:7301/local?code={code})、downloadUrl(留空不显示下载按钮);
options 页与使用说明同步。
四、验证
- /api/health → 404;/api/query/ABC123 → 200 state:ok + data;
/api/query/ → 400 state:bad-request + loggedIn/user/env/server。
- 浏览器 /local?code=ABC123:正常展示;**杀掉软件后点「重新查询」→ 立即显示
「服务暂不可用 / 本地打印服务未启动,请下载安装后再试」+ 下载按钮 + 已安装启动按钮**。
- 插件脚本 node --check 全通过;PSTRules.buildUrl 输出 yuncang://open?code=YT1234567890,
v2 旧配置升级后模板自动变为协议、fallbackUrl/downloadUrl 就位。
- 前端 vue-tsc + vite build 通过;桌面端 0 警告 0 错误。
五、文档
- desktop/README.md:接口表改为两个接口 + 状态码/state 对照表 + 响应示例;
「和前端/插件怎么配合」改为插件直接唤起;新增「插件直接唤起与唤不起时的提示」一节。
331 lines
13 KiB
C#
331 lines
13 KiB
C#
using System;
|
||
using System.Net;
|
||
using System.Text;
|
||
using System.Threading;
|
||
using System.Threading.Tasks;
|
||
|
||
namespace YuncangTrace.LocalService.Services;
|
||
|
||
/// <summary>
|
||
/// 本机 HTTP 服务(只监听 127.0.0.1)
|
||
///
|
||
/// 给浏览器里的页面调用(我们的 `/local` 公共页、以及任何想取数据的前端):
|
||
/// - <c>GET /api/query/{code}</c> 查信息;**同时把服务/登录状态一起返回**(没登录回 401 `state:need-login`),
|
||
/// 页面一次请求就能决定「展示结果」还是「提示唤起」,不再需要单独的探活接口;
|
||
/// - <c>POST /api/activate-login</c> 把登录窗/主界面叫到前台。
|
||
///
|
||
/// ⚠️ 两个坑(都在这里处理好了):
|
||
/// 1. **CORS**:页面同源是站点域名,请求本机属于跨域,必须回
|
||
/// `Access-Control-Allow-Origin` 等头,否则浏览器直接拦掉(表现像「服务没启动」);
|
||
/// 2. **Private Network Access**:公网 https 页面访问 localhost 时,Chrome 会先发
|
||
/// 带 `Access-Control-Request-Private-Network: true` 的预检,必须回
|
||
/// `Access-Control-Allow-Private-Network: true`,否则预检失败。
|
||
///
|
||
/// 用 <see cref="HttpListener"/>(HTTP.sys):绑定 `http://localhost:端口/` 一般不需要管理员权限;
|
||
/// 若报「拒绝访问(5)」,用管理员执行一次:
|
||
/// <c>netsh http add urlacl url=http://localhost:17300/ user=%USERNAME%</c>
|
||
/// </summary>
|
||
public sealed class LocalHttpServer : IDisposable
|
||
{
|
||
/// <summary>监听端口(前端/插件里写死的 17300)</summary>
|
||
public const int Port = 17300;
|
||
|
||
private readonly HttpListener _listener = new();
|
||
private readonly OrderQueryService _queryService;
|
||
private CancellationTokenSource? _cts;
|
||
private Task? _loop;
|
||
|
||
/// <summary>日志回调(服务线程 → UI 线程的桥,UI 那边自己 Dispatcher.Invoke)</summary>
|
||
public event Action<string>? Log;
|
||
|
||
/// <summary>网页请求唤起登录(`POST /api/activate-login`);服务线程触发,订阅方自己切 UI 线程</summary>
|
||
public event Action? LoginRequested;
|
||
|
||
/// <summary>当前是否已登录(由 App 提供,随 `/api/query` 一起返回)</summary>
|
||
public Func<bool>? IsLoggedInProvider { get; set; }
|
||
|
||
/// <summary>当前登录用户显示名(由 App 提供,随 `/api/query` 一起返回)</summary>
|
||
public Func<string?>? UserNameProvider { get; set; }
|
||
|
||
/// <summary>当前后端地址(由 App 提供,随 `/api/query` 一起返回,排障用)</summary>
|
||
public Func<string?>? ServerBaseUrlProvider { get; set; }
|
||
|
||
public LocalHttpServer(OrderQueryService queryService)
|
||
{
|
||
_queryService = queryService;
|
||
}
|
||
|
||
/// <summary>是否已登录(网页靠它判断要不要唤起登录)</summary>
|
||
public bool IsLoggedIn => IsLoggedInProvider?.Invoke() ?? false;
|
||
|
||
/// <summary>浏览器里可直接打开的地址</summary>
|
||
public string BaseUrl => $"http://localhost:{Port}";
|
||
|
||
public bool IsRunning => _listener.IsListening;
|
||
|
||
/// <summary>启动监听;失败抛 <see cref="HttpListenerException"/>(端口被占 / 没权限)</summary>
|
||
public void Start()
|
||
{
|
||
if (IsRunning) return;
|
||
|
||
_listener.Prefixes.Clear();
|
||
// 两个都监听:前端页面默认用 localhost,但改 VITE_LOCAL_SERVICE 用 127.0.0.1 时也得能连
|
||
// (HttpListener 只接受 "注册过的 host",否则直接 400)
|
||
_listener.Prefixes.Add($"{BaseUrl}/");
|
||
_listener.Prefixes.Add($"http://127.0.0.1:{Port}/");
|
||
_listener.Start();
|
||
|
||
_cts = new CancellationTokenSource();
|
||
_loop = Task.Run(() => AcceptLoopAsync(_cts.Token));
|
||
|
||
Log?.Invoke($"服务已启动:{BaseUrl}");
|
||
}
|
||
|
||
public void Stop()
|
||
{
|
||
if (!IsRunning) return;
|
||
|
||
try
|
||
{
|
||
_cts?.Cancel();
|
||
_listener.Stop();
|
||
_listener.Close();
|
||
}
|
||
catch (Exception ex)
|
||
{
|
||
Log?.Invoke($"停止服务时出错:{ex.Message}");
|
||
}
|
||
finally
|
||
{
|
||
Log?.Invoke("服务已停止");
|
||
}
|
||
}
|
||
|
||
private async Task AcceptLoopAsync(CancellationToken token)
|
||
{
|
||
while (!token.IsCancellationRequested && _listener.IsListening)
|
||
{
|
||
HttpListenerContext context;
|
||
try
|
||
{
|
||
context = await _listener.GetContextAsync().ConfigureAwait(false);
|
||
}
|
||
catch (Exception)
|
||
{
|
||
// Stop()/Close() 会让 GetContextAsync 抛异常,属于正常退出路径
|
||
break;
|
||
}
|
||
|
||
_ = Task.Run(() => HandleAsync(context), CancellationToken.None);
|
||
}
|
||
}
|
||
|
||
private async Task HandleAsync(HttpListenerContext context)
|
||
{
|
||
var request = context.Request;
|
||
var response = context.Response;
|
||
|
||
try
|
||
{
|
||
WriteCorsHeaders(request, response);
|
||
|
||
// 预检请求(含 PNA 预检)直接放行
|
||
if (request.HttpMethod.Equals("OPTIONS", StringComparison.OrdinalIgnoreCase))
|
||
{
|
||
response.StatusCode = 204;
|
||
response.Close();
|
||
return;
|
||
}
|
||
|
||
var path = request.Url?.AbsolutePath ?? "/";
|
||
Log?.Invoke($"{request.HttpMethod} {path} ← {request.RemoteEndPoint?.Address}");
|
||
|
||
// 网页请求唤起登录(POST,避免被浏览器的链接预取误触发)
|
||
if (path.Equals("/api/activate-login", StringComparison.OrdinalIgnoreCase))
|
||
{
|
||
if (!request.HttpMethod.Equals("POST", StringComparison.OrdinalIgnoreCase))
|
||
{
|
||
await WriteJsonAsync(response, 405, new { ok = false, message = "请用 POST" }).ConfigureAwait(false);
|
||
return;
|
||
}
|
||
|
||
Log?.Invoke("网页请求唤起登录");
|
||
LoginRequested?.Invoke();
|
||
|
||
await WriteJsonAsync(response, 200, new
|
||
{
|
||
ok = true,
|
||
loggedIn = IsLoggedIn,
|
||
message = IsLoggedIn ? "已登录,已把主界面唤到前台" : "已请求本机软件显示登录窗口",
|
||
}).ConfigureAwait(false);
|
||
return;
|
||
}
|
||
|
||
if (!request.HttpMethod.Equals("GET", StringComparison.OrdinalIgnoreCase))
|
||
{
|
||
await WriteJsonAsync(response, 405, new { ok = false, message = "只支持 GET" }).ConfigureAwait(false);
|
||
return;
|
||
}
|
||
|
||
const string queryPrefix = "/api/query/";
|
||
if (path.StartsWith(queryPrefix, StringComparison.OrdinalIgnoreCase))
|
||
{
|
||
// 一个接口把「软件在跑吗 / 登录了吗 / 查到什么」全返回 ——
|
||
// 网页只发一次请求就能决定展示结果还是提示“唤起”,不会出现“探活通过、真正查询时软件已退出”的错位。
|
||
var code = Uri.UnescapeDataString(path[queryPrefix.Length..]).Trim();
|
||
var loggedIn = IsLoggedIn;
|
||
var user = UserNameProvider?.Invoke();
|
||
var env = BuildInfo.Environment;
|
||
var server = ServerBaseUrlProvider?.Invoke();
|
||
|
||
if (!loggedIn)
|
||
{
|
||
await WriteJsonAsync(response, 401, new
|
||
{
|
||
ok = false,
|
||
state = "need-login",
|
||
code,
|
||
loggedIn = false,
|
||
user,
|
||
env,
|
||
server,
|
||
message = "本机软件未登录,请先在软件里登录",
|
||
}).ConfigureAwait(false);
|
||
return;
|
||
}
|
||
|
||
var result = _queryService.Query(code);
|
||
|
||
if (result.Ok)
|
||
{
|
||
await WriteJsonAsync(response, 200, new
|
||
{
|
||
ok = true,
|
||
state = "ok",
|
||
code,
|
||
loggedIn,
|
||
user,
|
||
env,
|
||
server,
|
||
data = result.Data,
|
||
}).ConfigureAwait(false);
|
||
return;
|
||
}
|
||
|
||
var state = result.StatusCode switch
|
||
{
|
||
400 => "bad-request",
|
||
404 => "not-found",
|
||
_ => "error",
|
||
};
|
||
|
||
await WriteJsonAsync(response, result.StatusCode, new
|
||
{
|
||
ok = false,
|
||
state,
|
||
code,
|
||
loggedIn,
|
||
user,
|
||
env,
|
||
server,
|
||
message = result.Message,
|
||
}).ConfigureAwait(false);
|
||
return;
|
||
}
|
||
|
||
// 浏览器直接打开本机服务时给一个说明页(方便排查、也是手工测试入口)
|
||
if (path == "/" || path.Equals("/index.html", StringComparison.OrdinalIgnoreCase))
|
||
{
|
||
var html = """
|
||
<!doctype html><meta charset="utf-8">
|
||
<title>云仓视频溯源软件(本机服务)</title>
|
||
<style>body{font:14px/1.7 "Microsoft YaHei UI",sans-serif;margin:40px;color:#1f2430}
|
||
code{background:#f3f4f6;padding:1px 6px;border-radius:5px}a{color:#2563eb}</style>
|
||
<h2>云仓视频溯源软件(本机服务)</h2>
|
||
<p>服务运行中,只监听本机(127.0.0.1:17300)。</p>
|
||
<ul>
|
||
<li><code>/api/query/{运单号}</code> 查询(同时返回服务/登录状态;没登录回 401)</li>
|
||
<li><code>POST /api/activate-login</code> 把登录窗叫到前台</li>
|
||
</ul>
|
||
""";
|
||
await WriteHtmlAsync(response, 200, html).ConfigureAwait(false);
|
||
return;
|
||
}
|
||
|
||
await WriteJsonAsync(response, 404, new { ok = false, message = "接口不存在" }).ConfigureAwait(false);
|
||
}
|
||
catch (Exception ex)
|
||
{
|
||
Log?.Invoke($"处理请求出错:{ex.Message}");
|
||
try
|
||
{
|
||
await WriteJsonAsync(response, 500, new { ok = false, message = "本机服务内部错误" }).ConfigureAwait(false);
|
||
}
|
||
catch
|
||
{
|
||
// 响应已经发出去 / 连接断了,忽略
|
||
}
|
||
}
|
||
finally
|
||
{
|
||
try
|
||
{
|
||
response.Close();
|
||
}
|
||
catch
|
||
{
|
||
// 忽略
|
||
}
|
||
}
|
||
}
|
||
|
||
/// <summary>CORS + 私有网络访问(PNA)头</summary>
|
||
private static void WriteCorsHeaders(HttpListenerRequest request, HttpListenerResponse response)
|
||
{
|
||
// 回显 Origin(比写死 * 更稳:以后要带 cookie/凭据也能用)
|
||
var origin = request.Headers["Origin"];
|
||
response.Headers["Access-Control-Allow-Origin"] = string.IsNullOrEmpty(origin) ? "*" : origin;
|
||
response.Headers["Vary"] = "Origin";
|
||
response.Headers["Access-Control-Allow-Methods"] = "GET, POST, OPTIONS";
|
||
response.Headers["Access-Control-Allow-Headers"] = "Content-Type, Accept";
|
||
response.Headers["Access-Control-Max-Age"] = "600";
|
||
|
||
// 公网页面访问 localhost 时,Chrome 会带 Access-Control-Request-Private-Network: true
|
||
if (string.Equals(request.Headers["Access-Control-Request-Private-Network"], "true", StringComparison.OrdinalIgnoreCase))
|
||
{
|
||
response.Headers["Access-Control-Allow-Private-Network"] = "true";
|
||
}
|
||
}
|
||
|
||
private static async Task WriteJsonAsync(HttpListenerResponse response, int statusCode, object? payload)
|
||
{
|
||
var body = JsonUtil.ToJson(payload);
|
||
await WriteTextAsync(response, statusCode, "application/json; charset=utf-8", body).ConfigureAwait(false);
|
||
}
|
||
|
||
private static async Task WriteHtmlAsync(HttpListenerResponse response, int statusCode, string html)
|
||
{
|
||
await WriteTextAsync(response, statusCode, "text/html; charset=utf-8", html).ConfigureAwait(false);
|
||
}
|
||
|
||
private static async Task WriteTextAsync(HttpListenerResponse response, int statusCode, string contentType, string body)
|
||
{
|
||
var bytes = Encoding.UTF8.GetBytes(body);
|
||
|
||
response.StatusCode = statusCode;
|
||
response.ContentType = contentType;
|
||
response.ContentEncoding = Encoding.UTF8;
|
||
response.Headers["Cache-Control"] = "no-store";
|
||
response.ContentLength64 = bytes.Length;
|
||
|
||
await response.OutputStream.WriteAsync(bytes).ConfigureAwait(false);
|
||
}
|
||
|
||
public void Dispose()
|
||
{
|
||
Stop();
|
||
_cts?.Dispose();
|
||
_listener.Close();
|
||
}
|
||
}
|