# pangu-msf-docs

**Repository Path**: Debugman/pangu-msf-docs

## Basic Information

- **Project Name**: pangu-msf-docs
- **Description**: 盘古微服务体系文档
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 5
- **Created**: 2025-03-26
- **Last Updated**: 2025-03-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

盘古微服务脚手架
============
[![JDK](https://img.shields.io/badge/JDK-1.8+-blue.svg)](https://www.oracle.com/technetwork/java/javase/overview/index.html)
[![SpringBoot](https://img.shields.io/badge/SpringBoot-2.0.x-green.svg)](https://spring.io/projects/spring-boot)
[![SpringCloud](https://img.shields.io/badge/SpringCloud-Finchley.x-green.svg)](https://spring.io/projects/spring-cloud)
[![License](https://img.shields.io/badge/License-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)

# 一、简介
盘古微服务框架是基于Vue + SpringBoot + SpringCloud搭建的前后端分离的企业级架构，充分利用 Spring Boot 的开发便利性，简化了分布式系统基础设施搭建的成本，使开发者可以专注于构建业务逻辑，为企业内部IT技术的的升级改造提供便利

- 企业统一门户，多种SSO单点登录方式
- 统一认证 和 基于RBAC、OAuth2的统一权限管理
- 实现基于JWT的无状态认证鉴权 + 基于OAuth2授权码模式的有状态认证鉴权，供不同场景下使用
- 前后端开发规范及相应的代码生成
- 丰富的开箱即用组件，组件自带监控指标，开始使用即可监控
- 企业级多租户解决方案
- 封装抽象Spring Security，实现简单功能可配置，多种认证、鉴权方式可插拔式的自由组合

### 核心依赖

|      依赖       |      版本      |
| :-------------: | :------------: |
|       JDK       |      1.8+      |
|   Spring Boot   | 2.0.9.RELEASE  |
|  Spring Cloud   |  Finchley.SR3  |
| Spring Security | 5.0.12.RELEASE |
|  Mybatis Plus   |     3.2.0      |
|     Apollo      |     1.5.0      |
|   Micrometer    |     1.2.0      |

<br>

# 二、目标&优势

1. 提供一整套的企业级微服务解决方案
2. 支持多种认证鉴权方式，支持多端接入，集成单点登录
3. 提供基于Starter自动装配功能的组件，便于快速开发集成客户端和三方组件
5. 可视化的后台管理系统
6. 组件默认支持Metrics指标监控（micrometer）
7. 实现多租户的SAAS服务平台
7. 全局链路跟踪及埋点日志实现
8. 整套的代码开发规范、代码生成工具及接口契约辅助工具
9. 提供快速部署，可以快速部署一套验证环境或者镜像服务
10. 完善的使用指南、部署指南、规范文档、及二次开发指南

<br>

# 三、软件架构

提供微服务架构总体体系图、拓扑结构示意图等

**基于JWT的无状态单点登录认证 - 网关集中校验**

![基于JWT的无状态单点登录认证 - 网关集中校验](images/架构图-基于JWT的无状态单点登录认证-网关集中校验.png)

<br>

**基于OAuth2授权码模式的有状态单点登录认证 - 网关集中校验**

![基于OAuth2授权码模式的有状态单点登录认证 - 网关集中校验](images/架构图-基于OAuth2授权码模式的有状态单点登录认证-网关集中校验.png)

<br>

# 四、部署指南

为了便于使用者在本机、测试环境、生产环境快速搭建部署基于盘古微服务体系提供的一整套场景及相关服务，增加详细的部署指南

- **本机开发部署**
  - [基于JWT的无状态单点登录认证本地部署运行指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E9%83%A8%E7%BD%B2%E6%8C%87%E5%8D%97/%E5%9F%BA%E4%BA%8EJWT%E7%9A%84%E6%97%A0%E7%8A%B6%E6%80%81%E5%8D%95%E7%82%B9%E7%99%BB%E5%BD%95%E8%AE%A4%E8%AF%81%E6%9C%AC%E5%9C%B0%E9%83%A8%E7%BD%B2%E8%BF%90%E8%A1%8C%E6%8C%87%E5%8D%97.md)

<br>

# 五、使用指南

为了便于使用者在开发过程中快速了解盘古微服务架构的使用方式，快速接入，专门提供了盘古微服务架构的一系列使用指南，如快速体验指南、代码生成使用指南、各组件的使用指南等

- **快速体验**
  - [QuickStart使用指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97/QuickStart%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97.md)

- **基础服务**
  - [代码生成使用指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97/%E4%BB%A3%E7%A0%81%E7%94%9F%E6%88%90%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97.md)
- **组件**
  - [RocketMQ组件使用指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97/%E7%BB%84%E4%BB%B6/RocketMQ%E7%BB%84%E4%BB%B6%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97.md)
  - [Elastic-Job组件使用指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97/%E7%BB%84%E4%BB%B6/Elastic-Job%E7%BB%84%E4%BB%B6%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97.md)
  - [基于JWT的无状态认证组件使用指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97/%E7%BB%84%E4%BB%B6/%E5%9F%BA%E4%BA%8EJWT%E7%9A%84%E6%97%A0%E7%8A%B6%E6%80%81%E8%AE%A4%E8%AF%81%E7%BB%84%E4%BB%B6%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97.md)
  - [Metrics监控使用指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97/%E7%BB%84%E4%BB%B6/Metrics%E7%9B%91%E6%8E%A7%E7%BB%84%E4%BB%B6%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97.md)
  - [Zuul网关基于Tag的路由使用指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97/%E7%BB%84%E4%BB%B6/Zuul%E7%BD%91%E5%85%B3%E5%9F%BA%E4%BA%8ETag%E7%9A%84%E8%B7%AF%E7%94%B1%E7%BB%84%E4%BB%B6%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97.md)

<br>

# 六、开发指南

由于盘古微服务对Web、Spring Security、监控等功能做了优化和封装，更加易用和便于扩展，提供可以插拔的自定义功能增强，对于有在基于盘古微服务体系二次开发需求的使用者，提供了二次开发指南，其中可以了解项目的优化和封装逻辑，指导二次开发

- [盘古微服务组件开发指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/%E7%9B%98%E5%8F%A4%E5%BE%AE%E6%9C%8D%E5%8A%A1%E7%BB%84%E4%BB%B6%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97.md)
- [盘古微服务Web MVC开发指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/%E7%9B%98%E5%8F%A4%E5%BE%AE%E6%9C%8D%E5%8A%A1Web%20MVC%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97.md)
- [盘古微服务Spring Security自定义安全组件开发指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/%E7%9B%98%E5%8F%A4%E5%BE%AE%E6%9C%8D%E5%8A%A1Spring%20Security%E8%87%AA%E5%AE%9A%E4%B9%89%E5%AE%89%E5%85%A8%E7%BB%84%E4%BB%B6%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97.md)
- [盘古Metrics监控开发指南](https://gitee.com/pangu-tech/pangu-msf-docs/blob/master/%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/%E7%9B%98%E5%8F%A4Metrics%E7%9B%91%E6%8E%A7%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97.md)

<br>

# 七、设计规划Road Map

> V1.0.0
> 	1. 制定微服务开发规范
> 		+ 前后端API交互规范
> 		+ 统一异常处理规范
> 		+ 应用分层规范
> 		+ 包分层、实体定义转换规范
> 		+ 服务间调用规范
> 	2. 基于JWT的无状态单点登录认证 + 基于OAuth2授权码模式的有状态单点登录认证
> 	3. 网关层的RBAC统一鉴权控制，推拉结合的权限数据同步
> 	4. 基于盘古微服务开发规范对应代码生成工具
> 	5. 可视化的管理系统
> 		+ 基于RBAC的用户权限管理系统
> 		+ 统一门户

<br>

# 八、参考文献