BinaryPrefs 开源项目教程

2024-09-08 15:04:13作者：伍霜盼Ellen

binaryprefs

Rapidly fast and lightweight re-implementation of SharedPreferences which stores each preference in files separately, performs disk operations via NIO with memory mapped byte buffers and works IPC (between processes). Written from scratch.

1. 项目的目录结构及介绍

BinaryPrefs 项目的目录结构如下：

binaryprefs/
├── library/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   │   ├── com/
│   │   │   │   │   ├── ironz/
│   │   │   │   │   │   ├── binaryprefs/
│   │   │   │   │   │   │   ├── dump/
│   │   │   │   │   │   │   │   ├── DumpReceiver.java
│   │   │   │   │   │   │   ├── ...
│   │   │   ├── resources/
│   │   │   ├── AndroidManifest.xml
│   ├── build.gradle
├── gradle/
├── gradlew
├── gradlew.bat
├── settings.gradle
├── README.md

目录结构介绍

library/: 项目的主要代码库，包含了所有的源代码和资源文件。
- src/main/java/: Java 源代码目录，包含了项目的所有 Java 文件。
  - com/ironz/binaryprefs/: 主要的包目录，包含了项目的核心代码。
    - dump/: 包含了用于日志输出的相关代码。
      - DumpReceiver.java: 用于处理日志输出的 Java 文件。
- src/main/resources/: 资源文件目录，包含了项目的配置文件和其他资源文件。
- AndroidManifest.xml: Android 项目的配置文件，定义了应用的组件、权限等。
- build.gradle: 项目的构建脚本，定义了项目的依赖和构建配置。
gradle/: Gradle 构建工具的相关文件。
gradlew, gradlew.bat: Gradle 的包装脚本，用于在不同平台上运行 Gradle 构建。
settings.gradle: Gradle 项目的设置文件，定义了项目的模块和配置。
README.md: 项目的说明文档，包含了项目的介绍、使用方法等。

2. 项目的启动文件介绍

在 BinaryPrefs 项目中，没有明确的“启动文件”，因为该项目是一个库项目，而不是一个独立的应用程序。然而，项目的核心功能是通过 BinaryPreferencesBuilder 类来构建和配置 Preferences 实例。

核心启动类

BinaryPreferencesBuilder.java: 这是项目的核心启动类，用于构建和配置 Preferences 实例。通过这个类，你可以定义自定义的目录、启用进程间通信（IPC）模式、设置加密等。

Preferences preferences = new BinaryPreferencesBuilder(context)
    .customDirectory(Environment.getExternalStorageDirectory())
    .supportInterProcess(true)
    .build();

启动流程

创建 BinaryPreferencesBuilder 实例: 使用 context 初始化 BinaryPreferencesBuilder。
配置选项: 通过链式调用设置自定义目录、启用 IPC 模式等。
构建 Preferences 实例: 调用 build() 方法生成 Preferences 实例。

3. 项目的配置文件介绍

`build.gradle`

build.gradle 文件是项目的构建脚本，定义了项目的依赖、插件和其他构建配置。

plugins {
    id 'com.android.library'
    id 'kotlin-android'
}

android {
    compileSdkVersion 30
    defaultConfig {
        minSdkVersion 16
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
    implementation 'androidx.core:core-ktx:1.3.2'
    implementation 'androidx.appcompat:appcompat:1.2.0'
}

`AndroidManifest.xml`

AndroidManifest.xml 文件是 Android 项目的配置文件，定义了应用的组件、权限等。

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.ironz.binaryprefs">

    <application>
        <receiver android:name=".dump.DumpReceiver">
            <intent-filter>
                <action android:name="com.ironz.binaryprefs.ACTION_DUMP_PREFERENCE" />
            </intent-filter>
        </receiver>
    </application>

</manifest>

`settings.gradle`

settings.gradle 文件是 Gradle 项目的设置文件，定义了项目的模块和配置。

include ':library'

总结

BinaryPrefs 是一个快速且轻量级的 SharedPreferences 实现，通过 NIO 和内存映射字节缓冲区进行磁盘操作，并支持进程间通信（IPC）。项目的目录结构清晰，核心启动类为 BinaryPreferencesBuilder，配置文件包括 build.gradle、AndroidManifest.xml 和 settings.gradle。

binaryprefs