为什么要分离静态资源
使用springboot的项目通常打包为jar文件部署,有些项目使用容器,一些项目直接启动jar包。非前后端分离项目,如果需要修改页面、js、图片等前端内容,需要重新打包、上传、重启,部署过程过于繁琐。分离静态资源以后,可以方便、快速的更新静态内容。下面介绍如何在打包时分离静态文件
第1步,通过修改pom文件实现jar包不包含静态文件内容
pom文件
build标签下面的resource标签
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
</resource>
<resource>
<directory>src/main/resources</directory>
<!--下面这里根据项目实际情况列出不打到jar包的目录-->
<excludes>
<exclude>webapp/</exclude>
<exclude>templates/</exclude>
</excludes>
</resource>
</resources>
第2步,修改静态资源路径和freemarker路径
静态资源路径
@Configuration
public class MyWebAppConfigurer implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
//这里是静态文件资源映射。路径写了2个映射:一个是file、一个是classpath。file用于在打包发布后使用。claspath用于开发调试使用
registry.addResourceHandler("/**").addResourceLocations("file:webapp/").addResourceLocations("classpath:/webapp/");
registry.addResourceHandler("/static/**").addResourceLocations("file:webapp/static/").addResourceLocations("classpath:/webapp/static/");
registry.addResourceHandler("/plugins/**").addResourceLocations("file:webapp/plugins/").addResourceLocations("classpath:/webapp/plugins/");
}
}
freemarker模板文件路径
#如果是其他模板框架修改对应配置即可
#和前面一样,配置file、classpath两种方式
spring.freemarker.template-loader-path=file:templates/,classpath:/templates
修改完毕,执行mvn clean package ,查看jar包,你会发现静态文件已经不在里面了。手动将静态资源的目录拷贝到jar包同目录,启动jar包,可访问项目
第3步,使用assembly插件,更便捷打包
pom文件加入assembly插件
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.1.1</version>
<executions>
<execution>
<id>build-package</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
<configuration>
<finalName>${project.artifactId}</finalName>
<descriptors>
<descriptor>assembly.xml</descriptor>
</descriptors>
</configuration>
</execution>
</executions>
</plugin>
assembly.xml文件,放在pom文件同目录
<assembly xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/assembly-1.0.0.xsd">
<id>assembly</id>
<formats>
<format>zip</format>
</formats>
<includeBaseDirectory>true</includeBaseDirectory>
<fileSets>
<!--每个fileSet对应一个目录,按项目实际情况设置-->
<fileSet>
<directory>src/main/resources/templates</directory>
<outputDirectory>${file.separator}templates</outputDirectory>
<includes>
<include>*/**</include>
</includes>
</fileSet>
<fileSet>
<directory>src/main/resources/webapp</directory>
<outputDirectory>${file.separator}webapp</outputDirectory>
<includes>
<include>*/**</include>
</includes>
</fileSet>
</fileSets>
<files>
<file>
<!--这里是可执行的jar文件-->
<source>${project.build.directory}/${project.build.finalName}-exec.jar</source>
<outputDirectory>${file.separator}</outputDirectory>
</file>
</files>
</assembly>
完成这一步以后,执行mvn clean package,会产生一个zip包,里面包含了可执行的jar文件和静态资源。可以直接上传这个zip到服务器解压启动。
存在的问题
存在问题
如果有同学这么尝试了,会发现开发环境的页面404,或者静态文件找不到。是因为第1步的exclude把静态文件都去掉,idea在编译的时候自然也就去了静态文件。
这里提供一个零时的解决方法:
1、开发时,将excludes注释掉
2、打包时,开启excludes
后续
下一步2个方向:
1、解决这里的问题
2、使用自动化部署的方案,比如gitlab-ci等,结合docker-compose实现自动部署