# AddBrick
**Repository Path**: temporal-flow/add-brick
## Basic Information
- **Project Name**: AddBrick
- **Description**: 添砖微服务开发框架模板，基于若依微服务框架修改并拓展消息实时推送模块、Websockt连接、邮箱验证码发送、RabbitMQ消息队列、Redis发布订阅
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 5
- **Forks**: 0
- **Created**: 2024-07-06
- **Last Updated**: 2025-06-10
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
AddBrick v1.0.0
基于Spring Boot/Spring Cloud & Alibaba 分布式微服务架构
## 框架简介
添砖微服务开发框架模板，基于若依微服务框架修改并拓展。拓展功能如下：
* Websockt连接
* knife4j接口文档
* 文件上传使用阿里云对象存储（AliOSS）
* 用户签到（RedisBitMap）
* 邮箱验证码发送（JavaMail）
* RabbitMQ消息队列
* Redis发布订阅、分布式锁（Redisson）
## 系统模块
~~~
com.addbrick
├── addbrick-gateway // 网关模块 [9000]
├── addbrick-auth // 认证中心 [9100]
├── addbrick-api // 接口模块
│ └── addbrick-api-system // 系统接口
├── addbrick-common // 通用模块
│ └── addbrick-common-core // 核心模块
│ └── addbrick-common-datascope // 权限范围
│ └── addbrick-common-datasource // 多数据源
│ └── addbrick-common-elasticsearch // 搜索引擎（待完善）
│ └── addbrick-common-log // 日志记录
│ └── addbrick-common-rabbitmq // 消息队列
│ └── addbrick-common-redis // 缓存服务(添加分布式锁)
│ └── addbrick-common-seata // 分布式事务
│ └── addbrick-common-security // 安全模块
│ └── addbrick-common-swagger // 系统接口（添加knife4j）
├── addbrick-modules // 业务模块
│ └── addbrick-file // 文件服务 [9201]
│ └── addbrick-system // 系统模块 [9204]
│ └── addbrick-websocket // Websocket服务 [9209]
├──pom.xml // 公共依赖
~~~
## 环境要求
* jdk >= 17
* redis >= 3.2.100
* nacos >= 2.2.0（版本太低会出现bug）
* mysql >= 8.0.33
## 使用说明
1. mysql导入源码中的sql目录下的所有sql文件（sql名即为数据库名，自行创建数据库）
2. 修改nacos配置文件(nacos-server-2.2.0\nacos\conf\application.properties)中的mysql配置（注意数据库名必须为addbrick_nacos_config、端口、用户名和密码）
db.url.0=jdbc:mysql://localhost:3306/addbrick_nacos_config?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true& useUnicode=true&useSSL=false&serverTimezone=UTC
db.user.0=root（用户名可自行修改）
db.password.0=password（密码可自行修改）
3. nacos运行：找到目录（nacos-server-2.2.0\nacos\bin），在cmd窗口下输入命令（startup.cmd -m standalone）即可
4. redis运行：找到目录（Redis-x64-3.2.100），点击redis-server.exe运行即可
5. 运行redis和nacos后，再运行所有的 AddBrickxxxApplication 项目即可
6. 可在 http://localhost：{port}/doc.html 下访问接口文档,port为各个application的端口号
7. 访问 http://localhost:8848/nacos 即可查看nacos服务注册中心，可在服务管理下的服务列表中找到已经运行成功的服务。
## 添砖技术交流群
QQ群： 