# lumin-framework

**Repository Path**: xfcode-projects/lumin-framework

## Basic Information

- **Project Name**: lumin-framework
- **Description**: lumin-framework 是 Java 企业软件标准开发通用抽象框架底座，只负责抽象定义、编程规范、通用能力、基础架构约束， 不耦合任何中间件、不依赖第三方云服务、不包含具体基础设施实现。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://www.xfcode.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-15
- **Last Updated**: 2026-05-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# lumin-framework 核心框架包 README
## 项目简介
`lumin-framework` 是 **Java 企业软件标准开发通用抽象框架底座**，只负责**抽象定义、编程规范、通用能力、基础架构约束**，
**不耦合任何中间件、不依赖第三方云服务、不包含具体基础设施实现**。

遵循**抽象与实现分离**设计思想：
- 本仓库只定义**接口、注解、规范、基础模型、通用工具、Web标准、安全抽象、扩展抽象**

## 整体模块结构
```
lumin-framework
├── lumin-common       公共基础抽象与通用模型
├── lumin-core         框架内核、SPI扩展、基础上下文与规范
├── lumin-web         Web 层统一规范与抽象封装
├── lumin-security    权限安全抽象、认证授权规范定义
└── lumin-ext         通用业务扩展抽象、注解与标准定义
```

## 各模块职责说明

### 1. lumin-common 公共基础层
定位：**最底层基础依赖，无业务、无中间件强依赖**
- 全局统一返回结果体、分页模型、基础DTO/VO规范
- 全局常量、系统枚举、业务状态码定义
- 通用工具类：字符串、日期、集合、树形结构、加解密、正则等
- 基础自定义注解、通用异常基类、业务异常定义
- 基础脱敏标记注解、校验标记注解
- 全局通用配置常量、环境常量
- 字典数据模型、树形节点基础模型

### 2. lumin-core 框架内核层
定位：**框架启动内核、SPI扩展、整体架构规范**
- 框架自动配置基础骨架、条件装配抽象
- 全局应用上下文、Spring容器工具、Bean工厂工具
- SPI 扩展机制定义、扩展点接口规范
- 框架生命周期回调、初始化监听抽象
- 配置属性基类、环境读取工具、系统元数据抽象
- 全局统一线程池规范、异步执行抽象定义
- 数据源切换注解（主从库）
- 缓存服务抽象接口（Redis/Caffeine等实现）

### 3. lumin-web Web 层规范抽象
定位：**统一后端接口编程规范，只做抽象不做中间件实现**
- 全局统一响应格式封装规范
- 全局异常拦截、异常翻译抽象规范
- 请求参数统一封装、请求头上下文抽象
- 跨域配置抽象、接口防重提交注解+抽象逻辑
- 接口日志记录抽象、请求链路上下文定义
- 操作日志记录注解（@OperLog）
- 基础 Web 自动配置基类、Web 全局过滤器规范

### 4. lumin-security 安全权限抽象层
定位：**只定义权限、认证、鉴权抽象接口与注解，不做具体实现**
- 登录认证抽象接口、登录用户上下文定义
- JWT 加解密抽象规范、令牌解析抽象
- 权限校验注解、接口鉴权抽象定义
- RBAC 角色/权限资源抽象模型
- 数据权限过滤抽象接口、数据范围注解
- 会话管理抽象、匿名访问、接口放行注解

### 5. lumin-ext 通用业务扩展抽象层
定位：**通用业务能力的注解、抽象接口、规范定义**
- Excel 导入导出**注解与抽象规范**（具体实现放 infrastructure）
- 自定义参数校验注解、校验器扩展抽象（手机号、邮箱等）
- 数据脱敏注解、脱敏规则抽象定义
- 代码生成器模板规范、元数据抽象
- 国际化 i18n 多语言抽象接口、语言上下文定义
- 通用字典、树形结构抽象模型
- 文件存储服务抽象接口（本地/OSS/MinIO等实现）
- 短信服务抽象接口（阿里云/腾讯云等实现）
- 邮件服务抽象接口（SMTP/SendGrid等实现）
- 定时任务调度抽象接口与执行器（Quartz/XXL-JOB等实现）

## 设计核心理念
1. **只抽象、不实现**
   所有中间件、存储、消息、云服务**只定义标准接口**，具体实现下沉到独立 `lumin-infrastructure`。

2. **分层解耦、无循环依赖**
   依赖流向：`common → core → web/security/ext`，单向依赖，架构干净。

3. **规范先行**
   统一返回、异常处理、接口风格、权限注解、脱敏、校验全框架统一标准。

4. **轻量化可裁剪**
   业务项目可按需单独引入任意子模块，无需引入全家桶。

5. **可扩展可插拔**
   基于 SPI 扩展机制，业务或基础设施层可自定义实现框架抽象接口，不侵入内核源码。

## 与基础设施层关系
```
lumin-framework        只做：抽象、注解、规范、模型、接口定义
lumin-infrastructure   只做：Redis/MQ/OSS/ES/数据源 具体实现
```
- `lumin-framework` **绝不依赖** infrastructure
- infrastructure 依赖 `lumin-framework` 实现标准抽象接口
- 业务项目通过 starter 按需整合两者

## 适配版本
- 适配 SpringBoot 2.7.x / 3.x
- 基于 Java 8+ 开发
- 无侵入、兼容现有 SpringBoot 项目

## 使用方式
业务项目直接引入对应模块或后续封装的 `lumin-starter`，即可遵循框架统一开发规范，

---
我可以接下来给你：
1. 每个模块的 **标准包结构**
2. 父工程 + 5个子模块的 **完整 pom.xml 模板**
   你要我直接生成吗？