# library

**Repository Path**: qiaoyuning/library

## Basic Information

- **Project Name**: library
- **Description**: 本项目是一个基于 Spring Boot 3.1.0 的图书管理系统。核心框架: Spring Boot, Spring Data JPA, Spring Security，开发语言: Java 17，数据库: MySQL，API文档: SpringDoc (Swagger UI)，本文档旨在为新开发者提供清晰、完整的项目启动和运行指南。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-02
- **Last Updated**: 2025-11-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 图书管理系统 - 项目运行手册

## 1. 项目概述

本项目是一个基于 **Spring Boot 3.1.0** 的图书管理系统。

- **核心框架**: Spring Boot, Spring Data JPA, Spring Security
- **开发语言**: Java 17
- **数据库**: MySQL
- **API文档**: SpringDoc (Swagger UI)

本文档旨在为新开发者提供清晰、完整的项目启动和运行指南。

## 2. 环境要求

请确保您的开发环境满足以下要求：

- **JDK**: `Java 17` (必须，Spring Boot 3.x 要求)
- **数据库**: `MySQL 8.0` 或更高版本
- **IDE**: 推荐 `IntelliJ IDEA`
- **Maven**: 项目自带 Maven Wrapper (`mvnw`)，无需单独安装。

## 3. 首次配置与启动步骤

请严格按照以下步骤操作，以确保项目顺利运行。

### 步骤 3.1: 创建并配置数据库

1.  在您的 MySQL 服务中创建一个新的数据库，名称为 `library`。
    ```sql
    CREATE DATABASE library CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
    ```
2.  打开项目配置文件 `src/main/resources/application.properties`，根据您的本地环境修改数据库连接信息：
    ```properties
    spring.datasource.url=jdbc:mysql://localhost:3306/library?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    spring.datasource.username=root
    spring.datasource.password=123456 # <= 修改为您的MySQL密码
    ```

### 步骤 3.2: 导入数据库结构与初始数据

项目的数据库备份文件位于 `src/main/resources/sql/library.sql`。

打开命令行工具，进入项目根目录，执行以下命令将数据导入到您刚创建的 `library` 数据库中：

```bash
# 语法: mysql -u[用户名] -p[密码] [数据库名] < [SQL文件路径]
mysql -uroot -p123456 library < src/main/resources/sql/library.sql
```
**注意**: 请将 `-uroot` 和 `-p123456` 替换为您自己的数据库用户名和密码。

### 步骤 3.3: 安装项目依赖

在项目根目录下，执行以下命令下载所有必需的依赖包：

- **Windows**: `mvnw.cmd clean install`
- **Linux / macOS**: `./mvnw clean install`

### 步骤 3.4: 运行项目

您可以通过以下两种方式启动项目：

1.  **通过 IDE 运行**:
    - 在 IntelliJ IDEA 中，找到主启动类 `LibraryApplication.java`。
    - 右键点击该文件，选择 `Run 'LibraryApplication'`。

2.  **通过 Maven 命令运行**:
    - 在项目根目录的命令行中执行：
      - **Windows**: `mvnw.cmd spring-boot:run`
      - **Linux / macOS**: `./mvnw spring-boot:run`

项目启动成功后，服务将运行在 `8090` 端口。

## 4. 访问项目

- **后端服务地址**: `http://localhost:8090`
- **API 文档 (Swagger)**: `http://localhost:8090/swagger-ui.html`

您可以通过访问 Swagger UI 地址来查看和测试所有可用的 API 接口。

## 5. 关键文件结构

```
library/
├── .mvn/                  # Maven Wrapper
├── src/
│   ├── main/
│   │   ├── java/          # Java 源代码
│   │   └── resources/
│   │       ├── sql/
│   │       │   └── library.sql  # <== 数据库初始化脚本
│   │       └── application.properties # <== 核心配置文件
│   └── test/              # 测试代码
├── pom.xml                # Maven 项目配置文件
└── RUNNING.md             # 本运行手册
```