Spring Boot实战：静态资源处理

时间 2019-12-01

原文原文链接

 做者：liuxiaopeng
 博客地址：http://www.cnblogs.com/paddix/

前两章咱们分享了Spring boot对Restful 的支持，不过Restful的接口一般仅仅返回数据。而作web开发的时候，咱们每每会有不少静态资源，如html、图片、css等。那如何向前端返回静态资源呢？之前作过web开发的同窗应该知道，咱们之前建立的web工程下面会有一个webapp的目录，咱们只要把静态资源放在该目录下就能够直接访问。可是，基于Spring boot的工程并无这个目录，那咱们应该怎么处理？css

1、最笨的方式html

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

@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对静态资源的支持。web

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

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

　　　　classpath:/public/app

　　　　classpath:/resources/框架

　　　　classpath:/static/webapp

　　　　classpath:/META-INFO/resouces/maven

　　咱们如今就在资源文件resources目录下创建以下四个目录：

　　注意蓝色条下的资源文件夹resources与类路径下的文件夹classpath:/resources是不一样的，蓝色条下的resources表明的是该目录下的文件为资源文件，在打包的时候会将该目录下的文件所有打包的类路径下，这个名称是能够改的，在pom.xml指定资源目录便可：

<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访问到四个目录下的静态资源了。

3、自定义静态资源目录

　　经过第二节内容咱们已经知道了Spring boot默承认以访问的静态资源的目录，可是你们确定会想，这个目录是固定的吗？咱们可不能够本身定义静态资源目录？答案是确定的，咱们如今就来自定义一个静态资源目录，咱们定义一个images的目录来存放图片，全部/image/**的路径都会访问images目录下的资源：

@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中配置便可：

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等目录下的资源了。

4、总结

　　本文主要给你们分享了Spring boot 对静态资源的处理方式，Spring boot 默承认以访问classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/四个目录下的静态资源，咱们也能够根据本身的须要进行个性化配置。最后，须要说明一点的是，若是这四个目录中存在相同名称的资源，那会优先返回哪一个目录下的资源呢？你们经过static-locations的默认值顺序应该能猜到，默认状况下，Spring boot会优先返回/META-INF/resources下的资源。固然，由于咱们能够自定义static-locations的值，因此这个优先顺序也是能够调整的。