frontend-maven-plugin 使用教程

本教程旨在指导你如何安装和使用 frontend-maven-plugin，这是一个用于管理前端构建的Maven插件，它可以自动下载、安装Node.js和NPM，并运行前端构建任务。

1. 项目目录结构及介绍

frontend-maven-plugin 不直接提供一个明确的目录结构，因为它是一个Maven插件，你将在你的Maven项目中引入它。通常，如果你有一个Java项目，并且希望整合前端构建，你的项目目录可能如下所示：

- src
  - main
    - java
      - (your Java sources)
    - resources
      - (your resources)
  - frontend
    - src
      - (your front-end sources like JavaScript, CSS, HTML)
    - package.json
    - webpack.config.js (or other build configuration files)

在这里，frontend 目录包含前端项目的源代码和配置文件，而 package.json 是Node.js项目的主要配置文件，用于定义依赖关系和脚本。

2. 项目的启动文件介绍

在 frontend-maven-plugin 中并没有特殊的启动文件，但你通常会在你的 package.json 文件中定义脚本，比如 build 或 start，Maven插件会调用这些脚本来执行前端构建。例如：

{
  "name": "my-app",
  "version": "1.0.0",
  "scripts": {
    "build": "webpack --config webpack.config.js",
    "start": "node server.js"
  },
  "dependencies": {...},
  "devDependencies": {...}
}

在这个例子中，build 脚本将由 frontend-maven-plugin 运行以执行WebPack打包。

3. 项目的配置文件介绍

Maven的pom.xml配置

frontend-maven-plugin 需要在你的 pom.xml 文件中配置。下面是一个示例配置，展示了如何下载Node.js和NPM，以及执行 npm install 和 npm run build：

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>com.github.eirslett</groupId>
        <artifactId>frontend-maven-plugin</artifactId>
        <version>1.x.y</version> <!-- replace x.y with latest version -->
        <configuration>
          <installDirectory>target</installDirectory>
          <workingDirectory>src/main/frontend</workingDirectory>
          <nodeVersion>v14.x.x</nodeVersion> <!-- replace x.x with desired version -->
          <npmVersion>6.x.x</npmVersion> <!-- replace x.x with desired version -->
        </configuration>
        <executions>
          <execution>
            <id>install node and npm</id>
            <goals>
              <goal>install-node-and-npm</goal>
            </goals>
          </execution>
          <execution>
            <id>npm install</id>
            <goals>
              <goal>npm</goal>
            </goals>
            <configuration>
              <arguments>install</arguments>
            </configuration>
          </execution>
          <execution>
            <id>npm build</id>
            <goals>
              <goal>npm</goal>
            </goals>
            <configuration>
              <arguments>run build</arguments>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  ...
</project>

在这段配置中，installDirectory 设置了Node.js和NPM的安装位置，workingDirectory 定义了前端项目的根目录，nodeVersion 和 npmVersion 分别指定了所需的Node.js和NPM版本。npm 标签内的 arguments 属性用来传递给 npm 命令的参数，如 install 和 run build。

现在，当你运行 mvn clean install，Maven将会自动执行前端构建。

请注意替换 <version> 标签中的 x.y.z 为最新的稳定版本号，以及根据实际需求设置 nodeVersion 和 npmVersion。

通过以上步骤，你应该已经成功地将 frontend-maven-plugin 集成到了你的项目中，可以实现自动化管理和构建前端代码。