Spring Boot 静态资源处理,妙!

谁践踏了优雅 2022-10-08 14:24 186阅读 0赞

0D5F937FE12312312D81F17F.jpg

程序员的成长之路

互联网/程序员/技术/资料共享

关注

阅读本文大概需要 4 分钟。

来自:cnblogs.com/paddix/p/8301331.html

做web开发的时候,我们往往会有很多静态资源,如html、图片、css等。那如何向前端返回静态资源呢?

以前做过web开发的同学应该知道,我们以前创建的web工程下面会有一个webapp的目录,我们只要把静态资源放在该目录下就可以直接访问。

但是,基于Spring boot的工程并没有这个目录,那我们应该怎么处理?

一、最笨的方式

我们首先来分享一种最笨的办法,就是将静态资源通过流直接返回给前端,我们在maven工程的resources的根目录下建立一个html的目录,然后我们把html文件放在该目录下,并且规定任何访问路径以/static/开头的即访问该目录下的静态资源,其实现如下:

  1. @Controller
  2. public class StaticResourceController {
  3. @RequestMapping("/static/**")
  4. public void getHtml(HttpServletRequest request, HttpServletResponse response) {
  5. String uri = request.getRequestURI();
  6. String[] arr = uri.split("static/");
  7. String resourceName = "index.html";
  8. if (arr.length > 1) {
  9. resourceName = arr[1];
  10. }
  11. String url = StaticResourceController.class.getResource("/").getPath() +
  12. "html/" + resourceName;
  13. try {
  14. FileReader reader = new FileReader(new File(url));
  15. BufferedReader br = new BufferedReader(reader);
  16. StringBuilder sb = new StringBuilder();
  17. String line = br.readLine();
  18. while (line != null) {
  19. sb.append(line);
  20. line = br.readLine();
  21. }
  22. response.getOutputStream().write(sb.toString().getBytes());
  23. response.flushBuffer();
  24. } catch (IOException e) {
  25. e.printStackTrace();
  26. }
  27. }
  28. }

其实现过程很简单,就是先从路径中分离出来资源uri,然后从static目录下读取文件,并输出到前端。

因为只做简单演示,所以这里只处理了文本类型的文件,图片文件可以做类似的处理。当然,我们在实际中肯定不会这么做,Spring Boot 也肯定有更好的解决办法。

不过这个办法虽然有点笨,但确是最本质的东西,无论框架如何方便的帮我们处理了这类问题,但是抛开框架,我们依然要能够熟练的写出一个web项目,只有知道其实现原理,你才会在遇到问题时能得心应手。

现在我们再来看看Spring boot对静态资源的支持。

二、Spring boot默认静态资源访问方式

Spring boot默认对/**的访问可以直接访问四个目录下的文件:

  • classpath:/public/
  • classpath:/resources/
  • classpath:/static/
  • classpath:/META-INFO/resouces/

我们现在就在资源文件resources目录下建立如下四个目录:

4ed3f8776b96e6d8bce521a8f0de9ce5.png

注意蓝色条下的资源文件夹resources与类路径下的文件夹classpath:/resources是不同的,蓝色条下的resources代表的是该目录下的文件为资源文件,在打包的时候会将该目录下的文件全部打包的类路径下,这个名称是可以改的,在pom.xml指定资源目录即可:

  1. <resources>
  2. <resource>
  3. <directory>src/main/resources</directory>
  4. </resource>
  5. </resources>

而类路径下的resources是spring boot默认的静态资源文件夹之一,和public、static以及MEAT-INFO/resources的功能相同。现在我们重启Spring boot就可以通过:

  • http://localhost:8080/1.html
  • http://localhost:8080/2.html
  • http://localhost:8080/3.html
  • http://localhost:8080/4.html

四个URL访问到四个目录下的静态资源了。

三、自定义静态资源目录

通过第二节内容我们已经知道了Spring boot默认可以访问的静态资源的目录,但是大家肯定会想,这个目录是固定的吗?我们可不可以自己定义静态资源目录?

答案是肯定的,我们现在就来自定义一个静态资源目录,我们定义一个images的目录来存放图片,所有/image/**的路径都会访问images目录下的资源:

  1. @Configuration
  2. public class ImageMvcConfig extends WebMvcConfigurerAdapter {
  3. @Override
  4. public void addResourceHandlers(ResourceHandlerRegistry registry) {
  5. registry.addResourceHandler("/image/**")
  6. .addResourceLocations("classpath:/images/");
  7. }
  8. }

这段代码应该比较简单,@Configuration 标识一个配置类,这个在前面的文章中提到过多次。

WebMvcConfigurerAdapter是Spring提供的一个配置mvc的适配器,里面有很多配置的方法,addResourceHandlers就是专门处理静态资源的方法,其他方法后续我们还会讲到。

现在我们在验证上面的配置是否有效。我在images目录下放了一张spring.jpg的图片,现在我们通过http://localhost:8080/image/spring.jpg来访问图片:

18517c06f0ffa6f9cc5547f7fc543303.png

其实除了上面的办法还有一种更简单的办法,就是直接在application.yml中配置即可:

  1. spring:
  2. mvc:
  3. static-path-pattern: /image/**
  4. resources:
  5. static-locations: classpath:/images/

static-path-pattern:访问模式,默认为/**,多个可以逗号分隔

static-locations:资源目录,多个目录逗号分隔,默认资源目录为classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/

注意,这个配置会覆盖Spring boot默认的静态资源目录,例如如果按示例中配置,则无法再访问static、public、resources等目录下的资源了。

四、总结

本文主要给大家分享了Spring boot 对静态资源的处理方式,Spring boot 默认可以访问

classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/

四个目录下的静态资源,我们也可以根据自己的需要进行个性化配置。

最后,需要说明一点的是,如果这四个目录中存在相同名称的资源,那会优先返回哪个目录下的资源呢?

大家通过static-locations的默认值顺序应该能猜到,默认情况下,Spring boot会优先返回/META-INF/resources下的资源。

当然,因为我们可以自定义static-locations的值,所以这个优先顺序也是可以调整的。

推荐阅读:

鸿蒙OS到底是不是Android套皮?(终于讲明白了)

JVM 有 Full GC,为什么还会出现 OutOfMemoryError呢?

  1. 最近面试BAT,整理一份面试资料《Java面试BATJ通关手册》,覆盖了Java核心技术、JVMJava并发、SSM、微服务、数据库、数据结构等等。

获取方式:点个「**在看」,点击上方小卡片,进入公众号后回复「面试题**」领取,更多内容陆续奉上。

朕已阅 dd7d4e557fd2e00468adc452da9d2ac7.gif

发表评论

表情:
评论列表 (有 0 条评论,186人围观)

还没有评论,来说两句吧...

相关阅读