Swift Vapor中如何创建启动实例化、控制器可访问的全局对象

1. 实现应用全局作用域存储对象 #

Vapor 原生提供了Application和Request的存储扩展机制，不需要自行定义全局变量，完全满足「启动时初始化、全控制器可访问」的需求，同时可以绕过Session仅支持字符串存储的限制。

首先定义全局存储类和对应的存储键，注意并发访问必须加锁，避免多请求下的数据竞争：

import Vapor

// 存储键定义，遵循Vapor内置StorageKey协议
private struct GlobalModelStoreKey: StorageKey {
    typealias Value = GlobalModelStore
}

/// 全局跨请求数据存储类
final class GlobalModelStore {
    // Vapor内置线程锁，保证并发读写安全
    private let lock = Lock()
    // 按用户ID维度存储自定义模型数据，可替换Value类型为你需要的任意类型
    private var userDataMap: [UUID: [String: Any]] = [:]
    
    /// 写入用户关联数据
    /// - Parameters:
    ///   - data: 任意类型的模型数据，无需转字符串
    ///   - userID: 关联的用户唯一ID
    ///   - key: 数据标识键
    func set<T>(_ data: T, userID: UUID, key: String) {
        lock.withLock {
            var userStore = userDataMap[userID] ?? [:]
            userStore[key] = data
            userDataMap[userID] = userStore
        }
    }
    
    /// 读取用户关联数据
    /// - Parameters:
    ///   - userID: 关联的用户唯一ID
    ///   - key: 数据标识键
    ///   - type: 目标数据类型
    /// - Returns: 类型匹配的存储数据，不存在/类型不匹配时返回nil
    func get<T>(userID: UUID, key: String, type: T.Type) -> T? {
        lock.withLock {
            userDataMap[userID]?[key] as? T
        }
    }
    
    /// 清理指定用户的所有存储数据，避免内存泄漏
    func clear(userID: UUID) {
        lock.withLock {
            userDataMap.removeValue(forKey: userID)
        }
    }
}

给Application添加扩展属性，支持全局访问，同时在应用启动阶段完成初始化：

extension Application {
    var globalStore: GlobalModelStore {
        get { self.storage[GlobalModelStoreKey.self]! }
        set { self.storage[GlobalModelStoreKey.self] = newValue }
    }
}

打开项目中的configure.swift文件，在应用配置阶段初始化全局对象，应用启动后该对象会一直存在于应用生命周期内：

// app启动配置流程中加入这行，完成全局对象初始化
app.globalStore = GlobalModelStore()

为了方便控制器中调用，给Request添加扩展属性，不需要每次通过req.application链式调用：

extension Request {
    var globalStore: GlobalModelStore {
        self.application.globalStore
    }
}

2. 控制器中调用方式 #

你提到的「通过隐藏字段关联用户」的逻辑可以直接适配：Session中只需要存储用户ID的字符串值，请求进入后先从认证信息/Session拿到用户ID，直接通过全局存储读写任意类型的模型数据即可，不需要做字符串序列化/反序列化。

示例代码：

// 写入跨请求暂存数据
func saveTempInfo(req: Request) async throws -> HTTPResponseStatus {
    // 拿到当前认证的用户，根据你的实际认证逻辑调整
    let currentUser = try req.auth.require(User.self)
    // 解析请求中的模型数据，支持任意自定义类型
    let tempModel = try req.content.decode(OrderTempForm.self)
    // 写入全局存储
    req.globalStore.set(tempModel, userID: currentUser.id!, key: "unpaid_order_form")
    return .ok
}

// 读取跨请求暂存数据
func getTempInfo(req: Request) async throws -> OrderTempForm {
    let currentUser = try req.auth.require(User.self)
    guard let storedForm = req.globalStore.get(
        userID: currentUser.id!,
        key: "unpaid_order_form",
        type: OrderTempForm.self
    ) else {
        throw Abort(.notFound, reason: "暂存的表单数据已失效")
    }
    return storedForm
}

3. 注意事项 #

• 该存储基于应用内存实现，应用重启后所有数据会清空，仅适合存储临时跨请求的非持久化数据，需要长期存储的数据请落库。
• 必须通过锁保证并发读写安全，禁止直接在多线程环境下无锁读写字典，否则会触发运行时崩溃。
• 请在用户退出登录、Session过期时主动调用clear(userID:)方法清理对应数据，避免内存持续增长。
• 单实例部署场景下该方案性能最优，如果是多实例分布式部署，建议替换存储层为Redis等共享缓存组件。

内容的提问来源于stack exchange，提问作者michaD