packServer/desktop/Services/LocalHttpServer.cs
liufumingren fb896272f4 桌面端接入 .NET 8 SDK 并首编译通过;服务地址改为构建期环境配置(开发/生产)
一、工具链
- 本机没有 .NET,微软域名又被网络阻断,改用 curl 从 builds.dotnet.microsoft.com 拉
  dotnet-sdk-8.0.426-win-x64.zip,解压到 %LOCALAPPDATA%\Microsoft\dotnet(免管理员),
  并写入用户 PATH / DOTNET_ROOT / DOTNET_CLI_TELEMETRY_OPTOUT。

二、首次编译暴露的两个真实缺陷(都已修复)
- ProtocolHelper.cs 缺 using System.Collections.Generic(ImplicitUsings=disable 后
  IEnumerable<string> 找不到)。
- App.xaml 少了 BgBrush,LoginWindow/MainWindow 用 StaticResource 引用它 → 编译期查不出,
  运行期一弹登录窗就 XamlParseException 直接退出(事件日志里能看到)。
  已补 BgBrush=#F5F7FA 并注明「缺一个就会运行时炸」。
- 顺带把 WFAC010(WinForms 建议 DPI 改走 ApplicationHighDpiMode)压掉并写明原因:
  本程序宿主是 WPF,走不到 WinForms 的 ApplicationConfiguration,DPI 只能由 manifest 决定。

三、服务地址 = 构建期环境(对齐前端 VITE_BACKEND 的思路)
- csproj:Debug → AppEnvironment=Development、ServerBaseUrl=http://127.0.0.1:7300;
  Release → Production、占位 https://packs.example.com;用 -p:ServerBaseUrl= 覆盖;
  两者通过 AssemblyMetadataAttribute 写进程序集,exe 自带「我是哪个环境」。
- 新增 Services/BuildInfo.cs 读元数据(带兜底,绝不抛)。
- AppSettings:默认值改为 BuildInfo.DefaultServer;等于内置默认值时不落盘(换构建能自动跟随),
  老版本已把默认值写进 settings.json 的也识别为"没改过";新增 UseServer() 支持运行时临时覆盖。
- App:解析 --server=xxx / -s xxx,其次 YUNCANG_SERVER 环境变量,写在构建默认值之前。
- 登录窗:「服务器地址」改叫「服务地址」,右侧显示"开发环境/生产环境"(只展示,由构建决定),
  输入框 ToolTip 说明留空即用当前环境默认地址。
- /api/health 增加 env(Development/Production)与 server(当前后端地址),排障一眼看出装错没有。

四、验证
- Debug / Release / Release+域名覆盖 三种构建均 0 警告 0 错误;
- Debug:health 返回 env=Development、server=http://127.0.0.1:7300;
- Release:env=Production、server=https://packs.example.com;
  Release 加 -p:ServerBaseUrl=https://trace.yuncang.cn 后 server 随之变化;
- 带 --server=http://10.0.0.9:7300 启动:server 被覆盖,settings.json 未被污染;
- health / 未登录 query(401) / activate-login(200,登录窗弹出) / OPTIONS 预检(204+CORS) 全部正常。
- 注意:改 -p: 属性必须 -t:Rebuild,否则 MSBuild 不会重新生成 AssemblyInfo。

五、README
- 新增「环境配置(开发 / 生产)」:构建矩阵、发布时覆盖域名、优先级、默认值不落盘的原因、
  settings.json/session.json 的行为;补了本机 SDK 装在用户目录、需要 DOTNET_ROOT 的说明;
  行为表新增「网页请求唤起登录」一行;health 返回字段更新。
2026-10-17 10:48:11 +08:00

308 lines
12 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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/health</c> 探活:返回 2xx 即认为「软件已启动」
/// - <c>GET /api/query/{code}</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/health` 用)</summary>
public Func<bool>? IsLoggedInProvider { get; set; }
/// <summary>当前登录用户显示名(由 App 提供,供 `/api/health` 用)</summary>
public Func<string?>? UserNameProvider { get; set; }
/// <summary>当前后端地址(由 App 提供,供 `/api/health` 排障用)</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;
}
if (path.Equals("/api/health", StringComparison.OrdinalIgnoreCase)
|| path.Equals("/api/health/", StringComparison.OrdinalIgnoreCase))
{
// ok = 服务在跑(前端只认这个);loggedIn = 本机软件是否已登录(没登录就唤起登录)
await WriteJsonAsync(response, 200, new
{
ok = true,
name = "云仓视频溯源打印服务",
version = typeof(LocalHttpServer).Assembly.GetName().Version?.ToString() ?? "1.0.0",
port = Port,
env = BuildInfo.Environment,
server = ServerBaseUrlProvider?.Invoke(),
loggedIn = IsLoggedIn,
user = UserNameProvider?.Invoke(),
serverTime = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"),
}).ConfigureAwait(false);
return;
}
const string queryPrefix = "/api/query/";
if (path.StartsWith(queryPrefix, StringComparison.OrdinalIgnoreCase))
{
// 未登录不查(网页会先把登录窗叫出来)
if (!IsLoggedIn)
{
await WriteJsonAsync(response, 401, new { ok = false, message = "本机软件未登录,请先在软件里登录", loggedIn = false }).ConfigureAwait(false);
return;
}
var code = Uri.UnescapeDataString(path[queryPrefix.Length..]).Trim();
var result = _queryService.Query(code);
if (result.Ok)
{
await WriteJsonAsync(response, 200, result.Data).ConfigureAwait(false);
}
else
{
await WriteJsonAsync(response, result.StatusCode, new { ok = false, 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><a href="/api/health">/api/health</a> 探活(含登录状态)</li>
<li><code>/api/query/{运单号}</code> 按运单号查信息(需已登录)</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();
}
}