如何在Xamarin Forms项目中打包并复用预构建Realm文件？

我明白你之前查过针对Xamarin iOS的旧方案，但随着Xamarin Forms的更新，现在有更通用的方式来处理预构建文件的打包和复用——不管是Realm数据库还是其他任意文件。下面分通用PCL层的处理思路，以及各平台的具体实现步骤：

一、PCL层的通用准备工作 #

首先，把你的预构建Realm数据库文件（比如prebuilt.realm）添加到PCL项目中，设置生成操作为Embedded Resource，这样文件会被嵌入到程序集里，方便跨平台调用。

然后在PCL中创建一个通用的服务接口，用来抽象文件复制的逻辑（因为PCL无法直接访问平台文件系统），让各平台项目实现这个接口：

public interface IFileService
{
    Task<string> CopyEmbeddedFileToLocalAsync(string embeddedFilePath, string localFileName);
}

这个接口的核心作用是把嵌入的只读资源，复制到各平台的本地可读写目录——毕竟Realm需要操作可读写的本地文件，没法直接读取嵌入的资源。

二、各平台的具体实现 #

通过Xamarin Forms的DependencyService，我们可以在PCL中调用各平台的具体实现。

Android平台 #

在Android项目中添加接口实现类：

[assembly: Dependency(typeof(AndroidFileService))]
namespace YourApp.Droid
{
    public class AndroidFileService : IFileService
    {
        public async Task<string> CopyEmbeddedFileToLocalAsync(string embeddedFilePath, string localFileName)
        {
            // 获取Android的私人存储目录
            var localPath = Path.Combine(System.Environment.GetFolderPath(System.Environment.SpecialFolder.Personal), localFileName);
            
            // 文件已存在就直接返回路径，避免重复复制
            if (File.Exists(localPath))
            {
                return localPath;
            }

            // 从嵌入资源中读取流，复制到本地文件
            using (var stream = Assembly.GetExecutingAssembly().GetManifestResourceStream(embeddedFilePath))
            using (var fileStream = new FileStream(localPath, FileMode.Create))
            {
                await stream.CopyToAsync(fileStream);
            }

            return localPath;
        }
    }
}

⚠️ 注意：embeddedFilePath是PCL项目中文件的完整资源路径，格式为你的PCL项目命名空间.文件夹名.文件名，比如MyApp.Core.Data.prebuilt.realm。

iOS平台 #

在iOS项目中添加接口实现类：

[assembly: Dependency(typeof(IOSFileService))]
namespace YourApp.iOS
{
    public class IOSFileService : IFileService
    {
        public async Task<string> CopyEmbeddedFileToLocalAsync(string embeddedFilePath, string localFileName)
        {
            // 获取iOS的Documents目录
            var documentsPath = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
            var localPath = Path.Combine(documentsPath, localFileName);
            
            if (File.Exists(localPath))
            {
                return localPath;
            }

            var embeddedStream = Assembly.GetExecutingAssembly().GetManifestResourceStream(embeddedFilePath);
            if (embeddedStream == null)
            {
                throw new FileNotFoundException("嵌入文件未找到，请检查资源路径", embeddedFilePath);
            }

            using (var fileStream = new FileStream(localPath, FileMode.Create))
            {
                await embeddedStream.CopyToAsync(fileStream);
            }

            return localPath;
        }
    }
}

UWP平台 #

在UWP项目中添加接口实现类：

[assembly: Dependency(typeof(UWPFileService))]
namespace YourApp.UWP
{
    public class UWPFileService : IFileService
    {
        public async Task<string> CopyEmbeddedFileToLocalAsync(string embeddedFilePath, string localFileName)
        {
            var localFolder = ApplicationData.Current.LocalFolder;
            var localFile = await localFolder.TryGetItemAsync(localFileName) as StorageFile;
            
            if (localFile != null)
            {
                return localFile.Path;
            }

            var assembly = typeof(UWPFileService).GetTypeInfo().Assembly;
            using (var stream = assembly.GetManifestResourceStream(embeddedFilePath))
            {
                localFile = await localFolder.CreateFileAsync(localFileName, CreationCollisionOption.ReplaceExisting);
                using (var fileStream = await localFile.OpenStreamForWriteAsync())
                {
                    await stream.CopyToAsync(fileStream);
                }
            }

            return localFile.Path;
        }
    }
}

三、在PCL中调用并初始化Realm #

在PCL的业务代码里，通过DependencyService获取平台实现，复制文件后初始化Realm：

var fileService = DependencyService.Get<IFileService>();
var realmPath = await fileService.CopyEmbeddedFileToLocalAsync("MyApp.Core.Data.prebuilt.realm", "app.realm");
var config = new RealmConfiguration(realmPath);
var realm = Realm.GetInstance(config);

四、关键注意事项 #

• 确保预构建的Realm数据库版本，和你项目中使用的Realm NuGet包版本完全一致，否则会出现兼容性问题，导致无法打开数据库。
• 如果不确定embeddedFilePath是否正确，可以通过Assembly.GetExecutingAssembly().GetManifestResourceNames()方法，打印出所有嵌入的资源名称来核对。
• 第一次复制文件后，后续会直接复用本地路径，避免重复IO操作。

内容的提问来源于stack exchange，提问作者Dr. Atul Tiwari