SpringCloud多模块项目搭建

缺乏、安全感 2022-05-10 22:03 554阅读 0赞

## 多模块Maven项目 ##

为了便于统一的版本维护和管理，经常会用到Maven的多模块模式。

本文以以下模块结构为例，对如何创建多模块Maven项目进行描述。   
![这里写图片描述][70]

## 构建主工程 ##

首先创建一个Maven项目作为主工程，类型无所谓，这里建议使用`maven-archetype-quickstart`骨架，创建过程如下：

*  `File-->New-->Project`
 *  `-->Maven-->Create from archetype-->maven-archetype-quickstart-Next`
 *  `-->GroupId={你的GroupId}-->AritifactId={你的ArtifactId}`
 *  `-->Next-->Next-->Finish-->New Whindow`

本示例中，我的主项目叫`main-project`，`GroupId`和`AritifactId`的配置如下：   
![这里写图片描述][70 1]

## 构建子模块 ##

子模块项目创建于主工程之内，创建过程如下：

*  `右键点击项目名称-->New-->Module`
 *  `选中Spring Initializr-->Next`
 *  `-->Group={主工程的GroupId}-->Aritifact={当前模块的ArtifactId}`、
 *  `-->Next-->Next-->Finish`

本示例中，子模块的名称为`module-a`和`module-b`，`Group`和`Aritifact`的配置如下：   
![这里写图片描述][70 2]

通过同样的方式创建子模块`module-b`。

## 优化结构 ##

完成上述的主工程以及两个子模块创建之后，项目结构视图如下：   
![这里写图片描述][70 3]

下面对这个多模块项目进行优化。

删除主工程多余目录

并不需要在主工程进行任何代码开发，所以删除其`src`目录。

编辑主工程pom.xml

作为主工程，其`pom.xml`可以作为其他子模块工程的基准依赖，方便进行统一的版本管理。

将主工程`pom.xml`修改如下：

<?xml version="1.0" encoding="UTF-8"?>
    
    <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/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>pers.hanchao</groupId>
        <artifactId>main-project</artifactId>
        <version>1.0-SNAPSHOT</version>
        <name>main-project</name>
    
        
        <modules>
            <module>module-a</module>
            <module>module-b</module>
        </modules>
    
        
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.2.RELEASE</version>
            <relativePath/> 
        </parent>
    
        
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
            <spring-cloud.version>Dalston.SR1</spring-cloud.version>
        </properties>
    
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-eureka-server</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>
    
        
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${spring-cloud.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        
        <repositories>
            <repository>
                <id>spring-snapshots</id>
                <name>Spring Snapshots</name>
                <url>https://repo.spring.io/snapshot</url>
                <snapshots>
                    <enabled>true</enabled>
                </snapshots>
            </repository>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>
        </repositories>
    </project>

在上述的`pom.xml`文件中，主要做了以下几件事：

*  配置`Spring Boot`的版本
 *  配置`Spring Cloud`的版本
 *  配置微服务的一些基本组件，如`actuator`、`eureka`、`web`和`test`。
 *  配置编码方式
 *  配置`java`版本
 *  配置子模块

注意：`Spring Boot`和`Spring Cloud`有特定的对照关系，具体可参看：[http://projects.spring.io/spring-cloud/][http_projects.spring.io_spring-cloud]

### 编辑子模块pom.xml ###

子模块`pom.xml`可以引用主工程`pom.xml`的依赖关系，所以也对其进行配置，其中`module-a`的`pom.xml`配置如下：

从上面的配置可以得知，`module-a`从`主工程`中继承了一系列依赖关系，如`actuator`、`eureka`、`web`和`test`。

并且，`module-a`还可以对自己模块特有的一些依赖进行配置。

## 运行测试 ##

改写`module-a`的启动类`ModuleAApplication.java`，如下：

@RestController
    @SpringBootApplication
    public class ModuleAApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ModuleAApplication.class, args);
        }
    
        @GetMapping("/hi")
        public String hi(){
            return "Hello World!";
        }
    }

启动项目，在浏览器访问[http://localhost:8080/hi][http_localhost_8080_hi]，结果如图所示：   
![这里写图片描述][70 4]

说明配置成功。

原文链接：[https://blog.csdn.net/hanchao5272/article/details/80558780][https_blog.csdn.net_hanchao5272_article_details_80558780]

[70]: /images/20220511/3cc6feb8dac144e48df2d6eb4cbf0b57.png
[70 1]: /images/20220511/544413b7b9fa4bf9805ace9fee6924a2.png
[70 2]: /images/20220511/7e9dce12caff4e3a8758a7a031ae6c91.png
[70 3]: /images/20220511/e92911451d0049f1a7d3796f15601d7e.png
[http_projects.spring.io_spring-cloud]: http://projects.spring.io/spring-cloud/
[http_localhost_8080_hi]: http://localhost:8080/hi
[70 4]: /images/20220511/6bf00c83fbfa466196933e668a66de27.png
[https_blog.csdn.net_hanchao5272_article_details_80558780]: https://blog.csdn.net/hanchao5272/article/details/80558780