Go to file
baladiwei 9cd9330456 Merge pull request 'kafka线程数修改' (#104) from wanjia9506/gitlink-notification-system:dev_gitlink_model into master 2021-09-29 09:42:20 +08:00
common 代码优化:valid异常处理日志等级调整 2021-09-22 09:37:11 +08:00
db docker scripts alter 2021-09-17 15:04:57 +08:00
executor kafka线程数修改 2021-09-29 09:38:58 +08:00
middleware 处理 -v 映射的问题 2021-09-17 15:14:58 +08:00
model 代码优化 2021-09-18 15:30:45 +08:00
reader Merge branch 'master' of https://git.trustie.net/Gitlink/gitlink-notification-system into dev_gitlink_model 2021-09-18 15:31:01 +08:00
writer 代码优化 2021-09-22 09:17:52 +08:00
.dockerignore 将GNS服务容器化 2021-09-15 10:03:33 +08:00
.gitignore 处理忽略文件 2021-09-17 11:19:27 +08:00
LICENSE Initial commit 2021-09-02 11:22:24 +08:00
README.md readme alter 2021-09-16 16:24:30 +08:00
pom.xml 新增发送Email的逻辑 2021-09-16 11:18:15 +08:00

README.md

主要组成部分:

  1. 管理后台(在建) :提供对分布式的任务集中监控、管理等功能
  2. 各类执行器 :消息中心的业务逻辑实现,目前只实现「系统通知」和「邮件通知」功能,后续可以考虑短信通知、微信通知等实现
  3. GNS-Writer:给 业务层 调用的 API 网关,负责从业务逻辑层接受信息
  4. middleware:独立运行的中间件服务, 包括消息中间件、缓存中间件、DB
  5. GNS-Reader:给 业务层 调用的 API 网关,负责提供业务数据

一些约定:

  1. 默认分支为 master 分支,每更新一次线上负责,则会建立对应的 release 分支
  2. 绝不接受直接 push 代码的任何行为
  3. 请务必在代码中必要的地方加入适当的注释
  4. 请务必注意开源协议,并在代码文件中标出所遵从的协议详细信息以及作者

协作方式

  1. 首先 fork 本仓库到自己名下
  2. git checkout {remote}/master -b {local_branch_name} 新建本地分支
  3. 在本地分支修改任务并推送到自己名下的仓库
  4. 仓库首页 触发 pull request 并等待审核处理

使用 Docker 运行

  1. git pull 拉取本仓库并保存到本地
  2. 下载并安装 Docker Engine
  3. 配置好 Java 环境以及 Maven 环境 (Java 8 版本以上、Maven 3 版本以上)
  4. 复制配置文件,在仓库跟目录执行:
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  
  1. 修改 {repo}/middleware/.env 文件里 SQL_SCRIPT_PATHDOCKER_DATA_PATH 绝对路径到本地磁盘
  2. 进入到仓库根目录下的 {repo}/middleware 目录并执行 start_docker_compose.sh 脚本
  3. 浏览器访问
    1. 数据推送相关接口:http://localhost:58082/doc.html
    2. 数据读取相关接口:http://localhost:58080/doc.html
  4. 停止 Docker 时环境时请执行 {repo}/middleware/end_docker_compose.sh 脚本