OLP Protobuf模式的命名约定

Question

我正在尝试使用maven原型将一些现有架构迁移到OLP。 软件包名称应该是什么样的命名约定？ 我们正在辩论应该是“ com.here.hdlm.protobuf.schema”还是“ com.here.schema.hdlm.protobuf”。 也许我们甚至应该从名称中跳过protobuf。

谢谢。

Answer 1

您绝对应该使用将项目名称放在反向互联网域名和公司名称之后的约定，即https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html ，即“ com.here.hdlm ”

至于“ protobuf.schema”，“ schema.protobuf”还是跳过protobuf，这取决于您。

作为其他参考-https://developer.here.com/olp/documentation/data-user-guide/portal/schemas-creating.html

Answer 2

这里的工件服务仅托管Protobuf模式。 我建议不要在名称中使用单词“ protobuf”和“ schema”，因为这暗示并会使软件包名称更长。

Protobuf Schema发布文档的一部分与命名有关： https : //developer.here.com/olp/documentation/archetypes/dev_guide/topics/archetypes-best-practices.html

这是本节的内容：

包命名

在生成模式项目的阶段，系统会提示您定义模式的组ID，工件ID和程序包名称。 如果您未指定任何软件包名称，则使用组ID。

将架构上载到OLP后，组ID和工件ID将用于生成架构的HERE资源名称（HRN）。 例如，“ HMC建筑足迹”架构的HRN为hrn：here：schema :::: com.here.schema.rib：building-footprints_v2：2.13.0。

程序包名称用于protobuf，Java和Scala程序包名称中。

对于组ID，请使用公司的反向域名，例如com.here.schema.rib。

对于工件ID，请使用特定于项目中打包的模式类型的名称，例如建筑物占地面积。 尝试使工件ID尽可能短。

另外，请确保方案的主要版本包含在软件包名称中。 例如，版本2.3应将v2作为其软件包名称的一部分，例如：com.here.platform.schema.foo.v2。 软件包名称中是否存在主要版本，还可以通过软件包验证程序中的主要版本进行验证。

我们建议遵循Java包命名约定。