易鹏官方文档

Appearance

📁 易鹏项目目录结构详解 ​

📘 文档说明

本文档详细介绍了易鹏项目的整体目录结构，帮助开发者快速了解项目架构和各模块职责。

🌐 项目总体结构 ​

yipeng项目根目录
├── yipeng-gateway     #  gateway网关服务
├── yipeng-auth        # 🔐 鉴权认证服务  
├── yipeng-common      # 📦 公共组件库

🚀 yipeng-gateway 网关项目 ​

项目职责： API网关，负责请求路由、负载均衡、安全控制等 
yipeng-gateway/
├── com.kp.framework/
│   ├── GatewayApplication.java     # 🎯 网关启动类
├── resources/
│   ├── bootstrap.yml              # ⚙️ 环境切换配置文件
│   ├── bootstrap-dev.yml          # 🛠️ 开发环境配置文件

🔐 yipeng-auth 鉴权项目 ​

项目职责： 用户认证授权、权限管理、系统基础功能 
yipeng-auth/
├── com.kp.framework/
│   ├── api/                       # 🌐 对外RESTful API接口
│   ├── common/                    # 📚 系统公共组件
│   │   ├── cache/                # 💾 缓存相关实现
│   │   ├── properties/           # ⚙️ 配置文件读取工具
│   │   ├── rabbitmq/             # 🐰 RabbitMQ消息消费处理
│   ├── config/                   # ⚙️ 项目配置类
│   ├── modules/                  # 📦 功能业务模块
│   │   ├── data/                # 📊 下拉框数据接口
│   │   ├── dept/                # 👥 部门管理模块
│   │   ├── logRecord/           # 📝 操作日志记录
│   │   ├── menu/                # 🎯 菜单权限管理
│   │   ├── post/                # 💼 岗位管理模块
│   │   ├── project/             # 📋 项目管理模块
│   │   ├── role/                # 👑 角色权限管理
│   │   ├── user/                # 👤 用户管理模块
│   │   ├── welcome/             # 🏠 系统欢迎页面
│   ├── AuthenticationApplication.java  # 🎯 鉴权服务启动类

📦 yipeng-common 公共组件库 ​

项目职责： 提供框架核心功能、安全组件、远程调用等通用能力

🧠 framework-core 框架核心模块 ​

framework-core/
├── com.kp.framework/
│   ├── annotation/               # 🏷️ 自定义注解扩展
│   ├── configruation/            # ⚙️ 框架核心配置
│   ├── constant/                 # 🔢 框架常量定义
│   ├── controller/               # 🎯 框架内置控制器
│   ├── entity/                   # 📄 框架基础实体类
│   ├── enums/                    # 🔢 框架枚举类型
│   ├── exception/                # ⚠️ 异常处理机制
│   ├── listener/                 # 📡 框架事件监听器
│   ├── mapper/                   # 🗃️ MyBatis-Plus映射器
│   ├── transactional/            # 💰 事务管理配置
│   ├── utils/                    # 🔧 实用工具集合
│   │   ├── kptool/              # 🦅 鲲鹏工具封装库

🔒 framework-security 安全框架模块 ​

framework-security/
├── com.kp.framework/
│   ├── common/                   # 📚 安全公共组件
│   │   ├── annotation/          # 🏷️ 数据权限注解
│   │   ├── enums/               # 🔢 安全相关枚举
│   │   ├── parent/              # 🧬 基础父类定义
│   │   ├── properties/          # ⚙️ 安全配置读取
│   │   ├── security/            # 🔐 权限控制核心
│   ├── config/                  # ⚙️ 安全配置信息
│   ├── modules/                 # 📦 安全功能模块

🌐 framework-feign 远程调用模块 ​

framework-feign/
├── com.kp.framework/
│   ├── configruation/           # ⚙️ Feign客户端配置
│   ├── microservices/           # 🔄 微服务调用模块
│   │   ├── auth/               # 🔐 鉴权服务调用接口
│   ├── util/                   # 🔍 接口校验工具类

📊 目录结构特点 ​

🎯 分层架构

  • 网关层：统一入口
  • 业务层：具体功能实现
  • 公共层：通用组件复用

🔌 模块化设计

  • 高内聚低耦合
  • 功能模块独立
  • 便于维护扩展

🛡️ 安全保障

  • 权限控制完善
  • 数据安全防护
  • 访问日志记录
💡 开发建议：
  • 新增功能模块时遵循现有目录结构规范
  • 公共组件优先考虑提取到common模块
  • 接口设计保持RESTful风格
  • 注重代码复用性和可维护性