# springcloud-template

**Repository Path**: lvsccode/springcloud-template

## Basic Information

- **Project Name**: springcloud-template
- **Description**: 一个基于springcloud netflix开发的脚手架，记录了关于微服务开发中一些基础功能、通用功能的最佳设计，欢迎大家学习、指导。
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 12
- **Created**: 2024-04-17
- **Last Updated**: 2024-04-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

一个基于 Spring Cloud Netflix 、Spring Boot 2.0.3 的微服务开发模板

## 功能说明

- 基于Eureka服务下线实现无报错优雅发版
- 统一异常处理和响应包装
- 请求参数、响应结果统一日志打印(可将日志ID传递至子线程)
- 自定义线程池日志、Tomcat线程池(主要加了日志打印功能)
- Feign请求头数据在微服务间传递
- 基于MDC实现的自定义请求链路追踪
- 基于redis+注解实现的API幂等
- 统一认证demo，包括微信、支付宝授权登录等各种登录方式
- 文件存储demo，包括阿里云OSS、腾讯云COS等多种云存储方式
- 短信发送demo，支持阿里云、腾讯云等多个渠道，结合MQ实现短信异步发送，并记录短信发送结果
- ToC优惠券实现demo，能够在不修改表结构的情况增加优惠券使用条件，或者增加复杂度更高的使用条件，具有高扩展性
- ToC弹窗实现demo，能够在不修改表结构的情况增加弹窗条件，或者增加复杂度更高的弹窗条件，具有高扩展性
- 微信订阅消息实现demo，提供存储设计表结构，代码通用，易于使用，易于问题排查
- 动态数据源使用demo
- 导航栏金刚位、轮播图实现demo，能够在不修改表结构的情况增加展示条件，或者增加复杂度更高的展示条件，具有高扩展性

## 快速开始

### 核心依赖

| 依赖                   | 版本       |
| ---------------------- |------------|
| Spring Boot            | 2.2.13     |
| Spring Cloud Netflix   | 2.2.0      |

### 模块说明

```lua
springcloud-template
├── template-common -- 公共模块
└── template-framework -- 框架代码(内部微服务)
     └── advice -- 统一异常处理、响应日志统一打印
     └── apollo -- apollo属性刷新配置（分享：https://www.toutiao.com/article/7258567779102917139）
     └── autoconfigure -- 自动配置
     └── deploy -- 优雅发版(可做到用户无感发版，完全不报错，分享：https://www.toutiao.com/article/7136601651804127751)
     └── interceptor -- Feign请求头数据在微服务间传递（分享：https://www.toutiao.com/article/7126056949267268108）
     └── threadpool -- 自定义线程池（JDK和Tomcat）
└── template-framework-edge -- 框架代码(边缘微服务)
     └── filter -- http公共请求参数设置到请求头在微服务内传递
     └── interceptor -- 访问控制(结合@PublicUrl使用)
├── template-eureka -- 注册中心
├── template-gateway -- 网关(与zuul二选一，分享：https://www.toutiao.com/article/7271926711678321215)
├── template-zuul -- 网关（与gateway二选一）
├── template-config -- 配置中心
└── template-order -- 订单服务(内部微服务)
     └── template-order-api -- 被依赖开放api
└── template-order -- 订单服务(内部微服务)
     └── template-order-api -- 被依赖开放api
└── template-tool -- 工具服务(内部微服务)
     └── template-tool-api -- 被依赖开放api
     └── template-tool-api -- 被依赖开放api
     └── controller
          └── FileController -- 文件存储使用demo（支持阿里OSS、腾讯云COS、MinIO、本地磁盘等多种方式）
     └── popup -- 弹窗设计demo（分享：https://www.toutiao.com/article/7287587310307738146）
          └── condition -- 弹窗条件实现类
          └── PopCondition -- 抽象定义弹窗条件
          └── PopService -- 弹窗查询的核心代码
          └── ReplaceParam -- 参数替换接口
     └── sms -- 短信设计demo（分享：https://www.toutiao.com/article/7248173282141291047）
          └── AsyncSmsSender -- 短信发送器（异步）
          └── MysqlSendPostProcessor -- 短信发送记录
          └── SmsSenderConsumer -- 短信发送处理器（消费者逻辑）
     └── subscribe -- 微信订阅消息设计demo
          └── AsyncSubscribeSender -- 订阅消息发送器（异步）
          └── SubscribeSenderConsumer -- 订阅消息发送处理器（消费者逻辑）
└── template-user -- 用户服务(内部微服务)
     └── canal-- canal使用demo
     └── coupon -- 优惠券设计demo（分享：https://www.toutiao.com/article/7228973418354475572）
          └── UseCouponService -- 优惠券核心类
└── template-auth -- 统一认证接入层(边缘微服务)
     └── authentication -- 登录（分享：https://www.toutiao.com/article/7144259146018406948）
          └── 本机号码一键登录
          └── 用户名+密码登录
          └── 手机号+验证码登录
          └── 手机号+验证码登录并绑定授权码
          └── APP微信授权登录
          └── 微信小程序登录(新版)
          └── 微信小程序登录(旧版)
          └── 微信公众号登录
          └── 支付宝小程序登录
     └── token -- token的使用
          └── JWT
          └── sa-token的应用
     └── wx -- binarywang的应用
├── template-app -- app端接入层(边缘微服务)
├── template-web -- web端接入层(边缘微服务)
├── template-admin -- 管理后台端
├── sql -- 项目中的表结构设计
```

### 本地开发 运行

- 先启动注册中心eureka，[http://localhost:7001/](http://localhost:7001/)
- 启动需要的边缘微服务，通过pom找到其依赖的内部微服务启动（如果需要预览API内没有依赖内部微服务，也可不启动），就可以请求相关API进行效果预览了（建议使用postman等工具）


### 运用

- 建议作为参考demo，再结合你的项目选择合适代码放到你的项目中


## 开源共建

### 开源协议

springcloud-template 开源软件遵循 [Apache 2.0 协议](https://www.apache.org/licenses/LICENSE-2.0.html)。
允许商业使用，但务必保留类作者、Copyright 信息。

### 其他说明

1. 联系作者 <a href="mailto:897665787@qq.com">897665787@qq.com</a>