# csz-library

**Repository Path**: gnehSoM/csz-library

## Basic Information

- **Project Name**: csz-library
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-27
- **Last Updated**: 2026-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# csz-library

## 项目简介

csz-library 是一个基于 Spring Boot 框架的图书馆管理系统，采用微服务架构，提供用户信息维护和图书管理等功能。

## 技术栈

- **Java 17**
- **Spring Boot 3.2.3**
- **Maven 3.6+**
- **Spring Cloud Nacos** (配置中心和服务发现)
- **MySQL 8.0** (关系型数据库)
- **Redis** (缓存数据库)
- **MyBatis-Plus 3.5.5** (ORM 框架)
- **SpringDoc 2.4.0** (API 文档)
- **Lombok** (代码简化工具)
- **Spring Security** (身份认证和授权)

## 项目结构

```
csz-library/
├── common-module/         # 公共模块，包含共享配置和工具类
│   ├── src/main/java/com/csz/cszlibrary/  # 主要源代码
│   └── src/main/resources/                # 资源文件
├── user-module/           # 用户信息维护模块
│   ├── src/main/java/com/csz/cszlibrary/  # 主要源代码
│   └── src/main/resources/                # 资源文件
├── book-module/           # 图书管理模块
│   ├── src/main/java/com/csz/cszlibrary/  # 主要源代码
│   └── src/main/resources/                # 资源文件
├── .mvn/                  # Maven 包装器配置
├── .gitattributes         # Git 属性配置
├── .gitignore             # Git 忽略配置
├── mvnw                   # Maven 包装器脚本（Linux/Mac）
├── mvnw.cmd               # Maven 包装器脚本（Windows）
├── pom.xml                # Maven 项目配置
├── README.md              # 项目说明文档
└── LICENSE                # MIT 许可证文件
```

## 快速开始

### 前提条件

- JDK 17 或更高版本
- Maven 3.6 或更高版本
- MySQL 8.0 数据库（已创建 csz-lib 数据库）
- Redis 服务
- Nacos 服务（可选，用于配置中心和服务发现）

### 环境配置

1. **MySQL 配置**：
   - 数据库：csz-lib
   - 用户名：root
   - 密码：123456

2. **Redis 配置**：
   - 主机：localhost
   - 端口：6379
   - 密码：123456

### 构建和运行

1. 克隆项目

```bash
git clone <项目地址>
cd csz-library
```

2. 构建项目

```bash
./mvnw clean package -DskipTests
```

3. 运行模块

**运行用户模块**：
```bash
java -jar user-module/target/user-module-0.0.1-SNAPSHOT.jar
```

**运行图书模块**：
```bash
java -jar book-module/target/book-module-0.0.1-SNAPSHOT.jar
```

### 访问地址

- **用户模块**：http://localhost:10002
- **图书模块**：http://localhost:10003
- **用户模块 Swagger UI**：http://localhost:10002/swagger-ui.html
- **图书模块 Swagger UI**：http://localhost:10003/swagger-ui.html

### 登录信息

- **用户名**：admin
- **密码**：123456

## 功能特性

### 用户模块 (user-module)
- [x] 用户信息维护
- [x] 登录认证
- [x] API 文档

### 图书模块 (book-module)
- [x] 图书管理
- [x] API 文档

## 模块说明

- **common-module**：包含公共配置、工具类和安全配置，被其他模块依赖
- **user-module**：用户信息维护模块，端口 10002
- **book-module**：图书管理模块，端口 10003

## 开发指南

### 在 VS Code 中开发

1. 安装必要的扩展：
   - Java Extension Pack
   - Spring Boot Extension Pack

2. 启动方式：
   - 使用 Spring Boot Dashboard 启动各个模块
   - 使用 Run and Debug 配置启动
   - 使用终端命令启动

### 代码规范

- 遵循 Spring Boot 代码规范
- 使用 Lombok 简化代码
- 使用 MyBatis-Plus 进行数据库操作
- 使用 SpringDoc 生成 API 文档

## 贡献指南

1. Fork 项目
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 打开 Pull Request

## 许可证

本项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件

## 联系信息

- 项目维护者：CSZ
- 项目地址：<项目地址>