5 客户端配置

​ 相对于RocketMQ的Broker集群，生产者和消费者都是客户端。本小节主要描述生产者和消费者公共的行为配置。

5.1 客户端寻址方式

RocketMQ可以令客户端找到Name Server, 然后通过Name Server再找到Broker。如下所示有多种配置方式，优先级由高到低，高优先级会覆盖低优先级。

  • 代码中指定Name Server地址，多个namesrv地址之间用分号分割
  1. producer.setNamesrvAddr("192.168.0.1:9876;192.168.0.2:9876");  
  3. consumer.setNamesrvAddr("192.168.0.1:9876;192.168.0.2:9876");
  • Java启动参数中指定Name Server地址
  1. -Drocketmq.namesrv.addr=192.168.0.1:9876;192.168.0.2:9876
  • 环境变量指定Name Server地址
  1. export   NAMESRV_ADDR=192.168.0.1:9876;192.168.0.2:9876
  • HTTP静态服务器寻址（默认）

客户端启动后，会定时访问一个静态HTTP服务器，地址如下：http://jmenv.tbsite.net:8080/rocketmq/nsaddr，这个URL的返回内容如下：

  1. 192.168.0.1:9876;192.168.0.2:9876

客户端默认每隔2分钟访问一次这个HTTP服务器，并更新本地的Name Server地址。URL已经在代码中硬编码，可通过修改/etc/hosts文件来改变要访问的服务器，例如在/etc/hosts增加如下配置：

  1. 10.232.22.67    jmenv.taobao.net

推荐使用HTTP静态服务器寻址方式，好处是客户端部署简单，且Name Server集群可以热升级。

5.2 客户端配置

DefaultMQProducer、TransactionMQProducer、DefaultMQPushConsumer、DefaultMQPullConsumer都继承于ClientConfig类，ClientConfig为客户端的公共配置类。客户端的配置都是get、set形式，每个参数都可以用spring来配置，也可以在代码中配置，例如namesrvAddr这个参数可以这样配置，producer.setNamesrvAddr(“192.168.0.1:9876”)，其他参数同理。

1 客户端的公共配置

参数名默认值说明
namesrvAddrName Server地址列表，多个NameServer地址用分号隔开
clientIP本机IP客户端本机IP地址，某些机器会发生无法识别客户端IP地址情况，需要应用在代码中强制指定
instanceNameDEFAULT客户端实例名称，客户端创建的多个Producer、Consumer实际是共用一个内部实例（这个实例包含网络连接、线程资源等）
clientCallbackExecutorThreads4通信层异步回调线程数
pollNameServerInteval30000轮询Name Server间隔时间，单位毫秒
heartbeatBrokerInterval30000向Broker发送心跳间隔时间，单位毫秒
persistConsumerOffsetInterval5000持久化Consumer消费进度间隔时间，单位毫秒

2 Producer配置

参数名默认值说明
producerGroupDEFAULT_PRODUCERProducer组名，多个Producer如果属于一个应用，发送同样的消息，则应该将它们归为同一组
createTopicKeyTBW102在发送消息时，自动创建服务器不存在的topic，需要指定Key，该Key可用于配置发送消息所在topic的默认路由。
defaultTopicQueueNums4在发送消息，自动创建服务器不存在的topic时，默认创建的队列数
sendMsgTimeout10000发送消息超时时间，单位毫秒
compressMsgBodyOverHowmuch4096消息Body超过多大开始压缩（Consumer收到消息会自动解压缩），单位字节
retryAnotherBrokerWhenNotStoreOKFALSE如果发送消息返回sendResult，但是sendStatus!=SEND_OK，是否重试发送
retryTimesWhenSendFailed2如果消息发送失败，最大重试次数，该参数只对同步发送模式起作用
maxMessageSize4MB客户端限制的消息大小，超过报错，同时服务端也会限制，所以需要跟服务端配合使用。
transactionCheckListener事务消息回查监听器，如果发送事务消息，必须设置
checkThreadPoolMinSize1Broker回查Producer事务状态时，线程池最小线程数
checkThreadPoolMaxSize1Broker回查Producer事务状态时，线程池最大线程数
checkRequestHoldMax2000Broker回查Producer事务状态时，Producer本地缓冲请求队列大小
RPCHooknull该参数是在Producer创建时传入的，包含消息发送前的预处理和消息响应后的处理两个接口，用户可以在第一个接口中做一些安全控制或者其他操作。

3 PushConsumer配置

参数名默认值说明
consumerGroupDEFAULT_CONSUMERConsumer组名，多个Consumer如果属于一个应用，订阅同样的消息，且消费逻辑一致，则应该将它们归为同一组
messageModelCLUSTERING消费模型支持集群消费和广播消费两种
consumeFromWhereCONSUME_FROM_LAST_OFFSETConsumer启动后，默认从上次消费的位置开始消费，这包含两种情况：一种是上次消费的位置未过期，则消费从上次中止的位置进行；一种是上次消费位置已经过期，则从当前队列第一条消息开始消费
consumeTimestamp半个小时前只有当consumeFromWhere值为CONSUME_FROM_TIMESTAMP时才起作用。
allocateMessageQueueStrategyAllocateMessageQueueAveragelyRebalance算法实现策略
subscription订阅关系
messageListener消息监听器
offsetStore消费进度存储
consumeThreadMin10消费线程池最小线程数
consumeThreadMax20消费线程池最大线程数
consumeConcurrentlyMaxSpan2000单队列并行消费允许的最大跨度
pullThresholdForQueue1000拉消息本地队列缓存消息最大数
pullInterval0拉消息间隔，由于是长轮询，所以为0，但是如果应用为了流控，也可以设置大于0的值，单位毫秒
consumeMessageBatchMaxSize1批量消费，一次消费多少条消息
pullBatchSize32批量拉消息，一次最多拉多少条

4 PullConsumer配置

参数名默认值说明
consumerGroupDEFAULT_CONSUMERConsumer组名，多个Consumer如果属于一个应用，订阅同样的消息，且消费逻辑一致，则应该将它们归为同一组
brokerSuspendMaxTimeMillis20000长轮询，Consumer拉消息请求在Broker挂起最长时间，单位毫秒
consumerTimeoutMillisWhenSuspend30000长轮询，Consumer拉消息请求在Broker挂起超过指定时间，客户端认为超时，单位毫秒
consumerPullTimeoutMillis10000非长轮询，拉消息超时时间，单位毫秒
messageModelBROADCASTING消息支持两种模式：集群消费和广播消费
messageQueueListener监听队列变化
offsetStore消费进度存储
registerTopics注册的topic集合
allocateMessageQueueStrategyAllocateMessageQueueAveragelyRebalance算法实现策略

5 Message数据结构

字段名默认值说明
Topicnull必填，消息所属topic的名称
Bodynull必填，消息体
Tagsnull选填，消息标签，方便服务器过滤使用。目前只支持每个消息设置一个tag
Keysnull选填，代表这条消息的业务关键词，服务器会根据keys创建哈希索引，设置后，可以在Console系统根据Topic、Keys来查询消息，由于是哈希索引，请尽可能保证key唯一，例如订单号，商品Id等。
Flag0选填，完全由应用来设置，RocketMQ不做干预
DelayTimeLevel0选填，消息延时级别，0表示不延时，大于0会延时特定的时间才会被消费
WaitStoreMsgOKTRUE选填，表示消息是否在服务器落盘后才返回应答。