obkv - Rust高性能轻量级键值存储库

介绍

obkv 是一个用纯 Rust 编写的高性能、轻量级键值存储库，专为需要快速键值访问的场景设计。它具有以下特点：

• 高性能：基于内存的高效数据结构实现
• 轻量级：无外部依赖，极小开销
• 简单易用：提供简洁的API接口
• 线程安全：支持多线程并发访问

安装

在 Cargo.toml 中添加依赖：

[dependencies]
obkv = "0.3"

基本使用方法

创建和打开存储

use obkv::KvStore;

// 创建内存中的键值存储
let mut store = KvStore::new();

// 或者从文件加载持久化存储
let mut store = KvStore::open("data.db").unwrap();

基本CRUD操作

// 插入/更新键值
store.set("name", "Alice").unwrap();

// 获取值
let name = store.get("name").unwrap();
println!("Name: {}", name); // 输出: Name: Alice

// 检查键是否存在
if store.contains("name") {
    println!("Key 'name' exists");
}

// 删除键值
store.remove("name").unwrap();

批量操作

// 批量插入
let mut batch = store.batch();
batch.set("key1", "value1");
batch.set("key2", "value2");
batch.set("key3", "value3");
batch.commit().unwrap();

// 批量获取
let values = store.multi_get(&["key1", "key2", "key3"]).unwrap();
for (key, value) in values {
    println!("{}: {}", key, value);
}

迭代器

// 遍历所有键值对
for (key, value) in store.iter() {
    println!("{} => {}", key, value);
}

// 前缀搜索
for (key, value) in store.prefix("user_") {
    println!("User {}: {}", key, value);
}

高级用法

事务支持

use obkv::Transaction;

let mut tx = store.transaction();
tx.set("account1", "100");
tx.set("account2", "200");

// 提交事务
if let Err(e) = tx.commit() {
    eprintln!("Transaction failed: {}", e);
}

性能优化配置

use obkv::{KvStore, Options};

let options = Options {
    cache_size: 1024 * 1024, // 1MB缓存
    sync_on_write: false,    // 异步写入
    ..Default::default()
};

let mut store = KvStore::with_options("data.db", options).unwrap();

完整示例：配置管理系统

use obkv::{KvStore, Transaction};
use serde::{Deserialize, Serialize};
use std::error::Error;

#[derive(Debug, Serialize, Deserialize)]
struct AppConfig {
    server_port: u16,
    db_url: String,
    cache_enabled: bool,
}

impl AppConfig {
    // 将配置保存到键值存储
    fn save_to_store(&self, store: &mut KvStore) -> Result<(), Box<dyn Error>> {
        let serialized = serde_json::to_string(self)?;
        
        // 使用事务确保原子性
        let mut tx = store.transaction();
        tx.set("config:app", &serialized)?;
        tx.commit()?;
        
        Ok(())
    }

    // 从键值存储加载配置
    fn load_from_store(store: &KvStore) -> Result<Option<Self>, Box<dyn Error>> {
        if let Some(config_str) = store.get("config:app")? {
            let config: AppConfig = serde_json::from_str(&config_str)?;
            Ok(Some(config))
        } else {
            Ok(None)
        }
    }
}

fn main() -> Result<(), Box<dyn Error>> {
    // 初始化键值存储(持久化到文件)
    let mut store = KvStore::open("config.db")?;

    // 创建并保存默认配置
    let default_config = AppConfig {
        server_port: 8080,
        db_url: "postgres://localhost:5432/mydb".to_string(),
        cache_enabled: true,
    };
    
    default_config.save_to_store(&mut store)?;
    println!("Default configuration saved");

    // 从存储加载配置
    if let Some(loaded_config) = AppConfig::load_from_store(&store)? {
        println!("Loaded configuration: {:?}", loaded_config);
        
        // 更新部分配置
        let mut updated_config = loaded_config;
        updated_config.server_port = 9090;
        updated_config.save_to_store(&mut store)?;
        println!("Configuration updated");
    }

    // 批量操作示例：保存多个环境配置
    let mut batch = store.batch();
    batch.set("config:dev", r#"{"server_port":3000,"db_url":"dev.db","cache_enabled":true}"#);
    batch.set("config:test", r#"{"server_port":4000,"db_url":"test.db","cache_enabled":false}"#);
    batch.set("config:prod", r#"{"server_port":80,"db_url":"prod.db","cache_enabled":true}"#);
    batch.commit()?;
    println!("Multiple environment configurations saved");

    // 使用前缀获取所有配置
    println!("All configurations:");
    for (key, value) in store.prefix("config:") {
        println!("{} => {}", key, value);
    }

    Ok(())
}

注意事项

1. obkv 主要设计用于内存存储，虽然支持持久化，但不适合超大规模数据
2. 对于生产环境，应考虑添加适当的错误处理和日志记录
3. 在多线程环境下使用时，确保正确处理并发访问

obkv 是一个简单高效的键值存储解决方案，非常适合需要轻量级存储的场景，如配置管理、缓存系统或小型应用的状态存储。