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包命名約定。