wsr/orange-admin
1
0
Fork 0
mirror of https://gitee.com/orangeform/orange-admin.git synced 2026-01-17 18:46:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

update README.md.

Browse Source
This commit is contained in:
orange-form
2020-11-21 22:40:30 +08:00
committed by Gitee
parent 517e4e7a4c
commit f6fe2569e8
1 changed files with 18 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -29,48 +29,49 @@
#### 竞争优势 #### 竞争优势
- 排在首位的就是 15 万字以上的专业、详尽、完善和暗黑护眼的操作指南、开发文档和教学视频。 - 排在首位的就是 15 万字以上的专业、详尽、完善和暗黑护眼的操作指南、开发文档和教学视频。
- 真正的低代码生成工具，而非单纯的敏捷脚手架，可生成相对复杂的中台化业务代码。 - 真正的低代码生成工具，而非单纯的敏捷脚手架，可生成 70% 以上相对复杂的中台化业务代码。
- 浅显易懂的极高质量生成后工程代码，经过 SonarQube 和 Alibaba 代码规范严格扫描。 - 浅显易懂的极高质量生成后工程代码，经过 SonarQube 和 Alibaba 代码规范严格扫描。
- 合理、透明、全网超低价的教学版和企业版商业授权。(请我们撸一次串的价格) - 合理、透明、全网超低价的教学版和企业版商业授权。(请我们撸一次串的价格)
#### 关于我们 #### 关于我们
- S.L 老师，20年开发经验，后台全栈架构师，代码强迫症、性能洁癖、能看出一像素偏差。精通C++/Java/Scala/Web高并发/大数据/C++服务器/视频直播网络技术，略懂容器。 - S.L 老师，20年开发经验，后台全栈架构师，代码强迫症、性能洁癖、能看出一像素偏差。精通 C++/Java/Scala/Web高并发/大数据/C++服务器/视频直播网络技术，略懂容器。
- J.T 老师，15年开发经验，前端全栈架构师，思维极缜密、号边界王。精通C++/Java/Javascript/Vue & React/C++客户端/Android原生/小程序/视频直播编解码技术。 - J.T 老师，15年开发经验，前端全栈架构师，思维极缜密、号边界王。精通 C++/Java/Javascript/Vue & React/C++客户端/Android原生/小程序/视频直播编解码技术。
- 欢迎加入我们的技术交流QQ群，几乎每天都有30分钟的技术分享。 [![](https://img.shields.io/badge/加入QQ群-788581363-red.svg)](//shang.qq.com/wpa/qunwpa?idkey=590857a1b4c587e2be3d66b9a7e2015109772e777c6451c897dee393489b1661) - 欢迎加入我们的技术交流 QQ 群，几乎每天都有30分钟的技术分享。 [![](https://img.shields.io/badge/加入QQ群-788581363-red.svg)](//shang.qq.com/wpa/qunwpa?idkey=590857a1b4c587e2be3d66b9a7e2015109772e777c6451c897dee393489b1661)
- 由于被恶意举报，如果您通过群号搜索不到，请添加作者的QQ (3510245832)，我们会将您拉入群中。 - 由于被恶意举报，如果您通过群号搜索不到，请添加作者的 QQ (3510245832)，我们会将您拉入群中。
![QQ群](https://images.gitee.com/uploads/images/2020/0924/092230_dda4c368_7431510.png "orange-group1.png") ![QQ群](https://images.gitee.com/uploads/images/2020/0924/092230_dda4c368_7431510.png "orange-group1.png")
### 生成后工程 ### 生成后工程
>可无限制的用于学习、培训、接私活、公司自用和开发商业项目等场景，其中基础框架代码将永久免费，并持续更新。 >可无限制的用于学习、培训、接私活、公司自用和开发商业项目等场景，其中基础框架代码将永久免费，并持续更新。
#### 开箱即用 #### 开箱即用
项目信息如您所愿，工程名称、目录结构、基础包名、common模块、代码注释中的@author信息等，在创建工程时即已配置，不会留有橙单的任何信息。因此无需二次修改，前后端直接编译运行即可。如编译期和运行时出现问题，那一定是我们的bug，在得到您反馈后，我们将及时修复。 项目信息如您所愿，工程名称、目录结构、基础包名、common模块、代码注释中的 @author 信息等，在创建工程时即已配置，不会留有橙单的任何信息。因此无需二次修改，前后端直接编译运行即可。如编译期和运行时出现问题，那一定是我们的 bug，在得到您反馈后，我们将及时修复。
#### 技术选型 #### 技术选型
- 前端: Element (Vue) / Ant Design (React) + ECharts / AntV + Axios + Webpack。 - 前端: Element (Vue) / Ant Design (React) + ECharts / AntV + Axios + Webpack。
- 后端: Spring Boot / Spring Cloud / Spring Cloud Alibaba + Spring Security OAuth2 + Mybatis + Jwt。 - 后端: Spring Boot / Spring Cloud / Spring Cloud Alibaba + Spring Security OAuth2 + Mybatis + Jwt。
- 工具库: Hutool + Guava + Caffeine + Lombok + MapStruct + 通用Mapper + Knife4j + qdox。 - 工具库: Hutool + Guava + Caffeine + Lombok + MapStruct + 通用 Mapper + Knife4j + qdox。
- 服务组件: Redis + Zookeeper + Consul + Apollo + XXL-Job + Quartz + Seata + Minio + Kafka + Nacos + Sentinel + Nepxion Discovery。 - 服务组件: Redis + Zookeeper + Consul + Apollo + XXL-Job + Quartz + Seata + Minio + Canal + Kafka + Nacos + Sentinel + Nepxion Discovery。
- 系统监控: ELK + PinPoint / SkyWalking + Grafana + Prometheus。 - 系统监控: ELK + PinPoint / SkyWalking + Grafana + Prometheus。
#### 基础功能 #### 基础功能
- 前端框架：单页面、多标签、多栏目和子路由，多套高颜值样式模式可供选择。 - 前端框架：单页面、多标签、多栏目和子路由，多套高颜值样式模式可供选择。
- 前端能力：列表编辑、统计图表、多表联动、明细数据下钻、上传下载、数据导出、自定义打印样式模板、富文本等。 - 前端能力：列表编辑、统计图表、多表联动、明细数据下钻、上传下载、数据导出、自定义打印样式模板、富文本等。
- 页面布局：支持基于 Fragment 和 Block 的灵活布局方式，通过配置即可生成多样化的表单页面，并可预览。 - 页面布局：支持基于 Fragment 和 Block 的灵活布局方式，通过配置即可生成多样化的表单页面，并可预览。
- 接口规范：微服务和单体服务的接口命名规则和参数定义完全一致，便于日后的平滑升级。 - 接口规范：微服务和单体服务的接口命名和参数定义规范完全一致，便于日后的平滑升级。
- 后台架构：分布式锁、分布式 Id 生成器、分布式缓存、分布式事务、分布式限流和灰度发布等，按需集成。 - 后台架构：分布式锁、分布式 Id、分布式缓存、分布式事务、分布式限流和灰度发布等，按需集成。
- 用户管理：支持基于OAuth2的单点登录。 - 用户管理：支持基于 OAuth2 的单点登录。
- 操作权限：前端控制可精确到按钮级的操作和标签级的显示，同时提供多维度的权限分配路径查询能力。 - 操作权限：前端控制可精确到按钮级的操作和标签级的显示，同时提供了多维度的权限分配路径查询能力。
- 数据权限：基于 Mybatis 拦截器 + JSqlParser 的实现方式，配置更灵活，代码侵入性更低。 - 数据权限：基于 Mybatis 拦截器 + JSqlParser 的实现方式，配置更灵活，代码侵入性更低。
- 多数据源：可根据配置动态生成，路由策略灵活可扩展。 - 多数据源：可根据配置动态生成，路由策略灵活可扩展。
- 数据组装：Java 注解方式实现数据组装，支持统一接口的**服务内和跨服务**的一对一、一对多、多对多、字典、聚合计算等关系数据组合。 - 数据组装：Java 注解方式实现数据组装，支持统一接口的**服务内和跨服务**的一对一、一对多、多对多、字典、聚合计算等关系数据组合。
- 定时任务：我们不仅提供了 Job 基础框架的集成，更能生成灵活可配、高度优化、便于二次开发的 Job 业务逻辑代码。 - 定时任务：我们不仅提供了多套 Job 基础框架的集成，更能生成灵活可配、高度优化、便于二次开发的 Job 业务逻辑代码。
- 系统监控：基于 Kafka + ELK 的日志收集，基于 PinPoint/SkyWalking 的服务链路跟踪，基于 GPE 的服务性能指标监控。 - 系统监控：基于 Kafka + ELK 的日志收集，基于 PinPoint/SkyWalking 的服务链路跟踪，基于 GPE 的服务性能指标监控。
- 接口文档：目前已集成 Knife4j，同时支持基于 qdox 逆推 Java 工程代码，实现 0 注解导出 Postman 接口文件和 Markdown 文档。 - 接口文档：目前已集成 Knife4j，同时支持基于 qdox 逆推 Java 工程代码，实现 0 注解导出 Postman 接口文件和 Markdown 文档。
- 缓存同步：同时集成了 Canal-Admin 和 Canal-Server，以便于用户的 Canal Instance 管理。目前已实现字典变化数据到 Redis 的实时缓存同步。
#### 设计理念 #### 设计理念
- 前沿的单表组合式设计，使业务服务的拆分与再合并 SO EASY。 - 前沿的单表组合式设计，使业务服务的拆分与再合并 SO EASY。
- 先代码，后SQL的原则，让服务横向扩充更具弹性。 - 先代码，后 SQL 的主流中台化设计原则，让服务横向扩充更具弹性。
- 标准化的服务间调用接口，使业务服务组合更具正交性。 - 标准化的服务间调用接口，使业务服务组合更具正交性。
- 前后端基于约定各司其职，默契配合，让系统运行飞起来。 - 前后端基于约定各司其职，默契配合，让系统运行飞起来。
- 可平滑的逐步演化为云原生架构。 - 可平滑的逐步演化为云原生架构。
@@ -80,13 +81,13 @@
- 遵循阿里巴巴标准的代码规范。 - 遵循阿里巴巴标准的代码规范。
- SonarQube 基于最严格检测规则的代码扫描。 - SonarQube 基于最严格检测规则的代码扫描。
- 产品级代码质量，层次清晰、滴水不漏。 - 产品级代码质量，层次清晰、滴水不漏。
- 近乎于0的代码重复率，35%以上的注释覆盖率。 - 近乎于 0 的代码重复率，35% 以上的注释覆盖率。
- 15年架构师优化的每一处细节。 - 15 年架构师优化的每一处细节。
#### 规则扫描 #### 规则扫描
此为在线演示工程的代码审查报告，而非当前开源示例工程。前者代码量更大，结构更复杂。 此为在线演示工程的代码审查报告，而非当前开源示例工程。前者代码量更大，结构更复杂。
1. SonarQube 扫描 1. SonarQube 扫描
- 基于SonarQube8.2缺省最严格的代码扫描规则，其中代码复杂度要求为15。 - 基于 SonarQube8.2 缺省最严格的代码扫描规则，其中代码复杂度要求为 15。
- 有气味代码共90处，其中85处为DTO、Model、常量字典、RPC接口等定义出现重复名称所致，均与模拟实际业务有关。 - 有气味代码共90处，其中85处为DTO、Model、常量字典、RPC接口等定义出现重复名称所致，均与模拟实际业务有关。
- 其余气味代码，是在权衡性能、可读性和易修改性等因素后保留下来的，具体见图4。 - 其余气味代码，是在权衡性能、可读性和易修改性等因素后保留下来的，具体见图4。
<table> <table>