SpringBoot静态资源路径问题、拦截器基础配置

落日映苍穹つ 2024-04-07 13:05 85阅读 0赞

## SpringBoot静态资源路径问题、拦截器基础配置 ##

### 1 前置基本知识 ###

#### 1.1 SpringBoot项目静态资源默认读取路径及优先级 ####

> 优先级如下：1 -> 2 -> 3 -> 4

*  优先级1：classpath:/META-INF/resources
 *  优先级2：classpath:/resources/
 *  优先级3：classpath:/static/
 *  优先级4: classpath:/public/

#### 1.2测试直接访问静态资源 ####

以上4个是SpringBoot默认读取静态资源文件目录，因此不需要配置任何参数，直接输入URL即可访问
    http://localhost:8080/b.html

结果：  
![在这里插入图片描述][e82e0a65010147ac9736e44d34bd88cb.png]

#### 1.3 测试路径访问优先级 ####

静态资源项目结构：

> 测试同时访问a.html

![在这里插入图片描述][34faf0859e164253a002251c0b492c46.png]

访问地址：

http://localhost:8080/a.html

测试结果：  
![在这里插入图片描述][dbd64c63f2544c6bbef04f9afb545b50.png]

#### 1.4 存在问题 ####

1）那么这个时候如果我们想要通过controller然后跳转到对应页面该怎么办呢？  
一般来说，controller跳转的页面都是放在templates目录下的，

如果我们像之前访问static目录下的文件那样，直接访问templates下的html文件

http://localhost:8080/test.html

结果：

![在这里插入图片描述][c5696c9c152740d0a811a75ec699f7de.png]

*  因此，想要访问templates下的静态资源，需要通过controller内部转发或重定向

@Controller//不能是@RestController【@RestController会转换为json格式】
    public class TestController {
        
    
        @RequestMapping("/test")
        public String test(){
        
            System.out.println("22222");
    //        return "/test.html"; //直接访问
    //        return "forward:/test.html";//请求转发
            return "redirect:/test.html";//重定向
        }
    }

![在这里插入图片描述][711531b1ff294c02ae908ccb63ae688e.png]  
结果：访问成功

2)如果我们目录层级有多层呢？

@Controller//不能是@RestController【@RestController会转换为json格式】
    public class TestController {
        
    
        @RequestMapping("/test")
        public String test(){
        
            System.out.println("3333");
            return "/html/test.html";
        }
    }

![在这里插入图片描述][e7fd6b632b014b81a3da69b88b8eef60.png]

可以直接通过在跳转的视图上添加上路径【但是如果路径太长就会有太多重复代码且不易扩展】

解决办法：  
①可以通过yml配置文件+controller请求转发/重定向  
②可以通过模板引擎如：thymeleaf  
导入jar包：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>

配置前后缀：

spring:
      #设置页面前后缀
      thymeleaf:
        prefix: classpath:/templates/html/
        suffix: .html

### 2 application.yml配置 ###

#### 2.1 spring.resources.static-location ####

> 设置SpringBoot项目静态资源位置【修改之后，默认静态资源位置失效】

spring.resources.static-location参数指定了SpringBoot-Web项目中静态文件存放位置，该参数默认设置为：classpath:/static,classpath:/public,classpath:/resources,classpath:/META-INF/resources,servlet context:/。  
以上地址中没有/template地址，当前配置文件中配置此项后，默认配置失效，使用自定义设置。

*  classpath：一般来说就是对应的项目中：web-pratice\\src\\main\\resources文件目录。如：**classpath:templates/**是将resouces目录下的templates文件夹设置为静态文件目录。【classpath路径为：文件编译后在target/classes目录下的文件】
 *  静态文件目录：存放html、jsp、css、js、图片、文本等类型文件的目录。这些文件都可以通过浏览器URL进行访问。同时controller中转发的文件目录也必须被设置为静态文件目录。

spring:
     web:
     resources:
     static-locations:  classpath:/templates/

*  static-path-pattern原理：当SpringBoot自动装配WebMvcAutoConfiguration时，当执行到addResourceHandlers方法时，其中的staticPathPattern默认值是/\*\*。如果yml文件中存在配置项spring.mvc.static-path-pattern，默认配置会被覆盖。当通过浏览器进行访问时，springMVC使用SimpleURLHandlerMapping进行路由映射，当执行到方法AbstractURLHandlerMapping时，将会使用spring.mvc.static-path-pattern配置项来匹配路径URL

#### 2.2 spring.mvc.static-path-pattern ####

> 设置静态资源访问路径【/login/test.html】

①在yml配置static-path-pattern

spring:
      mvc:
        static-path-pattern: /login/**
        # /login/** 访问login目录下的资源及其子目录【多层目录】
        # /login/* 访问login目录下的资源，不包括子目录【单层】

②这个时候，直接访问静态资源a.html  
http://localhost:8080/a.html  
报错：  
![在这里插入图片描述][0ea722ae8d224d87b0879db4199c55c0.png]  
③在URL前面加上login，再访问：  
http://localhost:8080/login/a.html  
***成功：***  
![在这里插入图片描述][c23b52100f1b49d383def06536251707.png]

#### 2.3 两大配置项总结（原理） ####

*  static-path-pattern:/login/\*\*配置就是在访问静态资源的路径上追加login关键字。默认值是static-path-pattern:/\*\*。

比如没有设置这个配置项之前，访问静态资源http://localhost:8080/test.html；设置了之后就必须是http://localhost:8080/login/test.html

*  static-locations:classpath:/static, classpath:templates , 用来指定存放静态资源的路径，查找静态资源时，会从上面的路径开始搜索，没有找到则返回404

### 3 拓展 ###

#### 3.1 请求转发与重定向 ####

*  请求转发：一次请求，服务器内部调用另外的组件处理，request和response可以共用【有限制性，只能转发到该应用中的某些资源、页面或controller请求】，可以直接访问WEB-INF目录下的页面
 *  重定向：两次请求，地址会改变，request和response不能共用，不能直接访问WEB-INF下面的资源【根据要跳转的资源，可以分为跳转到页面或跳转到其他controller】

请求转发、重定向，三种方式：

1.  ModelAndView

/**
     * 被跳转的controller
     */
    @Controller
    public class OtherController {
        
     
        /**
         * 被跳转的controller返回result.jsp
         * @return
         * @throws Exception
         */
        @RequestMapping("/other.do")
        public ModelAndView other()throws Exception{
        
     
            ModelAndView mv = new ModelAndView();
            mv.addObject("type", "被跳转的controller");
     
            mv.setViewName("result");
            return mv;
        }
    }

1.  字符串方式【String】

@Controller//不能是@RestController【@RestController会转换为json格式】
    public class TestController {
        
    
        @RequestMapping("/test")
        public String test(){
        
            System.out.println("6666");
            return "forward:/test.html";
        }
    }

1.  通过servlet api【返回值为void】

request.getRequestDispatcher("/jsp/result.jsp").forward(request, response);

> 如果templates有多层路径，可以通过在yml中配置静态资源路径+controller中的请求转发或重定向

①项目结构  
![在这里插入图片描述][a260188b99b944e69578b4ca82ccda13.png]  
②yml文件

spring:
      web:
        resources:
          static-locations: classpath:/templates/html/

③TestController

@Controller//不能是@RestController【@RestController会转换为json格式】
    public class TestController {
        
    
        @RequestMapping("/test")
        public String test(){
        
            System.out.println("777");
            return "forward:/test.html";
        }
    }

#### 3.2 WebMvcConfigurer(配置拦截、设置静态资源路径) ####

实现方式：

*  方式一实现WebMvcConfigurer接口（推荐）
 *  方式二继承WebMvcConfigurationSupport类

主要作用：

/* 拦截器配置 */
    void addInterceptors(InterceptorRegistry var1);
    /* 视图跳转控制器 */
    void addViewControllers(ViewControllerRegistry registry);
    /**
      *静态资源处理
      */
    void addResourceHandlers(ResourceHandlerRegistry registry);
    /* 默认静态资源处理器 */
    void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer);
    /**
      * 这里配置视图解析器
      */
    void configureViewResolvers(ViewResolverRegistry registry);
    /* 配置内容裁决的一些选项*/
    void configureContentNegotiation(ContentNegotiationConfigurer configurer);

##### \[1\]拦截器功能 #####

①配置拦截器  
首先，我们需要自定义拦截器

public class SystemInterceptor implements HandlerInterceptor {
        
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        
            System.out.println("经过拦截器...");
            return false;
        }
    }

②注册拦截器

@Configuration
    public class MyWebMvcConfigure implements WebMvcConfigurer {
        
        
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
        
            //注册拦截器
            registry.addInterceptor(new SystemInterceptor()).addPathPatterns("/**").excludePathPatterns("/login");
        }
    }

③controller层

@Controller
    public class TestController {
        
    
        @RequestMapping("/test")
        public String test(){
        
            System.out.println("3333");
            return "/html/test.html";
        }
    
        @RequestMapping("/login")
        public String login(){
        
            System.out.println("login...");
            return "login.html";
        }
    }

④测试  
![在这里插入图片描述][a8aee7b3569c4b07ab2b81b88b69f88c.png]

1.访问test

http://localhost:8080/test

结果：  
页面上空白，控制台打印：

2022-09-05 20:20:27.971  INFO 25188 --- [nio-8080-exec-2] o.s.web.servlet.DispatcherServlet        : Completed initialization in 1 ms
    经过拦截器...

2.访问login

http://localhost:8080/login

结果：  
成功返回页面  
![在这里插入图片描述][23721447ee4347f3a747f9f2e359c588.png]

##### \[2\]静态资源映射功能 #####

①创建MyWebMvcConfigure类  
将URL路径上的sub映射为test333

@Configuration
    public class MyWebMvcConfigure implements WebMvcConfigurer {
        
    
        @Override
        public void addResourceHandlers(ResourceHandlerRegistry registry) {
        
            registry.addResourceHandler("/sub/**").addResourceLocations("classpath:/test333/");
        }
    
    //    @Override
    //    public void addInterceptors(InterceptorRegistry registry) {
        
    //        //注册拦截器
    //        registry.addInterceptor(new SystemInterceptor()).addPathPatterns("/**").excludePathPatterns("/login");
    //    }
    }

项目结构  
![在这里插入图片描述][8db414484a5a4e9fbea2bbf2c540bb6d.png]  
②访问http://localhost:8080/sub/test3.html

> 映射之后为：classpath:/test333/test3.html

![在这里插入图片描述][12a79d78d377468dba6de85daa0675e6.png]

③结果，成功响应  
![在这里插入图片描述][51357782eb32434cbbbf66ef291d7daf.png]

[e82e0a65010147ac9736e44d34bd88cb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/dd46c5a2dcaf4bc9842b8061359bc2f9.png
[34faf0859e164253a002251c0b492c46.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/171a2514ad164150bfa8710d9115d6b9.png
[dbd64c63f2544c6bbef04f9afb545b50.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/fb83595d16da468698710c7d3104fd31.png
[c5696c9c152740d0a811a75ec699f7de.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/a87ae0a074e7483c8463211f05852c16.png
[711531b1ff294c02ae908ccb63ae688e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/7c342bcf757a40c093f07213d07beee4.png
[e7fd6b632b014b81a3da69b88b8eef60.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/bb3ce8e4dac0499a8694fb2ec5b67193.png
[0ea722ae8d224d87b0879db4199c55c0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/dd2f411c28854e469c1e0a2d0136da72.png
[c23b52100f1b49d383def06536251707.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/f6c575053efa4a9d8673868de434becd.png
[a260188b99b944e69578b4ca82ccda13.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/ab6f66cd8c77492c814e03873be50316.png
[a8aee7b3569c4b07ab2b81b88b69f88c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/d79611290cbc4713aa85db051c7e4ba8.png
[23721447ee4347f3a747f9f2e359c588.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/5d6c80bde29b4bea92f48a5b0828409c.png
[8db414484a5a4e9fbea2bbf2c540bb6d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/5a28f5ffb2b64367bde797e487f1ce56.png
[12a79d78d377468dba6de85daa0675e6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/d3943cb83ac64cfcb8c4f47187c084a9.png
[51357782eb32434cbbbf66ef291d7daf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/fbb2a23a82874a74a636a6b6e765a14e.png