Maven artifact and groupId naming

maven-2 naming-conventions

I'm currently in the process of moving some project from Ant to Maven. Conformist as I am, I want to use well-established conventions for finding groupId and artifactId, but I can't find any detailed conventions (there are some, but they don't cover the points I'm wondering about).

Take this project for instance, first the Java package: com.mycompany.teatimer

Tea timer is actually two words, but the Java package naming conventions forbid the insertion of underscores or hyphens, so I'm writing it all together.

I chose the groupId identical to the package ID because I think that's a good idea. Is it?

Finally, I have to pick an artifactId, I currently went for teatimer. But when I look at other Maven projects, they use hyphens to split words in artifactIds, like this: tea-timer. But it does look weird when concatenated to the groupId: com.mycompany.teatimer.tea-timer.

How would you do this?

Another example:

Package name: com.mycompany.awesomeinhouseframework

groupId: com.mycompany.awesomeinhouseframework (?)

artifactId: awesome-inhouse-framework (?)

Community

Weirdness is highly subjective, I just suggest to follow the official recommendation:

Guide to naming conventions on groupId, artifactId and version groupId will identify your project uniquely across all projects, so we need to enforce a naming schema. It has to follow the package name rules, what means that has to be at least as a domain name you control, and you can create as many subgroups as you want. Look at More information about package names. eg. org.apache.maven, org.apache.commons A good way to determine the granularity of the groupId is to use the project structure. That is, if the current project is a multiple module project, it should append a new identifier to the parent's groupId. eg. org.apache.maven, org.apache.maven.plugins, org.apache.maven.reporting artifactId is the name of the jar without version. If you created it then you can choose whatever name you want with lowercase letters and no strange symbols. If it's a third party jar you have to take the name of the jar as it's distributed. eg. maven, commons-math version if you distribute it then you can choose any typical version with numbers and dots (1.0, 1.1, 1.0.1, ...). Don't use dates as they are usually associated with SNAPSHOT (nightly) builds. If it's a third party artifact, you have to use their version number whatever it is, and as strange as it can look. eg. 2.0, 2.0.1, 1.3.1

I know these conventions, but they don't really say how the artifact name should be made up (there are no JAR naming conventions) and what to do if it would be the same as the groupId - I haven't seen a single POM where that is the case.

@Noarth 1. The artifact name is at your discretion (but using hyphens in the name is a common practice). 2. You're looking for an absolute "rule" that doesn't exist (what if your awesome inhouse framework is made of several modules?). See for example the Spring, Maven, Hibernate, etc artifacts.

What about package? What's the difference to groupId?

Is the artifactId allowed to have numbers in it?

@PascalThivent I have no company. I create a maven project in IntelliJ for SDP course project. Is there any recommendation to choose these for personal project? I am new in Maven.

Dmitry Timofeev

Your convention seems to be reasonable. If I were searching for your framework in the Maven repo, I would look for awesome-inhouse-framework-x.y.jar in com.mycompany.awesomeinhouseframework group directory. And I would find it there according to your convention.

Two simple rules work for me:

reverse-domain-packages for groupId (since such are quite unique) with all the constrains regarding Java packages names

project name as artifactId (keeping in mind that it should be jar-name friendly i.e. not contain characters that maybe invalid for a file name or just look weird)

I find the mixture of non-hyphen (awesomeinhouseframework) and hyphen (awesome-inhouse-framework) spelling a bit strange. Since the groupid does not allow hyphens I would stick with the non hyphen spelling for the artifactid as well.

Please clarify what do you mean by "jar-name friendly" ?

Manwal

Consider following as for building basic first Maven application:

groupId

com.companyname

artifactId

project

version

0.0.1

As a work for hire should I use com.my.company.project as groupId or com.client.company.project?

@GiacomoAlzetta you can use any of formate suits you better. Some examples ‘com.companyName.hirePortal’ or ‘org.compnayName.hirePortal’.

groupId should be com.companyname not com.companyname.project

Stephen Rauch

However, I disagree the official definition of Guide to naming conventions on groupId, artifactId, and version which proposes the groupId must start with a reversed domain name you control.

com means this project belongs to a company, and org means this project belongs to a social organization. These are alright, but for those strange domain like xxx.tv, xxx.uk, xxx.cn, it does not make sense to name the groupId started with "tv.","cn.", the groupId should deliver the basic information of the project rather than the domain.

This convention is preventing developers using maven due to that you must possess a domain before deploying your artifacts to the central maven repository. It is ridiculous. Possessing a domain could be a pretty cost year by year.

There is no requirement to actually own a registration for that domain name. The only requirement is that your group Id, which will be your Java package name, not conflict with any other such name when deployed. This convention is certainly not preventing developers from using Maven.

A good practice is to derive package names from the repository URL. If you're using GitHub, your account is called myuser and your repository is called myrepo, then simply use the package name com.github.myuser.myrepo. That's free and still unique.

Maven artifact and groupId naming

Follow WeChat

Want to stay one step ahead of the latest teleworks?

相似问题

Platform

Support

Contact US