Springboot自定义拦截器

Myth丶恋晨 2023-07-04 14:17 4阅读 0赞

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3draF9fXw_size_16_color_FFFFFF_t_70][]

> 本文基于boot搭建拦截器demo，配置路径拦截等一系列相关知识

**屁话不多说，直接进正文！**

**目录结构**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3draF9fXw_size_16_color_FFFFFF_t_70 1][]

**自定义拦截器**

package com.p_job.chess.interceptor;
    
    import com.p_job.chess.entity.Member;
    import com.p_job.chess.properties.LoginInterceptorConfig;
    import com.p_job.chess.utils.SessionUtil;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Component;
    import org.springframework.web.servlet.HandlerInterceptor;
    import org.springframework.web.servlet.ModelAndView;
    
    import javax.annotation.PostConstruct;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    @Component
    public class LoginInterceptor implements HandlerInterceptor {
    
        @Autowired
        private LoginInterceptorConfig loginInterceptorConfig;
    
        private static LoginInterceptor loginInterceptor;
    
        @PostConstruct
        public void init(){
            loginInterceptor = this;
            loginInterceptor.loginInterceptorConfig = this.loginInterceptorConfig;
        }
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            Member member = SessionUtil.getMember(request);
            if (member == null) response.sendRedirect(loginInterceptor.loginInterceptorConfig.getUrl());
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        }
    
        @Override
        public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        }
    
    }

> 上述示例代码就是简单的从session中获取当前登录用户，判断session中是否有此用户信息，没有则重定向到登录界面。

**注：**

**preHandle：请求到达controller层前触发，可配置权限拦截，以及url验签等一系列操作**

**postHandle：请求执行完controller层业务逻辑，但是在返回前触发，可对视图以及返回数据进一步处理等操作。**

**afterCompletion：请求以及返回均执行完成后触发，可编写资源清理，日志记录等后续操作。**

**拦截器配置**

package com.p_job.chess.interceptor;
    
    import com.p_job.chess.properties.LoginInterceptorConfig;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    
    @Configuration
    public class LoginInterceptorConfigurer implements WebMvcConfigurer {
    
        @Autowired
        private LoginInterceptorConfig loginInterceptorConfig;
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            InterceptorRegistration registration = registry.addInterceptor(new LoginInterceptor());
            registration.addPathPatterns("/**");
            registration.excludePathPatterns(loginInterceptorConfig.getOpenUrls());
        }
    }

> 上述示例代码就是在**addInterceptors**中添加我们自定义的拦截器，及配置拦截的url，以及不拦截的url
> 
> --------------------
> 
> **registration.addPathPatterns("/\*\*");**
> 
> **配置拦截所有请求**
> 
> --------------------
> 
> **registration.excludePathPatterns(loginInterceptorConfig.getOpenUrls());**
> 
> **添加过滤的请求，即不拦截。参数类型为String\[\]**
> 
> **注：Springboot2.x****之后拦截器会拦截静态资源，所以一般需要在这单独配置不拦截静态资源。**

**以下部分就贴一下读取资源及配置过滤的url代码，不做特别说明**

package com.p_job.chess.properties;
    
    import com.p_job.chess.MyPropertySourceFactory;
    import lombok.Data;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.PropertySource;
    import org.springframework.stereotype.Component;
    
    @Data
    @Component
    @Configuration
    @PropertySource(value = "classpath:/config/interceptorConfig.yml",
            encoding = "utf-8", factory = MyPropertySourceFactory.class)
    @ConfigurationProperties(prefix = "login")
    public class LoginInterceptorConfig {
    
        private String url;
    
        private String[] openUrls;
    
    }

**interceptorConfig.yml**

login:
      url: /login.html
      open-urls:
        - /resetPwd
        - /question
        - /register
        - /login
        - /**/*.js
        - /**/*.jpg
        - /**/*.css
        - /*.html

package com.p_job.chess;
    
    import org.springframework.boot.env.YamlPropertySourceLoader;
    import org.springframework.core.env.PropertySource;
    import org.springframework.core.io.support.DefaultPropertySourceFactory;
    import org.springframework.core.io.support.EncodedResource;
    
    import java.io.IOException;
    import java.util.List;
    
    public class MyPropertySourceFactory extends DefaultPropertySourceFactory {
    
        @Override
        public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {
            if (resource == null) return super.createPropertySource(name, resource);
            List<PropertySource<?>> sources = new YamlPropertySourceLoader().load(resource.getResource().getFilename(), resource.getResource());
            return sources.get(0);
        }
    
    }

对你有帮助的话，右上角给个赞呗~

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3draF9fXw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200211214202935.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3draF9fXw==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3draF9fXw_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200211215526842.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3draF9fXw==,size_16,color_FFFFFF,t_70