拦截器
- 我们的开发时候会有很多的前端页面,但是用户没有登录的时候,时没有权限访问此页面的,所以就用到了拦截器。
- SpringMvc给我们提供了一个接口就是HandlerInterceptor接口,下面是这个接口的源码,源码中定义了三个方法preHandle:请求执行前的方法,postHandle:请求执行后的方法,afterCompletion:拦截完成之后的方法。
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//
package org.springframework.web.servlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.lang.Nullable;
public interface HandlerInterceptor {
default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
return true;
}
default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
}
default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
}
}
拦截器的使用
- 我们需要自己编写一个类来实现SpringMvc给我们提供的HandlerInterceptor接口,并实现preHandle方法在此方法中编写逻辑
- 用户登录的时候,通常的操作是把用户的信息,保存到session中,所以拦截的时候,我们可以判断session中是否有用户的登录信息,如果没有我们就拦截,如果有就放行,逻辑很简单,代码在下面
package com.cy.store.interceptor;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class LoginInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//获取session中的登录信息
Object obj = request.getSession().getAttribute("uid");
if (obj == null){
//重定向到登录页面
response.sendRedirect("/web/login.html");
return false;
}
return true;
}
}
- 我们写好上面的类之后,拦截器还是不可以使用的,我们需要注册拦截器,所以还需要编写一个配置类,还需要实现SpringMvc给我们提供的拦截器注册接口WebMvcConfigurer,这个接口的源码时下面的第一个,这个接口里面的方法很多,但是在这里我们只需要用到一个就是addInterceptors(InterceptorRegistry registry)方法。
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//
package org.springframework.web.servlet.config.annotation;
import java.util.List;
import org.springframework.format.FormatterRegistry;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.lang.Nullable;
import org.springframework.validation.MessageCodesResolver;
import org.springframework.validation.Validator;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
import org.springframework.web.servlet.HandlerExceptionResolver;
public interface WebMvcConfigurer {
default void configurePathMatch(PathMatchConfigurer configurer) {
}
default void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
}
default void configureAsyncSupport(AsyncSupportConfigurer configurer) {
}
default void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
}
default void addFormatters(FormatterRegistry registry) {
}
default void addInterceptors(InterceptorRegistry registry) {
}
default void addResourceHandlers(ResourceHandlerRegistry registry) {
}
default void addCorsMappings(CorsRegistry registry) {
}
default void addViewControllers(ViewControllerRegistry registry) {
}
default void configureViewResolvers(ViewResolverRegistry registry) {
}
default void addArgumentResolvers(List resolvers) {
}
default void addReturnValueHandlers(List handlers) {
}
default void configureMessageConverters(List> converters) {
}
default void extendMessageConverters(List> converters) {
}
default void configureHandlerExceptionResolvers(List resolvers) {
}
default void extendHandlerExceptionResolvers(List resolvers) {
}
@Nullable
default Validator getValidator() {
return null;
}
@Nullable
default MessageCodesResolver getMessageCodesResolver() {
return null;
}
}
- 我们编写好了自己的配置类之后进行注册操作,代码如下
package com.cy.store.config;
import com.cy.store.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.util.ArrayList;
import java.util.List;
@Configuration//加载当前配置类
public class LoginInterceptorConfigurer implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
//创建自定义拦截器对象,LoginInterceptor是我们上面自己创建的实现类
HandlerInterceptor interceptor = new LoginInterceptor();
//配置白名单:存放在一个List集合中,这里面的白名单是用户不登陆也可以访问的页面名单
List patterns = new ArrayList<>();
patterns.add("/bootstrap3/**");
patterns.add("/css/**");
patterns.add("/images/**");
patterns.add("/js/**");
patterns.add("/web/register.html");
patterns.add("/web/login.html");
patterns.add("/index.html");
patterns.add("/web/product.html");
patterns.add("/users/reg");
patterns.add("/users/login");
registry.addInterceptor(interceptor)//将我们创建的拦截器注册
.addPathPatterns("/**")//如果,我们上面定义的拦截器方法,返回的是false我们要拦截什么页面,表示要拦截的url是什么
.excludePathPatterns(patterns)//添加白名单
;
}
}