# quickstart

**Repository Path**: yuanchengman/quickstart

## Basic Information

- **Project Name**: quickstart
- **Description**: 用maven archetype搭建springboot 项目模板
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-08-16
- **Last Updated**: 2021-08-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: maven-archetype, SpringBoot

## README

### 项目说明
* 此项目是基础springboot的模板项目，集成了常用第三方jar包，方便快速搭建新项目

### 使用步骤

* 在项目根目录下执行下面命令，成功后会在target目录下生成generated-sources目录
```shell
  mvn archetype:create-from-project -Darchetype.properties=archetype.properties
  ```
* 找到/target/generated-sources/archetype/src/main/resources/archetype-resources/pom.xml，将原项目最外层的pom.xml中modules相关内容粘贴过去，并替换artifactId。
  
  *如果不做这一步，项目最终也可以正常创建，但创建出来的项目最外层pom.xml文件格式不对，会有很多莫名的换行。*
  ![img.png](img.png)
  ![img_1.png](img_1.png)
  ![img_2.png](img_2.png)
* 在/target/generated-sources/archetype下执行mvn install，将模板安装到本地
* 前面两步都完成后，执行`mvn archetype:generate`和相关参数即可在任意目录下用安装好的模板来创建项目了

**mvn archetype:generate命令参数详解**
* -DarchetypeGroupId：指定要用到的模板GroupId，不是自已随意命名的
* -DarchetypeArtifactId：指定要用到的模板ArtifactId，不是自己随意命名的
* -DarchetypeVersion：指定要用到的模板版本号，不是自己随意命名的
* -DgroupId：生成项目的GroupId，自主命名
* -DartifactId：生成项目的ArtifactId，自主命名
* -Dpackage：生成项目的包名，自主命名
* -Dversion：生成项目的版本号，自主命名

**示例**
```shell
mvn archetype:generate -DarchetypeGroupId=pers.ycm -DarchetypeArtifactId=quickstart-archetype -DarchetypeVersion=1.0.0 -DgroupId=com.ycm.shopping -DartifactId=ycm-shopping -Dpackage=com.ycm.shopping -Dversion=1.0.0
```

### 将archetype上传到私服
* 编辑/target/generated-sources/archetype/pom.xml，添加
  ```xml
  <distributionManagement>
      <repository>
          <id>xxx</id>
          <url>http://***/repository/release/</url>
      </repository>
  </distributionManagement>
  ```
  - id：与maven conf/setting.xml里面配置的私服server/id一样
  - url：使用私服repository地址，repository必须是hosted类型
* 在/target/generated-sources/archetype/pom.xml所在目录执行mvn deploy，提示build success即上传成功

### 使用私服中的archetype
* 在IDEA中依次打开 File->New->Project
![image.png](image.png)