-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
iOS_setup_cn
MMKV 是基于 mmap 内存映射的 key-value 组件,底层序列化/反序列化使用 protobuf 实现,性能高,稳定性强。从 2015 年中至今在微信上使用,其性能和稳定性经过了时间的验证。近期也已移植到 Android / macOS / Windows / POSIX 平台,一并开源。
- MMKV 支持 iOS 12.0 以上, macOS 10.13 以上,WatchOS 4.0 以上
- MMKV 需使用 Xcode 15.0 以上进行编译
-
通过 CocoaPods:(推荐)
- 安装 CocoaPods;
- 打开命令行,
cd
到你的项目工程目录, 输入pod repo update
让 CocoaPods 感知最新的 MMKV 版本; - 打开 Podfile, 添加
pod 'MMKV'
到你的 App Target 里面;或pod 'MMKVAppExtension'
到你的 AppExtension Target 里,或pod 'MMKVWatchExtension'
到你的 WatchExtension Target 里; - 在命令行输入
pod install
; - 用 Xcode 打开由 CocoaPods 自动生成的
.xcworkspace
文件; - 添加头文件
#import <MMKV/MMKV.h>
,就可以愉快地开始你的 MMKV 之旅了。 - 相应地,如果是其他 Extension Target,头文件也要相应地变更为
<MMKVAppExtension/MMKV.h>
或<MMKVWatchExtension/MMKV.h>
。
-
通过 Carthage:
- 安装 Carthage;
- 打开 Cartfile, 添加
github "Tencent/MMKV"
; - 打开命令行,
cd
到你的 project 目录, 输入carthage update
; - 将
Carthage/Build/
目录下的MMKV.framework
拖到你的项目工程配置的Build Phases
->Linked Binary and Libraries
里面; - 点击你的项目工程配置的
Build Phases
中 "+" 按钮,选择New Run Script Phase
。在创建的脚本中输入carthage copy-frameworks
, 并在Input Files
中添加路径$(SRCROOT)/Carthage/Build/iOS/MMKV.framework
, 在Output Files
中添加路径$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/MMKV.framework
; - 添加头文件
#import <MMKV/MMKV.h>
,就可以愉快地开始你的 MMKV 之旅了。
注意: Carthage 对于多个 scheme 未能很好地支持,如果你打算在 Extension 里使用 MMKV,建议使用其他方式集成。
-
通过动态库:
- 获取 MMKV 源码:
git clone https://github.com/Tencent/MMKV.git
- 把
iOS/MMKV/
目录下的MMKV.xcodeproj
拖到你的项目里; - 在你的项目工程配置的
General settings
->Enbedded Binaries
添加MMKV.framework
; 注意这里有两个库,要选择动态库那个; - 相应地,如果是 AppExtension 则添加
MMKVAppextension.framework
,如果是 WatchExtension 则添加MMKVWatchExtension.framework
; - 添加头文件
#import <MMKV/MMKV.h>
,就可以愉快地开始你的 MMKV 之旅了。
注: 如果你确定不需要加密功能,你可以在
Core/MMKVPredef.h
文件中打开宏MMKV_DISABLE_CRYPT
,以减小一些二进制大小。 - 获取 MMKV 源码:
-
通过静态库:
- 获取 MMKV 源码:
git clone https://github.com/Tencent/MMKV.git
- 把
iOS/MMKV/
目录下的MMKV.xcodeproj
拖到你的项目里; - 在你的项目工程配置的
Build Phases
->Target Dependencies
添加libMMKV Static.a
; 注意这里有两个库,要选择静态库那个; - 在你的项目工程配置的
Build Phases
->Linked Binary and Libraries
添加libMMKV Static.a
和libz.tbd
; - 在你的项目工程配置的
Build Settings
->Other Linker Flags
添加-ObjC
; - 添加头文件
#import <MMKV/MMKV.h>
,就可以愉快地开始你的 MMKV 之旅了; - 如果你想在 AppExtension 或 WatchExtension 里使用 MMKV,你应该用动态库的形式集成。
注: 如果你确定不需要加密功能,你可以在
Core/MMKVPredef.h
文件中打开宏MMKV_DISABLE_CRYPT
,以减小一些二进制大小。 - 获取 MMKV 源码:
MMKV is published under the BSD 3-Clause license. For details check out the LICENSE.TXT.
Check out the CHANGELOG.md for details of change history.
If you are interested in contributing, check out the CONTRIBUTING.md, also join our Tencent OpenSource Plan.
To give clarity of what is expected of our members, MMKV has adopted the code of conduct defined by the Contributor Covenant, which is widely used. And we think it articulates our values well. For more, check out the Code of Conduct.
Check out the FAQ first. Should there be any questions, don't hesitate to create issues.
User privacy is taken very seriously: MMKV does not obtain, collect or upload any personal information. Please refer to the MMKV SDK Personal Information Protection Rules for details.
- In English
- 中文
- In English
- 中文
- In English
- 中文
-
In English
-
中文
-
Golang