# mh-tools-message-adapter

**Repository Path**: person_my2/mh-tools-message-adapter

## Basic Information

- **Project Name**: mh-tools-message-adapter
- **Description**: 项目使用mybatis-plus、sringboot、mysql搭建消息发送平台（此消息非彼消息）。通过此项目可以发送钉钉群机器人、企业微信、手机短信、邮件通知等多功能消息，内置拦截重复发送消息、过滤关键字等个性化功能
- **Primary Language**: Java
- **License**: MulanPSL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2021-05-07
- **Last Updated**: 2021-06-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Pigeon(信鸽消息传递系统)

## 1. 系统背景

在系统试运行环境中，代码中抛出NPE等异常，此时代码开发者是无感知

为了避免此类情况，使用ELK采集错误日志，然后使用 `Pigeon`进行消息传递

预计支持`钉钉机器人、微信付服务号、企业微信、邮件通知、手机短信`等消息通知，目前仅支持`钉钉机器人`发送通知

## 2. 模块划分

| 包名   | 说明                         | 负责人 |
| ------ | ---------------------------- | ------ |
| common | 公共组件                     | 马称   |
| mail | 邮箱邮件发送 |    |
| ding   | 钉钉机器人消息发送           | 马称   |
| wechat | 微信服务号、企业微信消息发送 |    |
| mobile | 手机短信消息发送 |    |

## 2.1 接口文档

### 2.1.1 基本信息

**Path：** /message/send

**Method：** POST

**接口描述：发送通知消息**

**Body**

<table>
  <thead class="ant-table-thead">
    <tr>
      <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
    </tr>
  </thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> atMobiles</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">@联系人列表 支持多个以,分割</span></td><td key=5></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> content</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">内容</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> sendType</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">发送类型（dingtalk or email or dingtalk,email）</span></td><td key=5></td></tr><tr key=0-3><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> title</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">标题</span></td><td key=5></td></tr><tr key=0-4><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> token</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">密钥 支持多个以,分割</span></td><td key=5></td></tr>
               </tbody>
              </table>

#### 2.1.1.1 示例数据
```json
{
    "sendType": "dingtalk",
    "token": "56417ebba6a27ca352f0de77a2ae9da66d01f39610b5ee8a6033c60ef9071c55",
    "title": "监控报警",
    "atMobiles": "15601166691",
    "content": "#### <font color=#B8860B>【报警】</font><font color=#A0522D>代码发送过程VPN中断</font> \n\n 发送人员：百万 \n\n 详细地址：[详情请点击](https://www.baidu.com) \n\n 发送时间：2020-04-26 15:58:59 \n\n 错误信息：提交代码连接VPN被中断，详细错误信息麻烦登录服务器查看 \n\n 修复人员：@15601166691"
}
```

#### 2.1.1.2 效果如下

![消息发送效果图](https://images-machen.oss-cn-beijing.aliyuncs.com/20200514113801.png)

### 2.1.2 返回数据

<table>
  <thead class="ant-table-thead">
    <tr>
      <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
    </tr>
  </thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> detail</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> fail</span></td><td key=1><span>boolean</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-3><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> message</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-4><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> success</span></td><td key=1><span>boolean</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
               </tbody>
              </table>