专栏首页SpringBoot 核心技术SpringBoot2.x基础篇:将静态资源打包为WebJars

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

知识改变命运,撸码使我快乐,2020继续游走在开源界 点赞再看,养成习惯 给我来个Star吧,点击了解下基于SpringBoot的组件化接口服务落地解决方案

概述

我们在编写前后分离项目时,前端的项目一般需要静态资源(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依赖内的资源文件,如下图所示:

image

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

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

image

静态资源访问前缀

我们在访问静态资源的时候并没有直接加前缀,而是通过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网页通过这种方式打包。

作者个人 博客 使用开源框架 ApiBoot 助你成为Api接口服务架构师

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 第二十五章:SpringBoot添加支持CORS跨域访问

    恒宇少年
  • 使用ApiBoot Logging进行统一管理请求日志

    ApiBoot Logging通过集成minbox-logging来进行管理每一次请求的日志信息,包含头信息、参数、主体内容、路径、发生的服务器相关信息等,根据...

    恒宇少年
  • 第八章:使用拦截器记录你的SpringBoot的请求日志本章目标构建项目配置拦截器初尝试运行项目总结

    恒宇少年
  • emmet(Zen coding)前端写代码神器

    deepcc
  • 深度网路场景位置记忆效果惊人-视频-论文

    https://www.groundai.com/project/generative-temporal-models-with-spatial-memory-...

    智能算法
  • 综述:高维单细胞RNA测序数据分析工具(上)

    当你的才华还撑不起你的野心时,请潜下心来,脚踏实地,跟着我们慢慢进步。不知不觉在单细胞转录组领域做知识分析也快两年了,通过文献速递这个栏目很幸运聚集了一些小伙伴...

    生信技能树jimmy
  • 如何解决稀疏奖励下的强化学习?

    强化学习(Reinforcement Learning,RL)是实现强人工智能的方法之一,在智能体(Agent)与环境的交互过程中,通过学习策略(Policy)...

    机器之心
  • 【蒲慕明院士】人工智能可借鉴的 5 大自然神经网络特性(35PPT)

    【新智元导读】2016中国人工智能大会(CCAI 2016)日前在京召开。中国科学院外籍院士、中国科学院神经学研究所所长蒲慕明27日发表演讲《脑科学能为人工智能...

    新智元
  • 为什么说机器学习工程师不是这个时代的明星?

    数据科学家这个岗位被称作21世纪最性感的工作。与此同时,对机器学习工程师的需求量在这几年呈指数级增长。2019年,就业网站Indeed将计算机视觉工程师、机器学...

    大数据文摘
  • 政企携手推进“互联网+政务服务”,助力数字政府建设

    7月5日,“国有土地上房屋征收与棚改中具体问题的探讨沙龙”在瑞城名人酒店内举行,成都市房屋征收与拆迁管理协会秘书长史天瑞,项目管理科科长高宇,征收管理科科长江勇...

    场景录小程序

扫码关注云+社区

领取腾讯云代金券