# rpush **Repository Path**: gitLDR_admin/rpush ## Basic Information - **Project Name**: rpush - **Description**: 多平台统一消息推送系统。 一个接口触达多平台（包括微信公众号、企业微信、钉钉、邮箱等任何想的到平台，都能一个接口一次推送；极简的代码调用，极大减少业务方消息推送的代码量）； 同时提供基于netty和websocket的即时通讯实现，实现单聊、群聊等功能。开箱即用，采用SpringCloud微服务架构，扩展简单且没有单点问题。致力于包揽所有和消息推送有关的技术开发工作，节省开发资源。 - **Primary Language**: Java - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: http://159.75.121.163 - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 155 - **Created**: 2021-08-06 - **Last Updated**: 2021-08-06 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # rpush：多平台统一消息推送系统 * 一个接口触达多平台，支持一个接口多平台同时发送 * 消息平台逻辑与业务逻辑的解耦，业务方不需要关心各个平台的对接实现，只需要关心：要用哪些平台发、要发给对应平台的哪些人、要发什么内容 * 极强的扩展性，要新增一个消息平台的支持，理论只需要新增几个类就能完成，且不需要写任何前端代码即可获得该平台对应的ui交互（包括：配置交互、接收人维护、web手动消息发送交互等）。 * 当然支持web端手动发送消息 * 当然也支持定时任务 * 消息方案预设置 * 提供即时通讯实现，且支持服务器横向扩展 * 接收人导入 * 接收人按分组划分 * 消息日志 * ... ## 在线体验 http://159.75.121.163/ admin admin ## 目前支持的消息类型 * 邮箱 * 企业微信-应用消息 * 文本消息 * 图片消息 * 视频消息 * 文本消息 * 文本卡片消息 * 图文消息 * Markdown消息 * 企业微信-群机器人 * 文本消息 * 图片消息 * 图文消息 * Markdown消息 * 微信公众号 * 文本消息 * 图文消息 * 模板消息 * 钉钉-工作通知 * 文本 * Markdown * 链接消息 * 卡片消息 * OA消息 > Rpush的架构决定了扩展一个消息平台的消息类型会非常简单，所以如果要扩展一个消息平台，大部分时间都会花在查找该平台的对接文档上。后续会在工作之余加上其它的平台或消息类型。当然，欢迎参与扩展（扩展一个消息平台的消息类型，只需要几个java类即可，不需要写任何前端代码，即可获得包括ui交互内的所有功能）。 ## 效果展示 #### 单个消息类型发送示例 单个消息类型发送示例 #### web端多平台发送示例 web端多平台发送示例 #### postman多平台发送示例 postman多平台发送示例 #### 用代码发消息 秉持”业务服务只负责发消息“的解耦原则，业务服务在需要发消息的时候，代码应该越简单越好。所以，Rpush的发消息的sdk，一种消息只需要一行代码，有几种消息就有几行代码。比如这样： ```java /** * @author shuangmulin * @since 2021/6/8/008 11:37 **/ public class RpushSenderTest { /** * 要发送的内容 */ public static final String content = "您的会议室已经预定 \n" + ">**事项详情** \n" + ">事　项：开会\n" + ">组织者：@miglioguan \n" + ">参与者：@miglioguan、@kunliu、@jamdeezhou、@kanexiong、@kisonwang \n" + "> \n" + ">会议室：广州TIT 1楼 301\n" + ">日　期：2021年5月18日\n" + ">时　间：上午9:00-11:00\n" + "> \n" + ">请准时参加会议。 \n" + "> \n" + ">如需修改会议信息，请点击：[修改会议信息](https://work.weixin.qq.com)"; public static void main(String[] args) { // 企业微信-markdown消息 MarkdownMessageDTO markdown = RpushMessage.WECHAT_WORK_AGENT_MARKDOWN().content(content).receiverIds(Collections.singletonList("ZhongBaoLin")).build(); // 企业微信-群机器人消息 TextMessageDTO text = RpushMessage.WECHAT_WORK_ROBOT_TEXT().content(content).receiverIds(Collections.singletonList("ZhongBaoLin")).build(); // 邮箱 EmailMessageDTO email = RpushMessage.EMAIL().title("会议通知").content(content).build(); RpushService.instance("baolin", "666666").sendMessage(markdown, text, email); // 填上账号密码，运行即可 } } ``` 以上代码，一次发送了三种不同平台的不同消息类型，全部代码加起来也只需要四五行代码而已。要获得以上效果，只需要maven引用rpush的sdk模块即可： ```xml jitpack.io https://jitpack.io com.github.shuangmulin.rpush rpush-sdk v1.0.2 ``` #### 即时通讯 Rpush对即时通讯的实现方式比较`包容` ，即对具体的连接实现做了解耦，不局限于某一种连接方式，可以netty，可以websocket，可以comet，当然也可以用原始的bio来做。这里展示websocke的网页端和netty实现的命令行客户端之间互相单聊和群聊的效果（该示例的相关代码：[客户端示例代码地址](https://github.com/shuangmulin/rpush-client-sample)）： 单个消息类型发送示例 ### 一些比较核心的扩展点 #### 1. 可自由扩展的消息平台和消息类型 在Rpush的设计里，消息被归类为“消息平台”和“消息类型”，分别对应如下两个枚举： ```java /** * 消息平台枚举 **/ public enum MessagePlatformEnum { EMAIL(EmailConfig.class, "邮箱", "", "^[_a-z0-9-]+(\\.[_a-z0-9-]+)*@[a-z0-9-]+(\\.[a-z0-9-]+)*(\\.[a-z]{2,})$", true), WECHAT_WORK_AGENT(WechatWorkAgentConfig.class, "企业微信-应用消息", "", "", true), WECHAT_WORK_ROBOT(WechatWorkRobotConfig.class, "企业微信-群机器人", "", "", true), WECHAT_OFFICIAL_ACCOUNT(WechatOfficialAccountConfig.class, "微信公众号", "", "", true), DING_TALK_CORP(DingTalkCorpConfig.class, "钉钉-工作通知", "", "", true), RPUSH_SERVER(EmptyConfig.class, "rpush服务", "", "", true); } /** * 消息类型枚举 **/ public enum MessageType { EMAIL("普通邮件 ", MessagePlatformEnum.EMAIL), RPUSH_SERVER("文本", MessagePlatformEnum.RPUSH_SERVER), // ================================企业微信-应用==================================== WECHAT_WORK_AGENT_TEXT("文本", MessagePlatformEnum.WECHAT_WORK_AGENT), WECHAT_WORK_AGENT_IMAGE("图片", MessagePlatformEnum.WECHAT_WORK_AGENT), WECHAT_WORK_AGENT_VIDEO("视频", MessagePlatformEnum.WECHAT_WORK_AGENT), WECHAT_WORK_AGENT_FILE("文件", MessagePlatformEnum.WECHAT_WORK_AGENT), WECHAT_WORK_AGENT_TEXTCARD("文本卡片", MessagePlatformEnum.WECHAT_WORK_AGENT), WECHAT_WORK_AGENT_NEWS("图文消息", MessagePlatformEnum.WECHAT_WORK_AGENT), WECHAT_WORK_AGENT_MARKDOWN("Markdown", MessagePlatformEnum.WECHAT_WORK_AGENT), // ================================企业微信-群机器人==================================== WECHAT_WORK_ROBOT_TEXT("文本", MessagePlatformEnum.WECHAT_WORK_ROBOT), WECHAT_WORK_ROBOT_IMAGE("图片", MessagePlatformEnum.WECHAT_WORK_ROBOT), WECHAT_WORK_ROBOT_NEWS("图文消息", MessagePlatformEnum.WECHAT_WORK_ROBOT), WECHAT_WORK_ROBOT_MARKDOWN("Markdown", MessagePlatformEnum.WECHAT_WORK_ROBOT), // ================================微信公众号==================================== WECHAT_OFFICIAL_ACCOUNT_TEXT("文本", MessagePlatformEnum.WECHAT_OFFICIAL_ACCOUNT), WECHAT_OFFICIAL_ACCOUNT_NEWS("图文消息", MessagePlatformEnum.WECHAT_OFFICIAL_ACCOUNT), WECHAT_OFFICIAL_ACCOUNT_TEMPLATE("模板消息", MessagePlatformEnum.WECHAT_OFFICIAL_ACCOUNT), // ================================钉钉-工作通知==================================== DING_TALK_COPR_TEXT("文本", MessagePlatformEnum.DING_TALK_CORP), DING_TALK_COPR_MARKDOWN("Markdown", MessagePlatformEnum.DING_TALK_CORP), DING_TALK_COPR_LINK("链接消息", MessagePlatformEnum.DING_TALK_CORP), DING_TALK_COPR_ACTION_CARD_SINGLE("卡片-单按钮", MessagePlatformEnum.DING_TALK_CORP), DING_TALK_COPR_ACTION_CARD_MULTI("卡片-多按钮", MessagePlatformEnum.DING_TALK_CORP), DING_TALK_COPR_OA("OA消息", MessagePlatformEnum.DING_TALK_CORP), ; } ``` 这里拿“企业微信-应用的文本类型”的消息举例。假设现在要在Rpush实现这个类型的消息，步骤如下： 1. 定义企业微信的配置类，如下： ```java /** * 企业微信配置 **/ @EqualsAndHashCode(callSuper = true) @Data @NoArgsConstructor @AllArgsConstructor @Builder public class WechatWorkAgentConfig extends Config { private static final long serialVersionUID = -9206902816158196669L; @ConfigValue(value = "企业ID", description = "在此页面查看：https://work.weixin.qq.com/wework_admin/frame#profile") private String corpId; @ConfigValue(value = "应用Secret") private String secret; @ConfigValue(value = "应用agentId") private Integer agentId; } ``` 里面的字段就按对应平台需要的字段去定义就行，比如这里的企业微信就只有三个字段需要配置。而每个字段上的`@ConfigValue` 注解，是用来自动生成页面的，也就是说，只需要打上这个注解，就可以自动在页面上生成对应的增删改查的界面和交互（无需写一行前端代码）。 2. 在`MessagePlatformEnum`和`MessageType` 里加上对应的枚举，即`WECHAT_WORK_AGENT(WechatWorkAgentConfig.class, "企业微信-应用消息", "", "", true)` 和`WECHAT_WORK_AGENT_TEXT("文本", MessagePlatformEnum.WECHAT_WORK_AGENT),`。这里要注意下平台枚举的第一个参数就是第一步定义的配置类的Class。 3. 定义企业微信-应用-文本消息的参数，如下： ```java /** * 企业微信消息发送DTO **/ @EqualsAndHashCode(callSuper = true) @Data @SuperBuilder @NoArgsConstructor @AllArgsConstructor public class TextMessageDTO extends BaseMessage { private static final long serialVersionUID = -3289428483627765265L; /** * 接收人分组列表 */ @SchemeValue(type = SchemeValueType.RECEIVER_GROUP) private List receiverGroupIds; /** * 接收人列表 */ @SchemeValue(type = SchemeValueType.RECEIVER) private List receiverIds; @SchemeValue(description = "PartyID列表，非必填，多个接受者用‘|’分隔。当touser为@all时忽略本参数") private String toParty; @SchemeValue(description = "TagID列表，非必填，多个接受者用‘|’分隔。当touser为@all时忽略本参数") private String toTag; @SchemeValue(type = SchemeValueType.TEXTAREA, description = "请输入内容...") private String content; } ``` 同样的，里面的字段根据该消息类型需要的字段去定义就行。比如企业微信-应用-文本消息就只需要一个`content`内容字段以及接收人相关的字段。这里涉及到的`@SchemeValue` 注解，同样也是用来自动生成页面交互的，即只需要打上这个注解，就能自动在发消息页面生成对应的ui和交互。同时可以使用`com.regent.rpush.route.utils.sdk.SdkGenerator`类自动生成sdk代码。 4. 实现`com.regent.rpush.route.handler.MessageHandler`接口，正式写发消息的代码。 ```java /** * 企业微信文本消息handler **/ @Component public class AgentTextMessageHandler extends MessageHandler { @Override public MessageType messageType() { return MessageType.WECHAT_WORK_AGENT_TEXT; } @Override public void handle(TextMessageDTO param) { // 具体的发消息代码 } } ``` 这里有以下需要关心的点： * 接口上的泛型填第3步定义的类 * 实现`messageType`方法，返回当前类要处理的消息类型 * 实现`handle`方法，写发消息的代码，里面的参数是自动解析到这个方法的，直接使用即可 到这里，就不需要多做任何其它的事了。也就是说，做完以上四个步骤，就已经完成了一个消息类型的扩展。事做的少，获得的功能并不少： 1. 自动获得对应平台配置的增删改交互和ui ![配置](https://image3.myjuniu.com/1d02b5b0c103403d8025852a3158161f_pro_e5aacc90607acce8b0aefe318247cdd2_%E9%85%8D%E7%BD%AE.png "配置") 2. 自动获得对应平台接收人和接收人分组的增删改交互和ui（包括导入功能） ![接收人](https://image3.myjuniu.com/1d02b5b0c103403d8025852a3158161f_pro_fe398a352c6de7b0ea0a5ff4ffd79b76_接收人.png "接收人") ![接收人导入](https://image3.myjuniu.com/1d02b5b0c103403d8025852a3158161f_pro_6ab0b6d7c27110b43f4facf383d75a35_%E6%8E%A5%E6%94%B6%E4%BA%BA%E5%AF%BC%E5%85%A5.png "接收人导入") 3. 自动获得该消息类型手动发送消息的交互和ui ![发消息](https://image3.myjuniu.com/1d02b5b0c103403d8025852a3158161f_pro_74daddb25c6016840b8a968fbaa55e98_发消息.png "发消息") 4. 执行`com.regent.rpush.route.utils.sdk.SdkGenerator`，自动完成该消息类型的sdk代码 5. 自动获得该消息类型的定时任务的增删改交互和ui ![定时任务](https://image3.myjuniu.com/1d02b5b0c103403d8025852a3158161f_pro_d4c4cd123a5aba52c9baaed3de85bf4c_定时任务.png "定时任务") 而且增加一个消息类型，不会对业务服务之前正在使用的消息类型有任何影响，是纯粹的叠加”能力“。 #### 2. 可自由扩展的即时通讯实现 在rpush的架构里，投递一个消息的流程大致可以概括为：调用统一的接口向路由服务投递消息-》路由服务查出消息目标所在的服务器地址-》路由服务向对应的服务器传递消息-》对应的服务找到对应的会话发送消息。 这里的扩展点在最后一步，即用户和服务器的会话维护。要实现服务端向客户端推送消息，会有比较多的解决方案，比如用netty起一个nio服务器，客户端去连netty服务器或者服务端用socketio提供websocket实现，客户端按websocket的方式连服务器或者用comet实现长连接让客户端连等等。 > 这里做成扩展点的一个比较重要的考虑点就是要实现不同端之间的消息通信，比如上面例子里的命令行和网页之间的聊天，或者实现移动端和网页之间的聊天。 ##### RpushClient 不管是什么技术实现的服务端推送，都会有一个“客户端”性质的类，比如netty会有`Channel`，socketio提供的websocket会有`SocketIOClient` 。而对于rpush来说，只关心它们的一个共有的能力：消息投递。即`RpushClient`接口： ```java /** * 客户端 **/ public interface RpushClient { /** * 推送消息 */ void pushMessage(NormalMessageDTO message); void close(); } ``` 只要实现了这个接口的类，不管是什么技术的实现，都被认为是rpush的客户端。也就是说，netty也好，websocket也好，只要提供给rpush这个接口的能力即可，从而达到解耦具体实现的目的。 目前rpush已经做了netty和socketio两个实现，分别对应`com.regent.rpush.server.socket.nio.NioSocketChannelClient` 和`com.regent.rpush.server.socket.websocket.WebSocketClient`两个类。 ##### netty客户端sdk rpush提供了netty对应的客户端的sdk，项目依赖`rpush-client`即可，使用也非常简单，只需要几行代码即可。 ```java public class Main { public static void main(String[] args) { RpushClient rpushClient = new RpushClient(servicePath, registrationId); // 填上rpush服务地址和id rpushClient.addMsgProcessor(new PingIgnoreMsgProcessor()); // 忽略心跳消息 rpushClient.start(); // 向服务端发起连接 rpushClient.addMsgProcessor(msg -> { // 处理接收到的消息 return false; }); } } ``` ### 关于架构 // TODO... ## 用docker-compose快速部署一个Rpush服务 ```yml version: '2' services: nginx: image: nginx container_name: nginx ports: - 80:80 volumes: - /data/nginx/conf/nginx.conf:/etc/nginx/nginx.conf - /data/nginx/log:/var/log/nginx - /data/nginx/html:/usr/share/nginx/html rpush-eureka: image: shuangmulin/rpush-eureka container_name: rpush-eureka ports: - 8761:8761 rpush-zuul: image: shuangmulin/rpush-zuul environment: - eureka-service-ip=172.16.0.11 - eureka-service-port=8761 container_name: rpush-zuul ports: - 8124:8124 rpush-route: image: shuangmulin/rpush-route environment: - eureka-service-ip=localhost - eureka-service-port=8761 - jdbc.url=jdbc:mysql://localhost:3306/rpush?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8 - jdbc.username=root - jdbc.password=123456 - super-admin.username=superadmin - super-admin.password=superadmin - jwtSigningKey=fjksadjfklds container_name: rpush-route ports: - 8121:8121 rpush-server: image: shuangmulin/rpush-server environment: - eureka-service-ip=localhost - eureka-service-port=8761 container_name: rpush-server ports: - 8122:8122 rpush-scheduler: image: shuangmulin/rpush-scheduler environment: - eureka-service-ip=localhost - eureka-service-port=8761 - jdbc.url=jdbc:mysql://localhost:3306/rpush?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8 - jdbc.username=root - jdbc.password=123456 - super-admin.username=superadmin - super-admin.password=superadmin - jwtSigningKey=fasdferear container_name: rpush-scheduler ports: - 8123:8123 ``` > 运行 docker-compose up -d之后，直接访问8124端口即可