布尔型字段命名避坑指南：告别is前缀，打造简洁代码

后端

2024-01-13 23:50:48

在软件开发中，布尔型字段的命名是一门微妙的艺术。一个优雅且富含信息的名称可以提升代码的可读性和可维护性，而一个糟糕的名称则会让人困惑和沮丧。

is前缀：旧习惯的陷阱

过去，以is为前缀命名布尔型字段是一种常见的做法，例如isOnline、isActivated、isFlagged。这种做法看似合理，因为它直接表达了该字段的布尔性质。然而，随着时间的推移，is前缀逐渐显露出其弊端：

冗余： 在大多数情况下，变量名本身已经隐含了布尔性质。例如，active显然是一个布尔型字段，不需要再加is前缀。
破坏语法： 在代码中使用is时，可能会与保留相冲突，从而导致语法错误。例如，is instanceof是一种合法的语法结构，但如果一个字段名为isFoo，就会导致编译器报错。
可读性差： is前缀增加了字段名的长度，使代码变得冗长且难以阅读。

摒弃is前缀，拥抱简洁

现代的编码规范普遍建议摒弃is前缀，转而使用更简洁且富有性的名称。例如，可以将isOnline更改为online，isActivated更改为activated，isFlagged更改为flagged。

动词形式： 对于表示状态或行为的布尔型字段，可以使用动词形式，例如enabled、visible、authenticated。
形容词形式： 对于表示特性的布尔型字段，可以使用形容词形式，例如valid、complete、successful。
名词形式： 对于表示特定概念的布尔型字段，可以使用名词形式，例如hasAccess、isAdmin、isModerator。
长尾命名： 如果字段的语义较复杂，可以使用长尾命名，例如userHasActiveSubscription、orderIsEligibleForRefund。

好处多多，提升代码质量

摒弃is前缀带来的好处显而易见：

提高可读性： 简洁的字段名称让代码更易于理解和维护。
降低冲突风险： 避免与保留关键字冲突，确保代码的稳定性和可扩展性。
符合规范： 遵守现代编码规范，提升代码质量和行业认可度。

例子说明，一目了然

// 使用 is 前缀
private boolean isOnline;
private boolean isActivated;
private boolean isFlagged;

// 摒弃 is 前缀
private boolean online;
private boolean activated;
private boolean flagged;