# spring-cloud-platform

**Repository Path**: shigen/spring-cloud-platform

## Basic Information

- **Project Name**: spring-cloud-platform
- **Description**: sping cloud 的组件封装
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2023-04-30
- **Last Updated**: 2024-12-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 项目简介

`cloud-platform` 是基于spring-cloud、spring-cloud Alibaba
组件封装的项目脚手架，旨在减少项目初始化的成本。同时，对于一些组件，如Nacos、ELK、redis、mysql等提供一键化部署的脚本，方便容器的构建和管理。

## 亮点

1. 分模块组织的思想，将oss、lucene、elk、oss等分模块进行组织和管理
2. 脚本启动基础服务，如redis、Nacos、elk，减少环境的依赖和安装成本

## 项目结构

```
├── shigen-common               # 公共模块，自定义的util、message、exception、handler等
├── shigen-es                   # es的分装，elk的部署脚本和映射文件
├── shigen-gateway              # Gateway的封装，包含自定义的负载均衡策略、令牌算法的流控
├── shigen-generator            # 代码生成器
├── shigen-infrastructure       # 基础组件，包含nacos、elk、sentinel、spring-boot-admin
├── shigen-lucene               # lucene的查询接口
├── shigen-oss                  # oss的封装，包含常见的云存储平台minio、腾讯云
├── shigen-redis                # redis的封装
├── shigen-sample               # 基于代码生成器生成的controller、service、dao代码
├── shigen-security             # security的封装，实现动态权限验证
```

## 项目代码规范

在提交代码之前注意：

1. 一定要格式化代码，使用idea自带的`Reformat Code`功能
2. 一定要删除无用的import语句，使用用idea自带的`Optimize Imports`功能
3. 建议删除无用的代码，使用idea自带的`Remove unused code`功能

## 规划

2024年年底看到之前的代码目录结构还是存在很大的问题，于是抽时间开始进行cloud-platform 1.1.0版本的优化。终点关注：

1. 代码的模块划分是否合理
2. 代码的规范是否统一
3. 代码的优化：简单、易集成