README.md · 呼嘎嘎/skycloud-base

## Sky Cloud 项目
[![Build Status](https://travis-ci.org/xk11961677/skycloud-base.svg?branch=master)](https://travis-ci.org/xk11961677/skycloud-base)
[![license](https://img.shields.io/badge/license-MIT-ff69b4.svg)](https://mit-license.org/license.html)
[![springcloud](https://img.shields.io/badge/springcloud-greenwich-orange.svg)](https://spring.io/projects/spring-cloud)
![Gitter](https://img.shields.io/gitter/room/sky-docs/community)
![version](https://img.shields.io/badge/version-1.0.0-blueviolet.svg)
![helloworld](https://img.shields.io/badge/hello-world-blue)

## 文档地址
- [quick-start](https://xk11961677.github.io/sky-docs/)

### 项目介绍
```
功能点：
    
技术点：
    核心技术为springcloud Greenwich.RELEASE 全家桶实现。实现了基于RBAC、jwt和oauth2的无状态统一权限认证的解决方案，实现了异常和日志的统一管理。
	
	核心框架：springcloud Greenwich全家桶
	    服务注册与发现: consul
	    配置中心: apollo
	    调用链:  skywalking
	    监控:    (hystrix + turbine  + admin) prometheus + granfa
	        
	安全框架：Spring Security Spring Cloud Oauth2
	分布式任务调度：xxl-job
	持久层框架：MyBatis、通用Mapper4、Mybatis_PageHelper
	数据库连接池：Alibaba Druid
	日志管理：Logback	、ELK
	前端框架：Vue全家桶以及相关组件
	分表分库: sharding-jdbc
	消息队列: rocket-mq
	分布式事务: seata
	ETL:  datax
	
	
```
### 整体代码结构层
```

│  ├─framework-------------------------框架层(https://github.com/xk11961677/framework)                                          
│  │
│  ├─skycloud-base------------------微服务基础层(https://github.com/xk11961677/skycloud-base)
│  │
│  ├─skycloud-service---------------微服务业务层(https://github.com/xk11961677/skycloud-service)
│  │
    
```

### 平台目录结构说明
```
│
├─skycloud-base----------------------------父项目，公共依赖
│  │
│  ├─skycloud-base-auth------------------认证与授权
│  │  │
│  │  ├─skycloud-base-authentication-api------------------认证客户端Feign
│  │  │
│  │  ├─skycloud-base-authentication------------------认证中心
│  │  │
│  │  ├─skycloud-base-authorization------------------授权中心
│  │  │
│  ├─skycloud-base-gateway-----------------网关
│  │
│  ├─skycloud-base-bom------------------三方包、二方包
│  │
│  ├─skycloud-base-dependencies------------------一方包与整体兼容包对外依赖
│  │
│  ├─skycloud-base-codegen-----------------代码生成工具(web站点)
│  │
│  ├─skycloud-base-common------------------公共包(依赖JAR包)
│  │
│  ├─skycloud-base-config------------------配置中心(依赖JAR包)
│  │
│  ├─skycloud-base-consul------------------服务发现与注册(依赖JAR包)
│  │
│  ├─skycloud-base-hystrix-client------------------hystrix客户端(依赖JAR包)
│  │
│  ├─skycloud-base-hystrix-dashboard------------------hystrix单一面板
│  │
│  ├─skycloud-base-hystrix-turbine--------------------hystrix聚合中心
│  │
│  ├─skycloud-base-monitor------------------Spring boot admin监控
│  │
│  ├─skycloud-base-prometheus------------------prometheus grafana监控(依赖JAR包)
│  │
│  ├─skycloud-base-upload----------------------文件上传资源服务
│  │
│  ├─skycloud-base-log----------------------系统日志服务
│  │
│  ├─skycloud-base-log-api----------------------系统日志服务API
│  │
│  ├─skycloud-base-idgenerator----------------------ID生成器服务
│  │
│  ├─skycloud-base-idgenerator-api----------------------ID生成器API
│  │
│  ├─skycloud-base-nacos------------------------------注册与配置中心(nacos)(依赖JAR包)
│  │
│  ├─seata--------------------------------------分布式事务(seata)
│  │
│  ├─zipkin-------------------------------------调用链(zipkin)
│  │
│  ├─skywalking---------------------------------调用链(skywalking)
│  │
│  ├─skycloud-generator-tool--------------------------代码生成工具(废弃)
│  │

```

## 进度

| 服务          | 使用技术                 | 进度 | 备注                                                  |
| ------------- | ------------------------ | ---- | ----------------------------------------------------- |
| 注册中心      | consul/nacos             | ✅    |                                                       |
| 配置中心      | apollo/nacos             | ✅    |                                                       |
| 动态网关      | SpringCloud Gateway      | ✅    | 多种维度的流量控制（服务、IP、用户等），后端可配置化✅ |
| 授权认证      | Spring Security OAuth2   | ✅    |                                                       |
| 服务容错      | SpringCloud Hystrix      | ✅    |                                                       |
| 服务调用      | SpringCloud OpenFeign    | ✅    |  
| 调用链监控    | Skywalking/Zipkin         | ✅   |  
| 断路器监控    | Hystrix Dashbord + Tubine | ✅   | 
| 代码生成      | SpringCloud + velocity   | ✅    | 
| 任务调度      | xxl-job                  | ✅    |
| 分表分库      | sharding-jdbc            |  ✅   |  sharding与seata结合还需大量测试
| 分布式事务     | seata                    | ✅    | 现阶段还需大量测试
| 分布式ID     |  uid-generator            | ✅    | 
| 日志收集      | ELK                      | ✅    |  
| 企业监控      | prometheus + grafana     | ✅    |
| 数据迁移      | Datax                     | ✅    |
| 灰度发布      | todo                     | 🏗     |

数据迁移项目代码请[点我](https://github.com/xk11961677/skycloud-datax)

分布式事物 分表分库 在POC项目中请[点我](https://github.com/xk11961677/skycloud-service-example)

## [签名算法](docs/file/sign.md)

## git message 规约
#### 作用
用于生成规范changelog
#### 提交格式
1. [请点我](docs/script/changelog/commit.md)
2. idea 可使用 git commit template 插件
3. npm 可以使用 commitizen
#### 生成changelog方式
运行docs/script/changelog/gitlog.sh

## 代码发布方式
- [skycloud-base-bom](skycloud-base-bom) 
    -  版本号：<主版本>.<次版本>.<增量版本>-<代号>
    -  废弃: 升级版本号命令(统一设置新版本号)
         -  mvn versions:set -DnewVersion=x.x.x
    -  废弃: 升级版本号命令(使用maven plugin自动部署)
         -  mvn release:prepare  
             1. 把项目打一个release版本
             2. 在git的tag中打一个tag
             3. 自动升级SNAPSHOT 并提交更新后的pom文件到git
         -  mvn release:perform  
             1. 去git的tag上拿代码
             2. 用tag上的代码，打一个release版的包 
             3. deploy到的maven私服 
    -  直接修改<revision>1.0.0-SNAPSHOT</revision>属性版本

## docker 启动consul
```
1. 脚本位置: docs/docker/consul/docker-compose.yml

2. 启动命令: docker-compose up -d

3. 停止命令: docker-compose stop

4. 查看集群信息: docker exec -t node1 consul members
```

## docker 启动apollo
```
1. 启动consul前提下

2. 将docs/script/db/apollo 数据库脚本导入数据

3. 将docs/docker/apollo 三个脚本修改IP地址与数据库地址

4. 按步骤运行apollo_config.sh 、apollo_admin.sh 、apollo_portal.sh
```

## docker-compose 启动方式(仅为 java项目)
##### 前提条件 在skycloud-base根目录执行所有脚本
```
1. 创建镜像
docker-compose -f docs/docker/docker-compose.yml build

2. 启动容器
docker-compose -f docs/docker/docker-compose.yml up -d

```

## 运维管理页面
[vue address](https://github.com/xk11961677/skycloud-admin-vue)

![platform](docs/image/platform_01.png)

![platform](docs/image/platform_02.png)

## FAQ
- 在使用中有任何问题，欢迎反馈
- [apollo-consul源码与部署包](https://pan.baidu.com/s/1s7tXv1uXBdWGxL84Ha5tFw) 提取码: xbdw
- [apollo数据库](docs/script/db/apollo)
- ELK 现阶段测试使用 logstash-logback-encoder 直接写入logstash,消耗资源较大，生产建议不要使用
  改用EFK 或 flume+kafka+logstash/flume(自定义sink)+es 或 filebeat+kafka+elk 或logback appender --> MQ 等

## 开发计划
 1. 用户中心管理功能
 2. 优化dockerfile
 3. 灰度发布

## 架构图

![架构图](docs/image/architecture_diagram.jpg)

## 关于作者

## [LICENSE](LICENSE)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

呼嘎嘎/skycloud-base

简介

发行版

贡献者

近期动态

呼嘎嘎/skycloud-base .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

呼嘎嘎/skycloud-base