# luxor-framework

**Repository Path**: luxor/luxor-framework

## Basic Information

- **Project Name**: luxor-framework
- **Description**: luxor-framework是荔诚科技自研的企业快速开发框架，主要基于SpringScloud全家桶、Nacos注册/配置中心、OAuth2单点认证[集成微信,QQ，微博第三方登陆]，Redis缓存，Zookeeper分布式锁，Seata分布式事务，Rabbitmq消息队列，MyBatis数据持久化、分布式调度器、docker容器化等热门互联网技术实现。
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: 1.0.x
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2019-09-14
- **Last Updated**: 2026-09-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Web开发框架, 分布式微服务, RPA机器人爬虫, oa工作流

## README

# luxor-framework 企业微服务开发框架

`luxor-framework` 是基于 Spring Cloud 全家桶的企业微服务开发框架，面向大型互联网与高并发业务场景，封装安全认证、配置管理、缓存、分布式锁、消息队列、分布式事务、文件存储、调度、搜索、工作流等基础设施能力，业务服务可直接复用。

## 仓库组成

根 POM `luxor-parent` 聚合以下模块：

| 模块 | 说明 |
| --- | --- |
| `luxor-dependencies` | 依赖版本 BOM，继承 Spring Boot parent，统一管理第三方版本 |
| `luxor-commons` | 26 个通用组件：core、mvc、security、jdbc、redis、lock4j、storage、schedule、seata、workflow 等 |
| `luxor-middlewares` | 6 个业务中间件：system、accesslog、schedule、storage、cms、mall |
| `luxor-starters` | 5 个瘦 starter，仅 POM 聚合依赖：parent、boot、boot-thymeleaf、cloud、cloud-thymeleaf |
| `luxor-examples` | 示例应用：boot、boot-thymeleaf、cloud、webflux、seata（account/order/payment/storage） |
| `luxor-sdk-java` | 荔诚云 Open API Java SDK（groupId 为 `org.luxor`） |

## 技术选型

以下版本以 [luxor-dependencies/pom.xml](luxor-dependencies/pom.xml) 为准：

| 技术 | 版本/说明 |
| --- | --- |
| JDK | 1.8 |
| Maven | 3.6+ |
| Spring Boot | 2.0.6.RELEASE |
| Spring Cloud | Finchley.SR2 |
| Spring Cloud Alibaba | 2.0.2.RELEASE（Seata 经此引入；Nacos 未在代码中使用） |
| Spring Security | 由 Spring Boot parent 管理 |
| MyBatis-Plus | 3.3.2 |
| MySQL Connector/J | 8.0.28 |
| Redis | Spring Data Redis；底层连接为 Redisson 3.15.5（`RedissonConnectionFactory`，SDR 抽象层保留，配置沿用 `spring.redis.*`） |
| Elasticsearch | 7.3.1 |
| Quartz | 2.3.0 |
| Activiti | 7.0.0.SR1 |
| Swagger | 2.9.2 |
| 文件存储 | MinIO 8.5.12、FastDFS、阿里云 OSS、腾讯云 COS、七牛 |
| 其他 | Hutool 5.8.32、Lombok 1.18.24、Druid 1.1.10、OkHttp 4.12.0、Gson 2.8.9、Protostuff 1.8.0、Kryo 5.3.0 等 |

## 构建

环境要求：JDK 8、Maven 3.6+。仓库根目录的 `settings.xml` 配置了内网 Nexus 仓库，构建时建议使用：

```bash
mvn -s settings.xml -Drevision=1.0.0-SNAPSHOT -DskipTests clean install
```

只构建某个模块及其依赖：

```bash
mvn -s settings.xml -pl luxor-commons/luxor-common-redis -am -DskipTests clean install
```

注意：

- `luxor-commons` 与 `luxor-middlewares` 的父 POM 默认 `maven.test.skip=true`，需要跑测试时显式加 `-Dmaven.test.skip=false`。
- 内网 Nexus 不可达时依赖解析会失败，构建前先确认网络。
- `luxor-middleware-cms`、`luxor-middleware-mall` 目前仅有骨架（POM、SQL 与测试），无 main 源码；`luxor-common-sharding-jdbc` 在 `releases` profile 中暂不发布。

## 版本与分支

- 当前开发分支：`1.0.x`，版本 `1.0.0-SNAPSHOT`；另有 `2.0.x`、`master`。
- 已有标签：`1.0.1`、`v1.0.0`。
- 历史发布计划：v1.0.0（2019-10-28，基础框架与 Quick Start）、v2.0.0（2020-12-20，互联网业务组件）；当前代码以 `1.0.x` 为准。

## 代码规范与 AI 知识库

- AI 编码代理入口：[AGENTS.md](AGENTS.md)，知识库索引：[.harness/README.md](.harness/README.md)。
- 新代码遵循《阿里巴巴 Java 开发手册》与 DDD 设计思想，详见 [.harness/standards/coding-conventions.md](.harness/standards/coding-conventions.md) 与 [.harness/workflows/coding-process.md](.harness/workflows/coding-process.md)。