SpringBoot攔截器使用精講
我們對(duì)攔截器并不陌生,無(wú)論是 Struts 2 還是 Spring MVC 中都提供了攔截器功能,它可以根據(jù) URL 對(duì)請(qǐng)求進(jìn)行攔截,主要應(yīng)用于登陸校驗(yàn)、權(quán)限驗(yàn)證、亂碼解決、性能監(jiān)控和異常處理等功能上。Spring Boot 同樣提供了攔截器功能。?
在 Spring Boot 項(xiàng)目中,使用攔截器功能通常需要以下 3 步:
- 定義攔截器
- 注冊(cè)攔截器
- 指定攔截規(guī)則(如果是攔截所有,靜態(tài)資源也會(huì)被攔截)
定義攔截器
在 Spring Boot 中定義攔截器十分的簡(jiǎn)單,只需要?jiǎng)?chuàng)建一個(gè)攔截器類,并實(shí)現(xiàn) HandlerInterceptor 接口即可。
HandlerInterceptor? 接口中定義以下 3 個(gè)方法,如下表。
返回值類型 | 方法聲明 | 描述 |
---|---|---|
boolean | preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)? | 該方法在控制器處理請(qǐng)求方法前執(zhí)行,其返回值表示是否中斷后續(xù)操作,返回 true 表示繼續(xù)向下執(zhí)行,返回 false 表示中斷后續(xù)操作。 |
void | postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) | 該方法在控制器處理請(qǐng)求方法調(diào)用之后、解析視圖之前執(zhí)行,可以通過(guò)此方法對(duì)請(qǐng)求域中的模型和視圖做進(jìn)一步修改。 |
void | afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) | 該方法在視圖渲染結(jié)束后執(zhí)行,可以通過(guò)此方法實(shí)現(xiàn)資源清理、記錄日志信息等工作。 |
示例1
以 spring-boot-adminex 項(xiàng)目為例,在 net.biancheng.www.componet 中創(chuàng)建一個(gè)名為 LoginInterceptor 的攔截器類,對(duì)登陸進(jìn)行攔截,代碼如下。
package net.biancheng.www.componet; import lombok.extern.slf4j.Slf4j; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @Slf4j public class LoginInterceptor implements HandlerInterceptor { /** * 目標(biāo)方法執(zhí)行前 * * @param request * @param response * @param handler * @return * @throws Exception */ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { Object loginUser = request.getSession().getAttribute("loginUser"); if (loginUser == null) { //未登錄,返回登陸頁(yè) request.setAttribute("msg", "您沒(méi)有權(quán)限進(jìn)行此操作,請(qǐng)先登陸!"); request.getRequestDispatcher("/index.html").forward(request, response); return false; } else { //放行 return true; } } /** * 目標(biāo)方法執(zhí)行后 * * @param request * @param response * @param handler * @param modelAndView * @throws Exception */ @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { log.info("postHandle執(zhí)行{}", modelAndView); } /** * 頁(yè)面渲染后 * * @param request * @param response * @param handler * @param ex * @throws Exception */ @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { log.info("afterCompletion執(zhí)行異常{}", ex); } }
注冊(cè)攔截器
創(chuàng)建一個(gè)實(shí)現(xiàn)了 WebMvcConfigurer 接口的配置類(使用了 @Configuration 注解的類),重寫 addInterceptors() 方法,并在該方法中調(diào)用 registry.addInterceptor() 方法將自定義的攔截器注冊(cè)到容器中。
示例 2
在配置類 MyMvcConfig 中,添加以下方法注冊(cè)攔截器,代碼如下。
@Configuration public class MyMvcConfig implements WebMvcConfigurer { ...... @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new LoginInterceptor()); } }
指定攔截規(guī)則
在使用 registry.addInterceptor() 方法將攔截器注冊(cè)到容器中后,我們便可以繼續(xù)指定攔截器的攔截規(guī)則了,代碼如下。
@Slf4j @Configuration public class MyConfig implements WebMvcConfigurer { ...... @Override public void addInterceptors(InterceptorRegistry registry) { log.info("注冊(cè)攔截器"); registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**") //攔截所有請(qǐng)求,包括靜態(tài)資源文件 .excludePathPatterns("/", "/login", "/index.html", "/user/login", "/css/**", "/images/**", "/js/**", "/fonts/**"); //放行登錄頁(yè),登陸操作,靜態(tài)資源 } }
在指定攔截器攔截規(guī)則時(shí),調(diào)用了兩個(gè)方法,這兩個(gè)方法的說(shuō)明如下:
- addPathPatterns:該方法用于指定攔截路徑,例如攔截路徑為“/**”,表示攔截所有請(qǐng)求,包括對(duì)靜態(tài)資源的請(qǐng)求。
- excludePathPatterns:該方法用于排除攔截路徑,即指定不需要被攔截器攔截的請(qǐng)求。
至此,攔截器的基本功能已經(jīng)完成,接下來(lái),我們先實(shí)現(xiàn) spring-boot-adminex 的登陸功能,為驗(yàn)證登陸攔截做準(zhǔn)備。
實(shí)現(xiàn)登陸功能
1. 將 AdminEx 模板中的 main.html 移動(dòng)到 src/main/resources/templates 中,結(jié)構(gòu)如下圖。
圖1:main 頁(yè)面
2. 在 net.bianheng.www.controller 中創(chuàng)建一個(gè) LoginController, 并在其中添加處理登陸請(qǐng)求的方法 doLogin(),代碼如下。
package net.biancheng.www.controller; import lombok.extern.slf4j.Slf4j; import net.biancheng.www.bean.User; import org.springframework.stereotype.Controller; import org.springframework.util.StringUtils; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestMapping; import javax.servlet.http.HttpSession; import java.util.Map; @Slf4j @Controller public class LoginController { @RequestMapping("/user/login") public String doLogin(User user, Map<String, Object> map, HttpSession session) { if (user != null && StringUtils.hasText(user.getUsername()) && "123456".equals(user.getPassword())) { session.setAttribute("loginUser", user); log.info("登陸成功,用戶名:" + user.getUsername()); //防止重復(fù)提交使用重定向 return "redirect:/main.html"; } else { map.put("msg", "用戶名或密碼錯(cuò)誤"); log.error("登陸失敗"); return "login"; } } /* @RequestMapping("/main.html") public String mainPage(){ return "main"; }*/ }
3. 在配置類 MyMvcConfig 中添加視圖映射,代碼如下。
@Configuration public class MyMvcConfig implements WebMvcConfigurer { @Override public void addViewControllers(ViewControllerRegistry registry) { //當(dāng)訪問(wèn) “/” 或 “/index.html” 時(shí),都直接跳轉(zhuǎn)到登陸頁(yè)面 registry.addViewController("/").setViewName("login"); registry.addViewController("/index.html").setViewName("login"); //添加視圖映射 main.html 指向 dashboard.html registry.addViewController("/main.html").setViewName("main"); } ...... }
4. 在 login.html 適當(dāng)位置添加以下代碼,顯示錯(cuò)誤信息。
<p style="color: red" th:text="${msg}" th:if="${not #strings.isEmpty(msg)}"></p>
驗(yàn)證登陸及登陸攔截功能
1. 啟動(dòng) Spring Boot,在未登錄的情況下,直接通過(guò)“http://localhost:8080/main.html”訪問(wèn)主頁(yè),結(jié)果如下圖。
圖1:登陸被攔截
2. 在登陸頁(yè)用戶名和密碼輸入框內(nèi)分別輸入 “admin”和“admin123”,點(diǎn)擊下方的登陸按鈕,結(jié)果如下圖。
圖2:登陸失敗
3. 在登陸頁(yè)用戶名和密碼輸入框內(nèi)分別輸入 “admin”和“123456”,點(diǎn)擊下方的登陸按鈕,結(jié)果如下圖。
圖3:登陸成功?
以上就是SpringBoot攔截器使用精講的詳細(xì)內(nèi)容,更多關(guān)于SpringBoot攔截器的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Maven在Java8下如何忽略Javadoc的編譯錯(cuò)誤詳解
這篇文章主要給大家介紹了關(guān)于Maven在Java8下如何忽略Javadoc的編譯錯(cuò)誤的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2018-08-08java.math.BigDecimal的用法及加減乘除計(jì)算
這篇文章主要介紹了java.math.BigDecimal的用法及加減乘除計(jì)算,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-05-05在SpringBoot項(xiàng)目中整合攔截器的詳細(xì)步驟
在系統(tǒng)中經(jīng)常需要在處理用戶請(qǐng)求之前和之后執(zhí)行一些行為,例如檢測(cè)用戶的權(quán)限,或者將請(qǐng)求的信息記錄到日志中,即平時(shí)所說(shuō)的"權(quán)限檢測(cè)"及"日志記錄",下面這篇文章主要給大家介紹了關(guān)于在SpringBoot項(xiàng)目中整合攔截器的相關(guān)資料,需要的朋友可以參考下2022-09-09springboot 按月分表的實(shí)現(xiàn)方式
本文主要介紹了springboot 按月分表的實(shí)現(xiàn)方式,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04使用Log4j為項(xiàng)目配置日志輸出應(yīng)用詳解以及示例演示的實(shí)現(xiàn)分析
本篇文章是對(duì)Log4j為項(xiàng)目配置日志輸出應(yīng)用詳解以及示例演示的實(shí)現(xiàn)進(jìn)行了分析介紹,需要的朋友參考下2013-05-05java靜態(tài)工具類注入service出現(xiàn)NullPointerException異常處理
如果我們要在我們自己封裝的Utils工具類中或者非controller普通類中使用@Autowired注解注入Service或者M(jìn)apper接口,直接注入是報(bào)錯(cuò)的,因Utils用了靜態(tài)方法,我們無(wú)法直接用非靜態(tài)接口的,遇到這問(wèn)題,我們要想法解決,下面小編就簡(jiǎn)單介紹解決辦法,需要的朋友可參考下2021-09-09MyBatis如何實(shí)現(xiàn)流式查詢的示例代碼
這篇文章主要介紹了MyBatis 如何實(shí)現(xiàn)流式查詢的示例代碼,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-04-04Spring aop+反射實(shí)現(xiàn)電話號(hào)加密
線上項(xiàng)目涉及大量查詢接口中,存在電話號(hào)明文展示不合規(guī)的問(wèn)題。如果對(duì)每個(gè)接口返回結(jié)果中電話號(hào)相關(guān)字段修改相關(guān)代碼邏輯,則工作量較大花費(fèi)時(shí)間多。因此設(shè)計(jì)電話號(hào)加密注解,減少工作量。2021-06-06