八，SpringBoot Web 开发访问静态资源(附+详细源码剖析)

已于 2024-09-08 15:33:37 修改
阅读量777 收藏 7
点赞数 17
分类专栏： Spring Boot 文章标签： spring boot 前端 后端 java spring web
于 2024-09-08 15:31:33 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_61635597/article/details/142027399
版权

八，SpringBoot Web 开发访问静态资源(附+详细源码剖析)

文章目录

1. 基本介绍

SpringBoot 中对于静态资源的访问：

  1. 只要将静态资源放在类路径下: /static, /public, /resources, /META-INF/resources 就可以被直接访问-对应文件（这是 Spring Boot 的默认设置好的 ）。关于这一点，我们从 WebProperties.java 这个类的源码上可以找到，对应的配置属性。

在这里插入图片描述

private static final String[] CLASSPATH_RESOURCE_LOCATIONS = new String[]{"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"};
注意：classpath:/resources/ 表示服务器就会在 resources 路径下找，你在浏览器当中输入的url地址的时候，不可以输入 resources 目录，因为服务器就是会在 classpath:/resources/ 找的，而如果你写了resources在浏览器上的话，你想表达的就是：让浏览器从resources/resouces的路径下找，这是找不到的报404错误

注意：classpath:/resources/ 表示服务器就会在 resources路径下找，你在浏览器当中输入的url地址的时候，不可以输入 resources 目录，因为服务器就是会在 classpath:/resources/ 找的，而如果你写了resources 在浏览器上的话，你想表达的就是：让浏览器从resources/resouces的路径下找，这是找不到的报404错误

  1. 常见静态资源: js,css,图片(.jpg,.png,.gif,.bmp,.svg) ,字体文件(Fonts)等
  2. 访问方式： 默认：项目根路径/+静态资源名 比如: http://localhost:8080/hi.html 。关于这一点，我们可以从 WebMvcProperties.java 类当中找到答案。

在这里插入图片描述

2. 快速入门

2.1 准备工作

在 pom .xml 文件中导入相关的 jar 依赖。如下

在这里插入图片描述

<?xml version="1.0" encoding="UTF-8"?>
<project 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/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.rainbowsea</groupId>
    <artifactId>springboot_static_configuration</artifactId>
    <version>1.0-SNAPSHOT</version>


    <!--    导入SpringBoot 父工程-规定写法-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.3</version>
    </parent>

    <!--    导入web项目场景启动器：会自动导入和web开发相关的jar包所有依赖【库/jar】-->
    <!--    后面还会在说明spring-boot-starter-web 到底引入哪些相关依赖-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

</project>

编写启动程序：

在这里插入图片描述

package com.rainbowsea.springboot;


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication  // 标志启动场景
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

从上面的基本介绍 当中，我们知道了，Spring Boot 默认静态资源的访问路径有4 个，我们这里就测试这四个路径是否可以直接访问 。

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

注意：classpath 表示的是类路径，就是如图下面的: resources 目录，简单的说就是 classpath ===(等同于)resources 。

在这里插入图片描述

下面：我们分别在 resources 类路径下，创建对应的Spring Boot 默认的四个目录。如下图：
在这里插入图片描述

同时我们在这四个目录下，放入几张图片，用于访问测试。

在这里插入图片描述

启动程序运行测试：

在这里插入图片描述

打开浏览器进行直接访问静态资源文件：

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

注意：

private static final String[] CLASSPATH_RESOURCE_LOCATIONS = new String[]{"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"};
注意：classpath:/resources/ 表示服务器就会在 resources 路径下找，你在浏览器当中输入的url地址的时候，不可以输入 resources 目录，因为服务器就是会在 classpath:/resources/ 找的，而如果你写了resources在浏览器上的话，你想表达的就是：让浏览器从resources/resouces的路径下找，这是找不到的报404错误

在这里插入图片描述

resources/static 是Spring Bopt的默认静态路径，默认就是以“resources/static” 作为根路径访问的，所以，不需要再额外的加上 static 在浏览器上，如果你加了，那么你实际访问的是：resources/static/static这个路径，这个路径是不存在资源的，所以报错无法找到。

3. 改变静态资源访问前缀，定义为我们自己想要的

改变静态资源访问前缀，比如我们希望 http://locahost:8080/rainbowsea/* 下的请求路径，去请求静态资源，应用场景：静态资源访问前缀和控制器请求路径冲突。

我们这里需要用到 yaml 语法的内容，关于 yaml 语法想要了解的，大家可以移步至：✏️✏️✏️ 七，Spring Boot 当中的 yaml 语法使用-CSDN博客

首先，我们在 resources 类路径下创建一个名为 application.yaml 的文件。

在这里插入图片描述

编写如下内容：

在这里插入图片描述

spring:
  mvc:
    static-path-pattern: /rainbowsea/**

运行测试：

在这里插入图片描述

被我们改为了我们自己的 /rainbowsea/** 注意：后面的 /** 不可以省略 。不然无法访问的。

在这里插入图片描述

4. 改变Spring Boot当中的默认的静态资源路径(实现自定义静态资源路径)

Spring Boot 也是支持我们自定义静态资源路径，提高了灵活性。

改变默认的静态资源路径，比如：我们自己在类路径下增加 test 目录，作为静态资源路径，并完成测试。

同样要想改变 Spring Boot 当中的默认静态资源，这里我们还是使用 yaml 语法进行。在 resources 类路径下创建一个名为 application.yaml 的文件。

yaml 编写如下：

在这里插入图片描述

spring:
  web:
    resources:
      # 修改/指定 静态资源的访问路径/位置
      static-locations: ["classpath:/test/"] # 仿写
# 注意：尽量在最左边开始写，才有更多的提示

在这里插入图片描述

在 resources 类路径下，创建一个 test目录，同时在该目录下，放入一个名为 5.jpg 的图片，访问测试。

在这里插入图片描述

打开浏览器访问测试：

在这里插入图片描述

本质上： static-locations修改的是 WebProperties类当中staticlocations属性的值(也就是 springboot

的默认静态路径)。

所以这里我们修改了 Spring Boot 的默认静态资源路径，之前的放置在Spring Boot 默认的静态路径下的资源就无法被访问到了。

在这里插入图片描述

想要：保留原来Spring Boot 的默认静态资源路径，只需要把原来的Spring Boot 默认的路径添加上就可以了。

在这里插入图片描述

运行测试：

在这里插入图片描述

5. 静态资源访问注意事项和细节

  1. 注意：直接放在 resources 类的根路径下，是访问不到的。因为我们从 WebProperties 类源码上，就知道了，Spring Boot的默认静态资源路径，就只有四个，而 resources 类路径是不属于这四个当中的。
private static final String[] CLASSPATH_RESOURCE_LOCATIONS = new String[]{"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"};

运行测试：我们在 resources 类路径下，放入 6.jpg 图片，试试，可不可以被直接访问。

在这里插入图片描述

打开浏览器访问测试：

在这里插入图片描述

  1. 当默认请求的路径的资源的名字和 Controller 控制器请求处理的路径一样，冲突的时候。**优先看Controller能不能处理；不能，处理的请求交给静态资源处理，如果静态资源也找不到则相应点资源，则报：404找不到的，页面。

静态资源被访问原理：静态映射是 /** , 也就是对所有请求拦截，请求进来，先看Controller能不能处理，不能处理的请求交给静态资源处理，如果静态资源找不到则相应 404页面

在这里插入图片描述

在这里插入图片描述

package com.rainbowsea.springboot.controller;


import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController // @Controller + @ResponseBody
public class HiController {

    @RequestMapping("1.jpg")  // Controller 控制处理的请求的路径和静态资源的名字冲突
    public String hi(){
        return "hi";
    }
}

在这里插入图片描述

6. 总结：

  1. 理解Spring Boot 静态资源放在类路径下: /static, /public, /resources, /META-INF/resources 就可以被直接访问-对应文件（这是 Spring Boot 的默认设置好的 ）。关于这一点，我们从 WebProperties.java 这个类的源码上可以找到，对应的配置属性。
private static final String[] CLASSPATH_RESOURCE_LOCATIONS = new String[]{"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"};
注意：classpath:/resources/ 表示服务器就会在 resources 路径下找，你在浏览器当中输入的url地址的时候，不可以输入 resources 目录，因为服务器就是会在 classpath:/resources/ 找的，而如果你写了resources在浏览器上的话，你想表达的就是：让浏览器从resources/resouces的路径下找，这是找不到的报404错误
  1. 访问方式： 默认：项目根路径/+静态资源名 比如: http://localhost:8080/hi.html 。关于这一点，我们可以从 WebMvcProperties.java 类当中找到答案。
  2. 改变静态资源访问前缀，比如我们希望 http://locahost:8080/rainbowsea/* 下的请求路径，去请求静态资源，应用场景：静态资源访问前缀和控制器请求路径冲突。

在这里插入图片描述

  1. 改变Spring Boot当中的默认的静态资源路径（实现自定义静态资源路径）。

在这里插入图片描述

  1. 注意：直接放在 resources 类的根路径下，是访问不到的。因为我们从 WebProperties 类源码上，就知道了，Spring Boot的默认静态资源路径，就只有四个，而 resources 类路径是不属于这四个当中的。

7. 最后：

“在这个最后的篇章中，我要表达我对每一位读者的感激之情。你们的关注和回复是我创作的动力源泉，我从你们身上吸取了无尽的灵感与勇气。我会将你们的鼓励留在心底，继续在其他的领域奋斗。感谢你们，我们总会在某个时刻再次相遇。”

在这里插入图片描述

ChinaRainbowSea
关注
  • 17
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
【万字长文】SpringBoot整合SpringSecurity+JWT+Redis完整教程（提供Gitee源码）
黄团团的个人博客
07-28 5508
最近在学习SpringSecurity的过程中，参考了很多网上的教程，同时也参考了一些目前主流的开源框架，于是结合自己的思路写了一个SpringBoot整合SpringSecurity+JWT+Redis完整的项目，从0到1写完感觉还是收获到不少的，于是我把我完整的笔记写成博客分享给大家，算是比较全的一个项目了，仅供大家参考和学习哦！
SpringBoot中间件开发教程
程序员光剑
07-30 1989
Spring Boot 是目前最流行的 Java 框架之一，它简化了Spring应用配置，方便开发人员快速入门，降低了开发难度。为了帮助开发者更好地理解Spring Boot框架中的一些组件，提高日常工作效率和开发质量，我将通过编写系列文章来分享在实际项目中使用或开发的 Spring Boot 中间件开发经验。Spring Boot 的核心设计理念是约定优于配置（Convention over Configuration），意味着很多默认配置可以直接使用而无需做任何配置。
SpringBoot——Web开发之简单功能源码剖析
越努力越幸运的博客
09-10 483
文章目录五、SpringBoot——Web开发5.1 简单功能介绍（下篇）5.1.4 源码剖析——静态资源原理5.1.5 源码剖析——Rest映射5.1.6 源码剖析——请求映射原理 五、SpringBoot——Web开发 5.1 简单功能介绍（下篇） 5.1.4 源码剖析——静态资源原理 SpringBoot中，我们大部分的web的自动配置都放在WebMvcAutoConfiguration类中。我们可以去里面看看。（可以按两个Shift，输入类名，也可以自己去依赖里面找） 我们看看他都配了啥： 这个应该
SpringBoot---对静态资源的访问底层剖析
qq_42534991的博客
08-06 157
SpringBoot对静态资源的访问 前言：为了引入前端资源的，我们项目会有好多好多的的静态资源比如：js,css等等。如果我们是一个web应用，我们的main下会有一个webapp，我们以前都是将所有的页面导在这里面的，我记得是。But.现在很少用这个了，大部分就是pom。那么打包方式变成了jar的方式，这种方式该如何写页面？SpringBoot有一套规则是我们需要遵守的。 那么在SpringBoot中静态映射的规则是什么呢？？ 我们来走一波源码哈。准备上车。GO,竟然是静态资源自然联想到Spring
Spring Boot入门(18)：使用Spring Boot快速实现静态资源映射，完美展示前端页面！
**My Coding Family**
04-29 5334
Spring Boot如何设置静态资源映射，一文带你搞定。
java计算机毕业设计会议室预约管理系统（附源码+springboot+开题+论文+部署）
杰简程序毕设
04-20 734
通过该系统的应用，实现会议室的在线预约、分配和管理，提高会议室的使用效率和管理水平。此外，本研究还希望通过系统的实践应用，探索出一种符合企业实际需求的会议室管理模式，为类似系统的开发和应用提供有益的经验和借鉴。在部署阶段，与企业合作进行系统的上线和推广工作，提供必要的培训和技术支持，确保系统的顺利运行和持续优化。在员工信息管理方面，系统将记录员工的基本信息，并为其分配相应的权限，以确保系统的安全性和数据的保密性。其次，通过系统的实践应用，优化企业的会议室管理模式和流程，提升企业的整体管理水平和信息化程度。
静态资源与首页展示【源码剖析】
龍弟-idea的博客
09-30 6010
如果是一个web应用，在main下面会有个webapp，之前都是将所有页面导在这里；现在springboot也有静态资源放置的位置，但是有规定！ 首先，了解一下静态资源映射规则！ 在idea界面double Shift键:搜索WebMvcAutoConfiguration，SpringMVC的web配置都在这个配置类里面，其中有一个方法：addResourceHandlers添加资源处理 第一种静态资源映射规则！ 源码解析：看一下/webjars/**，都需要去 classpath:/M...
SpringBoot——Web开发之简单功能介绍
越努力越幸运的博客
09-10 182
文章目录五、SpringBoot——Web开发5.1 简单功能介绍5.1.1 静态资源访问5.1.2 欢迎页面5.1.3 网站的图标设置favicon5.1.4 源码剖析——静态资源原理 五、SpringBoot——Web开发 首先，我们先新建我们的项目，导入对应的包。为了不用截图，我就直接贴pom.xml的代码吧。（推荐用Spring Initializr建项目） <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://
Springboot 系列（七）web 开发之异常错误处理机制剖析
spring_root的博客
01-22 915
前言 相信大家在刚开始体验 Springboot 的时候一定会经常碰到这个页面，也就是访问一个不存在的页面的默认返回页面。 如果是其他客户端请求，如接口测试工具，会默认返回JSON数据。 { "timestamp":"2019-01-0622:26:16", "status":404, "error":"NotFound", ...
基于Springboot+Vue社团管理系统源码案例设计.zip
04-21
总的来说，这个基于Springboot+Vue的社团管理系统源码案例展示了现代Web开发中前后端分离的典型架构。通过深入研究源码，开发者不仅可以学习到Springboot和Vue的基础知识，还能了解到如何在实际项目中整合和优化这两...
基于springboot的智能学习平台系统源码数据库.zip
03-11
总的来说，基于SpringBoot的智能学习平台系统源码数据库是一个涵盖了多种技术的综合实践案例，对于Java开发者，尤其是初学者来说，它是学习现代Web开发的宝贵资源。通过研究源码，可以加深对SpringBoot、SSM框架以及...
Knife4j：为Spring Boot API赋能的文档生成器
apple_64847327的博客
09-04 1058
Knife4j，原名swagger-bootstrap-ui，是一个为Swagger生成更美观UI的增强工具。它不仅提供了更友好的用户界面，还增加了在线调试、文档导出、个性化配置等实用功能。Knife4j的设计理念是“像一把匕首一样小巧、轻量且功能强悍”，旨在为开发者提供更加便捷的API文档管理和测试工具。
利用Spring Boot Actuator进行应用性能调优
心猿意码
09-04 642
Spring Boot Actuator是一个可以让你轻松地暴露生产环境中运行的应用程序的当前状态的模块。它提供了一系列的HTTP端点，这些端点可以用来获取应用程序的各种内部信息，比如健康状况、度量指标、审计事件等。通过这些端点，我们可以更方便地了解应用的运行情况，进而对其进行调优。
spring boot项目中配置文件配置mapper*.xml文件路径无效的问题排查记录
最新发布
u010118011的博客
09-05 426
常见的原因在此就不描述了，导致此次自定义mapper无法被绑定的原因在于：项目中定义了sqlSessionFactoryBean，但这个Bean里只对dataSource设置了，并未设置MapperLocations，导致在application.properties中虽配置了mybatis-plus.mapper-locations的路径，但不生效。解决方式：根据项目添加并修改以下代码。
六，Spring Boot 容器中 Lombok 插件的详细使用，简化配置，提高开发效率
weixin_61635597的博客
09-02 1203
简化 Java Bean开发，可以使用 Lombok 的注解让代码更加简洁。Java项目中，很多没有技术含量但又必须存在的代码；比如：Pojo 的 getter/setter/toString；异常处理：I/O流的关闭操作等等。Java项目中，很多没有技术含量但又必须存在的代码：比如：这些代码既没有技术含量，又影响着代码的美观，Lombok 应运而生。Spring Boot 和 IDEA 官方支持IDEA 2020已经内置了 Lombok插件。
Spring Boot 3.3新特性解析：CDS支持与Base64配置
weixin_40381772的博客
09-03 1061
Spring Boot 3.3.0 已经发布，其中包含对 CDS支持与Base64配置。 CDS（Class Data Sharing）是一项JVM功能，允许在多个JVM实例之间共享类元数据，从而减少应用程序的启动时间和内存占用。Spring Boot 3.3提供了对CDS的支持，使得开发者可以更容易地创建与CDS兼容的应用布局。
Spring Boot如何解决跨域问题？
HBLOG
08-28 1443
跨域请求，就是说浏览器在执行脚本文件的ajax请求时，脚本文件所在的服务地址和请求的服务地址不一样。说白了就是ip、网络协议、端口都一样的时候，就是同一个域，否则就是跨域。这是由于Netscape提出一个著名的安全策略——同源策略造成的，这是浏览器对JavaScript施加的安全限制。是防止外网的脚本恶意攻击服务器的一种措施。
Spring Boot实现文件上传和下载
HBLOG
09-04 830
Web项目中，文件的上传和下载服务也是基于HTTP请求的，文件上传由于需要向服务接口提交数据，可以使用POST的请求方式，而文件的下载只是获取数据，因此可以使用GET请求方式。项目中经常会有上传和下载的需求，这篇文章简述一下springboot项目中实现简单的上传和下载。创建好指定的文件存放路径文件夹后，上传逻辑只需要将接收到的文件数据赋值到指定路径后即可。文件的下载逻辑是根据指定的文件名称到文件资源文件夹中获取，如果存在则返回文件。以上只是一些关键代码，所有代码请参见下面代码仓库。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值