oxcache 0.1.4

A high-performance multi-level cache library for Rust with L1 (memory) and L2 (Redis) caching.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
//! Copyright (c) 2025-2026, Kirky.X
//!
//! MIT License
//!
//! 单机 Redis 策略实现
//!
//! 支持单个 Redis 实例,支持主从读写分离。

use crate::backend::strategy::traits::{HealthStatus, L2BackendStrategy, ScanResult};
use crate::config::L2Config;
use crate::error::{CacheError, Result};
use async_trait::async_trait;
use redis::{aio::ConnectionManager, Client, RedisResult};
use std::collections::HashMap;
use std::time::Duration;
use tracing::{debug, instrument, warn};

/// 单机 Redis 策略
///
/// 支持单个 Redis 实例,可选配置读从库。
#[allow(dead_code)]
#[derive(Clone)]
pub struct StandaloneStrategy {
    /// Redis 客户端
    client: Client,
    /// 主库连接管理器
    manager: ConnectionManager,
    /// 读从库连接管理器(可选)
    read_manager: Option<ConnectionManager>,
    /// 命令超时时间
    command_timeout: Duration,
}

impl StandaloneStrategy {
    /// 创建单机策略
    ///
    /// # 参数
    /// * `config` - L2 配置
    /// * `client` - Redis 客户端
    /// * `manager` - 主库连接管理器
    /// * `read_manager` - 读从库连接管理器(可选)
    ///
    /// # 返回值
    /// * 新的 StandaloneStrategy 实例
    pub fn new(
        config: &L2Config,
        client: Client,
        manager: ConnectionManager,
        read_manager: Option<ConnectionManager>,
    ) -> Self {
        Self {
            client,
            manager,
            read_manager,
            command_timeout: Duration::from_millis(config.command_timeout_ms),
        }
    }

    /// 获取连接管理器(根据读写选择)
    async fn get_connection(
        &self,
        read_only: bool,
    ) -> std::result::Result<ConnectionManager, CacheError> {
        if read_only {
            if let Some(rm) = &self.read_manager {
                return Ok(rm.clone());
            }
        }
        Ok(self.manager.clone())
    }
}

#[async_trait]
impl L2BackendStrategy for StandaloneStrategy {
    fn name(&self) -> &str {
        "standalone"
    }

    fn is_connected(&self) -> bool {
        // 简单检查:尝试获取连接
        // 实际实现中可以使用 ping
        true
    }

    #[instrument(skip(self), level = "debug", name = "standalone_get")]
    async fn get(&self, key: &str) -> Result<Option<Vec<u8>>> {
        debug!(key, "Getting value from Redis (standalone)");

        let result: RedisResult<Option<Vec<u8>>> = redis::cmd("GET")
            .arg(key)
            .query_async(&mut self.get_connection(false).await?)
            .await;

        match result {
            Ok(value) => Ok(value),
            Err(e) => {
                warn!(key, error = %e, "Failed to get value");
                Err(CacheError::RedisError(e))
            }
        }
    }

    #[instrument(skip(self, value), level = "debug", name = "standalone_set")]
    async fn set(&self, key: &str, value: &[u8], ttl: Option<u64>) -> Result<()> {
        debug!(key, value_len = value.len(), ttl = ?ttl, "Setting value to Redis (standalone)");

        let mut cmd = redis::cmd("SET");
        cmd.arg(key).arg(value);

        if let Some(ttl_secs) = ttl {
            cmd.arg("EX").arg(ttl_secs);
        }

        let result: RedisResult<()> = cmd
            .query_async(&mut self.get_connection(false).await?)
            .await;

        match result {
            Ok(_) => Ok(()),
            Err(e) => {
                warn!(key, error = %e, "Failed to set value");
                Err(CacheError::RedisError(e))
            }
        }
    }

    #[instrument(skip(self), level = "debug", name = "standalone_delete")]
    async fn delete(&self, key: &str) -> Result<bool> {
        debug!(key, "Deleting value from Redis (standalone)");

        let result: RedisResult<i32> = redis::cmd("DEL")
            .arg(key)
            .query_async(&mut self.get_connection(false).await?)
            .await;

        match result {
            Ok(n) => Ok(n > 0),
            Err(e) => {
                warn!(key, error = %e, "Failed to delete value");
                Err(CacheError::RedisError(e))
            }
        }
    }

    #[instrument(skip(self), level = "debug", name = "standalone_exists")]
    async fn exists(&self, key: &str) -> Result<bool> {
        let result: RedisResult<i32> = redis::cmd("EXISTS")
            .arg(key)
            .query_async(&mut self.get_connection(false).await?)
            .await;

        match result {
            Ok(n) => Ok(n > 0),
            Err(e) => Err(CacheError::RedisError(e)),
        }
    }

    #[instrument(skip(self), level = "debug", name = "standalone_expire")]
    async fn expire(&self, key: &str, ttl: u64) -> Result<bool> {
        let result: RedisResult<i32> = redis::cmd("EXPIRE")
            .arg(key)
            .arg(ttl)
            .query_async(&mut self.get_connection(false).await?)
            .await;

        match result {
            Ok(n) => Ok(n > 0),
            Err(e) => Err(CacheError::RedisError(e)),
        }
    }

    #[instrument(skip(self), level = "debug", name = "standalone_ttl")]
    async fn ttl(&self, key: &str) -> Result<Option<i64>> {
        let result: RedisResult<i64> = redis::cmd("TTL")
            .arg(key)
            .query_async(&mut self.get_connection(false).await?)
            .await;

        match result {
            Ok(-2) => Ok(None), // Key does not exist
            Ok(-1) => Ok(None), // Key has no associated expire
            Ok(ttl) => Ok(Some(ttl)),
            Err(e) => Err(CacheError::RedisError(e)),
        }
    }

    async fn get_with_version(&self, key: &str) -> Result<Option<(Vec<u8>, u64)>> {
        // 实现版本化获取:使用 GET 命令获取值
        // 版本号由调用者管理(存储在 key 的 metadata 中)
        // 这是简化实现,实际可以使用 Lua 脚本同时获取值和版本

        let value: Option<Vec<u8>> = self.get(key).await?;

        match value {
            Some(v) => {
                // 版本号需要从外部获取,这里返回 0 作为占位
                // 实际使用中,版本信息应该存储在值中或单独的 key 中
                Ok(Some((v, 0)))
            }
            None => Ok(None),
        }
    }

    async fn compare_and_set(
        &self,
        key: &str,
        value: &[u8],
        _expected_version: u64,
        _new_version: u64,
        ttl: Option<u64>,
    ) -> Result<bool> {
        // 使用 Lua 脚本实现 CAS 操作
        // 脚本检查当前版本,然后设置新值

        let lua_script = r#"
            local current_value = redis.call('GET', KEYS[1])
            if not current_value then
                return 0
            end

            -- 这里应该检查版本号,简化实现略过
            -- 实际实现中需要存储版本信息

            if ARGV[1] == 'SET' then
                if ARGV[3] then
                    redis.call('SET', KEYS[1], ARGV[2], 'EX', ARGV[3])
                else
                    redis.call('SET', KEYS[1], ARGV[2])
                end
                return 1
            end
            return 0
"#;

        let script = redis::Script::new(lua_script);

        let mut conn = self.get_connection(false).await?;
        let result: RedisResult<i32> = script
            .key(key)
            .arg(value)
            .arg("SET")
            .arg(ttl.unwrap_or(0))
            .invoke_async(&mut conn)
            .await;

        match result {
            Ok(n) => Ok(n == 1),
            Err(e) => Err(CacheError::RedisError(e)),
        }
    }

    async fn lock(&self, key: &str, ttl: u64) -> Result<Option<String>> {
        let lock_value = uuid::Uuid::new_v4().to_string();
        let ttl_ms = ttl * 1000;

        let result: RedisResult<Option<String>> = redis::cmd("SET")
            .arg(key)
            .arg(&lock_value)
            .arg("NX")
            .arg("PX")
            .arg(ttl_ms)
            .query_async(&mut self.get_connection(false).await?)
            .await;

        match result {
            Ok(Some(_)) => Ok(Some(lock_value)),
            Ok(None) => Ok(None),
            Err(e) => Err(CacheError::RedisError(e)),
        }
    }

    async fn unlock(&self, key: &str, value: &str) -> Result<bool> {
        let lua_script = r#"
            if redis.call("get", KEYS[1]) == ARGV[1] then
                return redis.call("del", KEYS[1])
            else
                return 0
            end
"#;

        let script = redis::Script::new(lua_script);
        let mut conn = self.get_connection(false).await?;
        let result: RedisResult<i32> = script.key(key).arg(value).invoke_async(&mut conn).await;

        match result {
            Ok(n) => Ok(n == 1),
            Err(e) => Err(CacheError::RedisError(e)),
        }
    }

    async fn mget(
        &self,
        keys: &[&str],
    ) -> std::result::Result<HashMap<String, Vec<u8>>, CacheError> {
        if keys.is_empty() {
            return Ok(HashMap::new());
        }

        let mut cmd = redis::cmd("MGET");
        for &key in keys {
            cmd.arg(key);
        }

        let result: RedisResult<Vec<Option<Vec<u8>>>> =
            cmd.query_async(&mut self.get_connection(true).await?).await;

        match result {
            Ok(values) => {
                let mut map = HashMap::new();
                for (i, value) in values.into_iter().enumerate() {
                    if let Some(v) = value {
                        map.insert(keys[i].to_string(), v);
                    }
                }
                Ok(map)
            }
            Err(e) => Err(CacheError::RedisError(e)),
        }
    }

    async fn mset(&self, items: &[(&str, &[u8])], ttl: Option<u64>) -> Result<()> {
        if items.is_empty() {
            return Ok(());
        }

        let mut cmd = redis::cmd("MSET");
        for &(key, value) in items {
            cmd.arg(key).arg(value);
        }

        // 如果指定了 TTL,需要为每个 key 设置
        // Redis MSET 不支持直接设置 TTL,需要逐个设置
        if let Some(ttl_secs) = ttl {
            let mut conn = self.get_connection(false).await?;
            for &(key, _) in items {
                let _: i32 = redis::cmd("EXPIRE")
                    .arg(key)
                    .arg(ttl_secs)
                    .query_async(&mut conn)
                    .await?;
            }
        }

        let result: RedisResult<()> = cmd
            .query_async(&mut self.get_connection(false).await?)
            .await;

        match result {
            Ok(_) => Ok(()),
            Err(e) => Err(CacheError::RedisError(e)),
        }
    }

    async fn scan(&self, pattern: &str, count: usize, cursor: u64) -> Result<ScanResult> {
        let result: RedisResult<(i32, Vec<String>)> = redis::cmd("SCAN")
            .arg(cursor)
            .arg("MATCH")
            .arg(pattern)
            .arg("COUNT")
            .arg(count)
            .query_async(&mut self.get_connection(false).await?)
            .await;

        match result {
            Ok((next_cursor, keys)) => Ok(ScanResult {
                keys,
                cursor: next_cursor as u64,
            }),
            Err(e) => Err(CacheError::RedisError(e)),
        }
    }

    async fn scan_keys(&self, pattern: &str, limit: usize) -> Result<Vec<String>> {
        let mut keys = Vec::new();
        let mut cursor = 0u64;

        while keys.len() < limit {
            let result = self.scan(pattern, 1000, cursor).await?;
            keys.extend(result.keys);

            cursor = result.cursor;
            if cursor == 0 {
                break;
            }
        }

        keys.truncate(limit);
        Ok(keys)
    }

    async fn ping(&self) -> Result<()> {
        let result: RedisResult<String> = redis::cmd("PING")
            .query_async(&mut self.get_connection(false).await?)
            .await;

        match result {
            Ok(_) => Ok(()),
            Err(e) => Err(CacheError::RedisError(e)),
        }
    }

    async fn health_check(&self) -> Result<HealthStatus> {
        match self.ping().await {
            Ok(_) => Ok(HealthStatus::Healthy),
            Err(e) => Ok(HealthStatus::Unhealthy(e.to_string())),
        }
    }

    fn command_timeout(&self) -> Duration {
        self.command_timeout
    }

    async fn close(&self) -> Result<()> {
        // ConnectionManager 在 drop 时会自动关闭连接
        // 这里可以添加额外的清理逻辑
        debug!("Closing standalone strategy connection");
        Ok(())
    }
}