首页 > 其他分享 >如何使用 Maven 搭建 Spring Boot 父子项目？

如何使用 Maven 搭建 Spring Boot 父子项目？

时间：2024-04-04 15:33:31浏览次数：28  
标签：parent Spring boot Maven common Boot org com starter

大家好，我是磊磊落落，目前我在技术上主要关注：Java、Golang、架构设计、云原生和自动化测试。欢迎来我的博客（leileiluoluo.com）获取我的最近更新！

本文探索如何使用 Maven 来搭建 Spring Boot 父子项目，方便我们在搭建 Spring Boot 微服务时作参考。

使用 Maven 搭建 Spring Boot 微服务项目时，最直接的做法是在每个项目的pom.xml中直接引用 Spring Boot Starter 父项目org.springframework.boot:spring-boot-starter-parent，并配置各项依赖。

但有多个微服务项目时，若要升级它们各自pom.xml中的依赖会产生大量的重复工作。因此，若将这些公共依赖抽取到一个父项目中，而这些子项目都引用这个父项目，那么依赖可在父项目中统一管理；这样，子项目若需升级，只需升级一下引用的父项目版本，升级过程将会变得非常简单。

本文接下来即会创建一个示例 Spring Boot 父项目，并尝试在子项目中引用并使用它。

写作本文时，用到的 Java、Maven 和 Spring Boot 的版本分别为：

  • Java: 1.8
  • Maven: 3.9.0
  • Spring Boot: 2.7.9

1 创建父项目

首先，开始搭建父项目starter-parent，父项目可包括多个子模块，本文的例子仅含common-utils一个子模块，该子模块用于编写项目用到的工具类。

下面使用mvn archetype:generate来生成项目的脚手架。

首先，使用如下命令生成starter-parent空项目，生成后删除不用的src文件夹，并修改pom.xml中的<packaging>为pom。

mvn archetype:generate  \
    -DgroupId=com.leileiluoluo \
    -DartifactId=starter-parent \
    -Dversion=1.0-SNAPSHOT \
    -DinteractiveMode=false

然后，进入starter-parent文件夹下，生成子模块common-utils，命令如下：

cd starter-parent/

mvn archetype:generate  \
    -DgroupId=com.leileiluoluo \
    -DartifactId=common-utils \
    -Dversion=1.0-SNAPSHOT \
    -DinteractiveMode=false

这样，项目脚手架就出来了，目录结构如下：

starter-parent
 |-- common-utils
 |   |-- src/main/java
 |   `-- pom.xml
 `-- pom.xml

修改下两个pom.xml文件，使配置更简单紧凑；并在common-utils下加一个工具类DataUtil.java。

修改后，项目目录结构如下：

starter-parent
 |-- common-utils
 |   |-- src/main/java
 |   |   `-- com/leileiluoluo/common/util/DataUtil.java
 |   `-- pom.xml
 `-- pom.xml

下面看一下该项目下几个文件的源码。

1.1 pom.xml

根 POM，注意<parent>引用了spring-boot-starter-parent；<packaging>类型为pom；<dependencyManagement>定义了所有的公共依赖；<pluginManagement>定义了所有的公共插件。

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.9</version>
        <relativePath/>
    </parent>

    <groupId>com.leileiluoluo</groupId>
    <artifactId>starter-parent</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <java.version>1.8</java.version>
        <spring.boot.version>2.7.9</spring.boot.version>
    </properties>

    <modules>
        <module>common-utils</module>
    </modules>

    <dependencyManagement>
        <dependencies>
            <!-- modules -->
            <dependency>
                <groupId>com.leileiluoluo</groupId>
                <artifactId>common-utils</artifactId>
                <version>${version}</version>
            </dependency>

            <!-- spring boot starters -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <version>${spring.boot.version}</version>
            </dependency>

            <!-- test -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <version>${spring.boot.version}</version>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.junit.jupiter</groupId>
                <artifactId>junit-jupiter-api</artifactId>
                <version>5.9.2</version>
                <scope>test</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

1.2 common-utils/pom.xml

common-utils子模块 POM，注意<groupId>与<parent>中的一致，所以可以省略；<dependency>中的<version>已在父 POM 中声明，可以省略。

<?xml version="1.0"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"
         xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.leileiluoluo</groupId>
        <artifactId>starter-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>common-utils</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

1.3 common-utils 下的 DataUtil.java

DataUtil.java为common-utils子模块下的 Java 类，供后面的项目使用。

package com.leileiluoluo.common.util;

import java.time.ZonedDateTime;
import java.time.format.DateTimeFormatter;

public class DateUtil {

    public static String getCurrentTimeStr() {
        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
        return ZonedDateTime.now().format(formatter);
    }

}

接下来尝试创建一个项目来引用这个父项目。尝试之前，使用 Maven 将该项目打包并安装到本地。

命令如下：

mvn clean install

...
[INFO] Reactor Summary for starter-parent 1.0-SNAPSHOT:
[INFO]
[INFO] starter-parent ..................................... SUCCESS [  0.170 s]
[INFO] common-utils ....................................... SUCCESS [  1.330 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.658 s
[INFO] Finished at: 2023-03-14T10:34:43+08:00
[INFO] ------------------------------------------------------------------------

2 使用父项目

下面创建子项目app-child来使用前面的父项目starter-parent。

创建后的子项目目录结构如下：

app-child
 |-- src/main/java
 |   `-- com/leileiluoluo/app/DemoApplication.java
 `-- pom.xml

下面接着看一下该项目下的几个文件，然后尝试启动项目并做测试。

2.1 pom.xml

该项目 POM，注意<parent>引用了前面搭建好的starter-parent；<packaging>采用默认类型jar；<dependencies>下引用的公共依赖均无需指定<version>；plugins下引用的公共插件也无需指定<version>。

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.leileiluoluo</groupId>
        <artifactId>starter-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>app-child</artifactId>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.leileiluoluo</groupId>
            <artifactId>common-utils</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2.2 DemoApplication.java

仅写了一个 API hello，在其方法内调用了父项目模块common-utils中的DateUtil.getCurrentTimeStr()方法。

package com.leileiluoluo.app;

import com.leileiluoluo.common.util.DateUtil;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @GetMapping("/hello")
    public String hello(@RequestParam(value = "name", defaultValue = "World") String name) {
        return String.format("Hello %s! %s", name, DateUtil.getCurrentTimeStr());
    }

}

2.3 启动与测试

下面使用 Maven 将该项目打包，然后运行打包好的jar包，命令如下：

cd app-child/
mvn clean package

java -jar target/app-child-1.0-SNAPSHOT.jar

启动完成后，使用curl请求一下，会得到如下内容。

curl 'http://localhost:8080/hello?name=Larry'

Hello Larry! 2023-03-13 16:31:23

综上，本文探索了如何使用 Maven 来搭建 Spring Boot 父子项目，方便我们在搭建 Spring Boot 微服务时作参考。本文中涉及的父项目starter-parent与子项目app-child的完整代码已托管至 GitHub，欢迎关注或 Fork。

参考资料

[1] Introduction to the POM | Maven - maven.apache.org

[2] Introduction to the Dependency Mechanism | Maven - maven.apache.org

[3] Guide to Working with Multiple Modules | Maven - maven.apache.org

[4] Spring Boot | Spring - spring.io

[5] Maven by Example: A Multi-Module Project | TheNEXUS - books.sonatype.com

[6] Multi-Module Project with Maven | Baeldung - www.baeldung.com

[7] Spring Boot Multi-Module Maven Project | HowToDoInJava - howtodoinjava.com

标签：parent,Spring,boot,Maven,common,Boot,org,com,starter
From： https://blog.csdn.net/leileiluoluo/article/details/137333452

相关文章

  • 如何快速搭建一个 Spring Boot 项目？
    大家好，我是磊磊落落，目前我在技术上主要关注：Java、Golang、架构设计、云原生和自动化测试。欢迎来我的博客（leileiluoluo.com）获取我的最近更新！SpringBoot可以用最少的配置来快速创建一个独立的、生产级的Spring应用程序。本文介绍如何快速搭建一个SpringBoot「Hello......
  • 从零开始学Spring Boot系列-集成MyBatis-Plus
    在SpringBoot应用开发中，MyBatis-Plus是一个强大且易于使用的MyBatis增强工具，它提供了很多实用的功能，如代码生成器、条件构造器、分页插件等，极大地简化了MyBatis的使用和配置。本篇文章将指导大家如何在SpringBoot项目中集成MyBatis-Plus。一、项目准备首先，确保你已经安装了Jav......
  • SpringSecurity认证和授权流程详解
    什么是SpringSecuritySpringSecurity是一个Java框架，用于保护应用程序的安全性。它提供了一套全面的安全解决方案，包括身份验证、授权、防止攻击等功能。SpringSecurity基于过滤器链的概念，可以轻松地集成到任何基于Spring的应用程序中。它支持多种身份验证选项和授权策略，开发人员......
  • Spring Boot3.x 体验
    参考https://start.spring.io/环境环境版本说明WindowsWindows10专业版22H219045.4170VSCode1.87.2SpringBootExtensionPackv0.2.1vscode插件ExtensionPackforJavav0.25.15vscode插件JDK17下载主页、msi下载SpringBoot3.2......
  • SpringBoot医院信管系统设计与实现毕设(文档+源码）
            目录一、项目介绍二、开发环境三、功能介绍四、核心代码五、效果图六、源码获取：        大家好呀，我是一个混迹在java圈的码农。今天要和大家分享的是一款基于SpringBoot大学生体质测试管理系统，项目源码请点击文章末尾联系我哦~目前有各类成......
  • 【spring】Spring Cloud Alibaba版本发布说明
    SpringCloudAlibaba版本发布说明由于SpringBoot3.0，SpringBoot2.7~2.4和2.4以下版本之间变化较大，目前企业级客户老项目相关SpringBoot版本仍停留在SpringBoot2.4以下，为了同时满足存量用户和新用户不同需求，社区以SpringBoot3.0和2.4分别为分界线，同时维护......
  • jquery的blockUI遮罩层的使用(1)，bootstrap前端开发
    //pluginmethodforblockingelementcontent$.fn.block=function(opts){if(this[0]===window){$.blockUI(opts);returnthis;}varfullOpts=$.extend({},$.blockUI.defaults,opts||{});this.each(function(){var$el=$(this);if(fullOpts......
  • 免费分享一套SpringBoot+Vue健身房管理系统，帅呆了~~
    大家好，我是java1234_小锋老师，看到一个不错的SpringBoot+Vue健身房管理系统，分享下哈。项目视频演示【免费】SpringBoot+Vue健身房管理系统Java毕业设计_哔哩哔哩_bilibili【免费】SpringBoot+Vue健身房管理系统Java毕业设计项目来自互联网，免费开源分享，严禁商业。更多毕业设......
  • SpringMVC学习笔记
    1、概述基于java实现的实现mvc模型的轻量级web框架SpringMVC是一种表现层的框架技术，用于web层的功能开发，是对Servlet进行的封装主要的作用是接收请求和数据，响应结果，所以如何处理请求和响应是SpringMVC的重点​ 之前的开发将后端服务器Servlet拆分成三层，分别是web、service......
  • 五、SpringCloud alibaba 之 nacos配置中心
    https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config5.1、创建配置文件进去Nacos的服务端，在服务端的配置管理功能里面的配置列表里面创建一个配置文件在创建配置文件时，要填写dataId在NacosSpringCloud中，dataId的完整格式如下：${prefix}-${spring.pro......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99