在 Flutter 应用程序中读取以前存储在本机应用程序中的共享首选项

Question

我有以下问题：现在 PlayStore 中有一个用本机代码（iOS 和 Android）编写的应用程序，我计划将其迁移到 Flutter。我的目标是用户不会注意到引擎盖下的变化，但可以像以前一样继续使用该应用程序。为此，我还需要迁移共享首选项。然而，这是相当困难的。在原生 Android 应用程序中，我存储了相关的共享偏好，如下所示：

SharedPreferences sharedPrefs = context.getSharedPreferences(
    "storage",
    Context.MODE_PRIVATE
);

sharedPrefs.putString('guuid', 'guuid_value');
editor.apply();

这会导致在此路径创建文件：

/data/data/patavinus.patavinus/shared_prefs/storage.xml

包含以下内容：

<?xml version='1.0' encoding='utf-8' standalone='yes' ?>
<map>
    <int name="guuid" value="guuid_value" />
</map>

如果我在 Flutter 中使用 shared_prefences 来获取这个值：

final sharedPreferences = await SharedPreferences.getInstance();
sharedPreferences.getString('guuid');

它返回 null 因为它正在寻找

/data/data/patavinus.patavinus/shared_prefs/FlutterSharedPreferences.xml 这是在 Flutter 中使用 shared_preferences 存储共享首选项时写入的文件。因为共享首选项是在本机应用程序上下文中编写的，所以文件显然不存在。

有没有什么方法可以让 Flutter 在不使用平台通道的情况下寻找/data/data/patavinus.patavinus/shared_prefs/storage.xml？

我知道它是如何工作的，就像这里提到的那样：How to access flutter Shared preferences on the android end (using java)。这种方式很简单，因为在 Android 中你可以选择在 Flutter 的前缀前面加上前缀。但是，在 Flutter 中你不能。

我也知道这个插件：https://pub.dev/packages/native_shared_preferences 但是，我不敢相信第三方插件是推荐的方式。此外，我将相关的共享首选项分布在多个资源文件中。在这个插件中，你只能设置一个（通过指定字符串资源flutter_shared_pref_name）。

Answer 1

按照here 的建议，您可以获取本机文件的内容并将其复制到新文件中。当用户第一次升级到你的 Flutter 应用时，你可以将内容复制到 Flutter 的存储文件中。

Answer 2

最好的选择是将共享首选项存储在与 SharedPreferences 插件相同的文件中的本机部分。所以这意味着这样做：

1. 在 Java 代码中替换您的 SharedPreferences 代码，使用与插件中相同的键：SharedPreferences sharedPref = context.getSharedPreferences("FlutterSharedPreferences", Context.MODE_PRIVATE);
2. 在原生部分保存所有带有前缀“flutter.”的首选项。因此，在本机部分，您将获得所需的首选项，例如：String test = sharedPref.getString("flutter.test", "");

Answer 3

由于对我的问题没有令人满意的答案，适用于两个主要操作系统并考虑到多个资源文件的分布，我自己编写了一个平台通道解决方案。

在 Android (Kotlin) 上，我让调用者提供“文件”参数，因为数据可能分布在多个资源文件中（就像我在问题中描述的那样）。

package my.test

import android.content.*
import androidx.annotation.NonNull
import io.flutter.embedding.android.FlutterActivity
import io.flutter.embedding.engine.FlutterEngine
import io.flutter.plugin.common.MethodChannel

class MainActivity: FlutterActivity() {
    private val CHANNEL = "testChannel"

    override fun configureFlutterEngine(@NonNull flutterEngine: FlutterEngine) {
        super.configureFlutterEngine(flutterEngine)
        MethodChannel(flutterEngine.dartExecutor.binaryMessenger, CHANNEL).setMethodCallHandler {
            call, result ->
            when (call.method) {
                "getStringValue" -> {
                    val key: String? = call.argument<String>("key");
                    val file: String? = call.argument<String>("file");

                    when {
                        key == null -> {
                            result.error("KEY_MISSING", "Argument 'key' is not provided.", null)
                        }
                        file == null -> {
                            result.error("FILE_MISSING", "Argument 'file' is not provided.", null)
                        }
                        else -> {
                            val value: String? = getStringValue(file, key)
                            result.success(value)
                        }
                    }
                }
                else -> {
                    result.notImplemented()
                }
            }
        }
    }

    private fun getStringValue(file: String, key: String): String? {
        return context.getSharedPreferences(
                file,
                Context.MODE_PRIVATE
        ).getString(key, null);
    }
}

在 iOS (Swift) 上，这不是必需的，因为我正在使用 UserDefaults

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    let controller : FlutterViewController = window?.rootViewController as! FlutterViewController
    let platformChannel = FlutterMethodChannel(
      name: "testChannel",
      binaryMessenger: controller.binaryMessenger
    )

    platformChannel.setMethodCallHandler({
      [weak self] (call: FlutterMethodCall, result: FlutterResult) -> Void in
      guard call.method == "getStringValue" else {
        result(FlutterMethodNotImplemented)
        return
      }

      if let args: Dictionary<String, Any> = call.arguments as? Dictionary<String, Any>,
        let number: String = args["key"] as? String, {
        self?.getStringValue(key: key, result: result)
        return
      } else {
        result(
          FlutterError.init(
            code: "KEY_MISSING",
            message: "Argument 'key' is not provided.", 
            details: nil
          )
        )
      }
    })

    GeneratedPluginRegistrant.register(with: self)
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }
}
    
private func getStringValue(key: String, result: FlutterResult) -> String? {
  let fetchedValue: String? = UserDefaults.object(forKey: key) as? String
  result(fetchedValue)
}

我希望 SharedPreferences 包可以添加省略颤振前缀的可能性，使开发人员能够从原生应用无缝迁移内容。

我还写了一篇博文，更详细地解释了问题和解决方案：https://www.flutterclutter.dev/flutter/tutorials/read-shared-preferences-from-native-apps/2021/9753/

Answer 4

我也知道这个插件：https://pub.dev/packages/native_shared_preferences 但是，我不敢相信第三方插件是推荐的方式。

我认为第三方插件很好。 Flutter 最棒的地方在于它令人惊叹的社区，它不断为生态系统做出贡献。也就是说，我不建议继续使用非官方库。因此，您可以测试在幕后迁移您的共享偏好。

• 在您的initState 查询中获取颤振共享偏好。
• 如果存在，请跳过。
• 如果不存在，则查询本机共享首选项，如果存在则复制

完成了。这将有助于迁移恕我直言。

Answer 5

我的选择是将其视为文件。
在flutter中读取android共享首选项文件

/data/data/patavinus.patavinus/shared_prefs/storage.xml

以您处理其他 xml 文件的方式获取值。

如果要进行一些更改，不要使用sharedPrefs.put，而是写入文件(/data/data/patavinus.patavinus/shared_prefs/storage.xml )在flutter中使用文件的write方法