# simple-server

**Repository Path**: it4/simple-server

## Basic Information

- **Project Name**: simple-server
- **Description**: 一个适合学习使用的简易的管理系统的后端服务，配置简单上手容易
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-10
- **Last Updated**: 2026-05-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: SpringBoot

## README

# Simple Server - 用户中心后端服务

基于 Spring Boot 3 构建的用户中心后端服务，提供用户管理、JWT 鉴权、文件上传等功能。

## 📋 目录

- [技术栈](#技术栈)
- [功能特性](#功能特性)
- [环境要求](#环境要求)
- [快速开始](#快速开始)
- [配置说明](#配置说明)
- [API 文档](#api-文档)
- [项目结构](#项目结构)
- [常见问题](#常见问题)

## 🛠 技术栈

- **核心框架**: Spring Boot 3.2.4
- **数据库**: MySQL 8.0 + MyBatis Plus 3.5.15
- **缓存**: Redis
- **安全认证**: JWT (jjwt 0.11.5)
- **文件存储**: x-file-storage 2.2.1 (支持阿里云 OSS)
- **工具库**: Hutool 5.8.40
- **API 文档**: Knife4j 4.4.0
- **Java 版本**: JDK 17

## ✨ 功能特性

- ✅ 用户注册/登录（BCrypt 密码加密）
- ✅ JWT Token 认证与授权
- ✅ 角色权限控制（普通用户/管理员）
- ✅ 验证码生成与校验
- ✅ 文件上传（阿里云 OSS）
- ✅ 全局异常处理
- ✅ 统一响应格式
- ✅ API 接口文档（Knife4j）
- ✅ 逻辑删除
- ✅ 跨域支持

## 📦 环境要求

- JDK 17+
- Maven 3.6+
- MySQL 8.0+
- Redis 6.0+
- 阿里云 OSS 账号（用于文件存储）

## 🚀 快速开始

### 1. 克隆项目

```bash
git clone https://gitee.com/it4/simple-server.git
cd simple-server
```

### 2. 创建数据库并导入 SQL

```sql
-- 创建数据库
CREATE
DATABASE simple_db DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

-- 导入表结构
USE
simple_db;
SOURCE
sql/user.sql;
```

### 3. 配置敏感信息（⚠️ 重要！）

#### ⚠️ 必须替换阿里云 OSS 配置

**本项目使用阿里云 OSS 进行文件存储，请务必替换为你自己的 OSS 配置！**

在 `src/main/resources/application-dev.yml` 文件末尾添加以下配置：

```yaml
# JWT 配置
jwt:
  secret-key: your_jwt_secret_key_here  # 建议修改为随机字符串（至少32位）

# 阿里云 OSS 配置（⚠️ 必须替换为你自己的信息）
dromara:
  x-file-storage:
    aliyun-oss:
      - platform: aliyun-oss-1
        access-key: YOUR_ACCESS_KEY_HERE        # ← 替换为你的 AccessKey
        secret-key: YOUR_SECRET_KEY_HERE        # ← 替换为你的 SecretKey
        end-point: oss-cn-beijing.aliyuncs.com  # ← 替换为你的 Endpoint
        bucket-name: your-bucket-name           # ← 替换为你的 Bucket 名称
        domain: https://your-bucket-name.oss-cn-beijing.aliyuncs.com/  # ← 替换为你的访问域名
        base-path: picture/
```

> **🔒 安全提示**：
> - ⚠️ **请勿使用示例中的密钥**，必须替换为你自己阿里云账号的 OSS 配置
> - 如何获取 OSS 配置：登录 [阿里云 OSS 控制台](https://oss.console.aliyun.com/) 创建 Bucket 并获取 AccessKey
> - 不要将真实的密钥提交到 Git 仓库

### 4. 修改数据库和 Redis 配置

编辑 `src/main/resources/application-dev.yml`，修改以下内容为你本地的配置：

```yaml
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/simple_db?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
    username: root          # ← 替换为你的 MySQL 用户名
    password: your_password # ← 替换为你的 MySQL 密码
  data:
    redis:
      host: localhost       # ← 替换为你的 Redis 地址
      port: 6379            # ← 替换为你的 Redis 端口
      # password: your_redis_password  # ← 如果 Redis 有密码则取消注释
```

### 5. 启动项目

```bash
# 方式一：使用 Maven（推荐）
mvn spring-boot:run

# 方式二：打包后运行
mvn clean package -DskipTests
java -jar target/simple-server-0.0.1-SNAPSHOT.jar
```

### 6. 访问应用

- **服务地址**: http://localhost:8054/api
- **API 文档**: http://localhost:8054/api/doc.html
- **健康检查**: http://localhost:8054/api/health/check

## ⚙️ 配置说明

### 主要配置项

- **服务器端口**: 8054（可在 application-dev.yml 中修改）
- **上下文路径**: /api
- **文件上传限制**: 单文件最大 10MB
- **JWT Token 有效期**: 2 小时
- **数据库**: MySQL 8.0+
- **缓存**: Redis 6.0+