liufumingren 30ad162c69 修复唤起:协议自动指向当前 exe + 单实例监听提前 + 自包含发布(不再依赖 DOTNET_ROOT)
现象:网页点「启动本机软件」/双击 exe 弹「You must install .NET Desktop Runtime」,
网页表现为唤起没反应、查询失败。

根因有两个:
1. 协议注册表指向的是 bin\Debug 的 framework-dependent exe,它靠 DOTNET_ROOT 找运行时;
   而浏览器/资源管理器/协议拉起的进程拿不到我们临时设的环境变量 → 直接弹安装提示。
   更糟的是协议只在主窗口手动点按钮才注册,换目录/换构建后注册表一直是旧路径。
2. 单实例的命名管道监听是在「登录完成、主窗口出现」之后才 StartListening,
   用户卡在登录窗期间被协议唤起 → 参数无人接收(第二个实例连不上管道就直接退出了)。

修复:
- App.EnsureProtocolRegistered():每次启动把 HKCU 的 command 校正到 Environment.ProcessPath,
  与当前 exe 一致时跳过(幂等);不一致时重注册并记日志(含原路径,方便排查)。
- _single.StartListening() 提前到启动服务之后、登录之前。
- 登录期间收到唤起:存 pending code 并把登录窗叫到前面,登录完成后自动查询(原有逻辑保留)。
- 抽出 BringLoginWindowToFront(),OnLoginRequested / 第二次双击(不带 URL)也走它——
  以前登录期间再双击 exe 是彻底没反应的。
- MainWindow 的协议状态改为显示「是否指向当前 exe」,指向旧路径时提示重启会自动校正。

分发形态改为自包含:
- desktop/nuget.config 指向华为云 NuGet 镜像(本机访问不了 api.nuget.org),
  自包含发布要下载 Microsoft.*.App.Runtime.win-x64;
- dotnet publish -c Release -r win-x64 --self-contained true -p:PublishSingleFile=true
  -p:IncludeNativeLibrariesForSelfExtract=true -o publish → 单文件约 154 MB,双击/协议唤起都能直接跑。
- publish/ 已在 .gitignore 里。

实测(全程清掉 DOTNET_ROOT,模拟用户环境):
- 冷启动:yuncang://open?code=COLD123 → 进程起来 → 恢复登录 → 自动查询 COLD123;
- 已运行时:yuncang://open?code=TEST999 → 管道转发到原实例 → 主窗口前置并查询;
- 注册表自动从 bin\Debug 校正到 publish\...exe(日志有记录);
- 网页 /local?code=ABC123 → 已登录 → 正常展示查询结果(真实桌面端,非 mock)。
2026-10-17 10:58:03 +08:00
..

云仓视频溯源软件(本机服务 / WPF)

Windows 桌面端,用前端 /local 公共页和 Chrome 插件做对接:

  • 登录页:账号密码登录后端(POST /api/web/auth/login)拿 user JWT,令牌存本机; 下次启动先用 /api/web/me 验证,还有效就直接进主界面;
  • 在 127.0.0.1:17300 起一个本机 HTTP 服务,浏览器里的页面直接查询本机数据;
  • 注册 yuncang:// 启动协议,网页可以「叫醒」本软件(前提是已安装);
  • 托盘图标:关窗口只是缩到托盘(本机服务不能因关窗断掉),双击托盘恢复窗口, 右键菜单有「打开主界面 / 服务地址 / 退出」;
  • 防多开:全局互斥体 + 命名管道 —— 第二个实例不会抢 17300 端口,而是把 yuncang://open?code=xxx 转给已运行的实例(在托盘里也会被叫出来并直接查询),然后自己退出。
desktop/
├── YuncangTrace.LocalService.csproj   # net8.0-windows + UseWPF + UseWindowsForms(托盘)
├── app.manifest                       # 高 DPI / 兼容性声明
├── Assets/app.ico                     # 程序/托盘图标(tools/make-icon.ps1 生成)
├── App.xaml / App.xaml.cs             # 防多开 + 托盘 + 登录流程 + 本机服务生命周期
├── LoginWindow.xaml / .xaml.cs        # 服务器地址 / 账号 / 密码 / 记住账号 / 自动恢复登录
├── MainWindow.xaml / .xaml.cs         # 服务状态、地址、协议注册、测试查询、日志、退出登录
└── Services/
    ├── LocalHttpServer.cs             # HttpListener + CORS + PNA
    ├── OrderQueryService.cs           # ★ 按运单号查数据(接真实数据源的地方)
    ├── ApiClient.cs                   # 登录 / 校验令牌(用到的全部后端接口)
    ├── SessionStore.cs                # 登录态(%LOCALAPPDATA%\YuncangTrace\session.json)
    ├── AppSettings.cs                 # 服务器地址 / 记住账号(%LOCALAPPDATA%\YuncangTrace\settings.json)
    ├── ProtocolHelper.cs              # yuncang:// 注册/反注册、解析 code
    ├── SingleInstance.cs              # 互斥体 + 命名管道转发参数(防多开)
    ├── TrayIconService.cs             # 托盘图标与菜单
    ├── AppLog.cs                      # 全局日志缓冲(窗口没开时的日志也不丢)
    └── JsonUtil.cs                    # JSON 序列化(中文不转义)

登录 / 托盘 / 防多开的行为

场景 行为
首次启动 先起本机服务(17300)与托盘,再弹登录页 → 登录成功才出主窗口
已有令牌 登录窗一闪而过:/api/web/me 通过就直接进主窗口;失效则清掉令牌留在登录页
关窗口(X) 隐藏到托盘,本机服务继续跑(第一次会冒一个气泡提示)
再次双击 exe / 点网页「启动本机软件」 不会开第二个:把 yuncang://open?code=… 通过命名管道转给已运行实例
托盘双击 / 右键「打开主界面」 恢复窗口
「退出登录」 清令牌 → 关闭主窗口 → 回到登录页(取消登录则退出程序)
网页请求唤起登录(POST /api/activate-login) 未登录:登录窗弹到最前;已登录:主界面弹到最前(不影响本机服务)
托盘右键「退出」 真正退出(dispose 托盘与本机服务)

环境配置(开发 / 生产)

和前端 VITE_BACKEND 一个思路:由构建决定,不靠用户手填。

构建 env 默认后端
dotnet build(Debug) Development http://127.0.0.1:7300(= 前端 dev 代理的后端)
dotnet build -c Release Production https://packs.example.com(占位,打包时必须覆盖)

打包正式版时指定真实域名:

dotnet publish -c Release -r win-x64 -p:ServerBaseUrl=https://trace.example.com -o publish

优先级(从高到低):

  1. 启动参数 --server=http://192.168.1.10:7300(临时,不落盘);
  2. 环境变量 YUNCANG_SERVER;
  3. -p:ServerBaseUrl= 注入的构建默认值;
  4. 用户在登录页手改并保存的地址(settings.json)。

几个细节:

  • 地址等于内置默认值时,settings.json 里存空串 —— 所以换 Debug/Release 构建能自动跟随, 不会被上一次构建的默认值钉死;只有用户手改过的地址才会持久化。
  • 换地址后不会复用旧令牌(session.json 里的 ServerBaseUrl 对不上就要求重新登录)。
  • GET /api/health 会回 env 和 server,排查环境是否装错时先看这两个字段。

环境要求

  • 编译:.NET 8 SDK(dotnet --list-sdks 能看到 8.x)
  • 只运行已发布的 exe:.NET 8 Desktop Runtime(不需要 SDK)

本机 SDK 装在用户目录(免管理员):%LOCALAPPDATA%\Microsoft\dotnet, 已加入用户 PATH 和 DOTNET_ROOT。新开的终端才能直接用 dotnet; 老终端里临时用:$env:DOTNET_ROOT="$env:LOCALAPPDATA\Microsoft\dotnet"; $env:Path="$env:DOTNET_ROOT;$env:Path"。 直接双击 bin\...\*.exe 也需要 DOTNET_ROOT 已生效(否则报 “You must install .NET”)。 官方安装包:winget install --id Microsoft.DotNet.SDK.8 -e(要 UAC)。

构建 / 运行 / 发布

cd desktop

dotnet build                             # 编译(Debug = 开发环境,连本地 7300)
dotnet build -c Release                  # 编译(Release = 生产环境,默认地址见上一节)
dotnet run                               # 直接跑(调试)

# ★ 发给用户、以及要用「网页叫醒」的话,必须用自包含发布
dotnet publish -c Release -r win-x64 --self-contained true `
  -p:PublishSingleFile=true -p:IncludeNativeLibrariesForSelfExtract=true `
  -p:ServerBaseUrl=https://正式域名 -o publish

为什么要自包含:dotnet build 出来的 exe 是 framework-dependent 的, 它自己会去找 C:\Program Files\dotnet 或 DOTNET_ROOT。从浏览器/资源管理器/协议拉起的进程 拿不到我们临时设的环境变量,于是弹「You must install .NET Desktop Runtime」—— 网页上表现就是「唤起没反应 / 弹安装提示」。

自包含单文件(约 154 MB)把运行时打进去了,双击和协议唤起都能直接跑,用户什么都不用装。

desktop/nuget.config 指向华为云 NuGet 镜像(本机访问不了 api.nuget.org)—— 自包含发布要下载 Microsoft.*.App.Runtime.win-x64 运行时包,没有镜像会 restore 失败。

开发阶段想让 bin\Debug 的 exe 也能直接双击,两个办法:装官方 SDK/Desktop Runtime 到标准位置, 或者每次用发布产物验证唤起。

本机接口(前端 /local 页用的就是这三个)

服务固定监听 http://localhost:17300(端口写在前端页面与插件里)。 代码里同时注册了 http://127.0.0.1:17300/ 前缀 —— HttpListener 只接受「注册过的 host」, 不注册的话用 127.0.0.1 访问会直接被回 400(前端改 VITE_LOCAL_SERVICE 时就会碰到)。

浏览器直接打开 http://localhost:17300/ 会看到一个说明页(列了接口,方便排查)。

方法 路径 说明
GET /api/health 验活 + 登录状态:2xx 即认为软件已启动。返回 { ok, name, version, port, env, server, loggedIn, user, serverTime }(env = Development/Production)
GET /api/query/{code} 按运单号查信息(需已登录,否则 401 { ok:false, loggedIn:false, message })。成功时字段平铺在顶层({ code, orderNo, ... })
POST /api/activate-login 把本机软件的登录窗叫到前台(已登录时把主界面叫到前台)。网页发现 loggedIn:false 时自动调它

示例:

curl http://localhost:17300/api/health
curl http://localhost:17300/api/query/321408064481776
curl -X POST http://localhost:17300/api/activate-login

为什么唤起登录用 POST:GET 会被浏览器/聊天工具的链接预取误触发,POST 不会。

浏览器跨域(页面在站点域名上,请求的是 localhost)必须回这些响应头,代码里已经处理:

  • Access-Control-Allow-Origin(回显 Origin)、Allow-Methods(GET, POST, OPTIONS)、Allow-Headers、Max-Age
  • Access-Control-Allow-Private-Network: true —— 公网 https 页面访问 localhost 时 Chrome 会发 私有网络预检(PNA),不回这个头预检就失败

⚠️ 千万别只回 200 不带 CORS 头:浏览器会直接拦掉,前端看起来和「软件没启动」一模一样。

启动协议(网页叫醒本软件)

yuncang://open?code=xxx。注册写在 HKCU(免管理员):

HKEY_CURRENT_USER\Software\Classes\yuncang
  (默认)         = "URL:云仓视频溯源软件"
  "URL Protocol" = ""
  \shell\open\command
    (默认)       = "C:\...\YuncangTrace.LocalService.exe" "%1"
  • 每次启动都会自动把注册项校正到「当前这个 exe」(幂等)。这一点很关键: 换目录安装、从 bin\Debug 换成发布版、重新装一遍之后,注册表里残留的旧路径会让网页 唤起一个不存在 / 缺运行时的 exe(典型现象就是弹「You must install .NET」或干脆没反应)。 界面上仍可手动「取消启动协议」;
  • 手工注册/排查:
reg add "HKCU\Software\Classes\yuncang" /ve /d "URL:云仓视频溯源软件" /f
reg add "HKCU\Software\Classes\yuncang" /v "URL Protocol" /d "" /f
reg add "HKCU\Software\Classes\yuncang\shell\open\command" /ve /d '"C:\Path\YuncangTrace.LocalService.exe" "%1"' /f
reg query "HKCU\Software\Classes\yuncang\shell\open\command"
  • 打包工具里对应:Inno Setup 的 [Registry] 段、NSIS 的 WriteRegStr HKCU ...、Electron 的 app.setAsDefaultProtocolClient('yuncang');
  • 协议名改了要同步前端 VITE_APP_PROTOCOL(默认 yuncang)。

和前端 / 插件怎么配合

  1. WMS 页面上点运单号旁的按钮 → 插件打开 http://<站点>/local?code=<运单号>(/local/ 也认);
  2. /local 页先探活 http://localhost:17300/api/health:
    • 连不上 → 提示「服务暂不可用 / 本地打印服务未启动,请下载安装后再试」+ 下载按钮; 点「已安装,启动本机软件」会走 yuncang://open?code=...,然后每 1s 轮询探活;
    • 连上了但 loggedIn:false(软件没登录)→ 页面自动 POST /api/activate-login 把本机登录窗叫到前台,然后每秒探活等登录完成(最长 30s),登录好自动继续查询;
    • 已登录 → 直接调 /api/query/{code} 展示(页面顶部会显示「本机软件已登录:xxx」)。
  3. 本软件被协议拉起时,会拿到 yuncang://open?code=xxx 参数:已经开着就转给原窗口(单实例), 没开就启动 → 先登录 → 登录完自动查询这个码(登录前收到的 code 会先存着)。 单实例的命名管道监听在登录之前就起来了,所以用户卡在登录窗时被网页唤起也不会丢参数 (只会把登录窗叫到前面,登录完自动查)。

★ 接真实数据

只改一处:Services/OrderQueryService.cs 的 Query(string? code)。

public QueryResult Query(string? code)
{
    var value = (code ?? "").Trim();
    if (value.Length == 0) return QueryResult.BadRequest("缺少运单号");

    // 例:查本地 SQLite / 扫本地打包视频目录 / 调内部接口
    var row = _db.FindByCode(value);
    if (row is null) return QueryResult.NotFound($"没有找到 {value} 的记录");

    return QueryResult.Success(new Dictionary<string, object?>
    {
        ["code"] = row.Code,
        ["orderNo"] = row.OrderNo,
        ["printStatus"] = row.PrintStatus,
        ["videoPath"] = row.VideoPath,
    });
}

返回对象平铺即可,前端页面会把顶层字段渲染成「项目 / 值」两列(字段随便加)。

常见问题

现象 处理
启动报「没有绑定端口的权限」/ Access is denied (5) 管理员执行 netsh http add urlacl url=http://localhost:17300/ user=%USERNAME%,或改成以当前用户身份运行
报端口被占用(错误 32) 已经开了一个实例(单实例会把参数转过去);检查任务管理器里的残留进程
网页提示服务不可用,但软件在跑 先用浏览器直接打开 http://localhost:17300/api/health:打不开→防火墙/端口;打得开→多半是 CORS 头没回
点网页「启动本机软件」没反应 协议没注册(界面看「启动协议」状态);或浏览器拦了自动跳转(必须用户点击)
唤起时弹「You must install .NET Desktop Runtime」 唤起的是 bin\Debug 这类 framework-dependent 的 exe(拿不到 DOTNET_ROOT)。用自包含发布产物,并让它启动一次以校正注册表
改了协议名 注册表重注册 + 前端 VITE_APP_PROTOCOL 同步 + 插件目标地址同步