1 Star 1 Fork 1

xutao / message-center

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

message-center

项目介绍

概述

  • 独立的消息推送应用
  • 实现了邮件推送、短信推送和APP消息推送
  • 适配了极光推送、个推、阿里云短信、腾讯云短信、云片短信等第三方云服务,开箱即用
  • 采用消息中间件或HTTP接口进行对接,便于与各类业务系统集成(包括但不限于Java/PHP/Python/JavaScript/Ruby/C#等语言开发的后端系统)

技术栈

  • Spring Boot 2.1.x

编译打包

mvn package -Pdev
mvn package -Ptest
mvn package -Pprod

使用说明

支持的短信服务商

阿里云

腾讯云

云片

支持的APP消息推送服务商

极光推送

个推

配置说明

可能需要修改的参数介绍

参数名 参数用途 默认值
msg.app-msg-pool-size 用于app消息推送的线程池大小 4
msg.sms-pool-size 用于短信消息推送的线程池大小 4
msg.max-sms-per-second 每秒钟发送短信条数上限 10
msg.email-pool-size 用于电子邮件消息推送的线程池大小 4
msg.jpush-enabled 是否启用极光推送 false
msg.jpush-app-key 极光推送的appKey
msg.jpush-master-secret 极光推送的密钥
msg.getui-enabled 是否启用个推 false
msg.getui-app-id 个推的appId
msg.getui-url 个推的url
msg.getui-master-secret 个推的密钥
msg.getui-app-key 个推的appKey
msg.qcloud-sms-enabled 是否启用腾讯云短信 false
msg.qcloud-sms-app-id 腾讯云短信appId
msg.qcloud-sms-app-key 腾讯云短信appKey
msg.aliyun-sms-enabled 是否启用阿里云短信 false
msg.aliyun-sms-region 阿里云短信区域编码 cn-hangzhou
msg.aliyun-sms-access-key 阿里云短信accessKey
msg.aliyun-sms-access-secret 阿里云短信accessSecret
msg.yunpian-sms-enabled 是否启用云片短信 false
msg.yunpian-sms-api-key 云片apiKey
spring.mail.host 邮件SMTP服务器IP地址或主机名
spring.mail.port 邮件SMTP服务器端口号
spring.mail.username 邮件SMTP服务器用户名
spring.mail.password 邮件SMTP服务器密码
spring.mail.default-encoding 邮件默认编码 UTF-8
spring.kafka.bootstrap-servers Apache Kafka 主机IP地址及端口号
spring.boot.admin.client.url Spring Boot Admin 应用的URL
spring.boot.admin.client.username Spring Boot Admin应用的认证用户名
spring.boot.admin.client.password Spring Boot Admin应用的认证密码
server.port 本应用HTTP端口号 12345
server.tomcat.max-threads 本应用内嵌tomcat线程数 16
logging.path 本应用日志文件的输出路径 /tmp

注意事项

  • 修改各个线程池大小会影响并发性能,实际应根据服务器硬件配置以及网络带宽等因素进行灵活调整
  • 由于短信发送服务属于按量计费且受运营商管制,因此强烈建议设置 msg.max-sms-per-second 参数为一个合理的值,避免因调用方的失误造成短时间内发送大量短信
  • 必须且只能开启1种app消息推送服务(msg.jpush-enabled / msg.getui-enabled 其中一项配置为 true)
  • 必须且只能开启1种短信服务(msg.qcloud-sms-enabled / msg.aliyun-sms-enabled / msg.yunpian-sms-enabled 其中一项配置为 true)
  • 本应用在启动后将以客户端身份向 Spring Boot Admin 服务端注册,请自行配置相应的URL、用户名、密码等信息

消息格式说明

APP消息格式

{
  "messageId": "1234567891",
  "messageType": "app",
  "receiverList": ["asdfghjkl", "poiuytre", "zxcvbnm"],
  "title": "通知标题",
  "content": "内容",
  "extras": {
    "userId": 9527,
    "orderId":"9875455214575"
  },
  "callbackUrl": "http://192.168.2.101:8080/appMsgCallback"
}

其中:

  • messageId为全局唯一的消息标识
  • messageType固定为app
  • receiver为设备在推送平台的别名(需要app端遵照服务商的约定进行绑定)
  • extras为额外的业务参数(需与app端约定格式和参数值)
  • callbackUrl为结果回调地址

短信格式

{
  "messageId": "1234567892",
  "messageType": "sms",
  "receiver": "手机号",
  "templateId": "10001",
  "signName": "中国移不动",
  "templateParams": {
    "clientName": "张无忌",
    "value": "100"
  },
  "callbackUrl": "http://192.168.2.101:8080/smsMsgCallback"
}

其中:

  • messageId为全局唯一的消息标识
  • messageType固定为sms
  • receiver为接收者手机号码
  • templateId为短信模板编号
  • signName为短信署名(上文已介绍)
  • templateParams为额外的业务参数(一般为短信推送服务商平台上定义的短信内容变量)
  • callbackUrl为结果回调地址

邮件格式

{
  "messageId":"1234567893",
  "messageType":"email",
  "receiver":"john@example.com",
  "subject":"这里是邮件标题",
  "htmlContent":true,
  "content":"这里是邮件正文",
  "attachmentList": ["/app/files/资料1.pdf", "/app/files/资料2.doc"],
  "callbackUrl": "http://192.168.2.101:8080/emailMsgCallback"
}

其中:

  • messageId为全局唯一的消息标识
  • messageType固定为email
  • receiver为接收者邮箱地址
  • subject: 邮件标题
  • htmlContent: 邮件正文是否为HTML格式
  • content: 邮件正文
  • attachmentList: 邮件附件的完整路径,允许有多个
  • callbackUrl为结果回调地址

APP消息推送集成(两种方式)

短信推送集成

注意事项

  • 短信配置中的参数 signName 为短信署名,必须先在服务商后台提交审核通过后再填入
  • 短信模板需要在服务商后台提交审核通过后,才能获得模板编号
  • 其它参数可通过服务商的后台查询得到
  • 其它事项,需要查询服务商的接入文档

对接(两种方式)

邮件推送集成(两种方式)

结果回调

说明

三种类型的消息(短信/app/邮件)在推送完毕后都支持回调。消息的生产者可以根据回调数据来做后续的业务处理。 message-center 将使用 HTTP POST 方式将结果数据推送到相对应的 callbackUrl。

回调参数格式

{
  "messageId": "1234567890",
  "success": false,
  "errorMsg": "网络连接超时"
}
  • messageId 为唯一的消息标识,字符串
  • success 为推送成功标识,布尔型
  • errorMsg 推送失败时会返回具体原因

如果不需要回调,直接把 callbackUrl 留空即可

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

服务端消息推送中心 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/flykiter/message-center.git
git@gitee.com:flykiter/message-center.git
flykiter
message-center
message-center
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891