命名:起一个明白的名字

2025.03.28 · 1 minute read

配置白名单,是一个技术术语,与它关联的上下文以及所造成的结果才是最重要的。这些信息应该被归档。

具体而言,当我们修改了白名单后,系统会在初始化的时候读取白名单。当系统进行到 ServiceInfoCalculation 的环节时,会触发 ServiceStatusChangedDetector 以检查新的 ServiceInfo 和旧的区别。这些变化将通过不同方式被发送,被广播。而其中只有在 whitelist 中的 Service,它的变化才能够被广播出去。

换句话说,白名单只不过是消息发送其中的一个环节,代表该处使用了这个技术,而其他的技术也可以被使用,比方说使用 hardcode array。对文档来,最重要的是 use case,是使用该技术所产生的影响和后果。

如果单纯以白名单作为中心,描述需求,会让读者或使用者感到困惑,是一种不合适的方式。最终,我们都应以描述整体作为关键。

感谢您的阅读!您的支持是我的动力。

如果您喜欢这篇文章,不妨请我喝杯咖啡。 ☕️