# Jade

**Repository Path**: ArnoldSu/Jade

## Basic Information

- **Project Name**: Jade
- **Description**: 他山之石，可以攻玉，一个Java快速开发集成平台。为了检验自身的代码编写以及架构搭建能力做一个普遍大众易用好用爱用的全部代码开源的java 开发平台。不仅仅是拿来即用我希望大家能根据此开源项目完成自己梦想中的项目。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-23
- **Last Updated**: 2023-06-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# jade

#### 介绍
洁白娇嫩，如玉一样的娇嫩的Java快速开发平台。
# 概述

他山之石，可以攻玉，一个Java快速开发集成平台。为了检验自身的代码编写以及架构搭建能力做一个普遍大众易用好用爱用的全部代码开源的java 开发平台。不仅仅是拿来即用我希望大家能根据此开源项目完成自己梦想中的项目。

# 搭建准备

## 技术选型

### spring-cloud-alibaba

官网地址：[https://spring.io/projects/spring-cloud-alibaba](https://spring.io/projects/spring-cloud-alibaba)

版本选择，官网wiki：[https://github.com/alibaba/spring-cloud-alibaba/wiki/版本说明](https://github.com/alibaba/spring-cloud-alibaba/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E)

![alibaba cloud版本说明](doc/image/1657711115449.jpg)
![三者关系说明](doc/image/1657711198323.jpg)

确定版本选择为2021.0.1.0****。****

### springcloud

官网地址：[https://spring.io/projects/spring-cloud#overview](https://spring.io/projects/spring-cloud#overview)

![输入图片说明](doc/image/1657711291867.jpg)

因为要与spring-cloud-alibaba的推荐版本一致所以springcloud版本我们确定为2021.0.1。

### springboot

官网地址：[https://spring.io/projects/spring-boot#overview](https://spring.io/projects/spring-boot#overview)

确定springboot的版本以及了解相应版本特性，官网wiki：[https://github.com/spring-projects/spring-boot/wiki#release-notes](https://github.com/spring-projects/spring-boot/wiki#release-notes)，我选型的时候官网指出主要是2.6和2.7是主要的维护版本，因为要与spring-cloud-alibaba的推荐版本一致所以springboot版本我们确定为2.6.3.

# 项目模块划分
## 总体架构图

![Jade系统架构](doc/image/Jade系统架构.png)

## 逻辑架构图

![项目逻辑架构图](doc/image/项目逻辑架构图.png)

- jade-core(核心模块)
    - jade-starter-cloud（Cloud依赖模块）
    - jade-starter-common(通用依赖模块)
    - jade-starter-db（数据库模块）
    - jade-starter-dependencies（统一封装依赖模块（可根据自身需求任意组合使用））
    - jade-starter-feign（feign模块）
    - jade-starter-log（日志模块 todo）
    - jade-starter-mail（邮件模块 todo ）
    - jade-starter-redis（redis缓存模块 todo）
    - jade-starter-rocketmq（rocketmq 模块 todo）
    - jade-starter-seata（seata模块 todo）
    - jade-starter-sentinel（sentinel模块 todo）
    - jade-starter-web（web模块）
- jade-gateway(网关模块)
    
    
- jade-mq(消息模块)
    - jade-msg-consumer（mq消费者模块）
    - jade-msg-provider（mq生产者模块）
- jade-platform(系统模块)
    - jade-admin（平台管理模块）
    - jade-admin-api（平台管理API模块）
- jade-support(支持平台模块)
    - jade-generator（代码生成模块）
    - jade-sql（sql追溯模块）

- jade-uaa(平台统一认证模块 todo )


#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

1.  xxxx
2.  xxxx
3.  xxxx

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)