CreazyCder/orange-admin

重要声明

橙单正式开源基于 flowable 6.6 和在线表单的的工作流功能，前后台代码全部开放，无任何代码混淆。 欢迎加入我们的QQ群(788581363)，或添加作者个人QQ(3510245832) 拉你入群。如果确实对您有所帮助，Fork 的同时，也请 Star 一下。

如果您不想东拼西凑的去找各种工作流相关的代码案例和小技巧，也不想自己趟坑，而是分分钟就想得到成熟稳定、开箱即用的工程，请考虑橙单 。目前已开源部分的所有测试和技术支持，均由橙单团队负责。

工作流支持

前后端代码无一丝混淆，完全交付，且代码质量超高 ，极易学习和二次开发，同时支持单体和微服务架构。
同时集成 Activiti 7.x 和 Flowable 6.6 作为工作流引擎，配置工程时可自行二选一。
集成工作流和在线表单，无需写一行代码即可配置出相对复杂的工作流业务。
支持同一流程的多版本发布，同时支持版本切换。
支持完整的工作流工单管理，稍作修改即可支持分布式操作。(下个版本会支持相关的代码生成)
支持部门岗位和用户岗位，配置工程时可自行选择是否支持。
支持基于部门、岗位、本部门领导岗位、上级部门领导岗位等候选组。
开箱即用的支持，工单撤销和终止、会签加签、待办已办转办、历史任务、审批详情列表、附件上传下载等。
工作流前端已集成美观的流程编辑器，同时支持流程图高亮及任务跟踪。
严格且合理的数据安全校验，流程敏感数据 (如合同信息) 不会被越权访问和下载。
已去除 Spring Security 的缺省依赖，并与现有权限系统完美整合。
工作流与在线表单演示环境，全部代码由橙单生成器直接生成，未经任何修改。 http://demo.orangeforms.com/flow。
橙单生成后工程(除工作流外)演示环境，全部代码由橙单生成器直接生成，未经任何修改。 http://demo.orangeforms.com。

选择橙单

有助于中台化平台架构梳理，支持微服务池共享，可生成 70% 以上相对复杂的中台化业务代码。
标准化服务调用接口，无论是单体向微服务过渡，还是微服务之间的分分合合，都极为平滑且非常 Easy。
纯手工打造、合理驾驭模式、教科书般的 5A 级代码质量。
前沿高效的设计、成熟的套路和策略，在提升前期开发效率的同时，也将极大的降低后期维护成本。
支持多种微服务间数据实时同步策略，高可用、高可靠、高性能、幂等性和重放式顺序性等特征均已支持。
专业、完善、详尽、暗黑护眼、完全免费开放且同步更新的近 18 万字在线文档。
技术问题的反馈、咨询和交流，我们都会及时回复，经常在开车等灯时答疑。
生成后工程无任何 License 限制，可进行任意修改，并用于任意数量的商用项目。

橙单生成器

如果说基础框架是技术轮子，那么我们就是生产线。不仅可以造出各种尺寸的轮子，通过我们的在线配置工具，还能生成您的更多业务所需。为了使轮子更为贴近项目的架构需求，我们目前已支持多种类型的工程结构模板，如多应用、多租户、多渠道等。架构师们通过选择最为适合的项目类型，可最大程度的降低对生成后工程进行裁剪和改造的工作量。

下图所示的微服务组件，在创建项目时可正交化组合。生成后的工程不仅可用于企业中台化改造，同样也适用于开发者进行微服务全技术栈的快速学习。

在线资源

网站首页。http://www.orangeforms.com
教学视频。https://www.bilibili.com/video/bv1Wg4y1i7vP
教学版演示配置。http://config.orangeforms.com
生成器操作指南。http://www.orangeforms.com/orange-doc/
后端代码文档。http://www.orangeforms.com/development-doc/
前端代码文档。http://www.orangeforms.com/development-vue/
演示项目。http://demo.orangeforms.com
工作流演示项目。http://demo.orangeforms.com/flow

在线表单支持

前后端代码完全交付，甚至可配置为自己的项目包名。
前后端代码无一丝混淆，且代码质量超高，极易学习和二次开发，同时支持单体和微服务架构。
可视化的拖拉拽编辑器，目前已经支持大部分常用组件，后续版本会支持图表。
支持主从表联动。
支持富文本、多图、多附件的上传和下载。
可视化接口配置编辑器，支持多数据库、数据表、一对一表关联、一对多表关联和多种数据字典等。
支持字典过滤、主表字段过滤、一对一从表字段过滤，同时支持范围、模糊和等于查询方式。
支持一对多的聚合字段计算，在主表列表中可动态计算并显示从表的聚合计算结果。
支持主表字段排序、一对一从表字段排序。
完美支持数据权限过滤和操作权限控制。
接口参数均为数据源 ID，不暴露任何后台数据表细节，从机制上彻底消除了 SQL 注入的风险。
运行时效率极高，动态表单关键数据结构均缓存 Redis，从而有效提升数据接口的应答效率。

多应用支持

生成器支持多应用功能，应用和服务之间保持多对多关系，服务池功能已基本支持，后续版本会持续优化。
单体工程可同时创建 WebAdmin 后台应用和面向前端 App 的 WebApi 应用。
微服务工程可创建非常典型的单体后台 WebAdmin 应用，及面向前端 App 的 WebApi 微服务应用。补充说明，WebAdmin 后台应用也可以配置为微服务应用，并可与 WebApi 应用共享服务池中的通用业务服务。
对于上述介绍的 WebAdmin 后台服务，与之前版本一致，仍然提供表单和权限功能。而 WebApi 作为面向前端的接口应用，为了降低架构师们的工程裁剪工作量，该类应用将不提供表单和权限功能。

多租户支持

多租户工程可同时创建三个应用，分别为租户运营管理后台应用 TenantAdmin，租户运营后台应用，以及面向租户前端 App 的 WebApi 应用。
对于多租户运营管理后台应用 TenantAdmin，不仅内置了自身的权限管理和租户运营管理等功能，同时也支持配置自定义的业务表单和租户统计表单。
支持全局公用字典和租户字典，前者由租户运营管理后台统一管理，租户字典数据可由租户管理员自行维护。为了保证整体运行时效率，两者均支持缓存 Redis。
租户数据支持逻辑隔离、物理隔离和混合隔离等多种方式，租户权限数据由租户运营管理服务统一管理，实时同步到多个租户运行系统数据库中。不仅非常有利于租户数据的迁移。同时也保证了运行时效率。业务逻辑代码与非多租户系统相比，差异也降至最低。
可配置定时任务 Job 服务，并将不同租户数据库中的业务行为数据，分组统计后刷新到租户运营管理数据库中，再由配置的统计表单进行显示。
可与现有的单点登录服务 (uaa) 无缝集成。

关于我们

S.L 老师，20年开发经验，后台全栈架构师，代码强迫症、性能洁癖、能看出一像素偏差。精通 C++/Java/Scala/Web高并发/大数据/C++服务器/视频直播网络技术，略懂容器。
J.T 老师，15年开发经验，前端全栈架构师，思维极缜密、号边界王。精通 C++/Java/Javascript/Vue & React/C++客户端/Android原生/小程序/视频直播编解码技术。
欢迎加入我们的技术交流 QQ 群，如遇任何使用中的问题我们都将第一时间为您答疑。
由于被恶意举报，如果您通过群号搜索不到，请添加作者的 QQ (3510245832)，我们会将您拉入群中。

生成后工程

可无限制的用于学习、培训、接私活、公司自用和开发商业项目等场景，其中基础框架代码将永久免费，并持续更新。

开箱即用

项目信息如您所愿，工程名称、目录结构、基础包名、common模块、代码注释中的 @author 信息等，在创建工程时即已配置，不会留有橙单的任何信息。因此无需二次修改，前后端直接编译运行即可。如编译期和运行时出现问题，那一定是我们的 bug，在得到您反馈后，我们将及时修复。

技术选型

前端: Element (Vue) / Ant Design (React) + ECharts / AntV + Axios + Webpack。
后端: Spring Boot / Spring Cloud / Spring Cloud Alibaba + Spring Security OAuth2 + Mybatis + Jwt。
工具库: Activiti + Flowable + Hutool + Guava + Caffeine + Lombok + MapStruct + Mybatis Plus + tk mapper + Knife4j + qdox。
服务组件: Redis + Zookeeper + Consul + Apollo + XXL-Job + Quartz + Seata + Minio + Canal + RocketMQ + Kafka + Nacos + Sentinel。
系统监控: ELK + PinPoint / SkyWalking + Grafana + Prometheus。

基础功能

前端框架：单页面、多标签、多栏目和子路由，多套高颜值样式主题可供选择。
前端能力：列表编辑、统计图表、多表联动、明细数据下钻、上传下载、数据导出、自定义打印样式模板、富文本等。
页面布局：支持基于 Fragment 和 Block 的灵活布局方式，通过配置即可生成多样化的表单页面，并可预览。
接口规范：微服务和单体服务的接口命名和参数定义规范完全一致，便于日后的平滑升级。
在线表单：支持可视化拖来拽编辑器，表单、后台接口和数据字典均可动态配置，完美集成数据权限过滤和操作权限控制，即配即得。
流程管理：支持美观的流程编辑器、流程图高亮跟踪、多版本发布、工单管理、待办已办转办、会签加签、撤销和提前终止等实用功能。并可基于在线表单生成复杂的工作流业务。
后台架构：分布式锁、分布式 Id、分布式缓存、分布式事务、分布式限流和灰度发布等，按需集成。
用户管理：支持基于 OAuth2 的单点登录。
操作权限：前端控制可精确到按钮级的操作和标签级的显示，同时提供了多维度的权限分配路径查询能力。
数据权限：基于 Mybatis 拦截器 + JSqlParser 的实现方式，配置更灵活，代码侵入性更低。
租户管理：租户权限管理数据、字典等通用数据，均由租户运营管理服务统一管理，并实时同步到多个租户运营库，具有极高的数据库级别容错性。
多数据源：支持简单和复杂两种多数据源注解。复杂注解可灵活自定义，并应对复杂的业务场景。
数据组装：Java 注解方式实现数据组装，支持统一接口的服务内和跨服务的一对一、一对多、多对多、字典、聚合计算等关系数据组合。
定时任务：我们不仅提供了多套 Job 基础框架的集成，更能生成灵活可配、高度优化、便于二次开发的 Job 业务逻辑代码。
系统监控：基于 Kafka + ELK 的日志收集，基于 PinPoint/SkyWalking 的服务链路跟踪，基于 GPE 的服务性能指标监控。
接口文档：目前已集成 Knife4j，同时支持基于 qdox 逆推 Java 工程代码，实现 0 注解导出 Postman 接口文件和 Markdown 文档。
操作日志：灵活可配置。统一拦截每次请求调用的输入输出，及各种调用数据细节，以便于后期的统计分析和问题定位。微服务工程由 Kafka 消费者服务统一批量处理，并与 ELK + SkyWalking/PinPoint 等日志监控系统完全打通。单体工程则异步的存入数据库表中。
缓存同步：同时集成了 Canal-Admin 和 Canal-Server，以便于用户的 Canal Instance 管理。目前已实现字典变化数据到 Redis 的实时缓存同步。

规则扫描

此为在线演示工程的代码审查报告，而非当前开源示例工程。前者代码量更大，结构更复杂。

SonarQube 扫描

基于 SonarQube8.2 缺省最严格的代码扫描规则，其中代码复杂度要求为 15。
有气味代码共90处，其中85处为DTO、Model、常量字典、RPC接口等定义出现重复名称所致，均与模拟实际业务有关。
其余气味代码，是在权衡性能、可读性和易修改性等因素后保留下来的，具体见图4。

Alibaba Code Guide 扫描

下载最新版本IDEA插件，同时打开所有审查条件。
全部代码扫描通过。

Statistic 代码统计

生成代码总量约为86000多行，主要包括Java、XML、YAML和SQL初始化脚本等。
Java代码覆盖率为37%。

开源工程部署

微服务后端工程：orange-demo-multi-service
微服务前端工程：orange-demo-multi-web
单体服务后端工程：orange-demo-single-service
单体服务前端工程：orange-demo-single-web

数据初始化。

通过常用的数据库访问工具(如：navicat)，执行工程目录下的zz-resource/db-scripts/zz-orange-demo.sql文件。
导入脚本主要负责，数据库创建、数据表创建和测试数据的插入。

Api接口文档

Knife4j文档访问方式为: http://localhost:8082/doc.html#/plus。(以上四个后台服务均支持)
Postman Api文档和Markdown文档，位于工程根目录的zz-resource/api-docs子目录下，Postman-Api.json可直接导入Postman。(仅app后台服务支持)

环境准备。
docker是必选组件。通过docker-compose命令，可快速启停服务所依赖的服务中间件，如nacos、redis、zookeeper、kafka和sentinel dashboard等。中间件的控制台访问方式，可参考工程目录下的README文件。

# 假定当前目录为工程根目录。
cd zz-resource/docker-files
# 启动和停止带有基础服务中间件的docker-compose.yml文件
docker-compose up -d
# 彻底终止容器
docker-compose down
# 在第一次启动之后，可以考虑每次执行下面的命令启动和停止容器。
docker-compose start
docker-compose stop