xdhuxc-message

用于发送邮件和钉钉消息。

功能

1、支持定时发送消息

2、支持重试和重发：已经支持

3、metrics 接口：已经支持

4、全字段文本查找：已经支持，但是有点问题

5、钉钉消息发送到个人工作通知和群组：目前可以发送到个人消息通知

6、重新设计错误码格式：已经完成，参考 kubernetes 错误状态码进行修改

7、增加操作审计：已经支持，审计部分待完善，增加操作的内容，对于删除和增加操作，记录内容；对于更新操作，增加操作前后的内容。操作审计应该做到网关处。

8、支持邮件发送至多人及抄送：已经支持

9、认证也应该放到网关处。

错误码设计

// 消息
MessageHasBeenSent string = "200-0220001"
// 参数错误
ReadEntityError string = "400-0140001"
// 权限错误
AuthorityFailed   string = "401-0140003"
InvalidParameters string = "400-0140004"
// 参数缺失
MissingMessageIDError     string = "400-0240001"
MissingPageParameterError string = "400-0240002"
// 消息错误
MessageDataError         string = "400-0240003"
HealthCheckError         string = "400-0240004"
CreateMessageError       string = "400-0240005"
SendMessageError         string = "400-0240006"
UpdateMessageStatusError string = "400-0240007"
NoSuchMessageError       string = "400-0240008"
ListMessagesError        string = "400-0240009"

示例如下：

200-02-2-0001

含义如下：

• 200：HTTP 状态码，也是最终的响应的状态码，和 HTTP 状态码的含义保持一致
• 02：资源类型：为每一种资源或错误类别使用两位数字来表示
• 2：HTTP 状态码第一位的数值，主要是为了在每种 HTTP 状态码下，返回的错误码均不同，可以单独作为主键
• 0001：当前错误的错误码，以此递增即可

接口说明

1）请求方法：POST

2）请求地址：http://127.0.0.1:8080/api/v1/message

3）请求头：

请求头	值
Content-Type	application/json
Accept	application/json

4）请求体

请求体数据格式为 JSON，字段包括：

字段	类型	是否必需	含义
sender	字符串	是	消息发送者
messageType	字符串	是	消息类型，目前支持：email，dingtalk
content	字符串	是	消息内容
receivers	字符串数组	是	对于钉钉，是消息接收者在钉钉系统中的 user_id 列表；对于邮件，是邮件接收者的邮箱数组
cc	字符串数组	否	邮件的抄送者邮箱数组
emailType	字符串	否，对于邮件消息，必填	邮件类型，可选项为：text/plain 或 text/html
subject	字符串	否，对于邮件消息，必填	邮件的主题
description	字符串	否	描述信息

5）响应

响应状态码	含义
200	处理程序接收到了请求，并成功处理
非 200	出现了错误，处理程序没有接收到请求或其他情况

示例

对于钉钉消息

请求体为：

{
    "sender": "xdhuxc",
    "messageType": "dingtalk",
    "content": "xdhuxc-dingtalk-1",
    "receivers": ["8", "88"],
    "description": "it is only a test"
}

响应体为：

{
    "result": {
        "id": 1,
        "sender": "xdhuxc",
        "messageType": "dingtalk",
        "isSent": true,
        "content": "xdhuxc-dingtalk-1",
        "description": "it is only a test",
        "createTime": "2019-11-25T16:13:12.596565+08:00",
        "updateTime": "2019-11-25T16:13:12.596565+08:00",
        "receivers": [
            "8", "88"
        ]
    },
    "code": 0
}

对于邮件消息

请求体为：

{
    "sender": "xdhuxc"
    "messageType": "email",
    "content": "xdhuxc-email-test-1",
    "receivers": ["xdhuxc@163.com", "xdhuxc@qq.com"],
    "cc": ["xdhuxc@163.com", "xdhuxc@qq.com"],
    "emailType": "text/plain",
    "subject": "xdhuxc test",
    "description": "it is only a test"
}

响应体为：

{
    "result": {
        "id": 1,
        "sender": "xdhuxc"
        "messageType": "email",
        "isSent": true,
        "content": "xdhuxc-email-test-1",
        "description": "it is only a test",
        "createTime": "2019-11-25T17:19:00.898447+08:00",
        "updateTime": "2019-11-25T17:19:00.898448+08:00",
        "receivers": [
            "xdhuxc@163.com",
            "xdhuxc@qq.com"
        ],
        "cc": [
            "xdhuxc@163.com",
            "xdhuxc@qq.com"
        ],
        "emailType": "text/plain",
        "subject": "xdhuxc test"
    },
    "code": 0
}

指标接口

http://localhost:8080/metrics

常见问题及解决

1、发送邮件消息时，报错如下：

{
    "code": 100007,
    "type": "",
    "result": "gomail: could not send email 1: 501 mail from address must be same as authorization user"
}

原因：邮件的实际发送人和邮件服务器的 user 不一致导致的。

解决：修改邮件的实际发送人为邮件服务器的 user。

参考资料

MySQL 全文索引

https://segmentfault.com/a/1190000020470079?utm_source=tag-newest