# lzh-1.8-redis-spring-boot-starter

**Repository Path**: coding_13/lzh-1.8-redis-spring-boot-starter

## Basic Information

- **Project Name**: lzh-1.8-redis-spring-boot-starter
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-08-09
- **Last Updated**: 2025-08-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# lzh-1.8-redis-spring-boot-starter

`lzh-1.8-redis-spring-boot-starter` 是一个基于 Spring Boot 的 Redis 集成启动器，旨在简化 Redis 在 Spring Boot 项目中的使用。它不仅封装了常用的 Redis 操作，还提供了分布式锁功能，适用于需要高并发和分布式处理的场景。

## 功能特性

- **Redis 操作封装**：通过 `RedisUtil` 提供了丰富的 Redis 操作方法，涵盖字符串、哈希、列表、集合、有序集合等数据结构。
- **分布式锁支持**：基于 Redisson 实现了注解驱动的分布式锁机制，通过 `@DistributedLock` 注解即可轻松实现分布式锁。
- **自动配置支持**：提供 `RedisConfig` 和 `RedissonConfig` 自动配置类，简化了 Redis 和 Redisson 的集成配置。
- **自定义序列化**：使用 `FastJsonRedisSerializer` 对 Redis 的键值进行序列化和反序列化，提升性能。

## 快速开始

### 1. 添加依赖

在 `pom.xml` 中添加以下依赖：

```xml
<dependency>
    <groupId>com.lzh</groupId>
    <artifactId>lzh-1.8-redis-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>
```

### 2. 配置 Redis 和 Redisson

在 `application.yml` 或 `application.properties` 中配置 Redis 和 Redisson 相关参数：

```yaml
spring:
  redis:
    host: localhost
    port: 6379
  redisson:
    enable: true
    timeout: 3000
    retryAttempts: 3
    retryInterval: 1000
```

### 3. 使用 Redis 工具类

注入 `RedisUtil` 并使用其提供的方法操作 Redis：

```java
@Autowired
private RedisUtil redisUtil;

public void exampleUsage() {
    String key = "exampleKey";
    String value = "exampleValue";

    // 设置键值
    redisUtil.set(key, value);

    // 获取键值
    Object result = redisUtil.get(key);
}
```

### 4. 使用分布式锁

在需要加锁的方法上添加 `@DistributedLock` 注解：

```java
@Service
public class ExampleService {

    @DistributedLock
    public void lockedMethod() {
        // 业务逻辑
    }
}
```

## 配置说明

| 配置项 | 描述 |
|-------|------|
| `spring.redis.host` | Redis 服务器地址，默认为 `localhost` |
| `spring.redis.port` | Redis 服务器端口，默认为 `6379` |
| `spring.redisson.enable` | 是否启用 Redisson 分布式锁，默认为 `true` |
| `spring.redisson.timeout` | Redisson 客户端超时时间（毫秒） |
| `spring.redisson.retryAttempts` | Redisson 客户端重试次数 |
| `spring.redisson.retryInterval` | Redisson 客户端重试间隔（毫秒） |

## 项目结构

- `RedisUtil`：封装了 Redis 的常用操作。
- `RedisConfig`：Redis 自动配置类。
- `RedissonConfig`：Redisson 自动配置类。
- `RedissonProperties`：Redisson 配置属性类。
- `FastJsonRedisSerializer`：Redis 序列化工具类。
- `DistributedLock`：分布式锁注解。
- `DistributedLockAdvice`：分布式锁切面逻辑。

## 贡献指南

欢迎贡献代码和改进文档。请遵循以下步骤：

1. Fork 项目。
2. 创建新分支 (`git checkout -b feature/new-feature`)。
3. 提交更改 (`git commit -am 'Add some feature'`)。
4. 推送分支 (`git push origin feature/new-feature`)。
5. 创建 Pull Request。

## 许可证

本项目采用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。