MAVEN 与 JAVA 包命名规范

抛出问题

在使用MAVEN搭建模块化项目时，我的组织结构如下：

root模块

文件夹名：package-module-project

pom.xml文件：

<project><groupId>com.chuillusion</groupId><artifactId>chuillusion-package</artifactId><version>0.0.1-SNAPSHOT</version><packaging>pom</packaging><modules><module>chuillusionCore</module><module>chuillusionBrowser</module><module>chuillusionApp</module><module>chuillusionDemo</module></modules>
</project>

子模块

2.1 核心模块
文件夹名：chuillusionCore

pom.xml文件：

<project><parent><artifactId>chuillusion-package</artifactId><groupId>com.chuillusion</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion><artifactId>chuillusion.core</artifactId>
</project>

Java包命名：com.chuillusion.cores为根包

存在问题

项目文件夹命名与maven中artifactId不一致

root模块项目命名为package-module-project，root所对应的artifactId命名为chuillusion-package

java包命名与maven不一致

核心模块中java根包命名为：com.chuillusion.cores，核心项目中artifactId命名为chuillusion.core

idea显示不一致

当项目名称与artifactId不一致时，idea则会在项目名则展示artifactId

如：chuillusionCore[chuillusion.core] ，即：项目名[artifactId]

命名规则探讨

官网说明

参考MAVEN官方文档中的命名规范

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

以驱动包案例分析

<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.43</version>
</dependency>

生成的包名称为：mysql:mysql-connector-java-5.1.43.jar，即为groupId:artifactId-version.jar

源码结构：com.mysql作为项目根包

疑问：个人感觉是没有按照规范进行命名的

assertj分析

<dependency><groupId>org.assertj</groupId><artifactId>assertj-core</artifactId><version>3.8.0</version>
</dependency>

源码结构：org.assertj.core作为根包

logback分析

<dependency><groupId>ch.qos.logback</groupId><artifactId>logback-classic</artifactId><version>1.3.0-alpha3</version><scope>test</scope>
</dependency>

源码结构：ch.qos.logback.classic作为根包

结论

1）源码包中需要有groupId开头，紧接artifactId作为根包

规范命名

养成良好的编码习惯，从命名规范做起

修改项目命名

项目名与artifactId相对应，源码目录与整体结构对应

root模块

项目名称：package-module-project

<project><groupId>com.chuillusion</groupId><artifactId>package-module-project</artifactId><version>0.0.1-SNAPSHOT</version><packaging>pom</packaging><modules><module>chuillusion-core</module><module>chuillusion-browser</module><module>chuillusion-app</module><module>chuillusion-demo</module></modules>
</project>

root项目为空结构，只有一个pom文件负责管理子模块，因此没有源码目录结构

核心模块修改

修改方式一：

项目名称：chuillusion-core

<project><parent><artifactId>package-module-project</artifactId><groupId>com.chuillusion</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion><artifactId>chuillusion-core</artifactId>
</project>

源码根目录结构：com.chuillusion.core

修改方式二

项目名称：core

<project><parent><artifactId>package-module-project</artifactId><groupId>com.chuillusion</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion><artifactId>core</artifactId>
</project>

源码根目录结构：com.chuillusion.core

说明

写这篇文章是因为1）项目中遇到的问题；2）在baidu上没有相关文章

欢迎各位留言指正文章的错误，谢谢！

---------------------
作者：楚丶迷梦
来源：CSDN
原文：https://blog.csdn.net/sinat_30254575/article/details/79735051
版权声明：本文为作者原创文章，转载请附上博文链接！
内容解析By：CSDN,CNBLOG博客文章一键转载插件

[转]maven与java命名规则相关推荐

java命名规则_Java命名规则
Java命名规则定义规范的目的是为了使项目的代码样式统一,使程序有良好的可读性. 命名规则: java源文件的命名如果有public类,那么源文件名就是public类名,一个文件中只能有一个pub ...
java命名规范怎么定义？java命名规则
在java刚刚入门时,我们可能首先就要了解java中一些常规的命名规范了,这也是必要的,否则当你以数字开头作为类名,都不知道为啥会报错.我们一起来看看,java命名规范是怎么定义呢?java命名规则和 ...
java命名规则与规范
标识符的使用 1.标识符:凡是自己可以起名字的地方都叫标识符. 比如:类名.变量名.方法名.接口名.包名- 2.标识符的命名规则: -->如果不遵守如下的规则,编译不通过!需要大家严格遵守 ①由 ...
Java命名规则和Java命名规范
Java的命名规则允许有下划线,数字,字母,$组成数字不能作为开头不能是关键字可以包含关键字区分大小写不能是true,false和null关键字 Java命名规范常量,都大写,如果是多单词 ...
java命名规则与命名规范
标识符命名规则在我们编写的程序中,我们所使用的变量名.类名.方法名等自定义的名称都叫做标识符在java中,标识符中可以包含字母.数字以及下划线和 $ 符号等等标识符不能以数字开头,也不能是关键字 ...
Java命名规则及规约
1.命名规则: 可以用字母.数字.字符以及中文命名: 字母需要区分大小写: 数字不可以放在开头首位: 字符可以用的只有:_ $: 不推荐使用中文命名: 2.命名规约: 类名:首字母大写,两个单词及以上 ...
java 全局变量命名规则_Java 基础运算符命名规则变量循环
1.程序: 一组指示计算机执行行动或坐车判断的指令,通常用某种程序设计语言编写,运行于某种目标体系结构上. 2.软件与计算机操作系统有关的计算机程序,规程.规则,以及可能有的文件,文档及数据 3.软 ...
Java中类、常量、变量、方法名等命名规则
Java中类.常量.变量.方法名等命名规则命名规则: 命名由字母.数字.下划线.美元符号($)构成. 命名不可以数字作为开头. 长度无限制,但不可存在空格. 大小写所表述内容含义不同. 命名不可与J ...
Java中包、类、方法、属性、常量的命名规则
1:包(package):用于将完成不同功能的类分门别类,放在不同的目录(包)下, 包的命名规则:对于包名:每个字母都需要小写. 将公司域名反转作为包名.比如www.baidu.com 比如:com. ...

[转]maven与java命名规则

MAVEN 与 JAVA 包命名规范

抛出问题

存在问题

命名规则探讨

Guide to naming conventions on groupId, artifactId and version

规范命名

说明

[转]maven与java命名规则相关推荐

最新文章

热门文章