Skip to content
📖0 阅读·🤍0 点赞

索引命名规范

  • 以小写英文字母命名索引
  • 不要使用 <span class="ne-text">驼峰</span>或者 <span class="ne-text">帕斯卡</span>命名法则
  • 如过出现多个单词的索引名称,以全小写 + 下划线分隔的方式:如 <span class="ne-text">my_index</span>

通俗的解释

记住 my_index这个例子,它就是完美遵循了 全小写 + 下划线分隔 (myindex之间用 _分开) 的典范。

咱们把数据库索引想象成图书馆的索引卡片或者快递站的快递柜编号,这样就好理解了。

规则解释(比喻版):

  1. 用小写字母命名: 就像图书馆的索引卡片或者快递柜的编号,都用小写字母写。这样看起来最整齐、最统一,不会有大写字母突然冒出来干扰视线。 错误例子(用了大写):MyIndex, USERNAME_INDEX 正确例子:myindex, username_index
  2. 不用驼峰或帕斯卡命名法: 这两种方法就像在名字里大小写混用来区分单词。 驼峰 (myIndex): 第一个单词小写,后面单词首字母大写。想象一下快递柜编号写成 myBox123,是不是有点别扭?不如全小写 my_box_123清晰。 帕斯卡 (MyIndex): 每个单词首字母都大写。这就像图书馆索引卡片写成 BookTitleIndex,感觉太正式、太“重”了,不如 book_title_index轻便易读。 *核心问题:*数据库系统(尤其是不同操作系统下)对大小写字母的敏感度可能不同。用大小写混合容易出错,全小写最安全、兼容性最好。
  3. 多个单词用下划线连接: 这是最关键的一点! 想象: 你的索引名字由多个单词组成(比如要建一个索引表示“用户的邮箱地址”)。 问题: 如果你直接连在一起写 useremail,读起来就费劲了,是 “user email” 还是 “us er email”?分不清单词边界。 解决方案: 在单词之间加下划线 _,就像在单词之间放一个小小的分隔符或者空格替代符错误例子(无分隔):useremailindex(难读) 错误例子(驼峰):userEmailIndex(大小写混合,有风险) 正确例子: user_email_index 好处: 一目了然: 一眼就能看出是三个单词:useremailindex机器友好: 下划线是计算机里非常常用的分隔符,系统处理起来很方便。 统一规范: 大家都这么写,代码看起来就整齐划一,容易维护。

总结一下这个命名规范的精髓:

给你的索引起名字时,想象你在写快递柜编号或者图书馆卡片编号:全部使用小写字母,如果名字包含多个词,就在词与词之间加一个下划线 _把它们清楚地分开。这样最清晰、最安全、最通用!

例子对比:

  • 表示“订单创建时间”的索引: 不好: orderCreateTimeIndex(驼峰,大小写混合) 不好: ordercreatetimeindex(全小写但无分隔,难读) 好: order_create_time_index(全小写 + 下划线分隔,清晰!)