baladiwei 9cd9330456 | ||
---|---|---|
common | ||
db | ||
executor | ||
middleware | ||
model | ||
reader | ||
writer | ||
.dockerignore | ||
.gitignore | ||
LICENSE | ||
README.md | ||
pom.xml |
README.md
主要组成部分:
- 管理后台(在建) :提供对分布式的任务集中监控、管理等功能
- 各类执行器 :消息中心的业务逻辑实现,目前只实现「系统通知」和「邮件通知」功能,后续可以考虑短信通知、微信通知等实现
- GNS-Writer:给
业务层
调用的 API 网关,负责从业务逻辑层接受信息 - middleware:独立运行的中间件服务, 包括消息中间件、缓存中间件、DB
- GNS-Reader:给
业务层
调用的 API 网关,负责提供业务数据
一些约定:
- 默认分支为
master
分支,每更新一次线上负责,则会建立对应的release
分支 - 绝不接受直接 push 代码的任何行为
- 请务必在代码中必要的地方加入适当的注释
- 请务必注意开源协议,并在代码文件中标出所遵从的协议详细信息以及作者
协作方式
- 首先
fork
本仓库到自己名下 git checkout {remote}/master -b {local_branch_name}
新建本地分支- 在本地分支修改任务并推送到自己名下的仓库
- 在 仓库首页 触发 pull request 并等待审核处理
使用 Docker 运行
- git pull 拉取本仓库并保存到本地
- 下载并安装 Docker Engine
- 配置好 Java 环境以及 Maven 环境 (Java 8 版本以上、Maven 3 版本以上)
- 复制配置文件,在仓库跟目录执行:
cp middleware/.env.example middleware/.env
cp reader/src/main/resources/application.yml.example reader/src/main/resources/application.yml
cp writer/src/main/resources/application.yml.example writer/src/main/resources/application.yml
cp executor/src/main/resources/application.yml.example executor/src/main/resources/application.yml
- 修改
{repo}/middleware/.env
文件里SQL_SCRIPT_PATH
和DOCKER_DATA_PATH
绝对路径到本地磁盘 - 进入到仓库根目录下的
{repo}/middleware
目录并执行start_docker_compose.sh
脚本 - 浏览器访问
- 数据推送相关接口:http://localhost:58082/doc.html
- 数据读取相关接口:http://localhost:58080/doc.html
- 停止 Docker 时环境时请执行
{repo}/middleware/end_docker_compose.sh
脚本