Improve trigger config

[huangdijia]

Summary by CodeRabbit

• 新特性

  • 引入了新的配置管理方式，支持依赖注入的构造函数。
  • 新增了获取配置值和检查配置键存在性的功能。

• 变更

  • Consumer 类的多个属性现在为只读，增强了对象状态的完整性。

[coderabbitai]

Caution

Review failed

The pull request is closed.

概述

走查

在 Config 类中移除了对 \Hyperf\Config\Config 的继承，新增了一个接受配置数组的构造函数，允许通过依赖注入传入配置数据。同时，添加了 get() 方法用于检索配置值，并提供默认值，新增的 has() 方法用于检查配置键的存在性。这些更改增强了类独立管理配置数据的能力。此外，Consumer 类中移除了对 Hyperf\Config\Config 的直接引用，改为在构造函数中实例化 Config，并引入了多个只读属性，确保这些属性在初始化后不可修改。

变更

文件	变更摘要
src/trigger/src/Config.php	移除对 \Hyperf\Config\Config 的继承，新增构造函数、get() 和 has() 方法
src/trigger/src/Consumer.php	移除对 Hyperf\Config\Config 的导入，新增多个只读属性并更新其签名

可能相关的 PRs

• Improve trigger config #813: 此 PR 也修改了 src/trigger/src/Config.php 中的 Config 类，添加了新的公共方法用于配置检索，直接与主 PR 的修改相关。

诗歌

🐰 配置小兔轻轻跳，
依赖注入真妙巧。
方法新增如春风，
只读属性更稳妥。
配置管理无忧愁，
代码清晰乐逍遥！ 🌈

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 32e4d65 and 94c3638.

📒 Files selected for processing (2)

• src/trigger/src/Config.php (1 hunks)
• src/trigger/src/Consumer.php (0 hunks)

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/trigger/src/Config.php (2)

38-41: password() 方法同样默认空字符串，算是合理。
若需要更安全的处理方式，可考虑在构造函数或其它位置对密码进行脱敏/加密。

---

63-69: subscribers() 方法定义了返回 class-string[] 数组，类型文档准确。
可考虑在读取到的值中进行简单类型校验或日志记录，确保所有订阅者类均有效并继承自 AbstractSubscriber。

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc431d1 and 32e4d65.

📒 Files selected for processing (1)

• src/trigger/src/Config.php (1 hunks)

🔇 Additional comments (13)

src/trigger/src/Config.php (13)

14-15: 导入 env 函数是个好做法，但请确保合理使用。
如果项目中需要在更多地方频繁访问 ENV 变量，也可考虑统一封装以便维护。

---

18-21: enable() 方法逻辑清晰，默认值设置合理。
建议确保各调用方在获取此值后做好容错处理，例如未启用时跳过相关流程。

---

23-26: host() 方法简单明了。
若需要动态扩展，可考虑通过环境变量传递默认值。

---

33-36: user() 方法保持默认空字符串可避免未配置时的意外报错。
建议检查调用端是否对空字符串有特殊处理需求。

---

43-46: databasesOnly() 方法返回数组显式清晰。
若有多处需要类似的数组配置，可统一通过常量或配置文件集中管理。

---

48-51: tablesOnly() 同上，命名可读性好。
同样建议统一管理默认值或以常量形式呈现，便于后期维护。

---

58-61: connectRetries() 方法。
默认值 10 能容错一定的网络抖动，但可能对启动时长有影响，可根据实际情况进行调整。

---

71-83: serverMutex() 的 array_replace 使用适当，可以覆盖默认配置。
在默认配置中引入了 env('APP_ENV', 'dev') . '_'，对区分环境很有帮助。只是要确认是否对前缀有长度或字符限制需求。

---

85-94: healthMonitor() 在默认配置里设置了 enable=true 及 interval=30，满足通用心跳检测需求。
如需更灵活可考虑在运行阶段动态调整。

---

96-106: snapshot() 默认使用 1.0 版本、24 小时过期及 10 秒间隔，符合常见快照逻辑。
若快照逻辑较为复杂，建议在调用方对不同业务需求进行动态控制。

---

108-116: concurrent() 仅返回 limit=1 的默认值，适合简单场景并发限制。
若业务需要更大并行能力，可在日后通过配置文件或环境变量灵活配置。

---

53-56: heartbeatPeriod() 方法默认值为 3，频率较高。
请确认此频率是否符合业务需求，避免对系统或网络造成过大负担。

---

28-31: port() 方法使用整型端口与默认 3306 值合乎 MySQL 习惯。
可在上层或调用方再次验证端口是否符合期望范围，以确保安全。