mirror of
https://gitee.com/ChinaLym/shoulder-platform.git
synced 2025-12-30 11:02:26 +00:00
readme
This commit is contained in:
21
README.md
21
README.md
@@ -114,15 +114,15 @@ ELK展示nginx日志演示
|
|||||||
|
|
||||||
## 层次设计
|
## 层次设计
|
||||||
|
|
||||||
| 层次 | 定位 | 方案 | Shoulder 支持 |
|
| 层次 | 定位 | 方案 | Shoulder 支持 |
|
||||||
|---|---|---|---|
|
|---|---|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| 业务应用服务 `SaaS` | 面向用户设计,更应该考虑如何方便用户 | 使用者根据实际业务把握 | `shoulder-framework` 提供了一些常用的能力,以及规约的对接;`shoulder-platform-common` 提供了快速开发一个与 `shoulder-platform` 设计、技术、风格统一的应用服务 |
|
| 平台对接开发包 `SDK` | 降低使用者调用 `shoulder` 的开发成本和难度 | 以 Spring Boot 自动装配形式提供,包含使用文档和Demo | 提供对接 shoulder-platform 内置接口的的默认实现,使用者也可根据平台api接口文档自行实现 |
|
||||||
| 平台对接开发包 `SDK` | 降低使用者调用 `shoulder` 的开发成本和难度 | 以 Spring Boot 自动装配形式提供,包含使用文档和Demo | 提供对接 shoulder-platform的默认实现,使用者也可根据平台api接口文档自行实现 |
|
| 业务应用服务 `SaaS` | 面向用户设计,更应该考虑如何方便用户 | 使用者根据实际业务把握 | `shoulder-framework` 提供了一些常用的能力,以及规约的对接;专业级别的使用团队可在此层加入一些自身团队的定制设计,对于大多数使用者无需过于关注该层;`shoulder-platform-common` 提供了基础模块,以帮助使用者快速实现一个与 `shoulder-platform` 设计、技术、风格统一的应用服务 |
|
||||||
| 共性业务层 `aPaaS` | 通用基础功能如认证、注册、授权、通知推送、知识库、错误码查询等 | api网关、web管理平台、用户中心、通知中心 | |
|
| 共性业务层 `aPaaS` | 通用基础功能如认证、注册、授权、通知推送、知识库、错误码查询等 | api网关、web管理平台、用户中心、通知中心 | `shoulder-platfrom` 所在,提供可配置、可替换的、通用的、基础业务能力,使用者可根据业务场景在此基础上快速实现业务目标 |
|
||||||
| 开发脚手架 `工具` | 统一维护共性代码,提供常用能力如异常拦截、错误码、安全加密等,统一管理技术和依赖版本 | `spring boot`、`spring cloud`、`shoulder-framework`、`shoulder-platform-common` 等 | 提供一些常用的功能封装,**可直接用于任何项目** |
|
| 开发脚手架 `工具` | 统一维护共性代码,提供常用能力如异常拦截、错误码、安全加密等,统一管理技术和依赖版本 | `spring boot`、`spring cloud`、`shoulder-framework`、`shoulder-platform-common` 等 | 提供一些常用的功能封装,**可直接用于任何项目** |
|
||||||
| 软件开发设计理论指导 `理论` | 软件开发设计理论指导,主要为了系统的易维护、易扩展、易观测、安全性 | 总结业界开发设计实践经验如 `阿里巴巴Java开发规范` 结合而成,详见[优雅软件设计规范](https://doc.itlym.cn) | shoulder给予了一定的理论指导,但这是**可选的**,不强制使用者必须遵循 |
|
| 软件开发设计理论指导 `理论` | 软件开发设计理论指导,主要为了系统的易维护、易扩展、易观测、安全性 | 总结业界开发设计实践经验如 `阿里巴巴Java开发规范` 结合而成,详见[优雅软件设计规范](https://doc.itlym.cn) | shoulder给予了一定的理论指导,但这是**可选的**,不强制使用者必须遵循 |
|
||||||
| 软件平台基础层 `iPaaS` | 无业务含义的基础中间件,数据库、消息队列、监控中间件、告警中间件等 | MySql、RabbitMQ、Nacos、Zipkin、ElasticSearch、Docker、K8s 等,以 `Docker` 镜像方式提供 | 提供大部分场景的最佳技术方案选型,安装、部署、参数调优方案,**可直接用于任何项目** |
|
| 软件平台基础层 `iPaaS` | 无业务含义的基础中间件,数据库、消息队列、监控中间件、告警中间件等 | MySql、RabbitMQ、Nacos、Zipkin、ElasticSearch、Docker、K8s 等,以 `Docker` 镜像方式提供 | 提供大部分场景的最佳技术方案选型,安装、部署、参数调优方案,**可直接用于任何项目** |
|
||||||
| 硬件基础层 `IaaS` | 硬件支撑,如CPU、内存、网络、存储等 | 依赖云主机厂商,如阿里云、腾讯云、亚马逊云等 | 无,shoulder不干涉该层 |
|
| 硬件基础层 `IaaS` | 硬件支撑,如CPU、内存、网络、存储等 | 依赖云主机厂商,如阿里云、腾讯云、亚马逊云等 | 无,shoulder不干涉该层 |
|
||||||
|
|
||||||
|
|
||||||
# 📒 版本变更记录
|
# 📒 版本变更记录
|
||||||
@@ -131,8 +131,7 @@ ELK展示nginx日志演示
|
|||||||
|
|
||||||
# 💗 贡献代码
|
# 💗 贡献代码
|
||||||
|
|
||||||
欢迎各类型代码提交,不限于`优化代码格式`、`优化注释/JavaDoc`、`修复 BUG`、`新增功能`
|
欢迎各类型代码提交,不限于 `优化代码格式`、`优化注释/JavaDoc`、`修复 BUG`、`新增功能`,更多请参考 [如何贡献代码](CONTRIBUTING.MD)
|
||||||
,更多请参考 [如何贡献代码](CONTRIBUTING.MD)
|
|
||||||
|
|
||||||
# 📩 反馈 or 联系我
|
# 📩 反馈 or 联系我
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user