BuguMQ(消息队列推送).doc

BuguMQ的设计说明 1 服务器 1 客户端 1 消息协议 1 消息队列：Queue 1 消息广播：Topic 1 文件传输 2 BuguMQ的使用示例 2 建立连接 2 获取Client 3 产生Queue消息 3 获取队列中消息数量 3 删除队列中的消息 3 消费Queue消息 4 停止消费 4 发布Topic消息 4 清除Topic上的保留消息 4 订阅Topic消息 5 退订 5 获取订阅者数量 6 在线状态 6 BuguMQ的文件传输 6 方法说明 7 示例代码 8 BuguMQ的设计说明 服务器 BuguMQ使用Redis作为MQ服务器。 客户端 BuguMQ提供jar包作为java语言客户端。 消息协议 BuguMQ使用Redis协议传输文本消息。在应用层，用户需要根据项目需求，制定自己的协议规范。 消息队列：Queue Queue消息模型，采用生产者/消费者（Producer/Consumer）模式实现。 同一个Queue，可以有多个消费者。Queue中的消息，如果被其中一个消费者消费掉了，那么其它的消费者不会接收到该消息。 尽管一个Queue可以有多个消费者，但它更常用于一对一消息通信。 Queue中的消息，是有顺序的，即FIFO（先进先出）。 Queue中的消息，默认是FIFO的。但可以发布一条紧急消息，它会被插入到队列的头部，被消费者立刻接收到。 Queue中的消息，可以持久保存。即使消费者不在线，等到它下次上线的时候，仍能接收到该消息。 Queue中的消息，默认是持久保存的，直到它被消费掉。但可以设置消息的有效期，如果在有效期内还没被消费，则会自动从队列中移除。 消息广播：Topic Topic消息模型，采用发布/订阅（Publish/Subscribe）模式实现。 同一个Topic，可以有多个订阅者。当有消息发布到该Topic时，所有的订阅者都能接收到该消息。 发布到Topic的消息，不会持久保存。只有在线的订阅者，才能接收到该消息。如果订阅者不在线，等到它下次上线的时候，仍然不会接收到该消息。 发布到Topic的消息，默认不会持久保存。但可以发布一条保留消息（retained message），一旦有客户端订阅该Topic，立刻会收到该保留消息。一个Topic只能保存最新的一条保留消息。 支持按模式（Pattern）订阅Topic，支持*和?等通配符。 文件传输 BuguMQ支持在客户端之间进行一对一的文件传输。 传输文件的时候，需要对方确认，对方同意后才能进行传输。 BuguMQ按块进行文件传输，块的大小由开发者决定。推荐值是32K字节。 BuguMQ的使用示例 建立连接 Connection conn = Connection.getInstance(); conn.setHost(192.168.0.200); conn.setPassword(foobared); conn.setClientId(my_client_id); conn.connect(); 其中，clientId是能够唯一标识该客户端的字符串。 一个应用中，应该只有一个Connection，在应用开始的时候连接一次。在应用退出的时候，记得断开该连接： conn.disconnect(); Connection内部使用了连接池，默认最多是8个连接，你可以自己定义这个数值，如下： JedisPoolConfig config = new JedisPoolConfig(); config.setMaxActive(10); //最多10个连接 conn.setPoolConfig(config); conn.connect(); 关于JedisPoolConfig的更多参数设置，请查看其源代码。 获取Client Client client = conn.getClient(); 产生Queue消息 client.produce(q1, hello); client.produce(q2, world); //产生紧急消息 client.produceUrgency(q1, hurry up!); //产生有效期为1分钟的消息 client.produce(q1, 60, my message); //产生2020年6月26日到期的消息 Date expireAt = parseDate(2020-06-26); client.produce(q1, expireAt,