Skip to content

Commit

Permalink
[ISSUE #587] Update description about enableTopicMessageTypeCheck def…
Browse files Browse the repository at this point in the history
…ault (#588)

* docs: Update description about enableTopicMessageTypeCheck default

* docs: Update description about enableTopicMessageTypeCheck default
  • Loading branch information
QianChenJun authored Jan 17, 2024
1 parent 8a23da9 commit 6fbfa38
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Categories defined by message transfer characteristics for type management and s

:::info

Starting from version 5.0, Apache RocketMQ supports enforcing the validation of message types, that is, each topic only allows messages of a single type to be sent. This can better facilitate operation and management of production systems and avoid confusion. However, to ensure backward compatibility with version 4.x, the validation feature is disabled by default. It is recommended to enable it manually through the server parameter "enableTopicMessageTypeCheck".
Starting from version 5.0, Apache RocketMQ supports enforcing the validation of message types, that is, each topic only allows messages of a single type to be sent. This can better facilitate operation and management of production systems and avoid confusion. However, to ensure backward compatibility with version 4.x, the validation feature is enable by default.
:::

## MessageQueue
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ A topic contains one or more queues. Message storage and scalability are impleme

* Transaction: [Transaction messages](../04-featureBehavior/04transactionmessage.md). Apache RocketMQ supports distributed transaction messages and ensures transaction consistency of database updates and message calls.

* Constraint: Starting from version 5.0, Apache RocketMQ supports enforcing the validation of message types, that is, each topic only allows messages of a single type to be sent. This can better facilitate operation and management of production systems and avoid confusion. However, to ensure backward compatibility with version 4.x, the validation feature is disabled by default. It is recommended to enable it manually through the server parameter "enableTopicMessageTypeCheck".
* Constraint: Starting from version 5.0, Apache RocketMQ supports enforcing the validation of message types, that is, each topic only allows messages of a single type to be sent. This can better facilitate operation and management of production systems and avoid confusion. However, to ensure backward compatibility with version 4.x, the validation feature is enable by default.


## Behavior constraints
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-5.0/01-introduction/02concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Apache RocketMQ 中按照消息传输特性的不同而定义的分类,用于

:::info

Apache RocketMQ 从5.0版本开始,支持强制校验消息类型,即每个主题Topic只允许发送一种消息类型的消息,这样可以更好的运维和管理生产系统,避免混乱。但同时保证向下兼容4.x版本行为,强制校验功能默认关闭,推荐通过服务端参数 enableTopicMessageTypeCheck 手动开启校验
Apache RocketMQ 从5.0版本开始,支持强制校验消息类型,即每个主题Topic只允许发送一种消息类型的消息,这样可以更好的运维和管理生产系统,避免混乱。但同时保证向下兼容4.x版本行为,强制校验功能默认开启

:::

Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-5.0/03-domainModel/02topic.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@

* Transaction:[事务消息](../04-featureBehavior/04transactionmessage.md),Apache RocketMQ 支持分布式事务消息,支持应用数据库更新和消息调用的事务一致性保障。

* 约束:Apache RocketMQ 从5.0版本开始,支持强制校验消息类型,即每个主题只允许发送一种消息类型的消息,这样可以更好的运维和管理生产系统,避免混乱。为保证向下兼容4.x版本行为,强制校验功能默认关闭,推荐通过服务端参数 enableTopicMessageTypeCheck 开启校验
* 约束:Apache RocketMQ 从5.0版本开始,支持强制校验消息类型,即每个主题只允许发送一种消息类型的消息,这样可以更好的运维和管理生产系统,避免混乱。为保证向下兼容4.x版本行为,强制校验功能默认开启



Expand All @@ -77,7 +77,7 @@ Apache RocketMQ 5.x版本支持将消息类型拆分到主题中进行独立运

:::info

为保证向下兼容4.x版本行为,上述强制校验功能默认关闭,推荐通过服务端参数 enableTopicMessageTypeCheck 开启校验
为保证向下兼容4.x版本行为,上述强制校验功能默认开启

:::

Expand All @@ -91,7 +91,7 @@ Apache RocketMQ 5.x版本支持将消息类型拆分到主题中进行独立运
## 版本兼容性


消息类型的强制校验,仅 Apache RocketMQ 服务端5.x版本支持,且默认关闭,推荐部署时打开配置。 Apache RocketMQ 服务端4.x和3.x历史版本的SDK不支持强制校验,您需要自己保证消息类型一致。 如果您使用的服务端版本为历史版本,建议您升级到
消息类型的强制校验,仅 Apache RocketMQ 服务端5.x版本支持,且默认开启,推荐部署时打开配置。 Apache RocketMQ 服务端4.x和3.x历史版本的SDK不支持强制校验,您需要自己保证消息类型一致。 如果您使用的服务端版本为历史版本,建议您升级到
Apache RocketMQ 服务端5.x版本。

## 使用示例
Expand Down

0 comments on commit 6fbfa38

Please sign in to comment.