实战 | maven 轻松重构项目

川长思鸟来 2023-01-06 15:59 134阅读 0赞

![format_png][]

现在是微服务盛行时代，说不准哪一天领导就会让你对一个大项目进行重构。大项目的痛点：编译慢、发布繁琐等。就像下面这张图：

![format_png 1][]

真的不敢动呀，一不小心就坍塌了。

比如说我们用户系统，我们可以这么重构（这里只是举例，每个项目拆分目的可能不同）。

user-system拆分成：

*  `user-web`
 *  `user-service`
 *  `user-dao`
 *  `user-common`

我们对其拆分后很有可能存在多个子项目中同时依赖某个jar包，如果使用不当可能会导致每个模块使用的版本不一样，所以想想能不能有什么方式来解决这类问题呢？

答案：能。但是得先了解两个概念：聚合和继承。

### 聚合 ###

所谓的聚合就是我们如果想一次性构建多个项目模块，那我们就需要把这些项目模块进行聚合。

配置模板

<modules>
        <module>项目模块一</module>
        <module>项目模块二</module>
        <module>项目模块三</module>
        <module>项目模块...</module>
    </modules>

#### 使用方式 ####

比如我们对user-web、user-service、user-dao、user-common四个项目模块进行聚合。

<modules>
        <module>user-web</module>
        <module>user-service</module>
        <module>user-dao</module>
        <module>user-common</module>
    </modules>

注意：其中module的路径为相对路径。

这样就解决了我们项目模块的聚合，我们再来看看maven是如何来解决由于重复依赖导致版本不一样的问题。

### 继承 ###

继承为了消除重复，我们把很多相同的配置提取出来，例如：grouptId，version等 。

#### 继承的配置 ####

<parent>
        <artifactId>maven-demo</artifactId>
        <groupId>com.tian</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

#### 继承代码中定义属性 ####

继承代码过程中，可以定义属性，例如：

<properties>
       <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
       <junit.version>4.13.1</junit.version>
       <maven.version>0.0.1-SNAPSHOT</maven.version>
    </properties>

访问属性的方式为$\{junit.version\}，例如：

<?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">
        <parent>
            <artifactId>maven-demo</artifactId>
            <groupId>com.tian</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>user-web</artifactId>
    
        <dependencies>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                
                <version>${junit.version}</version>
            </dependency>
        </dependencies>
    </project>

这样我们就可以使用到上面定义的属性junit.version=4.13.1。

#### 父模块用dependencyManagement进行管理 ####

由于项目模块较多，所以我们又抽象了一层，抽出一个parent来管理子项目的公共的依赖。为了项目的正确运行，必须让所有的子项目使用依赖项的统一版本，必须确保应用的各个项目的依赖项和版本一致，才能保证测试的和发布的是相同的结果。

<dependencyManagement>
        <dependencies>
         <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
          </dependency>
         </dependencies>
    </dependencyManagement>

这样的好处是子模块可以有选择性的继承，而不需要全部继承。

![format_png 2][]

这样做的好处：统一管理项目的版本号，确保应用的各个项目的依赖和版本一致，才能保证测试的和发布的是相同的成果，因此，在顶层pom中定义共同的依赖关系。同时可以避免在每个使用的子项目中都声明一个版本号，这样想升级或者切换到另一个版本时，只需要在父类容器里更新，不需要任何一个子项目的修改；如果某个子项目需要另外一个版本号时，只需要在dependencies中声明一个版本号即可。子类就会使用子类声明的版本号，不继承于父类版本号。

### 聚合和继承的关系 ###

在前面我们构建多模块项目中，关系如下

![format_png 3][]

mavendemo就是user-web、user-service等几个模块的父项目。

父项目主要是用来配置一些公共的配置，其它三个项目再通过继承的方式拥有父项目中的配置，首先配置父项目的pom.xml，添加对项目的`user-web`、`user-service`、`user-dao`、`user-common`这四个模块进行聚合以及jar包依赖。

相对于dependencyManagement，所有生命在dependencies里的依赖都会自动引入，并默认被所有的子项目继承。

#### 面试题：dependencyManagement和dependencies的区别 ####

*  dependencyManagement里只是声明依赖，并不实现引入，因此子项目需要显示的声明需要用的依赖。如果不在子项目中声明依赖，是不会从父项目中继承下来的；只有在子项目中写了该依赖项，并且没有指定具体版本，才会从父项目中继承该项，并且version和scope都读取自父pom;另外如果子项目中指定了版本号，那么会使用子项目中指定的jar版本。
 *  dependencies即使在子项目中不写该依赖项，那么子项目仍然会从父项目中继承该依赖项（全部继承）。

#### IDEA中配置Maven ####

在使用IDEA开发时，如何将Maven配置呢？

打开IDEA，在File--->Settings。输入栏搜索：maven

![format_png 4][]

配置我们之前安装好的maven目录、maven下面的setting.xml以及本地仓库目录。然后Apply--->OK。

![format_png 5][]

我们项目对某个项目进行clean 等操作的时候，就可以直接双击Lifcycle下面的。

![format_png 6][]

这样我们就把Maven集成到我们的IDEA中来了。

#### 编译运行项目 ####

我们可以在父项目中对所有子项目进行编译、打包等。我们就来对所有子模块进行打包。

![format_png 7][]

然后在对应子项目中可以找到target目录和对应的jar包。

![format_png 8][]

也可单独对某个子项目进行打包等操作。比如我们对user-common进行clean。

![format_png 9][]

于是，此时的user-common下的target已经被删掉，其他子项目中并没有收到影响。

### IDEA中如何创建多项目模块 ###

先创建一个user-parent的maven项目：

![format_png 10][]

然后把src目录删掉，创建子项目：

选中user-parent项目，右键，选中New-->Module

![format_png 11][]

来到New Module界面，选择Maven，选好自己的本地安装的JDK。

![format_png 12][]

next。填写子项目名称，我们这里创建一个user-web的子项目：

![format_png 13][]

注意这里user-web，默认是userweb，需要我们手工在两个单词之间添加横线：

![format_png 14][]

点击Finish:

![format_png 15][]

然后在看看user-parent的pom中的内容：

![format_png 16][]

已经添加了modules，同时把我们的user-web添加进去了。

同样方法，我们就可以创建更多字项目了：

![format_png 17][]

再看看user-parent中的pom.xml文件内容：

![format_png 18][]

到这里，我们就轻轻松松的构建了我们这个大项目user-parent，该项目包括了user-web，user-service，user-dao，-user-commmon子项目。

若是新建多模块项目，安装上面的步骤就搞定了。

若是大项目拆分，我们就可以使用上面的方式先创建好自己的多模块项目，然后对应把大项目里的内容拷贝到对应模块中（需要注意此时子模块直接肯定会有相互依赖的）。

### 总结 ###

通过继承，我们可以定义项目的父类项目，用于继承父项目的依赖、插件、属性等信息。聚合就是我们如果想一次性构建多个项目模块，那我们就需要对这些项目模块进行聚合。

构建多模块项目，在IDEA中使用创建Module的方式很轻松就可以创建了。在父项目中使用来管理子模块的依赖相关依赖。

对大项目进行重构时，只需要把各模块拆分出来的代码拷贝到对应子模块就可以了。

**「没有天生的信心，只有不断培养的信心。」**

推荐阅读

[搞定这24道JVM面试题，要价30k都有底气~][24_JVM_30k]

[京东面试：说说MySQL的架构体系][MySQL]

[6000多字 | 秒杀系统设计注意点][6000_ _]

[程序员面试宝典.pdf下载][.pdf]

![format_png 19][]

[format_png]: /images/20221119/b5a01d86c8734bf68cdb94c3357cf4c6.png
[format_png 1]: /images/20221119/54f5d059327c43f6b86762b0816a107b.png
[format_png 2]: /images/20221119/5997354764de400f8580f7d3a513de32.png
[format_png 3]: /images/20221119/182775d7424c4de29df7d285bbb04f03.png
[format_png 4]: /images/20221119/ab736d89b86742e29873aee9ae851945.png
[format_png 5]: /images/20221119/f0b2e95107bb45e5a1f2a8d6f0f4f8f7.png
[format_png 6]: /images/20221119/0988780de3124f36a9659c69cddfbb2c.png
[format_png 7]: /images/20221119/c768e3a2d24d40db9fcbb0f97b917516.png
[format_png 8]: /images/20221119/156ae79eb98f41848d9302c560d92cc1.png
[format_png 9]: /images/20221119/53832d4a175d4066b923bdc6ea1ba94e.png
[format_png 10]: /images/20221119/b0560d2fe070468e8f1b07c96220b552.png
[format_png 11]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wN0JpY1p5d09WdGtKM1ZXZmljNnZpY0NiamNnaWNnVXNhSnVVUnRXRkZVaDlxeFcyQ2hSbnU1cHRYSEJTcDhPY2NCeUcxd2VLeGtsOTJCdTdhMXRFS050dkEvNjQw?x-oss-process=image/format,png
[format_png 12]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wN0JpY1p5d09WdGtKM1ZXZmljNnZpY0NiamNnaWNnVXNhSnVUYjdHMEhOQ08wRjhUS080bG44RHFyZUlTaWI4WnZDQXlhY1VvNWYxSlYyeHNEYWZsTWRpYkh1Zy82NDA?x-oss-process=image/format,png
[format_png 13]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wN0JpY1p5d09WdGtKM1ZXZmljNnZpY0NiamNnaWNnVXNhSnVDY2M3RkJUdTZpY1A0S2x4d2lhVjdhOUh2ZXpWMXpwY0lCNUV5dDlvUUZpYWlhQkFjYWRYVVBpY1lvdy82NDA?x-oss-process=image/format,png
[format_png 14]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wN0JpY1p5d09WdGtKM1ZXZmljNnZpY0NiamNnaWNnVXNhSnVteGF6bFdHWXpYbE1sdEkxT2dyYWVpYXhlMHlZbjJJQlM1MlhzTDhvTkVHZTgwNVhkTzRlS2liUS82NDA?x-oss-process=image/format,png
[format_png 15]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wN0JpY1p5d09WdGtKM1ZXZmljNnZpY0NiamNnaWNnVXNhSnV2QmlhakxaU3EyZzQ0eUxpYkpQdXBsOU5sSVM4WFBOcWlhaWNNa2x4OFZYMmljY0ZsNnFnbHBncGQzUS82NDA?x-oss-process=image/format,png
[format_png 16]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wN0JpY1p5d09WdGtKM1ZXZmljNnZpY0NiamNnaWNnVXNhSnVQSUZCcXU3VTc5WUQwdlBQc0x4TEt6dXRBMEdJZnBHWGxCTmZzNE5zdmlhQ1lwUVJpYUtXdU1xZy82NDA?x-oss-process=image/format,png
[format_png 17]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wN0JpY1p5d09WdGtKM1ZXZmljNnZpY0NiamNnaWNnVXNhSnV6bVZ5cXBubTRrOEtpYnh0TzgwcXNVUXhCSE8wUGtpY3AwZmpBenFVUzg5Q3Y2N1E1Q2oybWx1US82NDA?x-oss-process=image/format,png
[format_png 18]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wN0JpY1p5d09WdGtKM1ZXZmljNnZpY0NiamNnaWNnVXNhSnViUDBTTk96QXJpYjE2UjIxQllCUGliTTZjOUNjU2NEWW9CR0xOVlp2QWczeWpDOEwwQTV5eUtzdy82NDA?x-oss-process=image/format,png
[24_JVM_30k]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd554737ca22ce21f0ac7a525605d6a2fb019dbdd784760a88c1353616ed4cd76303b41350d0&idx=1&mid=2247495644&scene=21&sn=dbfe39e1b0c1df404b0ff7f81b1990fc#wechat_redirect
[MySQL]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd555c89ca22d59fc0d8621d54df92c29304d7b95a2f84561dc652c3051f4f4e2b7dc8d7fb2c&idx=1&mid=2247496802&scene=21&sn=baf7cd7489b7635dec3bf1a8908b85f8#wechat_redirect
[6000_ _]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd554364ca22ca725928445323212594625cb2052a1fb1ec27d76fc46c6b813afb942f761f0a&idx=1&mid=2247494543&scene=21&sn=af1c26ff3af473898b32c6256a01871d#wechat_redirect
[.pdf]: http://mp.weixin.qq.com/s?__biz=MzU4MDM3MDgyMA%3D%3D&chksm=fd5540c2ca22c9d43adaea71eac78fd27ccbc395d86ab9a0bd7058ec846752854ba6891c29aa&idx=2&mid=2247493673&scene=21&sn=56f250a42913fed1b56fe6be41810b56#wechat_redirect
[format_png 19]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy8wN0JpY1p5d09WdGtrNW5LTTFoT2FSMGlhWHhHSDdpYnVrUEpPUmpvcFRYOGxKNUVscHZyWFBtRzZKNUZlOGVlWUJvclNpYlJKeW00aWN5T1d1cHB5dHgxYzlBLzY0MA?x-oss-process=image/format,png