# Easy-Admin

**Repository Path**: suddenlyyo/Easy-Admin

## Basic Information

- **Project Name**: Easy-Admin
- **Description**: 基于Spring Cloud的微服务架构系统，采用模块化设计，包含多个业务服务和通用模块,对应的前端见:https://gitee.com/suddenlyyo/Easy-Admin-Template
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-07
- **Last Updated**: 2025-12-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: SpringCloud, SpringBoot

## README

= Easy-Admin
:toc: left
:toclevels: 4
:toc-title: 目录
:sectnums:
:sectlinks:
:source-highlighter: highlight.js
:icons: font

== 介绍

基于Spring Cloud的微服务架构系统，采用模块化设计，包含多个业务服务和通用模块。

== 功能特性

* **服务注册与发现**：使用 Nacos 实现服务注册与发现
* **服务调用**：通过 OpenFeign 实现服务间调用
* **服务网关**：使用 Spring Cloud Gateway 实现统一的 API 网关
* **配置中心**：使用 Nacos 作为统一配置中心
* **服务保护**：集成 Sentinel 实现流量控制和服务保护
* **链路追踪**：整合 Skywalking 实现分布式请求链路追踪
* **异步处理**：支持 CompletableFuture 和多线程异步处理
* **安全控制**：基于 Spring Security 实现认证授权
* **缓存支持**：支持 Redis 阻塞式和响应式客户端
* **消息队列**：支持多种消息队列（RabbitMQ、Kafka、RocketMQ、ActiveMQ）
* **多租户支持**：基于字段级别的多租户架构，实现数据隔离

== 项目结构

....
Easy-Admin/
├── zx-common/                  # 通用模块
│   ├── zx-common-async/         # 异步处理
│   ├── zx-common-core/          # 核心配置
│   ├── zx-common-redis-block/   # Redis 阻塞式客户端
│   ├── zx-common-redis-reactive/ # Redis 响应式客户端
│   ├── zx-common-security/      # 安全组件
│   ├── zx-common-tools/         # 工具类
│   └── zx-common-validation/    # 参数校验
└── zx-services/                # 业务服务模块
    ├── zx-auth-15778/           # 认证服务
    ├── zx-common-feign-client/  # Feign客户端
    ├── zx-common-log/           # 日志处理
    ├── zx-common-security-block/ # 阻塞式安全组件
    ├── zx-common-security-reactive/ # 响应式安全组件
    ├── zx-gateway-15775/        # 网关服务
    ├── zx-notification-admin-15782/ # 通知管理服务
    ├── zx-notification-common/   # 通知系统公共模块
    ├── zx-notification-consumer-15781/ # 通知消费者
    ├── zx-notification-producer-15780/ # 通知生产者
    ├── zx-system-block-15776/    # 系统管理服务
    ├── zx-system-reactive-15777/ # 响应式系统服务(预留)
    └── zx-task-manager-15779/    # 任务管理服务
....

== 核心模块

=== 通用模块(zx-common)

* **zx-common-core**：核心配置，包含统一返回结果类、全局异常处理、Jackson配置等
* **zx-common-tools**：提供常用的工具类，如ID生成器、Spring上下文工具类等
* **zx-common-validation**：自定义参数校验框架
* **zx-common-security**：安全相关组件，包含登录用户信息模型
* **zx-common-async**：异步处理配置，包含自定义线程池配置
* **zx-common-log**：日志处理配置，提供操作日志和业务操作日志记录功能
* **zx-common-redis**：Redis客户端封装，提供阻塞式和响应式两种实现

=== 核心服务

* **网关服务(zx-gateway-15775)**：路由转发、权限校验、请求限流、日志记录
* **认证服务(zx-auth-15778)**：用户登录认证、Token签发与校验、刷新令牌处理
* **系统管理服务(zx-system-block-15776)**：用户管理、角色权限管理、菜单管理、部门管理等
* **任务管理服务(zx-task-manager-15779)**：定时任务调度、任务执行监控、任务日志记录
* **通知服务**：多渠道通知发送（站内信、短信、邮件、微信等）、消息队列异步处理
* **多租户支持**：基于字段级别的多租户架构，实现数据隔离和租户管理

== 前端项目

* **前端地址**：https://gitee.com/suddenlyyo/Easy-Admin-Template.git
+
基于Vue3 + Element Plus开发的前端管理界面，与本后端项目配套使用。

== 文档资源

* link:DEVELOPMENT_GUIDE.adoc[开发指南] - 详细的开发规范和项目说明
* link:./zx-services/zx-system-block-15776/DICT_GUIDE.md[字典功能使用指南] - 字典功能使用说明
* link:./zx-services/zx-task-manager-15779/TASK_MANAGEMENT.md[任务管理说明] - 任务管理功能说明
* link:./docs/architecture/MULTI_TENANCY_PATTERNS.md[多租户实现模式分析] - 多租户实现方案的通用分析
* link:./docs/architecture/MULTI_TENANCY_IMPLEMENTATION.md[当前项目多租户实现方案分析] - 针对本项目的多租户实现方案

== 快速开始

. **环境准备**
.. 安装 JDK 21
.. 安装 MySQL 并导入 sql 目录下的数据库脚本
.. 安装 Redis
.. 启动 Nacos 和 Sentinel 控制台
.. 启动 RabbitMQ 或其他消息队列

. **启动服务**
.. 可使用脚本启动核心服务: `./scripts/start-core-services.sh`
.. 也可按需启动服务: `./scripts/start-services.sh -l` 查看服务列表，然后按需启动

== 详细文档

有关开发规范、部署说明、数据库设计等详细信息，请参阅 link:DEVELOPMENT_GUIDE.adoc[DEVELOPMENT_GUIDE.adoc]

== 贡献指南

欢迎提交 Pull Request 和 Issue。请遵循项目代码风格和提交规范。

== 许可证

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