Maven артефакт и присвоение имен группам

В настоящее время я нахожусь в процессе переноса какого-то проекта из Ant в Maven. Конформист, как и я, я хочу использовать общепринятые соглашения для поиска groupIdи artifactId, но я не могу найти какие-либо подробные соглашения (есть некоторые, но они не охватывают вопросы, которые меня интересуют).

Возьмите этот проект, например, сначала пакет Java: com.mycompany.teatimer

Таймер чая на самом деле состоит из двух слов, но соглашения об именах пакетов Java запрещают вставку символов подчеркивания или дефиса, поэтому я пишу все это вместе.

Я выбрал groupIdидентичный идентификатору пакета, потому что думаю, что это хорошая идея. Это?

Наконец, я должен выбрать artifactId, я в настоящее время пошел на teatimer. Но когда я смотрю на других проектах Maven, они используют дефис для разделения слов в artifactIdсек, как это: tea-timer. Но это выглядит странно , когда присоединялись к groupId: com.mycompany.teatimer.tea-timer.

Как бы вы это сделали?

Другой пример:

Имя пакета: com.mycompany.awesomeinhouseframework

groupId: com.mycompany.awesomeinhouseframework(?)

artifactId: awesome-inhouse-framework(?)

Ваше соглашение кажется разумным. Если бы я искал ваш фреймворк в репозитории Maven, я бы искал awesome-inhouse-framework-x.y.jarв com.mycompany.awesomeinhouseframeworkкаталоге группы. И я нашел бы это там согласно вашему соглашению.

У меня работают два простых правила:

• обратные доменные пакеты для groupId (поскольку они довольно уникальны) со всеми ограничениями, касающимися имен пакетов Java
• имя проекта как artifactId (помните, что оно должно быть удобным для имени jar, то есть не содержать символов, которые могут быть недопустимы для имени файла или выглядят странно)

Странность очень субъективна, я просто предлагаю следовать официальной рекомендации:

Руководство по соглашениям об именах для groupId, artifactId и version

• groupIdбудет идентифицировать ваш проект уникально во всех проектах, поэтому нам нужно применить схему именования. Он должен следовать правилам имени пакета, что означает, что оно должно быть как минимум доменным именем, которым вы управляете, и вы можете создать столько подгрупп, сколько захотите. Посмотрите на Больше информации об именах пакетов .

  например. org.apache.maven,org.apache.commons

  Хороший способ определить гранулярность groupId - использовать структуру проекта. То есть, если текущий проект является проектом с несколькими модулями, он должен добавить новый идентификатор к groupId родителя.

  например. org.apache.maven, org.apache.maven.plugins, org.apache.maven.reporting

• artifactIdэто имя банки без версии. Если вы создали его, вы можете выбрать любое имя с строчными буквами и без странных символов. Если это баночка стороннего производителя, вы должны взять название банки по мере ее распространения.

  например. maven,commons-math

• versionесли вы распространяете его, вы можете выбрать любую типичную версию с номерами и точками (1.0, 1.1, 1.0.1, ...). Не используйте даты, поскольку они обычно связаны со сборками SNAPSHOT (ночные). Если это сторонний артефакт, вы должны использовать его номер версии, какой бы он ни был, и как бы странно это ни выглядело.

  например. 2.0, 2.0.1,1.3.1

Рассмотрим следующее для создания базового первого приложения Maven :

groupId

• com.companyname.project

artifactId

• проект

version

• 0.0.1

Однако я не согласен с официальным определением Руководства по соглашениям об именах для groupId, artifactId и версии, в котором предлагается, чтобы groupId должен начинаться с обратного доменного имени, которым вы управляете.

comозначает, что этот проект принадлежит компании, и orgозначает, что этот проект принадлежит социальной организации. Это нормально, но для таких странных доменов, как xxx.tv, xxx.uk, xxx.cn, не имеет смысла называть groupId, начинающийся с "tv.", "Cn.", GroupId должен предоставлять основную информацию проекта, а не домена.

Учтите это, чтобы получить полностью уникальный файл JAR:

• GroupID - com.companyname.project
• ArtifactId - com-название компании-проект
• Пакет - com.companyname.project