Соглашение об именах для схем прототипов OLP

Я пытаюсь перенести часть нашей существующей схемы в OLP, используя архетип maven. Есть ли какое-либо соглашение об именовании, как должно выглядеть имя пакета? Мы обсуждаем, должно ли это быть "com.here.hdlm.protobuf.schema" или "com.here.schema.hdlm.protobuf". Или, может быть, мы должны даже пропустить протобуф из названия.

Благодарю.

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

HERE Artifact Service размещает только схемы Protobuf. Я бы рекомендовал не использовать в названии слова "protobuf" и "схема", поскольку они подразумеваются и удлиняют имя пакета.

В документации по публикации схемы Protobuf есть раздел, связанный с именованием: https://developer.here.com/olp/documentation/archetypes/dev_guide/topics/archetypes-best-practices.html

Это содержание раздела:

Именование пакетов

Вам будет предложено определить идентификатор группы, идентификатор артефакта и имя пакета для вашей схемы на этапе создания проекта схемы. Если вы не укажете имя пакета, вместо него будет использоваться идентификатор группы.

Идентификатор группы и идентификатор артефакта используются для создания ЗДЕСЬ имени ресурса (HRN) схемы после загрузки схемы в OLP. Например, HRN схемы HMC Building Footprints - hrn:here:schema:::com.here.schema.rib:building-footprints_v2:2.13.0.

Имя пакета используется в именах пакетов protobuf, Java и Scala.

В качестве идентификатора группы используйте обратное доменное имя вашей компании, например com.here.schema.rib.

В качестве идентификатора артефакта используйте имя, соответствующее типу схем, упакованных в проект, например, следы здания. Старайтесь, чтобы идентификатор артефакта был как можно короче.

Кроме того, убедитесь, что основная версия вашей схемы включена в имя вашего пакета. Например, версия 2.3 должна содержать v2 как часть имени пакета, например: com.here.platform.schema.foo.v2. Наличие основной версии в имени пакета дополнительно проверяется основной версией в Package Validator.

Мы рекомендуем следовать соглашениям об именах пакетов Java.

Другие вопросы по тегам