Was sind Best Practices für die Benennung von Maven-Modulen?

Question

Unter der Annahme, dass wir ein Projekt mit dem Namen project und Module module1 und module2, früher neige ich dazu, die folgende Benennungsstrategie zu verwenden:

Jetzt benutze ich eine andere:

-- project 
    -- project-module1 
    -- project-module2 

Was für Best Practices Maven Module benennen?

Answer 1

ich einige Anmerkungen zu diesem Thema in der „Effektive Implementation“ Buch geschrieben, aber es gibt keine Regel oder kanonischen Konvention.

Zunächst einmal die wichtigsten Dinge ist, dass Sie konsistent sind:

etwas zusammenzufassen.

Allgemeine Maven Konvention verwendet '-' als Trennzeichen (commons-lang, maven-model).

Wenn Sie beabsichtigen, es extern genutzt werden, erinnere mich an die module = artifact ID = filename (Best Practice), so ist es erkennbar sein muss (maven-model-2.0.jar klar ist, model-2.0.jar nicht ist). In diesem Fall wiederholen Sie normalerweise das letzte Element der Gruppen-ID als Mini-Namespace. "Interne" Module können es der Kürze wegen weglassen (Wie die Beispielanwendung zeigt: http://github.com/brettporter/centrepoint/tree/master/centrepoint/modules/).

Abgesehen davon, würde ich halten sie so kurz wie möglich.

Sie können die Parallele zwischen Java-Paket- und Klassenbenennungskonventionen auf Maven-Gruppen- und Artefakt-IDs beziehen.

Answer 2

Sie können sogar noch einen Schritt weiter gehen:

-- project 
    -- project-module-1 
    -- project-module-2 

jetzt kein Scherz, das ist wirklich eine Frage des Geschmacks ist.

Haben Sie einen schönen Tag Maksim

Answer 3

Ich versuche normalerweise Modulnamen kurz zu halten. Wenn der Name "will" lang ist, ist das ein Hinweis darauf, dass eine andere Verschachtelungsebene wahrscheinlich eine gute Idee ist. Anstatt also diese:

- root 
    - api 
    - impl 
    - security 
    - service-soap 
    - service-rest 
    - client-swing 
    - client-web-html 
    - client-web-mobile 

I Nest Dinge würden weiter:

- root 
    - api 
    - impl 
    - security 
    - service 
     - soap 
     - rest 
    - client 
     - swing 
     - web 
      - html 
      - mobile 

durch Maven Reaktor Optionen können Sie immer noch die verschachtelte Module von oben isoliert bauen:

mvn -pl client/web clean install