feat: 优化mqtt client代码 #3380
Merged
feat: 优化mqtt client代码 #3380
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Caution Review failedThe pull request is closed. WalkthroughThe pull request introduces several modifications across multiple modules of the Laokou project. The changes primarily focus on enhancing event handling mechanisms, improving MQTT client management, and refactoring certain utility classes. Key modifications include adding event classes for MQTT client connections, updating event handling methods, implementing null checks in MQTT client operations, and converting some utility classes to final classes with private constructors to prevent instantiation. Changes
Sequence DiagramsequenceDiagram
participant Client
participant MqttClientManager
participant EventBus
participant EventHandler
Client->>MqttClientManager: Open Connection
MqttClientManager->>EventBus: Publish OpenEvent
EventBus->>EventHandler: Trigger onOpenEvent
EventHandler->>MqttClientManager: Open Client Connection
Client->>MqttClientManager: Close Connection
MqttClientManager->>EventBus: Publish CloseEvent
EventBus->>EventHandler: Trigger onCloseEvent
EventHandler->>MqttClientManager: Close Client Connection
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (12)
Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
审阅者指南 by Sourcery这个拉取请求通过确保客户端仅初始化一次，并且仅在客户端非空时执行订阅、取消订阅和发布操作来优化 MQTT 客户端代码。它还为打开和关闭事件添加了事件发布，并进行了一些小的代码改进。 MQTT 客户端生命周期序列图sequenceDiagram
participant App
participant MqttClientManager
participant MqttClient
participant EventBus
participant EventHandler
App->>MqttClientManager: add(clientId, properties, balancer)
MqttClientManager->>MqttClient: new MqttClient()
App->>MqttClientManager: open(clientId)
MqttClientManager->>MqttClient: open()
Note over MqttClient: 检查客户端是否为空
MqttClient->>MqttClient: 如果为空则初始化客户端
MqttClient->>EventBus: publish(OpenEvent)
EventBus->>EventHandler: onOpenEvent()
App->>MqttClientManager: subscribe(clientId, topics, qos)
MqttClientManager->>MqttClient: subscribe()
Note over MqttClient: 仅在客户端存在时订阅
App->>MqttClientManager: close(clientId)
MqttClientManager->>MqttClient: close()
MqttClient->>EventBus: publish(CloseEvent)
EventBus->>EventHandler: onCloseEvent()
MQTT 客户端变更类图classDiagram
class MqttClient {
-MqttAsyncClient client
+open()
+subscribe(String[] topics, int[] qos)
+unsubscribe(String[] topics)
+publish(String topic, byte[] payload, int qos)
+publishOpenEvent(String clientId)
+publishCloseEvent(String clientId)
}
class MqttClientManager {
-Map<String, MqttClient> MQTT_CLIENT_MAP
-ScheduledExecutorService EXECUTOR
+get(String clientId)
+remove(String clientId)
+add(String clientId, MqttBrokerProperties properties, MqttClientLoadBalancer balancer)
+open(String clientId)
+close(String clientId)
+publishOpenEvent(String clientId)
+publishCloseEvent(String clientId)
}
class EventHandler {
+onSubscribeEvent(SubscribeEvent event)
+onUnsubscribeEvent(UnsubscribeEvent event)
+onOpenEvent(OpenEvent event)
+onCloseEvent(CloseEvent event)
}
class OpenEvent {
-String clientId
}
class CloseEvent {
-String clientId
}
MqttClientManager --> MqttClient
EventHandler --> MqttClientManager
OpenEvent --|> ApplicationEvent
CloseEvent --|> ApplicationEvent
文件级变更
提示和命令与 Sourcery 交互
自定义您的体验访问您的仪表板以：
获取帮助Original review guide in EnglishReviewer's Guide by SourceryThis pull request optimizes the MQTT client code by ensuring that the client is only initialized once, and that subscribe, unsubscribe and publish operations are only performed if the client is not null. It also adds event publishing for open and close events, and makes some minor code improvements. Sequence diagram for MQTT client lifecyclesequenceDiagram
participant App
participant MqttClientManager
participant MqttClient
participant EventBus
participant EventHandler
App->>MqttClientManager: add(clientId, properties, balancer)
MqttClientManager->>MqttClient: new MqttClient()
App->>MqttClientManager: open(clientId)
MqttClientManager->>MqttClient: open()
Note over MqttClient: Check if client is null
MqttClient->>MqttClient: Initialize client if null
MqttClient->>EventBus: publish(OpenEvent)
EventBus->>EventHandler: onOpenEvent()
App->>MqttClientManager: subscribe(clientId, topics, qos)
MqttClientManager->>MqttClient: subscribe()
Note over MqttClient: Only subscribe if client exists
App->>MqttClientManager: close(clientId)
MqttClientManager->>MqttClient: close()
MqttClient->>EventBus: publish(CloseEvent)
EventBus->>EventHandler: onCloseEvent()
Class diagram for MQTT client changesclassDiagram
class MqttClient {
-MqttAsyncClient client
+open()
+subscribe(String[] topics, int[] qos)
+unsubscribe(String[] topics)
+publish(String topic, byte[] payload, int qos)
+publishOpenEvent(String clientId)
+publishCloseEvent(String clientId)
}
class MqttClientManager {
-Map<String, MqttClient> MQTT_CLIENT_MAP
-ScheduledExecutorService EXECUTOR
+get(String clientId)
+remove(String clientId)
+add(String clientId, MqttBrokerProperties properties, MqttClientLoadBalancer balancer)
+open(String clientId)
+close(String clientId)
+publishOpenEvent(String clientId)
+publishCloseEvent(String clientId)
}
class EventHandler {
+onSubscribeEvent(SubscribeEvent event)
+onUnsubscribeEvent(UnsubscribeEvent event)
+onOpenEvent(OpenEvent event)
+onCloseEvent(CloseEvent event)
}
class OpenEvent {
-String clientId
}
class CloseEvent {
-String clientId
}
MqttClientManager --> MqttClient
EventHandler --> MqttClientManager
OpenEvent --|> ApplicationEvent
CloseEvent --|> ApplicationEvent
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
嘿 @KouShenhai - 我已经审查了你的更改，看起来非常棒！
以下是我在审查期间查看的内容
- 🟢 一般性问题：一切看起来都很好
- 🟢 安全性：一切看起来都很好
- 🟢 测试：一切看起来都很好
- 🟢 复杂性：一切看起来都很好
- 🟢 文档：一切看起来都很好
帮助我变得更有用！请在每条评论上点击 👍 或 👎，我将使用这些反馈来改进你的评论。
Original comment in English
Hey @KouShenhai - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3380 +/- ##
============================================
+ Coverage 23.51% 23.72% +0.20%
- Complexity 199 201 +2
============================================
Files 158 158
Lines 2092 2091 -1
Branches 142 142
============================================
+ Hits 492 496 +4
+ Misses 1538 1533 -5
Partials 62 62 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
重构 MQTT 客户端代码，以防止创建多个客户端实例并添加打开和关闭事件。
增强功能：
测试：
Original summary in English
Summary by Sourcery
Refactor the MQTT client code to prevent multiple instances of the client from being created and add open and close events.
Enhancements:
Tests:
Summary by CodeRabbit
New Features
Refactor
Tests