Java 怎么借助构建工具生成符合规范的模块结构

千丽小哥_2951

千丽小哥_2951

2026-09-06

227人浏览

原创

java项目结构由maven或gradle按约定自动生成,非手动创建;执行archetype命令可秒级生成标准骨架,多模块需父pom或settings.gradle统一管理,生成后须核查resources分离、类名文件名一致、依赖引用规范及gitignore/mvnw纳入版本控制。

java 怎么借助构建工具生成符合规范的模块结构

Java 项目结构不是靠手动建文件夹凑出来的,而是由构建工具(Maven 或 Gradle)按约定自动生成的。只要命令用对、参数配准,几秒钟就能得到 src/main/java、src/test/java、pom.xml(或 build.gradle)齐全的标准骨架。

用 Maven archetype 快速生成单模块标准结构

Maven 内置原型机制是最直接的方式。执行以下命令即可生成符合 Java 标准目录规范的项目:

  • 必须指定 archetypeArtifactId:比如 maven-archetype-quickstart(普通 Java 库)或 maven-archetype-webapp(Web 项目),否则可能拉取过时模板,缺 resources 目录或编译插件
  • 包路径自动对齐 groupId:如 -DgroupId=com.example.user,生成后类文件会自动落在 src/main/java/com/example/user/ 下,且源码中 package 声明也匹配
  • 测试结构同步生成:src/test/java/com/example/user/ 和 src/test/resources/ 一并创建,确保 @Test 类能被正确识别,测试配置不污染主包

用 Maven 创建多模块项目(父子结构)

多模块不是“多个独立项目”,而是一个根 POM 统筹管理多个子模块。关键在三步:设父为 pom、声明 modules、子模块继承 parent。

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 根 pom.xml 必须设 <packaging>pom</packaging>,并在 <modules></modules> 中列出子模块路径(如 <module>common</module>),路径区分大小写、不能有空格或斜杠错误
  • 每个子模块有自己的 pom.xml,含 <parent></parent> 指向根,<packaging>jar</packaging>(或 war),依赖通过 <dependency></dependency> 引用同父下的其他模块(版本可继承,无需硬编码)
  • IDE 需主动导入 Maven 项目:IntelliJ IDEA 打开根目录 → 选 “Import project from external model” → 勾选 Maven;Eclipse 用 File → Import → Maven → Existing Maven Projects。否则模块间依赖连线不会显示,代码跳转失效

用 Gradle 创建多模块项目

Gradle 多模块更轻量,靠 settings.gradle 声明模块,各模块 build.gradle 独立配置,适合强调灵活性和脚本化控制的团队。

  • 根目录下创建 settings.gradle,用 include "common", "service", "web" 注册子模块,路径即子目录名(如 ./common)
  • 子模块目录自带 build.gradle,可定义自身插件(如 java-library)、依赖(implementation project(":common"))和发布配置
  • 资源与源码路径仍需严格对应:即使不用 Maven,Gradle 默认也遵循 src/main/java/com/example/... 结构,包声明必须与物理路径一致,否则编译报 package does not exist

生成后必须检查的关键细节

工具能搭出骨架,但规范落地靠人工核验。以下四点最容易出错,建议生成后立即确认:

  • src/main/resources 和 src/test/resources 是否分离:前者打包进 jar,后者仅测试期生效;.properties/.yml 文件绝不能放进 java 目录,否则编译器会尝试“编译”文本文件而报错
  • 所有 .java 文件名必须与 public 类名完全一致(大小写敏感),且一个文件只放一个 public 类;工具类别堆进 CommonUtils,应按职责拆成 DateFormatters、JsonValidators 等专用类
  • 模块间依赖是否用 artifactId 引用,而非本地路径:比如 <artifactid>common</artifactid>,不是 ../common;Maven install 后 jar 会进本地仓库,供跨项目复用
  • .gitignore 和 mvnw(Maven Wrapper)应纳入版本控制:保证不同开发机使用统一 Maven 版本,避免 “在我机器上能跑” 类问题

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10017

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7162

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6312

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1084

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

908

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1316

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2629

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19971

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1175

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习