WatermelonDB 跨 iOS 目标共享数据库实战指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00020/article/details/148394330

WatermelonDB 跨 iOS 目标共享数据库实战指南

WatermelonDB 🍉 Reactive & asynchronous database for powerful React and React Native apps ⚡️ 项目地址: https://gitcode.com/gh_mirrors/wa/WatermelonDB

前言

在 iOS 应用开发中，我们经常需要构建包含多个扩展（如通知服务扩展、分享扩展等）的复杂应用。这些扩展作为独立的目标(target)，默认情况下无法直接访问主应用的数据库。本文将详细介绍如何在 WatermelonDB 中实现跨目标数据库共享的解决方案。

应用场景

以下情况需要考虑跨目标共享数据库：

通知服务扩展需要读取数据库内容来定制通知
分享扩展需要访问主应用数据
iMessage 贴纸扩展需要与主应用同步数据
小组件(Widget)需要展示主应用数据

技术原理

iOS 提供了 App Groups 机制，允许同一开发者账号下的多个应用或扩展共享存储空间。WatermelonDB 通过将数据库文件存储在共享容器中，实现跨目标数据访问。

实现步骤

第一步：配置 App Groups

为每个需要共享数据库的目标配置相同的 App Group：
- 在 Xcode 中选中目标
- 进入 "Signing & Capabilities" 标签页
- 点击 "+ Capability" 按钮
- 选择 "App Groups"
- 添加 App Group 名称，格式通常为 group.$(PRODUCT_BUNDLE_IDENTIFIER)

关键点：所有目标的 App Group 名称必须完全一致，否则无法共享存储空间。

第二步：配置数据库路径

有两种方式可以实现数据库路径配置，各有优缺点：

方案A：通过 JavaScript 实现（简单但有限制）

优点：

实现简单
不需要原生代码修改

缺点：

会破坏 Chrome 远程调试功能
依赖第三方库

实现步骤：

安装 rn-fetch-blob 库
修改数据库初始化代码：

import { Platform } from 'react-native';
import { Database } from '@nozbe/watermelondb';
import SQLiteAdapter from '@nozbe/watermelondb/adapters/sqlite';
import RNFetchBlob from 'rn-fetch-blob';

const getAppGroupPath = (): string => {
  if (Platform.OS === 'ios') {
    return `${RNFetchBlob.fs.syncPathAppGroup('group.com.example.MyAwesomeApp')}/`;
  }
  return '';
}

const adapter = new SQLiteAdapter({
  dbName: `${getAppGroupPath()}default.db`,
  schema,
});

方案B：通过原生代码实现（推荐）

优点：

更稳定可靠
不影响调试功能
性能更好

缺点：

需要编写少量原生代码

实现步骤：

为每个目标编辑 Info.plist：
- 添加 AppGroup 键
- 值设置为 App Group 名称
创建原生模块：

Swift 代码 (AppGroup.swift):

import Foundation

@objc(AppGroup)
class AppGroup: NSObject {
  @objc
  func constantsToExport() -> [AnyHashable : Any]! {
    var path = ""
    if let suiteName = Bundle.main.object(forInfoDictionaryKey: "AppGroup") as? String,
       let directory = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: suiteName) {
      path = directory.path
    }
    return ["path": "\(path)/"]
  }
}

Objective-C 桥接文件 (AppGroup.m):

#import "React/RCTBridgeModule.h"
@interface RCT_EXTERN_MODULE(AppGroup, NSObject)
@end

修改 JavaScript 代码：

import { NativeModules } from 'react-native';

const getAppGroupPath = (): string => {
  return Platform.OS === 'ios' ? NativeModules.AppGroup.path : '';
}

const adapter = new SQLiteAdapter({
  dbName: `${getAppGroupPath()}default.db`,
  schema,
});