AI专业者开发社区 1 号成员
  •  0 回帖  •  14 浏览  •  4 个月前
 

Spring Boot实战：静态资源处理

　　前两章我们分享了 Spring boot 对 Restful 的支持，不过 Restful 的接口通常仅仅返回数据。而做 web 开发的时候，我们往往会有很多静态资源，如 html、图片、css 等。那如何向前端返回静态资源呢？以前做过 web 开发的同学应该知道，我们以前创建的 web 工程下面会有一个 webapp 的目录，我们只要把静态资源放在该目录下就可以直接访问。但是，基于 Spring boot 的工程并没有这个目录，那我们应该怎么处理？

一、最笨的方式

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

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

　　其实现过程很简单，就是先从路径中分离出来资源 uri，然后从 static 目录下读取文件，并输出到前端。因为只做简单演示，所以这里只处理了文本类型的文件，图片文件可以做类似的处理。当然，我们在实际中肯定不会这么做，Spring boot 也肯定有更好的解决办法。不过这个办法虽然有点笨，但确是最本质的东西，无论框架如何方便的帮我们处理了这类问题，但是抛开框架，我们依然要能够熟练的写出一个 web 项目，只有知道其实现原理，你才会在遇到问题时能得心应手。现在我们再来看看 Spring boot 对静态资源的支持。

 

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

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

　　　　classpath:/public/

　　　　classpath:/resources/

　　　　classpath:/static/

　　　　classpath:/META-INFO/resouces/

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

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

?
1
2
3
4
5
<resources>
     <resource>
         <directory>src/main/resources</directory>
     </resource>
</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
2
3
4
5
6
7
8
9
@Configuration
public class ImageMvcConfig extends WebMvcConfigurerAdapter {
 
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/image/**")
                .addResourceLocations("classpath:/images/");
    }
}

　　这段代码应该比较简单，@Configuration 标识一个配置类，这个在前面的文章中提到过多次。WebMvcConfigurerAdapter 是 Spring 提供的一个配置 mvc 的适配器，里面有很多配置的方法，addResourceHandlers 就是专门处理静态资源的方法，其他方法后续我们还会讲到。现在我们在验证上面的配置是否有效。我在 images 目录下放了一张 spring.jpg 的图片，现在我们通过 http://localhost:8080/image/spring.jpg 来访问图片：

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

?
1
2
3
4
5
spring:
  mvc:
    static-path-pattern: /image/**
  resources:
    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 的值，所以这个优先顺序也是可以调整的。