MQProvider (MobileIMSDK 6.5(Server端) API文档)

java.lang.Object
- net.x52im.mobileimsdk.server.bridge.MQProvider

直接已知子类:

BridgeProcessor
```
public class MQProvider
extends java.lang.Object
```
一个可重用的RabbitMQ服务提供者类，默认提供了一个生产者队列和一个消费者队列。
本类的代码经过高度提炼和内聚，不限于MobileIMSDK使用，可用于任意合适场景。
【本类中实现的功能有】：
- 1）一个消息生产者（子类可决定是否使用）；
- 2）一个消息消费者（子类可决定是否使用）；
- 3）与MQ服务器的断线重连和恢复能力；
- 4）生产者发送出错时会暂存到缓存数组（内存中），并在下次重连正常时自动重发；
- 5）遵照官方的最佳实践：复用的是同一个连接（connection）、各自两个channel（一个用于生产者、一个用于消费者）；
- 6）消费者手动ACK能力：业务层处理不成功可重新放回队列。
从以下版本开始:

3.0

作者:

Jack Jiang( http://www.52im.net/thread-2792-1-1.html )

字段概要

字段
限定符和类型	字段和说明
`protected com.rabbitmq.client.Connection`	`_connection` 一旦首次连接成功后，本连接对象将不会被重置，它会依靠自身的自动恢复功能，在断线后自动恢底层的连接，应用层不需要额外代码
`protected com.rabbitmq.client.ConnectionFactory`	`_factory` 连接工厂类，提取出来的目的是为了重用
`protected com.rabbitmq.client.Channel`	`_pubChannel` 生产者的Chnannel对象，连接断开再次恢复时，本变量被重新赋值
`protected com.rabbitmq.client.Channel`	`_workerChannel` 消息者的Chnannel对象，连接断开再次恢复时，本变量被重新赋值
`protected java.util.Observer`	`consumerObserver` 本类中消费者收到的消息通过此观察者进行回调通知
`protected java.lang.String`	`consumFromQueue` 消费者消息中转队列名：本类是此队列的消费者，将从其中读取消息
`protected java.lang.String`	`decodeCharset` 收到消息的字符解码格式
`static java.lang.String`	`DEFAULT_DECODE_CHARSET` 收到消息的字符解码格式。
`static java.lang.String`	`DEFAULT_ENCODE_CHARSET` 发出消息的字符编码格式。
`protected java.lang.String`	`encodeCharset` 发出消息的字符编码格式
`protected java.lang.String`	`mqURI` 消息队列服务器连接URI，形如：“amqp://admin:123456789@192.168.1.190”
`protected java.lang.String`	`publishToQueue` 生产者消息中转队列名：本类是此队列的生产者，会将消息发送至此
`protected java.util.concurrent.ConcurrentLinkedQueue<java.lang.String[]>`	`publishTrayAgainCache` 本地生产者用的暂存消息队列：因为当发送消息时，可能连接等原因导致此次消息没有成功发出，那么暂存至此列表中，以备下次连接恢复时，再次由本类自动完成发送，从而确保消息不丢并确保送达。
`protected boolean`	`publishTrayAgainEnable` 是否支持再次发送：true表示本地生产者发送失败时（比如连接MQ服务器不成功等情况）暂时缓存到本地内存 `publishTrayAgainCache` 中，等到与MQ中间件的连接成功时，自动再次尝试发送此缓存队列，从而保证生产者本来要发生送的消息在异常发生的情况下能再次发送直到成功。
`protected boolean`	`retryWorkerRunning` 此标识仅用于防止worker失败重试时因TimeTask的异步执行而发生重复执行的可能，仅此而已
`protected boolean`	`startRunning` 此标识仅用于防止首次连接失败重试时因TimeTask的异步执行而发生重复执行的可能，仅此而已
`protected java.lang.String`	`TAG` TAG for log
`protected java.util.Timer`	`timerForRetryWorker` 本定时的作用是当worker启动或运行过程中出错时，可以自动进行恢复，而不至于丧失功能
`protected java.util.Timer`	`timerForStartAgain` 【说明】：RabittMQ的Java客户端的automaticRecovery只在连接成功后才会启动，像这种首次连接时服务器根本就没开或者本地网络故障等，首次无法成功建立Connection的，connction返回直接是null，当然就不存在automaticRecovery能力了，所以需要自已来尝试重新start，一定要注意思路哦，别理解乱了。

构造器概要

构造器
构造器和说明
`MQProvider(java.lang.String mqURI, java.lang.String publishToQueue, java.lang.String consumFromQueue, java.lang.String TAG, boolean publishTrayAgainEnable)` 新建一个MQProvider对象（使用默认字符编码）。
`MQProvider(java.lang.String mqURI, java.lang.String publishToQueue, java.lang.String consumFromQueue, java.lang.String encodeCharset, java.lang.String decodeCharset, java.lang.String TAG, boolean publishTrayAgainEnable)` 新建一个MQProvider对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected boolean`	`init()`
`boolean`	`publish(java.lang.String message)` Method to publish a message, will queue messages internally if the connection is down and resend later.
`protected boolean`	`publish(java.lang.String exchangeName, java.lang.String routingKey, java.lang.String message)` Method to publish a message, will queue messages internally if the connection is down and resend later.
`void`	`start()` 调用者必须显示调用本方法才能启动本provider的整个执行策略。
`protected void`	`startPublisher(com.rabbitmq.client.Connection conn)`
`protected void`	`startWorker(com.rabbitmq.client.Connection conn)`
`protected com.rabbitmq.client.Connection`	`tryGetConnection()` 返回Connection实例，如果connection不存在则新建一个。
`protected void`	`whenConnected(com.rabbitmq.client.Connection conn)`
`protected boolean`	`work(byte[] contentBody)` 处理接收到的消息。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DEFAULT_ENCODE_CHARSET
```
public static final java.lang.String DEFAULT_ENCODE_CHARSET
```
    发出消息的字符编码格式。默认utf-8。
    
    另请参阅:
    
    常量字段值
  - DEFAULT_DECODE_CHARSET
```
public static final java.lang.String DEFAULT_DECODE_CHARSET
```
    收到消息的字符解码格式。默认utf-8。
    
    另请参阅:
    
    常量字段值
  - _factory
```
protected com.rabbitmq.client.ConnectionFactory _factory
```
    连接工厂类，提取出来的目的是为了重用
  - _connection
```
protected com.rabbitmq.client.Connection _connection
```
    一旦首次连接成功后，本连接对象将不会被重置，它会依靠自身的自动恢复功能，在断线后自动恢底层的连接，应用层不需要额外代码
  - _pubChannel
```
protected com.rabbitmq.client.Channel _pubChannel
```
    生产者的Chnannel对象，连接断开再次恢复时，本变量被重新赋值
  - _workerChannel
```
protected com.rabbitmq.client.Channel _workerChannel
```
    消息者的Chnannel对象，连接断开再次恢复时，本变量被重新赋值
    
    从以下版本开始:
    
    6.4
  - timerForStartAgain
```
protected final java.util.Timer timerForStartAgain
```
    【说明】：RabittMQ的Java客户端的automaticRecovery只在连接成功后才会启动，像这种首次连接时服务器根本就没开或者本地网络故障等，首次无法成功建立Connection的，connction返回直接是null，当然就不存在automaticRecovery能力了，所以需要自已来尝试重新start，一定要注意思路哦，别理解乱了。
  - startRunning
```
protected boolean startRunning
```
    此标识仅用于防止首次连接失败重试时因TimeTask的异步执行而发生重复执行的可能，仅此而已
  - timerForRetryWorker
```
protected final java.util.Timer timerForRetryWorker
```
    本定时的作用是当worker启动或运行过程中出错时，可以自动进行恢复，而不至于丧失功能
  - retryWorkerRunning
```
protected boolean retryWorkerRunning
```
    此标识仅用于防止worker失败重试时因TimeTask的异步执行而发生重复执行的可能，仅此而已
  - publishTrayAgainCache
```
protected java.util.concurrent.ConcurrentLinkedQueue<java.lang.String[]> publishTrayAgainCache
```
    本地生产者用的暂存消息队列：因为当发送消息时，可能连接等原因导致此次消息没有成功发出，那么暂存至此列表中，以备下次连接恢复时，再次由本类自动完成发送，从而确保消息不丢并确保送达。
  - publishTrayAgainEnable
```
protected boolean publishTrayAgainEnable
```
    是否支持再次发送：true表示本地生产者发送失败时（比如连接MQ服务器不成功等情况）暂时缓存到本地内存 publishTrayAgainCache 中，等到与MQ中间件的连接成功时，自动再次尝试发送此缓存队列，从而保证生产者本来要发生送的消息在异常发生的情况下能再次发送直到成功。默认false。
    【注意】：不是所有情况下都需要在发送失败的情况下保存在缓存中以备再次尝试，比如MobileIMSDKX的跨服桥接消息的发送： ##### 为了让publish调用时能准确地反应出是否发送成功（而不需要在没发送成功时自动再次发送） ##### ，暂时关闭了此离线再发功能，也许以后的其它逻辑中用的上，但还是暂时取消了相关代码！！ ##### 【JS认为】桥接转发如不成功就应该立即由调用者知道，不然有此离线功能的话就会导致为何消息 ##### 报已发出，但就是没有收到的问题，这对调试和用户体验都不利！
  - consumerObserver
```
protected java.util.Observer consumerObserver
```
    本类中消费者收到的消息通过此观察者进行回调通知
  - encodeCharset
```
protected java.lang.String encodeCharset
```
    发出消息的字符编码格式
  - decodeCharset
```
protected java.lang.String decodeCharset
```
    收到消息的字符解码格式
  - mqURI
```
protected java.lang.String mqURI
```
    消息队列服务器连接URI，形如：“amqp://admin:123456789@192.168.1.190”
  - publishToQueue
```
protected java.lang.String publishToQueue
```
    生产者消息中转队列名：本类是此队列的生产者，会将消息发送至此
  - consumFromQueue
```
protected java.lang.String consumFromQueue
```
    消费者消息中转队列名：本类是此队列的消费者，将从其中读取消息
  - TAG
```
protected java.lang.String TAG
```
    TAG for log
- 构造器详细资料
  - MQProvider
```
public MQProvider(java.lang.String mqURI,
                  java.lang.String publishToQueue,
                  java.lang.String consumFromQueue,
                  java.lang.String TAG,
                  boolean publishTrayAgainEnable)
```
    新建一个MQProvider对象（使用默认字符编码）。
    
    参数:
    
    mqURI - 消息队列服务器连接URI，形如：“amqp://admin:123456789@192.168.1.190”
    
    publishToQueue - 生产者消息中转队列名：本类是此队列的生产者，会将消息发送至此
    
    consumFromQueue - 消费者消息中转队列名：本类是此队列的消费者，将从其中读取消息
    
    publishTrayAgainEnable - 是否支持再次发送：true表示本地生产者发送失败时（比如连接MQ服务器不成功等情况）暂时缓存到本地内存 publishTrayAgainCache 中，等到与MQ中间件的连接成功时，自动再次尝试发送此缓存队列。默认false。
    
    另请参阅:
    
    MQProvider(String, String, String, String, String, String, boolean)
  - MQProvider
```
public MQProvider(java.lang.String mqURI,
                  java.lang.String publishToQueue,
                  java.lang.String consumFromQueue,
                  java.lang.String encodeCharset,
                  java.lang.String decodeCharset,
                  java.lang.String TAG,
                  boolean publishTrayAgainEnable)
```
    新建一个MQProvider对象。
    
    参数:
    
    mqURI - 消息队列服务器连接URI，形如：“amqp://admin:123456789@192.168.1.190”
    
    publishToQueue - 生产者消息中转队列名：本类是此队列的生产者，会将消息发送至此
    
    consumFromQueue - 消费者消息中转队列名：本类是此队列的消费者，将从其中读取消息
    
    encodeCharset - 发出消息的字符编码格式
    
    decodeCharset - 收到消息的字符解码格式
    
    TAG - 用于log显示时的前缀，仅此而已
    
    publishTrayAgainEnable - 是否支持再次发送：true表示本地生产者发送失败时（比如连接MQ服务器不成功等情况）暂时缓存到本地内存 publishTrayAgainCache 中，等到与MQ中间件的连接成功时，自动再次尝试发送此缓存队列。默认false。
- 方法详细资料
  - init
```
protected boolean init()
```
  - tryGetConnection
```
protected com.rabbitmq.client.Connection tryGetConnection()
```
    返回Connection实例，如果connection不存在则新建一个。
    
    返回:
    
    Connection被成功创建则返回它的实例引用，否则返回null
  - start
```
public void start()
```
    调用者必须显示调用本方法才能启动本provider的整个执行策略。
  - whenConnected
```
protected void whenConnected(com.rabbitmq.client.Connection conn)
```
  - startPublisher
```
protected void startPublisher(com.rabbitmq.client.Connection conn)
```
  - publish
```
public boolean publish(java.lang.String message)
```
    Method to publish a message, will queue messages internally if the connection is down and resend later.
    向默认的exchange和队列进行发送。
    
    参数:
    
    message -
    
    返回:
    
    true表示发送成功，否则表示未发送失败
    
    另请参阅:
    
    #IMMQ_QUEUE_APP2WEB
  - publish
```
protected boolean publish(java.lang.String exchangeName,
                          java.lang.String routingKey,
                          java.lang.String message)
```
    Method to publish a message, will queue messages internally if the connection is down and resend later.
    
    参数:
    
    exchangeName -
    
    routingKey -
    
    message -
    
    返回:
    
    true表示发送成功，否则表示未发送失败
  - startWorker
```
protected void startWorker(com.rabbitmq.client.Connection conn)
```
  - work
```
protected boolean work(byte[] contentBody)
```
    处理接收到的消息。子类需要重写本方法以便实现自已的处理逻辑，本方法默认只作为log输出使用！
    特别注意：本方法一旦返回false则消息将被MQ服务器重新放入队列，请一定注意false是你需要的，不然消息会重复哦。
    
    参数:
    
    contentBody - 从MQ服务器取到的消息内容byte数组
    
    返回:
    
    true表示此消息处理成功(本类将回复ACK给MQ服务端，服务端队列中会交此消息正常删除)，否则不成功(本类将通知MQ服务器将该条消息重新放回队列，以备下次再次获取)。

类 MQProvider

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DEFAULT_ENCODE_CHARSET

DEFAULT_DECODE_CHARSET

_factory

_connection

_pubChannel

_workerChannel

timerForStartAgain

startRunning

timerForRetryWorker

retryWorkerRunning

publishTrayAgainCache

publishTrayAgainEnable

consumerObserver

encodeCharset

decodeCharset

mqURI

publishToQueue

consumFromQueue

TAG

构造器详细资料

MQProvider

MQProvider

方法详细资料

init

tryGetConnection

start

whenConnected

startPublisher

publish

publish

startWorker

work