Skip to content

盘古开发框架
盘古开发框架

普蓝开源社区 / 盘古开发框架

通知 25
Star 3
Fork 0
盘古开发框架
盘古开发框架

前往新版Gitcode，体验更适合开发者的 AI 搜索 >>

提交 cfe1a0ed 编写于 作者: X xiongchun
浏览文件
操作

升级项目官网和文档中心

上级 22239489
隐藏空白更改
内联 并排
Showing with 420 addition and 37 deletion
pangu-website/docusaurus.config.js
浏览文件 @ cfe1a0ed
......@@ -7,23 +7,20 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
title: '盘古开发框架项目官网',
customFields: {
subTitle: '一套轻量稳健的工业级分布式微服务开发治理框架（兼容单体分层架构）',
},
tagline: '工业级微服务开发治理框架',
tagline: '一套轻量稳健的工业级移动端应用和中后台业务系统开发框架',
url: 'https://pulanos.gitee.io',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicon2.png',
organizationName: '盘古开发框架,普蓝开源社区', // Usually your GitHub org/user name.
projectName: 'pangu-framework', // Usually your repo name.
plugins: [require.resolve("docusaurus-plugin-image-zoom")],
//plugins: [require.resolve("docusaurus-plugin-image-zoom")],
//baseUrl: '/',
baseUrl: '/pangu-framework/',
// 百度统计
// 百度统计 暂停使用
scripts: [
//https://pulanos.gitee.io/pangu-framework/
{ src: 'https://hm.baidu.com/hm.js?8a2c2aae78c4983e3cf661fea34e6353', async: true },
//{ src: 'https://hm.baidu.com/hm.js?8a2c2aae78c4983e3cf661fea34e6353', async: true },
//https://pangu.pulanit.com/
//{src: 'https://hm.baidu.com/hm.js?abe6bd08ebb4621f70496f015defa76b', async: true},
],
......@@ -33,16 +30,16 @@ const config = {
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
path: 'docs',
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
editUrl: 'https://gitee.com/pulanos/pangu-framework/tree/master/pangu-website/',
//sidebarHideable:true
},
blog: {
blogSidebarTitle: '最新发布博客',
blogTitle: '博客',
showReadingTime: true,
blogSidebarCount: 0,
blogSidebarTitle: '最新发布博客',
postsPerPage: 10,
// Please change this to your repo.
editUrl: 'https://gitee.com/pulanos/pangu-framework/tree/master/pangu-website/',
......@@ -53,7 +50,18 @@ const config = {
}),
],
],
plugins: [
[
'@docusaurus/plugin-content-docs',
{
id: 'faq',
path: 'faq',
routeBasePath: 'faq',
sidebarPath: require.resolve('./sidebarsFaq.js'),
// ... other options
},
]
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
......@@ -76,7 +84,7 @@ const config = {
label: '开发文档',
},
{
to: '/faq',
to: '/faq/index',
label: '常见问答',
position: 'left'
},
......@@ -161,7 +169,7 @@ const config = {
}
],
copyright: `PanGu Dev Framework is Open Source and freely available under the <a target="_blank" class="ghostwhite" href="https://www.apache.org/licenses/LICENSE-2.0">Apache v2 License.</a>
<br>Copyright © ${new Date().getFullYear()} <a target="_blank" class="ghostwhite" href="https://www.pulanit.com">PuLan Open Source Community</a><br><img src="https://oscimg.oschina.net/oscnet/up-ba8a16960e88b912e4499d7dc0dd494d57e.gif" />`,
<br>Copyright © ${new Date().getFullYear()} <a target="_blank" class="ghostwhite" href="https://www.pulanit.com">PuLan Open Source Community</a><br><img src="./img/dashi.gif" />`,
},
zoom: {
selector: '.markdown :not(em) > img,.markdown > img',
......@@ -180,6 +188,7 @@ const config = {
metadata: [
{ name: 'author', content: '普蓝开源社区' },
{ name: 'keywords', content: '盘古开发框架 分布式微服务架构 垂直单体分层架构 普蓝开源社区' },
// 百度站点收录验证
{ name: 'baidu-site-verification', content: 'code-FsdXztrzOo' }
]
}),
......
pangu-website/faq/index.md 0 → 100644
浏览文件 @ cfe1a0ed
---
title: 简介
tags: [盘古简介,盘古架构]
sidebar_position: 1
slug: /index
---
# 简介
<head>
<title>盘古开发框架简介</title>
<meta name="keywords" content="盘古开发框架简介" />
<meta name="description" content="盘古开发框架是一套轻量稳健的工业级分布式微服务开发治理框架（兼容单体分层架构）" />
</head>
[**盘古开发框架**](/) 是独立于 Spring Cloud 生态的一套轻量灵活、成熟可靠的工业级分布式微服务开发治理框架（兼容垂直单体分层架构)。它基于 [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) 协议**开源**发布，且是**免费**的。我们希望不仅是开源的受益者，也能成为开源贡献者，与开源社区一起**共建共享开源生态**。
## 设计原则
在类设计、模块结构划分、技术组件选型、框架体系架构设计时会优先遵循的一些设计范式和指导原则。
- **极简原则**
大道至简，简单代表好用、稳定、易协作。坚持「Keep it Simple & Stupid」设计理念。
- **最佳实践原则**
通过大量的生产实例总结，沉淀复用最佳实践。
- **无为而无不为**
不求大而全，聚焦专而精，保持架构的纯洁与透明。坚持「Less is More」设计理念。
- **服务优先原则**
「服务」是盘古开发框架的一等公民，我们旨在微服务和云原生范式基础上构建「以服务为中心」的现代应用架构。
- **轻量灵活一致性原则**
通用功能模块化，既能下沉复用也能对标替换；一套架构既是分布式微服务架构的工业级首选，同时也能兼容单体应用开发。
## 生态架构图
<img width="800"
src={require('/resources/doc/34-pangu-framework.png').default}
alt="盘古开发框架生态架构图" />
## 主要功能
1. 自定义的 Spring Boot 启动器，完成各功能组件的自动装配。
2. 自研轻量 Maven 插件，支持各场景的模版代码生成。
3. 配置参数外部化、动态化和中心化管理。
4. 面向接口代理的高性能 RPC 服务调用。
5. 支持服务调用智能容错和负载均衡、服务限流与熔断、可视化的服务治理与运维等。构建「以服务为中心」的现代应用架构服务平台。
6. 强大的数据访问能力，内置通用 CRUD 接口；支持 Lambda 表达式；提供逻辑删除、乐观锁、分页、字段值填充等功能。
7. 支持基于异步非阻塞模型的高性能 HTTP 网关通过泛化调用后端 Dubbo 服务。同时网关支持 HTTP 层的鉴权、动态限流、熔断、防火墙、灰度发布等。
8. 提供靠谱的最终一致性分布式事务落地方案。
9. 提供数据治理相关功能，如：读写分离、数据分片、数据加密等。
10. 提供消息队列在异步通信、服务解耦、消峰填谷、缓存同步等应用场景下的使用能力。
11. 提供分布式环境下的多级缓存功能(注解式和编程式)。Caffeine 作为一级本地缓存，Redis 作为二级集中式缓存。
12. 支持可配置、可监控的分布式任务调度。
13. 支持注解声明式和编程式对业务代码在分布式环境下加并发互斥锁。
14. 应用日志输出级别动态切换、分布式日志跟踪等...
## 组件依赖
### 基础核心组件
- Spring ※ Spring Boot
- MyBatis (MyBatis Plus)
- Apache Dubbo
- Aliware Nacos
### 扩展增强型组件
- Apache ShardingSphere
- Aliware Seata
- Aliware Sentinel
- Layering Cache
- Lock4J
- TLog
### 辅助工具类组件
- Lombok
- Apache Commons
- Google Guava
- Hutool
### 可选组件
- Apache ShenYu
- XXL Job
> **可选组件**指：由我们优选的做过适配或提供集成方案但不作为盘古框架缺省或标配的组件。
## 模块列表
- 盘古资源依赖声明管理模块：pangu-parent
- 盘古公共基础类库：pangu-common
- 盘古启动、中心化配置等基础能力自动装配模块：pangu-spring-boot-starter
- 盘古 Dubbo 服务开发自动装配模块：pangu-dubbo-spring-boot-starter
- 盘古数据库持久化操作自动装配模块：pangu-jdbc-spring-boot-starter
- 盘古缓存开发自动装配模块：pangu-cache-spring-boot-starter
- 盘古 Web 应用自动装配模块：pangu-web-spring-boot-starter
- 盘古消息队列自动装配模块：pangu-rabbitmq-spring-boot-starter
- 盘古分布式事务自动装配模块：pangu-seata-spring-boot-starter
- 盘古数据治理（读写分离、数据分片等）自动装配模块：pangu-data-governance-spring-boot-starter
- 盘古代码生成器Maven插件：pangu-generator-maven-plugin
- 盘古项目官网和文档：pangu-website
- 盘古框架模版化参考范例集：pangu-examples
## FAQ
你最想了解的常见问答可能都在这里：[:soon: 常见问答 FAQ](/docs/faq)。
## 下一步
继续阅读其它章节获取你想要的答案或通过我们的 [开发者社区](/docs/community) 寻求更多帮助。
\ No newline at end of file
pangu-website/faq/安装.md 0 → 100644
浏览文件 @ cfe1a0ed
---
title: 安装
tags: [盘古简介,盘古架构]
sidebar_position: 2
slug: /install2
---
<head>
<title>盘古开发框架 | 安装 | 依赖管理模块 | 基础模块 | Dubbo模块 | JDBC模块 | 分布式事务管理模块 | 数据治理模块 | 缓存模块 | 消息队列模块 | 网关模块 | Web模块 | 代码生成插件</title>
<meta name="keywords" content="盘古开发框架 | 安装 | 依赖管理模块 | 基础模块 | Dubbo模块 | JDBC模块 | 分布式事务管理模块 | 数据治理模块 | 缓存模块 | 消息队列模块 | 网关模块 | Web模块 | 代码生成插件" />
<meta name="description" content="盘古开发框架是一套轻量稳健的工业级分布式微服务开发治理框架（兼容单体分层架构）" />
</head>
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
盘古开发框架已经发布到 Maven 中央仓库，直接使用如下方法安装使用即可。
## 依赖管理模块
盘古资源依赖声明管理模块。所有盘古引用都应该依赖这个模块。
<Tabs>
<TabItem value="maven" label="Maven坐标">
```jsx
<parent>
<groupId>com.gitee.pulanos.pangu</groupId>
<artifactId>pangu-parent</artifactId>
<version>${最新稳定版本}</version>
<relativePath/>
</parent>
```
</TabItem>
<TabItem value="Gradle" label="Gradle DSL">
```jsx
implementation 'com.gitee.pulanos.pangu:pangu-parent:${最新稳定版本}'
```
</TabItem>
</Tabs>
## 基础模块
盘古启动、中心化配置、动态日志等基础能力自动装配模块。
<Tabs>
<TabItem value="maven" label="Maven坐标">
```jsx
<dependency>
<groupId>com.gitee.pulanos.pangu</groupId>
<artifactId>pangu-spring-boot-starter</artifactId>
</dependency>
```
</TabItem>
<TabItem value="Gradle" label="Gradle DSL">
```jsx
implementation 'com.gitee.pulanos.pangu:pangu-spring-boot-starter:${最新稳定版本}'
```
</TabItem>
</Tabs>
## Dubbo模块
盘古微服务开发自动装配模块。
<Tabs>
<TabItem value="maven" label="Maven坐标">
```jsx
<dependency>
<groupId>com.gitee.pulanos.pangu</groupId>
<artifactId>pangu-dubbo-spring-boot-starter</artifactId>
</dependency>
```
</TabItem>
<TabItem value="Gradle" label="Gradle DSL">
```jsx
implementation 'com.gitee.pulanos.pangu:pangu-dubbo-spring-boot-starter:${最新稳定版本}'
```
</TabItem>
</Tabs>
## JDBC模块
盘古数据库持久化操作自动装配模块。
<Tabs>
<TabItem value="maven" label="Maven坐标">
```jsx
<dependency>
<groupId>com.gitee.pulanos.pangu</groupId>
<artifactId>pangu-jdbc-spring-boot-starter</artifactId>
</dependency>
```
</TabItem>
<TabItem value="Gradle" label="Gradle DSL">
```jsx
implementation 'com.gitee.pulanos.pangu:pangu-jdbc-spring-boot-starter:${最新稳定版本}'
```
</TabItem>
</Tabs>
## 分布式事务管理模块
盘古 Seata 分布式事务自动装配模块。
<Tabs>
<TabItem value="maven" label="Maven坐标">
```jsx
<dependency>
<groupId>com.gitee.pulanos.pangu</groupId>
<artifactId>pangu-seata-spring-boot-starter</artifactId>
</dependency>
```
</TabItem>
<TabItem value="Gradle" label="Gradle DSL">
```jsx
implementation 'com.gitee.pulanos.pangu:pangu-seata-spring-boot-starter:${最新稳定版本}'
```
</TabItem>
</Tabs>
## 数据治理模块
盘古 ShardingSphere 数据治理（如：读写分离、数据分片、数据加密等）自动装配模块。
<Tabs>
<TabItem value="maven" label="Maven坐标">
```jsx
<dependency>
<groupId>com.gitee.pulanos.pangu</groupId>
<artifactId>pangu-data-governance-spring-boot-starter</artifactId>
</dependency>
```
</TabItem>
<TabItem value="Gradle" label="Gradle DSL">
```jsx
implementation 'com.gitee.pulanos.pangu:pangu-data-governance-spring-boot-starter:${最新稳定版本}'
```
</TabItem>
</Tabs>
## 缓存模块
盘古缓存开发自动装配模块。
<Tabs>
<TabItem value="maven" label="Maven坐标">
```jsx
<dependency>
<groupId>com.gitee.pulanos.pangu</groupId>
<artifactId>pangu-cache-spring-boot-starter</artifactId>
</dependency>
```
</TabItem>
<TabItem value="Gradle" label="Gradle DSL">
```jsx
implementation 'com.gitee.pulanos.pangu:pangu-cache-spring-boot-starter:${最新稳定版本}'
```
</TabItem>
</Tabs>
## 消息队列模块
盘古 RabbitMQ 消息队列开发自动装配模块。
<Tabs>
<TabItem value="maven" label="Maven坐标">
```jsx
<dependency>
<groupId>com.gitee.pulanos.pangu</groupId>
<artifactId>pangu-rabbitmq-spring-boot-starter</artifactId>
</dependency>
```
</TabItem>
<TabItem value="Gradle" label="Gradle DSL">
```jsx
implementation 'com.gitee.pulanos.pangu:pangu-rabbitmq-spring-boot-starter:${最新稳定版本}'
```
</TabItem>
</Tabs>
## Web模块
盘古 Web 应用自动装配模块。
<Tabs>
<TabItem value="maven" label="Maven坐标">
```jsx
<dependency>
<groupId>com.gitee.pulanos.pangu</groupId>
<artifactId>pangu-web-spring-boot-starter</artifactId>
</dependency>
```
</TabItem>
<TabItem value="Gradle" label="Gradle DSL">
```jsx
implementation 'com.gitee.pulanos.pangu:pangu-web-spring-boot-starter:${最新稳定版本}'
```
</TabItem>
</Tabs>
## 代码生成插件
盘古代码生成器 Maven 插件。
<Tabs>
<TabItem value="maven" label="Maven坐标">
```jsx
<dependency>
<groupId>com.gitee.pulanos.pangu</groupId>
<artifactId>pangu-generator-maven-plugin</artifactId>
</dependency>
```
</TabItem>
<TabItem value="Gradle" label="Gradle DSL">
```jsx
implementation 'com.gitee.pulanos.pangu:pangu-generator-maven-plugin:${最新稳定版本}'
```
</TabItem>
</Tabs>
## 下一步
继续阅读其它章节获取你想要的答案或通过我们的 [开发者社区](/docs/community) 寻求更多帮助。
\ No newline at end of file
pangu-website/sidebarsFaq.js 0 → 100644
浏览文件 @ cfe1a0ed
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
// But you can create a sidebar manually
/*
tutorialSidebar: [
{
type: 'category',
label: 'Tutorial',
items: ['hello'],
},
],
*/
};
module.exports = sidebars;
pangu-website/src/components/HomepageFeatures.js
浏览文件 @ cfe1a0ed
......@@ -8,8 +8,8 @@ const FeatureList = [
Svg: require('../../static/img/plugins.svg').default,
description: (
<>
开箱即用的技术组件库、搭配自定义 SpringBoot 启动器和轻巧的代码生成 Maven 插件，可随意组合、自动装配、灵活插拔。
既能构建支持大并发高可用的互联网分布式架构也能快速搭建垂直单体分层架构。
开箱即用的技术组件库，可随意组合、自动装配、灵活插拔。成熟的权限系统系统参考实现，可实现快速搭建二次开发脚手架。
既能构建支持大并发高可用的互联网分布式架构也能快速搭建垂直单体分层架构。
</>
),
},
......@@ -17,7 +17,8 @@ const FeatureList = [
title: '成熟架构、稳定可靠',
Svg: require('../../static/img/feat_coming.svg').default,
description: (
<>盘古技术栈融合云原生思想，在微服务、容器化、DevOps 等方面完美支持和适配。可在云原生时代构建以「服务」为中心的现代应用架构，帮助用户在云环境中更好的构建、交付和管理自己的微服务平台。
<>
盘古技术栈融合云原生思想，在微服务、容器化、DevOps 等方面完美支持和适配。可在云原生时代构建以「服务」为中心的现代应用架构，帮助用户在云环境中更好的构建、交付和管理自己的微服务平台。
</>
),
},
......@@ -27,14 +28,14 @@ const FeatureList = [
description: (
<>
聚焦面向（移动）互联网的电商、金融、云端 SAAS 服务等大并发高可用可扩展的业务场景。
同时也能满足诸如 ERP 、CRM 等各种企业数字化和各级电子政务系统的中小规模应用需求。
同时也能满足诸如 ERP 、CRM 等各种企业数字化和各级电子政务系统的中小规模应用需求。
</>
),
}
];
function Feature({Svg, title, description}) {
function Feature({ Svg, title, description }) {
return (
<div className={clsx('col col--4')}>
<div className="text--center">
......
pangu-website/src/pages/index.js
浏览文件 @ cfe1a0ed
......@@ -7,26 +7,26 @@ import styles from './index.module.css';
import HomepageFeatures from '../components/HomepageFeatures';
function HomepageHeader() {
const {siteConfig} = useDocusaurusContext();
const { siteConfig } = useDocusaurusContext();
return (
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<div className="container">
<h1 class="hero__title"><span className={styles.hero__title2}>盘古开发框架</span></h1>
<p className="hero__subtitle">{siteConfig.customFields.subTitle}</p>
<div class="btn-group">
<div className={styles.buttons}>
<Link
className={styles.xcbutton}
to="/docs/intro">
快速开始
</Link>
<Link
className={styles.xcbutton2}
to="https://gitee.com/pulanos/pangu-framework">
下载代码
</Link>
<h1 className="hero__title"><span className={styles.hero__title2}>盘古开发框架</span></h1>
<p className="hero__subtitle">一套轻量稳健的工业级<b>移动端应用</b>和<b>中后台业务系统</b>开发框架</p>
<div className="btn-group">
<div className={styles.buttons}>
<Link
className={styles.xcbutton}
to="/docs/intro">
快速开始
</Link>
<Link
className={styles.xcbutton2}
to="https://gitee.com/pulanos/pangu-framework">
下载代码
</Link>
</div>
</div>
</div>
</div>
</header>
......@@ -34,11 +34,10 @@ function HomepageHeader() {
}
export default function Home() {
const {siteConfig} = useDocusaurusContext();
const { siteConfig } = useDocusaurusContext();
return (
<Layout
title={`盘古${siteConfig.tagline}`}
description="「盘古开发框架」是一套轻量灵活、成熟可靠的工业级分布式微服务开发和治理框架（兼容垂直单体分层架构)。它基于 Apache-2.0 LICENSE 协议开源发布，且是免费的。我们希望不仅是开源的受益者，也能成为开源的贡献者，与开源社区一起「共建共享开源生态」。">
description={`${siteConfig.tagline}`}>
<HomepageHeader />
<main>
<HomepageFeatures />
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或