# fairy-core-parent

**Repository Path**: integration-project/fairy-core-parent

## Basic Information

- **Project Name**: fairy-core-parent
- **Description**: fairy 核心包
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-21
- **Last Updated**: 2026-03-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# fairy-core-parent

## 项目介绍

fairy-core-parent 是一个企业级Java后台管理系统核心框架，采用Spring Boot构建，提供完整的业务功能模块支撑。该项目采用模块化设计，各模块职责明确、耦合度低，便于独立部署和维护。

## 软件架构

项目采用Maven多模块架构，主要包含以下核心模块：

| 模块名称 | 功能描述 |
|---------|---------|
| fairy-core-common | 公共模块，提供基础类、工具类、异常处理、线程池管理等通用能力 |
| fairy-core-security | 安全认证模块，实现OAuth2授权、用户认证、JWT令牌解析等功能 |
| fairy-core-security-client | OAuth2客户端模块，支持第三方应用接入授权 |
| fairy-core-security-resource | 资源保护模块，提供API访问控制和用户信息注入 |
| fairy-core-infras | 基础设施模块，集成Mybatis、Redis、Elasticsearch等组件 |
| fairy-core-log | 日志记录模块，基于Elasticsearch实现日志存储和查询 |
| fairy-core-system | 系统配置模块，管理字典、菜单、公告、系统参数等 |
| fairy-core-user | 用户管理模块，实现用户、角色、权限的完整CRUD |
| fairy-core-beetlsql | 代码生成模块，支持Java/Vue代码自动生成 |
| fairy-core-forum | 论坛功能模块，提供帖子、回复、点赞等功能 |
| fairy-core-story | 故事文章模块，基于Elasticsearch的内容管理 |
| fair-core-ai | AI集成模块，支持DeepSeek、微信公众号、掘金等平台接入 |

## 技术栈

- **核心框架**：Spring Boot 3.0.2 / Spring Security OAuth2
- **数据库**：MySQL、Redis、MongoDB、Elasticsearch
- **ORM**：Mybatis-Plus、BeetlSQL
- **安全认证**：JWT、OAuth2授权码模式
- **API文档**：Swagger/OpenAPI 3.0

## 模块详解

### 核心模块

#### fairy-core-common
公共基础模块，包含：
- 全局异常处理（BusinessException、BaseException）
- CORS跨域配置
- 线程池监控（`/thread-monitor`接口）
- UUID雪花算法生成器
- 白名单过滤器

#### fairy-core-security
安全认证核心模块，提供：
- 自定义授权类型（密码模式、邮箱模式）
- JWT令牌生成与解析
- 用户注册、登录、登出
- RSA密钥对支持
- 在线用户会话管理

#### fairy-core-infras
基础设施集成模块：
- Redis序列化配置（FastJson）
- Elasticsearch索引自动创建
- 文档版本控制（BaseObject）
- 基础CRUD模板（BaseController、BaseFairyService）

### 业务模块

#### fairy-core-system
系统管理模块：
- 公告管理（Announcement）
- 投诉管理（Complaint）
- 轮播图配置（FcSysCarousel）
- 系统参数（FcSysConfig）
- 字典数据（FcSysDict）
- 菜单权限（FcSysMenus）

#### fairy-core-user
用户与权限模块：
- 用户信息（FcUser）
- 角色管理（FcRole）
- 角色权限关联（FcRolePermissions）
- 用户角色关联（FcUserRole）
- 用户登录记录（FcUserLoginRecord）
- 用户会员信息（FcUserMember）
- 用户扩展信息（FcUserProfile）

#### fairy-core-forum
论坛功能模块：
- 论坛分类（ForumCategory）
- 帖子管理（ForumPost）
- 回复管理（ForumReply）
- 点赞功能（ForumLike）
- 事件监听机制

#### fairy-core-beetlsql
代码生成模块：
- 数据库表扫描（`/table/scan`）
- 代码生成接口（`/public/gen-code/{tableName}`）
- 支持Vue/Java代码模板
- 自动生成Controller、Service、Mapper

## API文档

项目集成Swagger/OpenAPI文档，访问地址：
```
http://ip:port/doc.html
```

## 快速开始

### 环境要求

- JDK 17
- Maven 3.9+
- MySQL 8.0+
- Redis 7+
- Elasticsearch 7.x+

### 编译构建

```bash
# 克隆项目
git clone https://gitee.com/integration-project/fairy-core-parent.git

# 编译项目
mvn clean install -DskipTests

# 启动各模块（根据需求选择）
java -jar fairy-core-admin/target/fairy-core-admin.jar
```

### 配置说明

主要配置文件路径：
- `fairy-core-security/src/main/resources/config/dev/` - 开发环境配置
- `fairy-core-security/src/main/resources/config/pro/` - 生产环境配置

关键配置项：
```yaml
# JWT配置
jwt:
  public-key.path: public_key.pem
  private-key.path: private_key.pem

# OAuth2配置
spring.security.oauth2.resourceserver.jwt.issuer-uri: xxx

# 线程池配置
fairy.thread-pool.enabled: true
fairy.thread-pool.corePoolSize: 10
fairy.thread-pool.maximumPoolSize: 50
```

## 模块文档

各模块详细说明请参考对应目录的README：

- [公共模块](fairy-core-common/README.md)
- [基础设施模块](fairy-core-infras/README.md)
- [日志模块](fairy-core-log/README.md)
- [安全模块](fairy-core-security/readme.md)
- [授权资源模块](fairy-core-security-resource/README.md)
- [系统模块](fairy-core-system/README.md)
- [用户模块](fairy-core-user/README.md)
- [故事模块](fairy-core-story/README.md)
- [论坛模块](fairy-core-forum/HELP.md)
- [beetlsql模块](fairy-core-beetlsql/HELP.md)

## 许可证

本项目遵循开源许可证协议。