Maven脚手架最佳实践

叁歲伎倆 2021-06-10 20:38 561阅读 0赞

# 背景和目标 #

开发新项目就需要搭建新工程，往往我们会从其他已有的项目中复制粘贴配置，经常不可避免的因为一些细节配置而踩坑，尤其对新人来说在对公司项目结构、基础中间件、配置、jar包版本还不了解的情况下，会浪费很多不必要的时间。基于这些痛点，希望能够达到以下目标：

*  统一规范项目结构、通用配置，约定大于配置。
 *  提升工作效率，集成公司基础中间件、基础util、代码生成工具等快速开发组件，并做到开箱即用。
 *  降低项目维护成本，易于组内成员相互协助时能快速上手。
 *  统一jar包管理，组内成员不用关心通用jar的版本，组内共同维护一个通用 `parent pom`，在jar包需要升级时，统一协调升级。

# 如何搭建脚手架 #

要搭建脚手架，首先我们需要一个模板工程，这个模板工程会集成一些工具类，通用配置，公司中间件，代码自动生成工具等，并且要有良好的分层结构等，达到开箱即用的标准，以下是按照阿里java开发规范制定的项目结构。

.
    ├── example-common
    │   ├── pom.xml
    │   └── src
    ├── example-dao
    │   ├── pom.xml
    │   └── src
    ├── example-domain
    │   ├── pom.xml
    │   └── src
    ├── example-manager
    │   ├── pom.xml
    │   └── src
    ├── example-message
    │   ├── pom.xml
    │   └── src
    ├── example-service
    │   ├── pom.xml
    │   └── src
    ├── example-web
    │   ├── pom.xml
    │   └── src
    ├── README.md
    ├── .gitignore
    └── pom.xml

定义脚手架根 `pom` 的 `maven` 坐标

<parent>
        <groupId>com.company.framework</groupId>
        <artifactId>dependencies-parent</artifactId>
        <version>1.0.0</version>
    </parent>
    <groupId>com.company</groupId>
    <artifactId>example</artifactId>
    <version>1.0-SNAPSHOT</version>

在父 `pom` 中添加以下插件

<build>  
        <pluginManagement>  
            <plugins>  
                
                <plugin>  
                    <groupId>org.apache.maven.plugins</groupId>  
                    <artifactId>maven-archetype-plugin</artifactId>   
                </plugin>  
                <plugin>  
                    <groupId>org.apache.maven.plugins</groupId>  
                    <artifactId>maven-compiler-plugin</artifactId>  
                    <configuration>  
                        <source>1.8</source>  
                        <target>1.8</target>  
                    </configuration>  
                </plugin>  
                <plugin>  
                    <groupId>org.apache.maven.plugins</groupId>  
                    <artifactId>maven-resources-plugin</artifactId>  
                    <configuration>  
                        <encoding>UTF-8</encoding>  
                    </configuration>  
                </plugin>
                
                <plugin>
    		<groupId>org.codehaus.mojo</groupId>
    		<artifactId>versions-maven-plugin</artifactId>
    		<configuration>
    		    <generateBackupPoms>false</generateBackupPoms>
    		</configuration>
    	    </plugin>  
            </plugins>  
        </pluginManagement>  
    </build>

重命名 `.gitignore` 文件为 `__gitignore__`，并在模板工程根目录下创建 `archetype.properties` 文件，添加以下内容

# 排除打包到脚手架中的文件
    excludePatterns=archetype.properties,*.iml,.idea/,logs/,build.sh
    # maven脚手架会丢弃.gitignore文件，需要重命名为__gitignore__，脚手架会把__XX__的文件按照配置进行替换
    gitignore=.gitignore

完成之后在根目录下执行

mvn archetype:create-from-project -Darchetype.properties=archetype.properties

执行完成后，会发现在 `./target/generated-sources/archetype` 目录下生成了脚手架工程，生成的脚手架工程可以当成是一个独立的项目，目录结构如下

.
    ├── pom.xml
    ├── src
    │   ├── main
    │   │   └── resources
    │   │       ├── META-INF
    │   │       │   └── maven
    │   │       │       └── archetype-metadata.xml
    │   │       └── archetype-resources
    │   │           ├── __rootArtifactId__-common
    │   │           │   ├── pom.xml
    │   │           │   └── src
    │   │           ├── __rootArtifactId__-dao
    │   │           │   ├── pom.xml
    │   │           │   └── src
    │   │           ├── __rootArtifactId__-domain
    │   │           │   ├── pom.xml
    │   │           │   └── src
    │   │           ├── __rootArtifactId__-manager
    │   │           │   ├── pom.xml
    │   │           │   └── src
    │   │           ├── __rootArtifactId__-message
    │   │           │   ├── pom.xml
    │   │           │   └── src
    │   │           ├── __rootArtifactId__-service
    │   │           │   ├── pom.xml
    │   │           │   └── src
    │   │           ├── __rootArtifactId__-web
    │   │           │   ├── pom.xml
    │   │           │   └── src
    │   │           ├── __gitignore__
    │   │           ├── README.md
    │   │           └── pom.xml
    │   └── test
    │       └── resources
    │           └── projects
    │               └── basic
    │                   ├── archetype.properties
    │                   └── goal.txt

在 `./target/generated-sources/archetype` 目录下执行 `mvn install` 就完成了脚手架项目的本地安装，如果需要推送到公司私服，需要在脚手架工程 `pom` 中添加如下内容，并执行 `mvn deploy` 完成私服推送。

<distributionManagement>
        <snapshotRepository>
            <id>libs-snapshots-local</id>
    	<name>libs-snapshots</name>
    	<url>你的私服快照仓库地址</url>
        </snapshotRepository>
        <repository>
            <id>libs-releases-local</id>
    	<name>libs-releases</name>
    	<url>你的私服releases仓库地址</url>
        </repository>
    </distributionManagement>
    复制代码

## 如何使用脚手架 ##

### 命令方式 ###

输入以下命令，根据提示输入 `groupId` 和 `artifactId`，其他选项直接按 `Enter` 跳过。  
注意: 本地 `maven setting.xml` 文件需要提前配置好 `maven` 私服地址。

mvn archetype:generate 
    -DarchetypeGroupId=com.company 
    -DarchetypeArtifactId=example-archetype 
    -DarchetypeVersion=1.0-SNAPSHOT

### idea界面方式 ###

1.  依次点击 `File -> New -> Project`，按照下图新增脚手架，填写脚手架 `GroupId、ArtifactId、Version` ，`Repository` 填写 `maven` 私服地址。
    
    ![image.png][]
    
     
2.  选中第一步新增的脚手架，点击 `Next` 填写自己项目的`GroupId、ArtifactId、Version`，一直点击 `Next` 完成项目生成。
    
    ![image.png][image.png 1]
    
     
3.  生成项目结构如下，至此，代码框架已经生成，可以进行业务代码的编写了。
    
    ![image.png][image.png 2]

[image.png]: /images/20210527/cd46876678794fd1a9f8f5ef8861b1ff.png
[image.png 1]: /images/20210527/75da9b0c8cc542a180fb4114b9528017.png
[image.png 2]: /images/20210527/19032a5f824f4e0189768cad9f0f1629.png