Files
ShadowsocksX-NG/ShadowsocksX-NG2/App/Composition/MainApp.swift
T
Qiu Yuzhou fb428f12bc refactor(app): 按分层重组 App/ 源码目录
App/ 根目录原有 73 个散落源文件,已无法从目录读出任何分组信息。

按「目录即分层」重组为 Composition / Application / Presentation / UI /
PlatformEffects / Resources 六个目录,UI 层再按子视图分目录(Workspace、
Home、Servers(含 Plugin)、Subscriptions、Rules、Settings、Diagnostics、
StatusMenu)。纯移动:类型名、模块名与 import 均未改动,App/ 根层不再有
散落文件。

配套改动:

- project.yml:Core 测试镜像的 excludes 由裸文件名改为 `**/` 递归形式。
  XcodeGen 的 exclude 不跨 `/`,裸名只匹配 App 根层;MainApp.swift 下移后
  旧写法会静默失效,把 @main 组合根编进测试镜像。info.path 与
  entitlements.path 指向 App/Resources/;并排除 `**/*.md`——App/ 下任何
  非源码文件都会被 XcodeGen 收进 Resources 阶段并封进签名后的 bundle。
- SkeletonTests 的架构守卫由「默认扫描全部 App/ + 7 个豁免文件 + 1 个豁免
  前缀 + 4 个豁免目录」改为正面圈定 App/UI/,豁免登记全部删除;新增运行时
  适配器放进 Application/ 即自动落在扫描范围外,无需再登记。
- README 工程结构说明同步;根 .gitignore 的生成物路径随 Resources/ 归位。

验证:clean build 0 error;task test 1022 用例全通过(含两个架构守卫);
task format 无改动(证明纯移动);task lint 与移动前同为 21 条内容型
warning;packaging-gate.sh ALL CHECKS PASSED,确认 plist/entitlements 归位
后签名与 entitlements 语义不变。

注意:迁移时须先删旧的生成物再 xcodegen generate,否则遗留的 App/Info.plist
会被当作普通资源扫进 Resources 阶段。
2026-10-05 19:56:18 +08:00

324 lines
15 KiB
Swift
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.
import AppKit
import SwiftUI
@main
struct ShadowsocksXNG2App: App {
/// 进程期强持有(组合根装配一次)。body 不读它:事实发布经各 workflow 的
/// didChange 通道,不借 @StateObject 订阅控制器变化。
private let proxyController: ProxyRuntimeController
@StateObject private var catalogWorkflow: CatalogWorkflow
@StateObject private var proxyControl: ProxyControlWorkflow
@StateObject private var loginController: LaunchAtLoginController
@StateObject private var settingsWorkflow: SettingsWorkflow
@StateObject private var diagnosticsWorkflow: DiagnosticsWorkflow
@StateObject private var workspaceRoute: WorkspaceRoute
@StateObject private var silentLaunch: SilentLaunchController
@StateObject private var rulesWorkflow: RulesWorkflow
@StateObject private var windowActivation: WindowActivationPolicyCoordinator
private let textClipboard: any TextClipboard
private let workspaceContent: MainWindowView
/// 窗口工具栏标签风格默认「图标和文本」。绑定版修饰符让用户仍可经工具栏
/// 右键改选,选择回写本 AppStorage 键持久化,下次启动延续。
@AppStorage("toolbarLabelStyle") private var toolbarLabelStyle: ToolbarLabelStyle = .titleAndIcon
/// 启动呈现行为在进程内一次性定格(ADR 0017):静默启动偏好关闭(默认)
/// 时 presented,开启时 suppressed。切换偏好当次会话无影响,下次启动生效。
private let launchPresentation: SceneLaunchBehavior
init() {
let composition = AppComposition.make()
proxyController = composition.controller
_catalogWorkflow = StateObject(wrappedValue: composition.catalogWorkflow)
_proxyControl = StateObject(wrappedValue: composition.proxyControl)
_loginController = StateObject(wrappedValue: composition.loginController)
_settingsWorkflow = StateObject(wrappedValue: composition.settingsWorkflow)
_diagnosticsWorkflow = StateObject(wrappedValue: composition.diagnosticsWorkflow)
_workspaceRoute = StateObject(wrappedValue: composition.workspaceRoute)
_silentLaunch = StateObject(wrappedValue: composition.silentLaunch)
_rulesWorkflow = StateObject(wrappedValue: composition.rulesWorkflow)
_windowActivation = StateObject(
wrappedValue: WindowActivationPolicyCoordinator(applying: NSAppWindowActivationApplier()))
textClipboard = composition.textClipboard
workspaceContent = composition.workspaceContent
launchPresentation = composition.silentLaunch.isEnabled ? .suppressed : .presented
// GUI 事件接入内存环形缓冲(spec #21 D5,issue #34):主窗口日志查看器与
// 诊断导出的来源;wrapper 侧不注册,仍走 stderr → agent.log 收敛。
RuntimeLog.setSink(RuntimeEventStore.shared)
}
var body: some Scene {
MenuBarExtra {
ProxyStatusMenu(
control: proxyControl,
catalogWorkflow: catalogWorkflow)
} label: {
StatusMenuLabel(control: proxyControl)
}
.menuBarExtraStyle(.menu)
// 主 workspace 窗口(ADR 0016/0017):SwiftUI `Window` scene。启动呈现由
// defaultLaunchBehavior 决定:静默启动关闭(默认)时 presented 启动即呈现
// (scene 方式启动开窗,LSUIElement 下实测生效),开启时 suppressed 直接
// 进菜单栏形态。窗口开着期间 app 为 regular(Dock 图标/Cmd-Tab/默认菜单
// 栏),最后一个窗口关闭回 accessory 菜单栏形态——随窗激活策略由窗口 NSWindow 生命
// 周期通知驱动(WindowActivationPolicy,scenePhase 在 macOS 跟随应用而非
// 窗口、关窗无事件,实测不可用);关窗后由状态菜单首项(打开主窗口)经
// openWindow 重开。
// 关窗不退进程(MenuBarExtra 持进程)。
Window("ShadowsocksX-NG2", id: WorkspaceRoute.workspaceSceneID) {
workspaceContent
.modifier(WindowActivationPolicy(coordinator: windowActivation))
}
.defaultLaunchBehavior(launchPresentation)
.defaultSize(width: 960, height: 640)
.windowToolbarLabelStyle($toolbarLabelStyle)
rulesReportScene
}
private var rulesReportScene: some Scene {
Window(RulesCopy.text("快照制作时的转换报告"), id: RulesReportView.sceneID) {
RulesReportView(workflow: rulesWorkflow)
.modifier(WindowActivationPolicy(coordinator: windowActivation))
}
.defaultLaunchBehavior(.suppressed)
.restorationBehavior(.disabled)
.commandsRemoved()
.defaultSize(width: 680, height: 480)
.windowToolbarLabelStyle($toolbarLabelStyle)
}
}
/// 随窗激活策略的真实 NSApp 落点。
@MainActor
private final class NSAppWindowActivationApplier: WindowActivationPolicyApplying {
func apply(_ policy: NSApplication.ActivationPolicy) {
NSApp.setActivationPolicy(policy)
}
}
/// 状态菜单的标签视图(状态栏图标)。图标为静态 SF Symbol,不随代理状态
/// 变化,故不观察 control——control 仅承载启动 resync。挂载时机与菜单内容
/// 视图不同:内容视图首次点开才创建,而标签在启动时即挂载——启动 resync
/// 只能挂在这里,挂在菜单内容上等于从不执行。主窗口的启动呈现由 Window
/// scene 的 defaultLaunchBehavior 负责,与本任务无时序耦合。
private struct StatusMenuLabel: View {
let control: ProxyControlWorkflow
var body: some View {
Image(systemName: "paperplane.fill")
.accessibilityLabel("ShadowsocksX-NG2")
.task {
await control.resyncOnLaunch()
}
}
}
/// 组合根装配:目录提交协调器与全部生产运行时适配器只在此接线一次,各 scene
/// 不再重复设置提交回调;目录工作流的实现依赖经 CatalogWorkflowDependencies
/// 显式装配(workflow 不自行创建生产默认实现);Legacy 导入后的 2.0 运行时
/// 边界同为一次性注入。主窗口是 SwiftUI `Window` scene(MainApp body 声明),
/// 内容视图在组合根构造一次;MainWindowView 值廉价且只捕获工作流对象,其
/// StateObject 状态与 onAppear 副作用在窗口首次打开时才发生。
@MainActor
private struct AppComposition {
let controller: ProxyRuntimeController
let catalogWorkflow: CatalogWorkflow
let proxyControl: ProxyControlWorkflow
let loginController: LaunchAtLoginController
let settingsWorkflow: SettingsWorkflow
let diagnosticsWorkflow: DiagnosticsWorkflow
let workspaceRoute: WorkspaceRoute
let silentLaunch: SilentLaunchController
let expansion: CatalogExpansionState
let textClipboard: any TextClipboard
let imageClipboard: any ImageClipboard
let rulesWorkflow: RulesWorkflow
let workspaceContent: MainWindowView
static func make() -> AppComposition {
let dependencies = ApplicationDependencies.make()
let textClipboard = dependencies.textClipboard
// The catalog document is read exactly once at startup. The coordinator
// publishes later committed snapshots; the controller receives read-only
// access to this same in-process source.
let catalogBootstrap = CatalogCommitCoordinator.bootstrap(
fileStore: dependencies.catalogFileStore)
let plugins = PluginCatalog()
let controller = makeRuntimeController(
dependencies: dependencies, bootstrap: catalogBootstrap, plugins: plugins)
let loginController = LaunchAtLoginController(service: dependencies.loginService)
let catalogWorkflow = makeCatalogWorkflow(
dependencies: dependencies,
controller: controller,
bootstrap: catalogBootstrap, plugins: plugins)
plugins.connect(
invalidateRuntime: { [weak controller] in controller?.pluginMappingsDidPublish() },
revalidate: { [weak catalogWorkflow] in catalogWorkflow?.republishCommittedState() },
converge: { [weak controller] in
guard let controller else { return }
_ = await controller.catalogDidCommit(
snapshot: controller.catalogSnapshotReader.catalogSnapshot)
})
// 代理控制工作流 module(issue #47):状态菜单等 UI 表面的唯一代理控制
// seam,组合根接线一次。生产 runtime adapter 包装既有控制器(不复制运行
// 时语义);目录目标事实经窄缝从目录工作流读取;本机接口事实经独立缝
// 提供(issue #72 命令地址候选)。
let proxyControl = ProxyControlWorkflow(
runtime: ControllerProxyRuntimeAdapter(controller: controller),
targetFacts: catalogWorkflow,
interfaceFacts: SystemInterfaceFactsProvider())
// 设置工作流 module(Candidate 02):设置窗口的唯一 seam,组合根接线一次;
// 写入侧经窄缝 SettingsCommitting(issue #44),运行时控制器薄扩展即生产实现。
let settingsWorkflow = SettingsWorkflow(committing: controller)
// 诊断工作流 module(issue #43):诊断区唯一 seam,组合根接线一次;共享
// 实例供诊断侧栏与详情共同使用。
let diagnosticsWorkflow = DiagnosticsWorkflow(
runtimeFacts: controller,
catalogFacts: { catalogWorkflow.diagnosticCatalogFacts },
managedPlugins: {
plugins.catalogSnapshot().entries.map { entry in
DiagnosticPluginFacts(
program: entry.program, version: entry.managedInfo?.release ?? "",
present: entry.availability == .available, source: entry.source)
}
})
let workspaceRoute = WorkspaceRoute()
let silentLaunch = SilentLaunchController(store: dependencies.silentLaunchStore)
let expansion = CatalogExpansionState()
let rulesWorkflow = RulesWorkflow(
loadDocument: { try controller.ruleDocuments.load() },
commitDocument: { await controller.commitRuleDocument($0) },
builtinSnapshots: controller.ruleSnapshots)
let workspaceContent = MainWindowView(
rulesWorkflow: rulesWorkflow,
route: workspaceRoute,
workflow: catalogWorkflow,
control: proxyControl,
diagnostics: diagnosticsWorkflow,
plugins: PluginManagementModel(catalog: plugins),
settingsWorkflow: settingsWorkflow,
loginController: loginController,
silentLaunch: silentLaunch,
expansion: expansion,
clipboard: textClipboard,
imageClipboard: dependencies.imageClipboard,
diagnosticReportExporter: dependencies.diagnosticReportExporter,
configurationGroupFileExporter: dependencies.configurationGroupFileExporter,
qrImageSaver: dependencies.qrImageSaver)
return AppComposition(
controller: controller,
catalogWorkflow: catalogWorkflow,
proxyControl: proxyControl,
loginController: loginController,
settingsWorkflow: settingsWorkflow,
diagnosticsWorkflow: diagnosticsWorkflow,
workspaceRoute: workspaceRoute,
silentLaunch: silentLaunch,
expansion: expansion,
textClipboard: textClipboard,
imageClipboard: dependencies.imageClipboard,
rulesWorkflow: rulesWorkflow,
workspaceContent: workspaceContent)
}
/// 运行时控制器接线:读侧接目录提交协调器快照,写侧接各持久化 seam 与
/// 系统服务适配器。
private static func makeRuntimeController(
dependencies: ApplicationDependencies,
bootstrap: CatalogCommitBootstrap,
plugins: PluginCatalog
) -> ProxyRuntimeController {
ProxyRuntimeController(
catalogSnapshotReader: bootstrap.catalogSnapshotReader,
activationFileStore: dependencies.activationFileStore,
runtimeFileStore: dependencies.runtimeFileStore,
credentials: dependencies.credentials,
plugins: plugins,
refreshPluginSecurityFacts: { [weak plugins] in _ = plugins?.refreshSecurityFacts() },
listenRestore: dependencies.listenRestore,
settingsStore: dependencies.settingsStore,
settingsRestore: dependencies.settingsRestore,
agent: dependencies.launchAgent,
systemProxyNetworkChangeMonitor: SystemProxyNetworkChangeMonitor())
}
/// 目录工作流接线(issue #40/#41/#49):提交协调器与生产运行时适配器在此
/// 一次性装配;Legacy 导入后的 2.0 运行时边界同为一次性注入。
private static func makeCatalogWorkflow(
dependencies: ApplicationDependencies,
controller: ProxyRuntimeController,
bootstrap: CatalogCommitBootstrap,
plugins: PluginCatalog
) -> CatalogWorkflow {
let coordinator = CatalogCommitCoordinator(
fileStore: dependencies.catalogFileStore,
runtime: ProxyRuntimeSyncAdapter(controller: controller),
bootstrap: bootstrap)
return CatalogWorkflow(
dependencies: CatalogWorkflowDependencies(
coordinator: coordinator,
credentials: dependencies.credentials,
plugins: plugins,
subscriptionFetcher: HTTPSSubscriptionFetcher(),
legacyImportService: dependencies.legacyImportService,
postLegacyImport: { _ in
await controller.legacyImportDidCommit()
},
activator: controller))
}
}
/// 组合根依赖集(仅生产形态):单测不再以本 app 为宿主(去宿主化,ADR 0021),
/// 装配永远面向真实存储、系统服务与用户默认域。
@MainActor
private struct ApplicationDependencies {
let credentials: CredentialStoring
let catalogFileStore: CatalogFileStore
let activationFileStore: ActivationStateFileStore
let runtimeFileStore: RuntimeFileStore
let settingsStore: ProxySettingsFileStore
let settingsRestore: RestoredProxySettings
let listenRestore: RestoredListenSettings
let legacyImportService: LegacyImportService
let launchAgent: LaunchAgentControlling
let loginService: LaunchAtLoginControlling
let silentLaunchStore: SilentLaunchStore
let textClipboard: any TextClipboard
let imageClipboard: any ImageClipboard
let diagnosticReportExporter: any DiagnosticReportExporter
let configurationGroupFileExporter: any ConfigurationGroupFileExporter
let qrImageSaver: any QrImageSaver
static func make() -> ApplicationDependencies {
// ADR 0017 初版文件形态的迁移(发布链从未包含,仅存量开发机):文件不存在
// 即空操作,随每次启动调用无害。
SilentLaunchStore.migrateLegacyFileIfPresent(
at: SilentLaunchStore.legacyFileURL, into: .standard)
let credentials = KeychainCredentialStore()
let catalogFileStore = CatalogFileStore(fileURL: CatalogFileStore.defaultFileURL())
let settingsStore = ProxySettingsFileStore()
let restoredSettings = ProxySettingsFileStore.restored(store: settingsStore)
return ApplicationDependencies(
credentials: credentials,
catalogFileStore: catalogFileStore,
activationFileStore: ActivationStateFileStore(
fileURL: ActivationStateFileStore.defaultFileURL()),
runtimeFileStore: RuntimeFileStore(),
settingsStore: settingsStore,
settingsRestore: restoredSettings,
listenRestore: RestoredListenSettings(
settings: restoredSettings.settings.listen, unreadableError: nil),
legacyImportService: LegacyImportService(
catalogStore: catalogFileStore, credentials: credentials),
launchAgent: SMAppLaunchAgentService(),
loginService: SMAppLaunchAtLoginService(),
silentLaunchStore: SilentLaunchStore(),
textClipboard: AppKitTextClipboard(),
imageClipboard: AppKitImageClipboard(),
diagnosticReportExporter: AppKitDiagnosticReportExporter(),
configurationGroupFileExporter: AppKitConfigurationGroupFileExporter(),
qrImageSaver: AppKitQrImageSaver())
}
}