SpringBoot2.x基础篇:将静态资源打包为WebJars

简介: 我们在编写前后分离项目时,前端的项目一般需要静态资源(`Image`、`CSS`、`JavaScript`...)来进行渲染界面,而如果我们对外采用依赖的方式提供使用时,我们的静态资源文件也应该放入打包文件内,这样才能更便捷的提供我们的功能,在我的开源分布式日志框架 [minbox-logging](https://gitee.com/minbox-projects/minbox-logging) 内提供了管理界面的功能,就是采用的这种方式实现,将静态资源以及**编译后**的`HTML`页面存放到`minbox-logging-admin-ui`依赖内,下面我们来看下具体的实现方式。

概述

我们在编写前后分离项目时,前端的项目一般需要静态资源(ImageCSSJavaScript...)来进行渲染界面,而如果我们对外采用依赖的方式提供使用时,我们的静态资源文件也应该放入打包文件内,这样才能更便捷的提供我们的功能,在我的开源分布式日志框架 minbox-logging 内提供了管理界面的功能,就是采用的这种方式实现,将静态资源以及编译后HTML页面存放到minbox-logging-admin-ui依赖内,下面我们来看下具体的实现方式。

推荐阅读

了解Resources Static Locations

在我们打包静态资源前,首先来了解下SpringBoot提供的spring.resources.static-locations配置默认值,该配置用于配置ResourceHandler,项目启动后会将该参数的配置值列表作为直接可访问的静态目录进行映射,通过这种方式我们就可以直接访问到我们需要的静态资源内容。

spring.resources.static-locations配置位于org.springframework.boot.autoconfigure.web.ResourceProperties配置类内,其默认值是使用本类内的静态常量CLASSPATH_RESOURCE_LOCATIONS的值,如下所示:

private static final String[] CLASSPATH_RESOURCE_LOCATIONS = { "classpath:/META-INF/resources/",
                                                              "classpath:/resources/", "classpath:/static/", "classpath:/public/" };

/**
     * Locations of static resources. Defaults to classpath:[/META-INF/resources/,
     * /resources/, /static/, /public/].
     */
private String[] staticLocations = CLASSPATH_RESOURCE_LOCATIONS;

通过查看源码我们得知,classpath:/META-INF/resources/目录下的资源是可以直接通过默认的映射绑定关系访问到的,通过这一点,我们可以将静态资源依赖内的资源文件存放到META-INF/resources目录下。

资源打包

我们使用Maven方式构建一个普通的项目,在pom.xml文件内添加资源目录配置,在编译过程中将src/main/resources目录下的文件全部复制到META-INF/resources下,如下所示:

<build>
  <resources>
    <resource>
      <directory>src/main/resources</directory>
      <targetPath>META-INF/resources</targetPath>
    </resource>
  </resources>
</build>
为了验证资源访问,我们在 src/main/resources目录下存放一个名为 head.jpg的图片。

我们为了本地演示使用,将Maven项目通过mvn install命令安装到本地仓库,以便于提供给其他项目使用。

使用WebJars依赖

我们来创建一个SpringBoot项目,在项目的pom.xml文件内添加如下依赖:

<dependencies>
  <!--静态资源的访问映射绑定需要web依赖-->
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <dependency>
    <groupId>org.example</groupId>
    <artifactId>webjars-sample</artifactId>
    <version>1.0-SNAPSHOT</version>
  </dependency>
</dependencies>

由于我们在之前通过mvn install命令将静态资源项目安装到了本地仓库,所以我们可以使用依赖。

通过IDEA工具我们可以查看webjars-sample依赖内的资源文件,如下图所示:

由于SpringBoot提供的spring.resources.static-locations参数默认值,会将classpath:/META-INF/resources目录作为静态资源映射,所以我们可以直接进行访问head.jpg文件。

运行SpringBoot项目,通过访问 http://localhost:8080/head.jpg,效果如下图:

静态资源访问前缀

我们在访问静态资源的时候并没有直接加前缀,而是通过ip:port/head.jpg直接访问,这主要是SpringBoot还提供了另外一个配置spring.mvc.static-path-pattern,其作用是用来配置静态资源的访问前缀,默认值为/**,如果需要修改直接在application.yml文件内进行赋值即可,

application.yml配置文件,如下所示:

spring:
  application:
    name: example
  mvc:
    static-path-pattern: /static/**

我们修改了spring.mvc.static-path-pattern配置的值为/static/**,当我们重启项目后需要通过 http://localhost:8080/static/head.jpg 才可以访问到资源。

总结

如果你有一些资源不希望被别人修改,让使用者更加便利的集成时,可以采用这种方式来封装自己的webjars,只需要添加依赖引用就可以访问到静态资源,也可以将静态HTML网页通过这种方式打包。

相关文章
|
7天前
|
前端开发 JavaScript Java
SpringBoot项目部署打包好的React、Vue项目刷新报错404
本文讨论了在SpringBoot项目中部署React或Vue打包好的前端项目时,刷新页面导致404错误的问题,并提供了两种解决方案:一是在SpringBoot启动类中配置错误页面重定向到index.html,二是将前端路由改为hash模式以避免刷新问题。
45 1
|
5天前
|
Java Spring
springboot静态资源目录访问,及自定义静态资源路径,index页面的访问
本文介绍了Spring Boot中静态资源的访问位置、如何进行静态资源访问测试、自定义静态资源路径和静态资源请求映射,以及如何处理自定义静态资源映射对index页面访问的影响。提供了两种解决方案:取消自定义静态资源映射或编写Controller来截获index.html的请求并重定向。
springboot静态资源目录访问,及自定义静态资源路径,index页面的访问
|
5月前
|
Java Maven
SpringBoot项目的用maven插件打包报Test错误
SpringBoot项目的用maven插件打包报Test错误
|
2月前
|
Java Maven
构建Springboot项目、实现简单的输出功能、将项目打包成可以执行的JAR包(详细图解过程)
这篇文章详细介绍了构建SpringBoot项目的过程,包括新建工程、选择环境配置、添加依赖、项目结构说明,并演示了如何编写一个简单的Controller控制器实现输出功能,最后讲解了如何使用Maven将项目打包成可执行的JAR包,并提供了运行JAR包的命令和测试效果。
构建Springboot项目、实现简单的输出功能、将项目打包成可以执行的JAR包(详细图解过程)
|
2月前
|
Dubbo Java Nacos
【实战攻略】破解Dubbo+Nacos+Spring Boot 3 Native打包后运行异常的终极秘籍——从零开始彻底攻克那些让你头疼不已的技术难题!
【8月更文挑战第15天】Nacos作为微服务注册与配置中心受到欢迎,但使用Dubbo+Nacos+Spring Boot 3进行GraalVM native打包后常遇运行异常。本文剖析此问题及其解决策略:确认GraalVM版本兼容性;配置反射列表以支持必要类和方法;采用静态代理替代动态代理;检查并调整配置文件;禁用不支持的功能;利用日志和GraalVM诊断工具定位问题;根据诊断结果调整GraalVM配置。通过系统排查方法,能有效解决此类问题,确保服务稳定运行。
66 0
|
3月前
|
Java 持续交付 Maven
Spring Boot程序的打包与运行:构建高效部署流程
构建高效的Spring Boot部署流程对于保障应用的快速、稳定上线至关重要。通过采用上述策略,您可以确保部署过程的自动化、可靠性和高效性,从而将专注点放在开发上面。无论是通过Maven的生命周期命令进行打包,还是通过容器技术对部署过程进行优化,选择正确的工具与实践是成功实现这一目标的关键。
111 2
|
2月前
|
前端开发 JavaScript Java
Spring Boot应用中的资源分离与高效打包实践
通过实施资源分离和高效打包策略,不仅可以提升Spring Boot应用的开发和部署效率,还能显著提高用户体验。在实际项目中,根据项目的实际情况和团队的技术栈选择合适的工具和方案是关键。希望本文能为读者在Spring Boot项目中实现资源分离和高效打包提供一些有价值的参考。
|
5月前
|
Java
springboot打包错误:Failed to execute goal org.apache.maven.plugins:maven-resources-plugin:3.2.0:resource
springboot打包错误:Failed to execute goal org.apache.maven.plugins:maven-resources-plugin:3.2.0:resource
68 0
|
2月前
|
Java Spring
Spring Boot实战:静态资源无法访问
Spring Boot实战:静态资源无法访问
52 0
|
3月前
|
Java
自主定义访问路径-----SpringBoot自主定义静态资源访问路径的方法
自主定义访问路径-----SpringBoot自主定义静态资源访问路径的方法