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

8

Angenommen, wir haben ein Projekt namens project und Module module1 und module2 , verwende ich früher die folgende Benennungsstrategie:

%Vor%

Jetzt benutze ich einen anderen:

%Vor%

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

    
Maksim Sorokin 18.08.2010, 07:03
quelle

3 Antworten

14

Ich habe im Buch "Effective Implementation" einige Anmerkungen dazu gemacht, aber es gibt keine Regel oder kanonische Konvention.

Um einige zusammenzufassen:

Zuallererst ist das Wichtigste, dass Sie konsistent sind.

Die allgemeine Konvention von Maven verwendet '-' als Trennzeichen ( commons-lang , maven-model ).

Wenn Sie beabsichtigen, dass es extern verwendet wird, erinnern Sie sich an module = artifact ID = filename (in der besten Praxis), damit es erkennbar sein muss ( maven-model-2.0.jar ist klar, model-2.0.jar ist nicht). In diesem Fall wiederholen Sie normalerweise das letzte Element der Gruppen-ID als Mini-Namespace. "Interne" Module können es aus Platzgründen weglassen (Wie die Beispielanwendung zeigt: Ссылка ).

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

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

    
Brett Porter 18.08.2010, 12:49
quelle
4

Normalerweise versuche ich Modulnamen kurz zu halten. Wenn der Name "will" lang ist, ist das ein Hinweis darauf, dass eine andere Verschachtelungsebene wahrscheinlich eine gute Idee ist. Also statt dessen:

%Vor%

Ich würde die Dinge weiter verschachteln:

%Vor%

Durch Mavenreaktor-Optionen können Sie die verschachtelten Module, die von oben isoliert sind, noch erstellen:

%Vor%     
Sean Patrick Floyd 18.08.2010 15:07
quelle
2

Sie können sogar noch einen Schritt weiter gehen:

%Vor%

Kein Witz, das ist wirklich eine Frage des Geschmacks.

Schönen Tag noch Maksim

    
Boris Pavlović 18.08.2010 07:34
quelle

Tags und Links