com.taobao.metamorphosis.client.consumer
类 ConsumerConfig

java.lang.Object
  com.taobao.metamorphosis.client.MetaClientConfig
      com.taobao.metamorphosis.client.consumer.ConsumerConfig

所有已实现的接口：

Serializable

public class ConsumerConfig
extends MetaClientConfig

消费者配置，主要配置选项如下：

• group:分组名称，必须，表示该消费者所在分组，同一分组的消费者正常情况下不会接收重复消息，共同消费某一topic
• consumerId: 消费者id，用于唯一标识一个消费者，可不设置，系统会根据分组名称自动生成
• commitOffsetPeriodInMills: 保存offset的时间间隔，默认5秒，单位毫秒
• fetchTimeoutInMills: 同步获取消息的默认超时时间，默认10秒，单位毫秒
• maxDelayFetchTimeInMills: 当获取消息失败的时候（包括get miss或者任何异常情况)会延迟获取，此值设置最大的延迟时间，单位毫秒
• fetchRunnerCount: 获取消息的线程数，默认cpu个。
• partition:当使用直连模式时，此值指定连接的分区，形如"brokerId-partition"的字符串
• offset:指定读取的offset偏移量,默认从0开始
• maxFetchRetries:同一条消息在处理失败情况下最大重试次数，默认5次，超过就跳过这条消息并记录
• maxIncreaseFetchDataRetries:拉取数据重试次数超过这个值,则增长每次拉取的数据量
• loadBalanceStrategyType: 消费者负载均衡策略

作者：

boyan, wuhua

另请参见：

序列化表格

字段摘要

从类 com.taobao.metamorphosis.client.MetaClientConfig 继承的字段

serverUrl, zkConfig

构造方法摘要

ConsumerConfig()

ConsumerConfig(String group)

ConsumerConfig(String consumerId, String group)

方法摘要

boolean	equals(Object obj)
long	getCommitOffsetPeriodInMills() 保存offset的间隔时间，单位毫秒，默认5秒
String	getConsumerId() 消费者id
int	getFetchRunnerCount() 请求线程数，默认cpus个
long	getFetchTimeoutInMills() 请求超时时间，毫秒为单位，默认10秒
String	getGroup() 消费者分组名
LoadBalanceStrategy.Type	getLoadBalanceStrategyType() 获取负载均衡策略类型
long	getMaxDelayFetchTimeInMills() 请求间隔的最大时间，单位毫秒，默认5秒
long	getMaxDelayFetchTimeWhenExceptionInMills() 已过时。 1.4开始废除，请使用maxDelayFetchTimeInMills
int	getMaxFetchRetries()
int	getMaxIncreaseFetchDataRetries() 拉取数据重试次数超过这个值,则增长每次拉取的数据量
long	getOffset() 请求offset起点
String	getPartition() 分区，仅在直接连接服务器的时候有效
int	hashCode()
boolean	isAlwaysConsumeFromMaxOffset()
void	setCommitOffsetPeriodInMills(long commitOffsetPeriodInMills) 设置保存offset的间隔时间，单位毫秒，默认5秒
void	setConsumeFromMaxOffset() 设置首次订阅是否从最新位置开始消费。
void	setConsumeFromMaxOffset(boolean always) 设置每次订阅是否从最新位置开始消费。
void	setConsumerId(String consumerId) 设置消费者id，可不设置，系统将按照"ip_时间"的规则自动产生
void	setFetchRunnerCount(int fetchRunnerCount) 设置请求线程数，默认cpus个
void	setFetchTimeoutInMills(long fetchTimeoutInMills) 设置请求超时时间，毫秒为单位，默认10秒
void	setGroup(String group) 设置消费者分组名
void	setLoadBalanceStrategyType(LoadBalanceStrategy.Type loadBalanceStrategyType) 设置负载均衡策略类型
void	setMaxDelayFetchTimeInMills(long maxDelayFetchTimeInMills) 设置请求间隔的最大时间，单位毫秒，默认5秒
void	setMaxDelayFetchTimeWhenExceptionInMills(long maxDelayFetchTimeWhenExceptionInMills) 已过时。 1.4开始废除，请使用maxDelayFetchTimeInMills
void	setMaxFetchRetries(int maxFetchRetries)
void	setMaxIncreaseFetchDataRetries(int maxFetchRetriesForDataNotEnough) 设置拉取数据重试次数超过这个值,则增长每次拉取的数据量
void	setOffset(long offset) 设置请求offset
void	setPartition(String partition) 设置分区,仅在直接连接服务器的时候有效

从类 com.taobao.metamorphosis.client.MetaClientConfig 继承的方法

getDiamondPartitionsDataId, getDiamondPartitionsGroup, getPartitionsInfo, getRecoverMessageIntervalInMills, getRecoverThreadCount, getServerUrl, getZkConfig, getZkConnect, getZkConnectionTimeoutMs, getZkRoot, getZkSessionTimeoutMs, getZkSyncTimeMs, isZkEnable, setPartitionsInfo, setRecoverMessageIntervalInMills, setRecoverThreadCount, setServerUrl, setZkConfig, setZkConnect, setZkConnectionTimeoutMs, setZkEnable, setZkRoot, setZkSessionTimeoutMs, setZkSyncTimeMs

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

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

ConsumerConfig

public ConsumerConfig(String group)

参数：

group - 分组名称

ConsumerConfig

public ConsumerConfig(String consumerId,
                      String group)

参数：

consumerId - 消费者id，如果不设置，系统会自动产生 "ip_时间"

group -

ConsumerConfig

public ConsumerConfig()

方法详细信息

getMaxFetchRetries

public int getMaxFetchRetries()

isAlwaysConsumeFromMaxOffset

public boolean isAlwaysConsumeFromMaxOffset()

setMaxFetchRetries

public void setMaxFetchRetries(int maxFetchRetries)

getMaxIncreaseFetchDataRetries

public int getMaxIncreaseFetchDataRetries()

拉取数据重试次数超过这个值,则增长每次拉取的数据量

返回：

setMaxIncreaseFetchDataRetries

public void setMaxIncreaseFetchDataRetries(int maxFetchRetriesForDataNotEnough)

设置拉取数据重试次数超过这个值,则增长每次拉取的数据量

参数：

maxFetchRetriesForDataNotEnough -

getFetchRunnerCount

public int getFetchRunnerCount()

请求线程数，默认cpus个

返回：

getOffset

public long getOffset()

请求offset起点

返回：

setOffset

public void setOffset(long offset)

设置请求offset

参数：

offset -

setConsumeFromMaxOffset

public void setConsumeFromMaxOffset()

设置首次订阅是否从最新位置开始消费。

参数：

offset -

setConsumeFromMaxOffset

public void setConsumeFromMaxOffset(boolean always)

设置每次订阅是否从最新位置开始消费。

参数：

always - 如果为true，表示每次启动都从最新位置开始消费。通常在测试的时候可以设置为true。

从以下版本开始：

1.4.5

getGroup

public String getGroup()

消费者分组名

返回：

setGroup

public void setGroup(String group)

设置消费者分组名

参数：

group - 分组名，不得为空

getPartition

public String getPartition()

分区，仅在直接连接服务器的时候有效

返回：

setPartition

public void setPartition(String partition)

设置分区,仅在直接连接服务器的时候有效

参数：

partition - 形如"brokerId-partition"的字符串

getConsumerId

public String getConsumerId()

消费者id

返回：

setConsumerId

public void setConsumerId(String consumerId)

设置消费者id，可不设置，系统将按照"ip_时间"的规则自动产生

参数：

consumerId -

getFetchTimeoutInMills

public long getFetchTimeoutInMills()

请求超时时间，毫秒为单位，默认10秒

返回：

setFetchTimeoutInMills

public void setFetchTimeoutInMills(long fetchTimeoutInMills)

设置请求超时时间，毫秒为单位，默认10秒

参数：

fetchTimeoutInMills - 毫秒

getMaxDelayFetchTimeInMills

public long getMaxDelayFetchTimeInMills()

请求间隔的最大时间，单位毫秒，默认5秒

返回：

setMaxDelayFetchTimeInMills

public void setMaxDelayFetchTimeInMills(long maxDelayFetchTimeInMills)

设置请求间隔的最大时间，单位毫秒，默认5秒

参数：

maxDelayFetchTimeInMills -

getMaxDelayFetchTimeWhenExceptionInMills

@Deprecated
public long getMaxDelayFetchTimeWhenExceptionInMills()

已过时。 1.4开始废除，请使用maxDelayFetchTimeInMills

当请求发生异常时(例如无可用连接等),请求间隔的最大时间，单位毫秒，默认10秒

返回：

setMaxDelayFetchTimeWhenExceptionInMills

@Deprecated
public void setMaxDelayFetchTimeWhenExceptionInMills(long maxDelayFetchTimeWhenExceptionInMills)

已过时。 1.4开始废除，请使用maxDelayFetchTimeInMills

当请求发生异常时(例如无可用连接等),设置请求间隔的最大时间，单位毫秒，默认10秒

参数：

maxDelayFetchTimeWhenExceptionInMills -

setFetchRunnerCount

public void setFetchRunnerCount(int fetchRunnerCount)

设置请求线程数，默认cpus个

参数：

fetchRunnerCount -

getCommitOffsetPeriodInMills

public long getCommitOffsetPeriodInMills()

保存offset的间隔时间，单位毫秒，默认5秒

返回：

setCommitOffsetPeriodInMills

public void setCommitOffsetPeriodInMills(long commitOffsetPeriodInMills)

设置保存offset的间隔时间，单位毫秒，默认5秒

参数：

commitOffsetPeriodInMills - 毫秒

getLoadBalanceStrategyType

public LoadBalanceStrategy.Type getLoadBalanceStrategyType()

获取负载均衡策略类型

返回：

setLoadBalanceStrategyType

public void setLoadBalanceStrategyType(LoadBalanceStrategy.Type loadBalanceStrategyType)

设置负载均衡策略类型

参数：

loadBalanceStrategyType -

hashCode

public int hashCode()

覆盖：

类 MetaClientConfig 中的 hashCode

equals

public boolean equals(Object obj)

覆盖：

类 MetaClientConfig 中的 equals