Java 包命名。下划线：特殊情况

Question

今天我在一个项目中命名一个包，该包将包含与称为“访问结构”的概念相关的代码。

现在，将这个包命名为“com.myemployer.project.component.accessstructures”似乎没有吸引力并且难以阅读，因为三个“S”。（更高级别的包实际上并未命名为“项目”和“组件”）。

我很想使用“...component.access_structures”

我在Oracle 站点上的 Java 约定中找不到任何提及的内容。一个简短的网络搜索没有带来任何结果。

此类名称的官方约定是什么？

Answer 1

来自Oracle 文档

包名称全部小写，以避免与类或接口的名称冲突。

公司使用他们的反向 Internet 域名来开始他们的包名称——例如，com.example.mypackage 表示一个程序员在 example.com 创建的名为 mypackage 的包。

单个公司内发生的名称冲突需要按照该公司内的惯例进行处理，可能通过在公司名称后包含地区或项目名称（例如，com.example.region.mypackage）。

在某些情况下，互联网域名可能不是有效的包名称。如果域名包含连字符或其他特殊字符，如果包名称以数字或其他字符作为 Java 名称的开头是非法的，或者包名称包含保留的 Java 关键字，则可能会发生这种情况，例如“int”。在这种情况下，建议的约定是添加下划线

尽管此文本没有指定您的确切大小写，但它确实说明对于无效的包名称，我们应该使用下划线。有人可能会争辩说，这accessStructures就是我们在 Java 中定义方法的方式，因此命名这样的包可能会令人困惑。总的来说，这真的取决于你。

如果你想遵守这个约定，我相信你应该命名你的包：

com.myemployer.project.component.access_structures

您也可以查找同义词并找到减少混淆的替代方法。我很快找到了一些：

• 访问框架
• 访问工厂
• 访问架构（accessarchitecture）
• 访问结构