[maven]--Java插件frontend-maven-plugin打包前端项目

本文介绍了如何在Java项目中利用frontend-maven-plugin插件打包前端项目。通过调整项目结构,使得前端项目与java项目的web部分相结合,创建war包并确保包含必要的web.xml和静态资源。在POM文件中设置了排除和添加特定文件的规则,以确保前端静态资源正确地整合到war包中。
摘要由CSDN通过智能技术生成

场景描述:

因为部署的时候不支持前端项目的直接部署,只能像java项目一样部署,因此需要给前端项目套上java的外壳,并将前端项目打包后的静态资源作为java项目的web部分部署

场景分析:

java的web部分是打成war包部署在tomcat中,部署在tomcat中的war包需要包含WEB-INF/web.xml部分,WEB-INF/web.xml对于tomcat容器是必须的文件:

  • 需要使用java工具完成对前端代码的打包,形成需要的静态资源
  • war包需要包含静态web项目
  • war包需要包含WEB-INF/web.xml

在java中我们一般使用frontend-maven-plugin插件完成对vue/react等项目的打包

因为java默认web文件夹是是src/main/webapp:

  • 如果直接使用webapp作为前端项目的名称,就导致所有的名称都必须是webapp,效果不好,如果以后可以将前端分离出来,该名称显得非常不明确,并且重复,或者就要重新命名
  • 如果新建前端项目在webapp文件夹下,会导致文件嵌套层次过多,纯粹是不喜欢这么不简洁的目录结构

因此根据最终需要的内容做了个调整,来达成最终需要的文件内容:

1.直接在main文件夹下创建前端项目
2.前端项目打包生成的静态资源文件夹dist在main文件夹下,与前端项目平级
3.直接在main文件夹下新建文件夹,用于放置额外war包必须的web.xml与check.html(该文件可以是其它必须文件)

项目结构 & war包结构

war包官方目录结构

代码结构:

|-- pom.xml
 `-- src
     `-- main
         |-- java
         |   `-- com
         |       `-- example
         |           `-- projects
         |               `-- SampleAction.java
         |-- resources
         |   |-- images
         |   |   `-- sampleimage.jpg
         |   `-- sampleresource
         `-- webapp
             |-- WEB-INF
             |   `-- web.xml
             |-- index.jsp
             `-- jsp
                 `-- websource.jsp

war包目录:

 |-- META-INF
 |   |-- MANIFEST.MF
 |   `-- maven
 |       `-- com.example.projects
 |           `-- documentedproject
 |               |-- pom.properties
 |               `-- pom.xml
 |-- WEB-INF
 |   |-- classes
 |   |   |-- com
 |   |   |   `-- example
 |   |   |       `-- projects
 |   |   |           |-- SampleAction.class
 |   |   |           `-- SampleActionDependency.class
 |   |   `-- images
 |   |       |-- sampleimage-dependency.jpg
 |   |       `-- sampleimage.jpg
 |   `-- web.xml
 |-- index-dependency.jsp
 |-- index.jsp
 `-- jsp
     `-- websource.jsp

war包构造目录结构

代码结构:

|-- pom.xml
 `-- src
     `-- main
         |-- extra 
         |   |-- web.xml 
         |   `-- check.html 
         |-- dist (build后生成的静态文件)
         |   |-- assets 
         |   |   |-- css 
         |   |   `-- js 
         |   `-- index.html 
         `-- front-demo(vue/react项目)
             |-- public 
             |-- src 
             |-- ......
             `-- package.json 

war包目录

 |-- META-INF
 |   |-- MANIFEST.MF
 |   `-- maven
 |       `-- com.example.projects
 |           `-- documentedproject
 |               |-- pom.properties
 |               `-- pom.xml
 |-- WEB-INF
 |   |-- classes (空文件夹)
 |   `-- web.xml
 |-- assets 
 |-- index.html 
 `-- check.html

实现

根据脚手架创建maven项目

在这里插入图片描述

在这里插入图片描述

调整项目结构

项目目录结构:

在这里插入图片描述
下图为前端打包后的目录结构:
在这里插入图片描述

  • resource 文件夹为空,但不可删除否则会导致复制多余的文件到war包中
  • check 用于存放必须的额外文件
  • front-demo 是前端项目(vue/react等,该项目执行npm build生成的dist与front-demo项目文件夹平级)
  • dist文件是前端build后的
如果您使用frontend-maven-plugin打包的jar文件中没有static文件夹,那可能是因为frontend-maven-plugin默认不会将静态资源文件包含在打包的jar文件中。为了解决这个问题,您可以尝试以下步骤: 1. 在您的Vue项目的根目录下创建一个名为`static`的文件夹,并将您的静态资源文件放置在其中。 2. 在您的Vue项目的根目录下创建一个名为`.npmrc`的文件,并添加以下内容: ``` prefix=${project.basedir}/target/${project.build.finalName}/static ``` 这将告诉frontend-maven-plugin将静态资源文件复制到打包的jar文件中的正确位置。 3. 更新您的pom.xml文件中frontend-maven-plugin插件的配置,确保它包含`copy`目标,并将`copy`目标的`outputDirectory`设置为`${project.build.directory}/${project.build.finalName}/static`。示例如下: ```xml <plugin> <groupId>com.github.eirslett</groupId> <artifactId>frontend-maven-plugin</artifactId> <version>1.12.0</version> <executions> <!-- 其他执行目标 --> <!-- ... --> <!-- 添加 copy 目标 --> <execution> <id>copy files</id> <goals> <goal>copy</goal> </goals> <configuration> <outputDirectory>${project.build.directory}/${project.build.finalName}/static</outputDirectory> <resources> <resource> <directory>static</directory> <includes> <include>**/*</include> </includes> </resource> </resources> </configuration> </execution> </executions> </plugin> ``` 4. 重新运行`mvn clean install`命令来重新打包您的应用。这将确保静态资源文件被正确地复制到打包的jar文件中的static文件夹中。 现在,您应该能够在打包后的jar文件中找到static文件夹并包含您的静态资源文件。请确保在使用这些静态资源文件时,使用正确的路径引用它们。 希望这能解决您的问题!如有其他疑问,请随时追问。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

三知之灵

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值