yang-base 0.1.0

个人使用构建后端服务器
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
//! 全局 Redis 访问器
//!
//! 提供线程安全的全局 Redis 实例访问。
//!
//! # 设计说明
//!
//! GlobalRedis 是对 yang-db::RedisClient 的封装,使用 OnceLock 实现全局单例模式。
//! 所有 Redis 操作都通过 yang-db 库实现,确保类型安全和统一的 Redis 访问接口。
//!
//! # 示例
//!
//! ```rust,ignore
//! use yang_base::database::GlobalRedis;
//! use yang_db::redis::RedisConfig;
//!
//! // 初始化全局 Redis
//! GlobalRedis::init("redis://127.0.0.1:6379", RedisConfig::default()).await?;
//!
//! // String 操作
//! GlobalRedis::set("key", "value", None).await?;
//! let value = GlobalRedis::get("key").await?;
//!
//! // Hash 操作
//! GlobalRedis::hset("user:1", "name", "Alice").await?;
//! let name = GlobalRedis::hget("user:1", "name").await?;
//!
//! // List 操作
//! GlobalRedis::lpush("queue", vec!["task1", "task2"]).await?;
//! let task = GlobalRedis::lpop("queue").await?;
//! ```

use crate::error::BaseError;
use std::sync::OnceLock;
use yang_db::redis::{RedisClient, RedisConfig};

/// 全局 Redis 实例
///
/// 使用 OnceLock 确保线程安全的单例模式
static GLOBAL_REDIS: OnceLock<RedisClient> = OnceLock::new();

/// 全局 Redis 访问器
///
/// 封装 yang-db::RedisClient,提供全局静态访问接口。
/// 所有 Redis 操作都通过 yang-db 库实现。
pub struct GlobalRedis;

impl GlobalRedis {
    /// 初始化全局 Redis
    ///
    /// # 参数
    ///
    /// - `url`: Redis 连接字符串,格式:`redis://host:port` 或 `redis://:password@host:port`
    /// - `config`: Redis 配置,包含连接池参数
    ///
    /// # 返回
    ///
    /// - `Ok(())`: 初始化成功
    /// - `Err(BaseError)`: 初始化失败
    ///
    /// # 错误
    ///
    /// - `RedisConnectionFailed`: Redis 连接失败
    /// - `RedisAlreadyInitialized`: Redis 已经初始化
    ///
    /// # 示例
    ///
    /// ```rust,ignore
    /// use yang_base::database::GlobalRedis;
    /// use yang_db::redis::RedisConfig;
    ///
    /// let config = RedisConfig::new(10, 5, 300, true);
    ///
    /// GlobalRedis::init("redis://127.0.0.1:6379", config).await?;
    /// ```
    pub async fn init(url: &str, config: RedisConfig) -> Result<(), BaseError> {
        // 使用 yang-db::RedisClient::connect_with_config 创建 Redis 连接
        let client = RedisClient::connect_with_config(url, config)
            .await
            .map_err(|e| BaseError::RedisConnectionFailed(e.to_string()))?;

        // 设置全局 Redis 实例
        GLOBAL_REDIS
            .set(client)
            .map_err(|_| BaseError::RedisAlreadyInitialized)?;

        log::info!("全局 Redis 已初始化");
        Ok(())
    }

    /// 获取全局 Redis 实例
    ///
    /// # 返回
    ///
    /// - `Ok(&'static RedisClient)`: yang-db::RedisClient 实例的静态引用
    /// - `Err(BaseError)`: Redis 未初始化
    ///
    /// # 错误
    ///
    /// - `RedisNotInitialized`: Redis 未初始化,需要先调用 `init` 方法
    pub fn client() -> Result<&'static RedisClient, BaseError> {
        GLOBAL_REDIS.get().ok_or(BaseError::RedisNotInitialized)
    }

    // ==================== String 操作 ====================

    /// 设置字符串值
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `value`: 值
    /// - `expire_seconds`: 过期时间(秒),None 表示不过期
    ///
    /// # 返回
    ///
    /// - `Ok(())`: 设置成功
    /// - `Err(BaseError)`: 设置失败
    pub async fn set(
        key: impl Into<String>,
        value: impl Into<String>,
        expire_seconds: Option<i64>,
    ) -> Result<(), BaseError> {
        let key_str = key.into();
        let value_str = value.into();

        if let Some(seconds) = expire_seconds {
            // 使用 SETEX 设置带过期时间的值
            Self::client()?
                .setex(key_str, seconds, value_str)
                .await
                .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
        } else {
            // 使用 SET 设置不过期的值
            Self::client()?
                .set(key_str, value_str)
                .await
                .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
        }
    }

    /// 获取字符串值
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    ///
    /// # 返回
    ///
    /// - `Ok(Some(String))`: 获取成功,返回值
    /// - `Ok(None)`: 键不存在
    /// - `Err(BaseError)`: 获取失败
    pub async fn get(key: impl Into<String>) -> Result<Option<String>, BaseError> {
        Self::client()?
            .get(key)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 删除键
    ///
    /// # 参数
    ///
    /// - `keys`: 键名列表
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 删除的键数量
    /// - `Err(BaseError)`: 删除失败
    pub async fn del(keys: &[String]) -> Result<i64, BaseError> {
        Self::client()?
            .del(keys)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 检查键是否存在
    ///
    /// # 参数
    ///
    /// - `keys`: 键名列表
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 存在的键数量
    /// - `Err(BaseError)`: 检查失败
    pub async fn exists(keys: &[String]) -> Result<i64, BaseError> {
        Self::client()?
            .exists(keys)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 设置键的过期时间
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `seconds`: 过期时间(秒)
    ///
    /// # 返回
    ///
    /// - `Ok(bool)`: true 表示设置成功,false 表示键不存在
    /// - `Err(BaseError)`: 设置失败
    pub async fn expire(key: impl Into<String>, seconds: i64) -> Result<bool, BaseError> {
        Self::client()?
            .expire(key, seconds)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 获取键的剩余生存时间
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 剩余秒数,-1 表示没有过期时间,-2 表示键不存在
    /// - `Err(BaseError)`: 获取失败
    pub async fn ttl(key: impl Into<String>) -> Result<i64, BaseError> {
        Self::client()?
            .ttl(key)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 移除键的过期时间
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    ///
    /// # 返回
    ///
    /// - `Ok(bool)`: true 表示成功,false 表示键不存在或没有过期时间
    /// - `Err(BaseError)`: 操作失败
    pub async fn persist(key: impl Into<String>) -> Result<bool, BaseError> {
        Self::client()?
            .persist(key)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 查找所有匹配给定模式的键
    ///
    /// # 参数
    ///
    /// - `pattern`: 匹配模式(支持 * ? [] 等通配符)
    ///
    /// # 返回
    ///
    /// - `Ok(Vec<String>)`: 匹配的键列表
    /// - `Err(BaseError)`: 查找失败
    pub async fn keys(pattern: impl Into<String>) -> Result<Vec<String>, BaseError> {
        Self::client()?
            .keys(pattern)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    // ==================== Hash 操作 ====================

    /// 设置 Hash 字段值
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `field`: 字段名
    /// - `value`: 值
    ///
    /// # 返回
    ///
    /// - `Ok(bool)`: true 表示新字段,false 表示更新已有字段
    /// - `Err(BaseError)`: 设置失败
    pub async fn hset(
        key: impl Into<String>,
        field: impl Into<String>,
        value: impl Into<String>,
    ) -> Result<bool, BaseError> {
        Self::client()?
            .hset(key, field, value)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 获取 Hash 字段值
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `field`: 字段名
    ///
    /// # 返回
    ///
    /// - `Ok(Some(String))`: 获取成功,返回值
    /// - `Ok(None)`: 字段不存在
    /// - `Err(BaseError)`: 获取失败
    pub async fn hget(
        key: impl Into<String>,
        field: impl Into<String>,
    ) -> Result<Option<String>, BaseError> {
        Self::client()?
            .hget(key, field)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 删除 Hash 字段
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `fields`: 字段名列表
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 删除的字段数量
    /// - `Err(BaseError)`: 删除失败
    pub async fn hdel(key: impl Into<String>, fields: &[String]) -> Result<i64, BaseError> {
        Self::client()?
            .hdel(key, fields)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 获取 Hash 所有字段和值
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    ///
    /// # 返回
    ///
    /// - `Ok(Vec<(String, String)>)`: 所有字段和值的列表
    /// - `Err(BaseError)`: 获取失败
    pub async fn hgetall(key: impl Into<String>) -> Result<Vec<(String, String)>, BaseError> {
        Self::client()?
            .hgetall(key)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 检查 Hash 字段是否存在
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `field`: 字段名
    ///
    /// # 返回
    ///
    /// - `Ok(bool)`: true 表示存在,false 表示不存在
    /// - `Err(BaseError)`: 检查失败
    pub async fn hexists(
        key: impl Into<String>,
        field: impl Into<String>,
    ) -> Result<bool, BaseError> {
        Self::client()?
            .hexists(key, field)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 获取 Hash 字段数量
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 字段数量
    /// - `Err(BaseError)`: 获取失败
    pub async fn hlen(key: impl Into<String>) -> Result<i64, BaseError> {
        Self::client()?
            .hlen(key)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    // ==================== List 操作 ====================

    /// 从列表左侧推入元素
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `values`: 值列表
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 推入后列表长度
    /// - `Err(BaseError)`: 推入失败
    pub async fn lpush(key: impl Into<String>, values: &[String]) -> Result<i64, BaseError> {
        Self::client()?
            .lpush(key, values)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 从列表右侧推入元素
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `values`: 值列表
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 推入后列表长度
    /// - `Err(BaseError)`: 推入失败
    pub async fn rpush(key: impl Into<String>, values: &[String]) -> Result<i64, BaseError> {
        Self::client()?
            .rpush(key, values)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 从列表左侧弹出元素
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    ///
    /// # 返回
    ///
    /// - `Ok(Some(String))`: 弹出的元素
    /// - `Ok(None)`: 列表为空
    /// - `Err(BaseError)`: 弹出失败
    pub async fn lpop(key: impl Into<String>) -> Result<Option<String>, BaseError> {
        Self::client()?
            .lpop(key)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 从列表右侧弹出元素
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    ///
    /// # 返回
    ///
    /// - `Ok(Some(String))`: 弹出的元素
    /// - `Ok(None)`: 列表为空
    /// - `Err(BaseError)`: 弹出失败
    pub async fn rpop(key: impl Into<String>) -> Result<Option<String>, BaseError> {
        Self::client()?
            .rpop(key)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 获取列表长度
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 列表长度
    /// - `Err(BaseError)`: 获取失败
    pub async fn llen(key: impl Into<String>) -> Result<i64, BaseError> {
        Self::client()?
            .llen(key)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 获取列表指定范围的元素
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `start`: 起始索引(0 表示第一个元素)
    /// - `stop`: 结束索引(-1 表示最后一个元素)
    ///
    /// # 返回
    ///
    /// - `Ok(Vec<String>)`: 元素列表
    /// - `Err(BaseError)`: 获取失败
    pub async fn lrange(
        key: impl Into<String>,
        start: i64,
        stop: i64,
    ) -> Result<Vec<String>, BaseError> {
        Self::client()?
            .lrange(key, start, stop)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    // ==================== Set 操作 ====================

    /// 向集合添加成员
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `members`: 成员列表
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 添加的成员数量
    /// - `Err(BaseError)`: 添加失败
    pub async fn sadd(key: impl Into<String>, members: &[String]) -> Result<i64, BaseError> {
        Self::client()?
            .sadd(key, members)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 从集合移除成员
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `members`: 成员列表
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 移除的成员数量
    /// - `Err(BaseError)`: 移除失败
    pub async fn srem(key: impl Into<String>, members: &[String]) -> Result<i64, BaseError> {
        Self::client()?
            .srem(key, members)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 检查成员是否在集合中
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `member`: 成员
    ///
    /// # 返回
    ///
    /// - `Ok(bool)`: true 表示存在,false 表示不存在
    /// - `Err(BaseError)`: 检查失败
    pub async fn sismember(
        key: impl Into<String>,
        member: impl Into<String>,
    ) -> Result<bool, BaseError> {
        Self::client()?
            .sismember(key, member)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 获取集合所有成员
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    ///
    /// # 返回
    ///
    /// - `Ok(Vec<String>)`: 成员列表
    /// - `Err(BaseError)`: 获取失败
    pub async fn smembers(key: impl Into<String>) -> Result<Vec<String>, BaseError> {
        Self::client()?
            .smembers(key)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 获取集合成员数量
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 成员数量
    /// - `Err(BaseError)`: 获取失败
    pub async fn scard(key: impl Into<String>) -> Result<i64, BaseError> {
        Self::client()?
            .scard(key)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    // ==================== Sorted Set 操作 ====================

    /// 向有序集合添加成员
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `members`: 成员和分数列表 (score, member)
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 添加的成员数量
    /// - `Err(BaseError)`: 添加失败
    pub async fn zadd(key: impl Into<String>, members: &[(f64, String)]) -> Result<i64, BaseError> {
        Self::client()?
            .zadd(key, members)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 从有序集合移除成员
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `members`: 成员列表
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 移除的成员数量
    /// - `Err(BaseError)`: 移除失败
    pub async fn zrem(key: impl Into<String>, members: &[String]) -> Result<i64, BaseError> {
        Self::client()?
            .zrem(key, members)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 获取有序集合成员数量
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    ///
    /// # 返回
    ///
    /// - `Ok(i64)`: 成员数量
    /// - `Err(BaseError)`: 获取失败
    pub async fn zcard(key: impl Into<String>) -> Result<i64, BaseError> {
        Self::client()?
            .zcard(key)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }

    /// 获取有序集合指定范围的成员(按分数从小到大)
    ///
    /// # 参数
    ///
    /// - `key`: 键名
    /// - `start`: 起始索引
    /// - `stop`: 结束索引
    ///
    /// # 返回
    ///
    /// - `Ok(Vec<String>)`: 成员列表
    /// - `Err(BaseError)`: 获取失败
    pub async fn zrange(
        key: impl Into<String>,
        start: i64,
        stop: i64,
    ) -> Result<Vec<String>, BaseError> {
        Self::client()?
            .zrange(key, start, stop)
            .await
            .map_err(|e| BaseError::RedisOperationFailed(e.to_string()))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_redis_not_initialized() {
        // 测试未初始化时获取 Redis 实例
        let result = GlobalRedis::client();
        assert!(result.is_err());
        assert!(matches!(result, Err(BaseError::RedisNotInitialized)));
    }
}