攔截器Interceptor,是SpringMVC中的核心內容,利用spring的AOP(Aspect Oriented Programming, 面向切面程式設計)特性,可以很方便的對使用者的業務程式碼進行橫向抽取,根據具體業務需求對應用功能進行增強。
在SpringBoot中使用Interceptor,同時採用全註解開發,涉及到以下介面和類:
- HandlerInterceptor:處理器攔截器,handler就是處理器,在springboot web開發中,由控制器來處理web請求,因此handler具體指控制器
- 使用全註解開發,通過@Configuration註解,讓一個java物件主任到IOC容器,並作為配置物件,這裡的JavaConfig類相當於一個xml配置檔案;
- 在以前的xml配置中
(1)通過引入一些標籤進行配置,在JavaConfig中,通過繼承一個類或者實現一個介面來實現配置,這裡所繼承的類、所實現的介面就相當於引入的標籤;
(3)通過設定所引入標籤的屬性和值,可以實現個性化配置,在JavaConfig中通過覆蓋類或者介面的方法來實現個性化配置。
下面通過一個案例來實現自定義攔截器
攔截/user/開頭的請求,不攔截/usr/login請求
1. 定義攔截器
package cn.eis220.web;
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 {
System.out.println("執行了logininterceptor的preHandle方法");
return true;
}
}
2. 使用JavaConfig註冊攔截器
java配置類相當於xml配置檔案
xml中通過引入interceptor標籤來進行配置,java配置類通過實現WebMvcController進行配置;
xml中通過修改標籤的屬性和值來個性化配置,java配置類通過實現WebMvcController的方法進行個性化配置
package cn.eis220.config;
import cn.eis220.web.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class MyAppCofnig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
LoginInterceptor loginInterceptor = new LoginInterceptor();
String[] path = {"/user/**"};
String[] excludePath = {"/user/login"};
registry.addInterceptor(loginInterceptor).addPathPatterns(path).excludePathPatterns(excludePath);
}
}
3. 定義控制器,測試攔截器
package cn.eis220.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class BootController {
@RequestMapping("/user/account")
@ResponseBody
public String userAccount(){
return "/user/account";
}
@RequestMapping("/user/login")
@ResponseBody
public String userLogin(){
return "/user/login";
}
}
4. 總結
步驟:
- 如何定義自己的攔截器:
實現HandlerInterceptor介面的方法,來自定義攔截器 - 如何註冊攔截器:
JavaConfig配置類實現WebMvcConfigurer介面的addInterceptor方法來註冊攔截器