Capacitor Preferences无法读取Xcode启动参数设置的UserDefaults键值对

核心原因 #

Capacitor的Preferences插件在iOS端默认使用应用组共享的UserDefaults容器，而Xcode启动参数（-AppKey Value格式）设置的键值对会存入应用自身的主UserDefaults容器，两者属于不同存储空间，因此无法互通。

解决方案 #

方案1：修改Preferences的存储容器（推荐） #

在iOS项目的AppDelegate.swift中，手动指定Preferences插件使用应用主容器的UserDefaults：

import Capacitor
import CapacitorPreferences

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        let capacitorConfig = CapacitorConfig()
        let bridge = CAPBridge(config: capacitorConfig, launchOptions: launchOptions)
        
        // 替换Preferences的存储容器为应用主容器
        if let preferencesPlugin = bridge.plugin(withName: "Preferences") as? Preferences {
            preferencesPlugin.userDefaults = UserDefaults.standard
        }
        
        bridge.initialize()
        return true
    }
}

修改后，Preferences插件会直接读取UserDefaults.standard，即可获取Xcode启动参数设置的键值对。

方案2：启动时同步两个容器的键值对 #

若不想修改Preferences默认存储，可在App启动时将主容器的键值对同步到应用组容器：

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // 替换为你的应用组ID（可在capacitor.config.ts的ios字段中查看）
    guard let appGroupDefaults = UserDefaults(suiteName: "group.com.your.app.id") else {
        return true
    }
    
    // 同步主容器所有键值到应用组容器
    for (key, value) in UserDefaults.standard.dictionaryRepresentation() {
        appGroupDefaults.set(value, forKey: key)
    }
    appGroupDefaults.synchronize()
    
    // 正常初始化Capacitor
    let capacitorConfig = CapacitorConfig()
    let bridge = CAPBridge(config: capacitorConfig, launchOptions: launchOptions)
    bridge.initialize()
    return true
}

方案3：自定义插件读取主容器参数 #

若仅需读取个别启动参数，可通过自定义Capacitor插件将主容器的UserDefaults暴露给前端：

1. 创建自定义插件：

@objc(LaunchParamsPlugin)
public class LaunchParamsPlugin: CAPPlugin {
    @objc func getLaunchParam(_ call: CAPPluginCall) {
        guard let key = call.getString("key") else {
            call.reject("Missing key parameter")
            return
        }
        let value = UserDefaults.standard.object(forKey: key)
        call.resolve(["value": value ?? NSNull()])
    }
}

2. 前端调用：

import { Plugins } from '@capacitor/core';
const { LaunchParamsPlugin } = Plugins;

const result = await LaunchParamsPlugin.getLaunchParam({ key: "YourTargetKey" });
console.log(result.value);

验证方式 #

设置Xcode启动参数后运行应用，通过上述任一方案即可在前端读取到对应键值对。

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