言

在多数企业的软件开发生态中，项目初始化往往遵循一套既定的模板规范，通常需要集成一些公司内部的中间件、通用的代码分层、标准的代码格式等等。传统的项目启动方式是简单复制旧项目并手动调整包名与配置，不仅效率低下，且容易因人为疏忽而导致错误，增加了项目的维护成本与风险。

Maven Archetype 作为一种项目模板工具，能够让我们轻松定义项目的基础结构，包括必要的依赖、配置文件模板乃至特定的代码片段，从而实现新项目的标准初始化。这不仅极大地简化了项目创建的流程，减少了重复劳动，还确保了项目的一致性和规范性，让开发者能够更专注于核心业务逻辑的实现。

什么是 Maven Archetype

Maven Archetype 是 Maven 项目中的一种模板机制，它可以根据已有项目生成一个模板项目，为我们快速创建一个 Maven 项目的骨架结构，包括目录、文件和配置等。这样，我们就可以基于这个标准化的项目结构快速启动新项目，而无需从头开始编写所有内容。

如何自定义 Archetype

1. 将 Maven 的 settings.xml 复制一份到.m2 目录下。
2. 进入项目根目录，执行 maven 命令：

mvn archetype:create-from-project

执行成功后，项目根目录下会生成 target 文件夹。

3. 删除项目根目录下 target 目录下的无用文件夹（如.idea、test、target 等）。
4. 将 target\generated-sources\archetype 复制一份到任意位置（防止被意外 mvn clean）。
5. 打开复制出来的项目，修改父 pom。

• 添加缺失的 module 信息

<modules>
    <module>${rootArtifactId}-adapter</module>
    <module>${rootArtifactId}-app</module>
    <module>${rootArtifactId}-client</module>
    <module>${rootArtifactId}-common</module>
    <module>${rootArtifactId}-domain</module>
    <module>${rootArtifactId}-infrastructure</module>
    <module>${rootArtifactId}-start</module>
</modules>

修改 dependencyManagement 下依赖引用的各个 module，改为如下格式：

<dependency>
    <groupId>${groupId}</groupId>
    <artifactId>${rootArtifactId}-adapter</artifactId>
    <version>${project.version}</version>
</dependency>

如何使用 Archetype

1. 在修改完成之后的 archetype 项目根目录下，执行 maven 命令：

mvn install

执行成功后，.m2\repository 目录下会生成 archetype-catalog.xml 文件。

2. 将此文件添加到 IDEA 的 archetype catalogs 中

3. 新建项目时，选择刚刚的 Catalog 和 Archetype，填写项目信息后直接创建即可。

如何共享 Archetype

1. 在修改完成之后的 Archetype 项目根目录下，执行 maven 命令：

mvn deploy

2. 将archetype-catalog.xml上传至 oss，得到一个 url。
3. 团队其他成员可将此 url 添加到 IDEA 的 archetype catalogs 中，其余使用 Archetype 步骤同上。

总结

Maven Archetype 是一个强大的工具，它可以帮助我们快速创建项目的骨架结构，节省了繁琐的配置和初始化工作。通过自定义 Archetype，我们可以根据项目需求定制模板，提高开发效率。使用 Archetype 时，只需在 IDEA 中添加相应的 Catalog 和 Archetype，填写项目信息即可快速创建项目。希望本文能帮助你更好地了解和使用Maven Archetype。

参考资料

1. https://maven.apache.org/archetype/index.html
2. https://baeldung-cn.com/maven-archetype

作者:当贝技术团队

来源-微信公众号:当贝技术团队

出处:https://mp.weixin.qq.com/s/516n2bPvZd1NZh6juSS92A

、相关技术栈版本概览

前提还是需要具备JAVA开发的基础概念，比如安装JDK环境。

二、整合相关技术栈

1. 创建空项目

使用 Spring Initializr 「https://start.spring.io/」快速创建Spring项目

在 Dependencies 对话框中搜索并添加 web 依赖关系，如屏幕截图所示。点击“生成”按钮，下载压缩包，并将其解压缩到计算机本地。

2. 编写基础的 Gradle 相关脚本

以下按相对项目的根目录进行说明，如文件不存在 可以手动创建：

• gradle.properties

# 当前项目版本
projectVersion=0.1.0-SNAPSHOT

# SpringBoot版本
springbootVersion=3.3.2

# JDK最低版本
jdkVersion=17

• build.gradle

buildscript {
    repositories {
        mavenLocal()
        maven { url "https://maven.aliyun.com/repository/public/" }
    }

    dependencies {
        /* 添加插件依赖路径（通过jar方式） */
        classpath "org.springframework.boot:spring-boot-gradle-plugin:${springbootVersion}"
    }
}

allprojects {
    apply plugin: "idea"
    apply plugin: "java"
    apply plugin: "org.springframework.boot"
    apply plugin: "io.spring.dependency-management"

    group='com.app4j.stack'
    version=projectVersion

    java {
        toolchain {
            languageVersion=JavaLanguageVersion.of(jdkVersion)
        }
    }

    configurations {
        // 排除tomcat
        all*.exclude module: 'spring-boot-starter-tomcat'
        compileOnly {
            extendsFrom annotationProcessor
        }
    }

    repositories {
        mavenLocal()
        maven { url "https://maven.aliyun.com/repository/public/" }
    }

    dependencies {
        // Lombok
        compileOnly 'org.projectlombok:lombok'
        annotationProcessor 'org.projectlombok:lombok'
        // Spring Web
        implementation 'org.springframework.boot:spring-boot-starter-web'
        // 使用undertow 替换tomcat
        implementation 'org.springframework.boot:spring-boot-starter-undertow'
    }
}

3. 创建 Springboot 启动类

com.app4j.web.WebApplication

package com.app4j.web;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;

/**
 * @author eric.hao
 * @since 2024/07/18
 */
@Slf4j
@SpringBootApplication
public class WebApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(WebApplication.class).run(args);
        log.info("[App4j] Application Started.");
    }
}

ok 项目这就可以正式启动啦！

4. 整合 Swagger

只需一步即可！引入 Knife4j Swagger 增加工具包：

dependencies {
    // Swagger
    implementation 'com.github.xiaoymin:knife4j-openapi3-jakarta-spring-boot-starter:4.5.0'
}

让我们添加一个接口，测试下 swagger 的效果：

package com.app4j.web.knife4j;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author eric.hao
 * @since 2024/07/27
 */
@RestController
@RequestMapping("/demo")
@Tag(name="示例接口")
public class Knife4jController {

    @Operation(summary="向客人问好")
    @PostMapping("/sayHi")
    public ResponseEntity<?> sayHi(@RequestParam(value="name") String name) {
        return ResponseEntity.ok("Hi:" + name);
    }
}

访问接口文档的本地地址：http://127.0.0.1:8080/doc.html

重要提示：为什么这次不用配置Docket Bean，就可以看到接口清单？

Knife4j 自4.0版本，下面的配置在 knife4j-openapi2-spring-boot-starter 中仍然需要如此配置，而在 knife4j-openapi3-spring-boot-starter 和 knife4j-openapi3-jakarta-spring-boot-starter 则不需要！！！

以上，我们完成了一个新的网站项目的初始化，并查看网站项目的OpenAPI！

关注点赞收藏不迷路！！振锁会持续给大家分享大厂一线的开发经验，手把手从0到架构设计！成为独当一面的多面手！！