您好,登錄后才能下訂單哦!
本篇內(nèi)容主要講解“java SpringBoot攔截器如何使用”,感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷,實用性強。下面就讓小編來帶大家學(xué)習(xí)“java SpringBoot攔截器如何使用”吧!
我們對攔截器并不陌生,無論是 Struts 2 還是 Spring MVC 中都提供了攔截器功能,它可以根據(jù) URL 對請求進行攔截,主要應(yīng)用于登陸校驗、權(quán)限驗證、亂碼解決、性能監(jiān)控和異常處理等功能上。Spring Boot 同樣提供了攔截器功能。
在 Spring Boot 項目中,使用攔截器功能通常需要以下 3 步:
定義攔截器
注冊攔截器
指定攔截規(guī)則(如果是攔截所有,靜態(tài)資源也會被攔截)
在 Spring Boot 中定義攔截器十分的簡單,只需要創(chuàng)建一個攔截器類,并實現(xiàn) HandlerInterceptor 接口即可。
HandlerInterceptor 接口中定義以下 3 個方法,如下表。
返回值類型 | 方法聲明 | 描述 |
---|---|---|
boolean | preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) | 該方法在控制器處理請求方法前執(zhí)行,其返回值表示是否中斷后續(xù)操作,返回 true 表示繼續(xù)向下執(zhí)行,返回 false 表示中斷后續(xù)操作。 |
void | postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) | 該方法在控制器處理請求方法調(diào)用之后、解析視圖之前執(zhí)行,可以通過此方法對請求域中的模型和視圖做進一步修改。 |
void | afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) | 該方法在視圖渲染結(jié)束后執(zhí)行,可以通過此方法實現(xiàn)資源清理、記錄日志信息等工作。 |
示例1
以 spring-boot-adminex 項目為例,在 net.biancheng.www.componet 中創(chuàng)建一個名為 LoginInterceptor 的攔截器類,對登陸進行攔截,代碼如下。
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 { /** * 目標方法執(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) { //未登錄,返回登陸頁 request.setAttribute("msg", "您沒有權(quán)限進行此操作,請先登陸!"); request.getRequestDispatcher("/index.html").forward(request, response); return false; } else { //放行 return true; } } /** * 目標方法執(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); } /** * 頁面渲染后 * * @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); } }
創(chuàng)建一個實現(xiàn)了 WebMvcConfigurer 接口的配置類(使用了 @Configuration 注解的類),重寫 addInterceptors() 方法,并在該方法中調(diào)用 registry.addInterceptor() 方法將自定義的攔截器注冊到容器中。
示例 2
在配置類 MyMvcConfig 中,添加以下方法注冊攔截器,代碼如下。
@Configuration public class MyMvcConfig implements WebMvcConfigurer { ...... @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new LoginInterceptor()); } }
在使用 registry.addInterceptor() 方法將攔截器注冊到容器中后,我們便可以繼續(xù)指定攔截器的攔截規(guī)則了,代碼如下。
@Slf4j @Configuration public class MyConfig implements WebMvcConfigurer { ...... @Override public void addInterceptors(InterceptorRegistry registry) { log.info("注冊攔截器"); registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**") //攔截所有請求,包括靜態(tài)資源文件 .excludePathPatterns("/", "/login", "/index.html", "/user/login", "/css/**", "/images/**", "/js/**", "/fonts/**"); //放行登錄頁,登陸操作,靜態(tài)資源 } }
在指定攔截器攔截規(guī)則時,調(diào)用了兩個方法,這兩個方法的說明如下:
addPathPatterns:該方法用于指定攔截路徑,例如攔截路徑為“/**”,表示攔截所有請求,包括對靜態(tài)資源的請求。
excludePathPatterns:該方法用于排除攔截路徑,即指定不需要被攔截器攔截的請求。
至此,攔截器的基本功能已經(jīng)完成,接下來,我們先實現(xiàn) spring-boot-adminex 的登陸功能,為驗證登陸攔截做準備。
1. 將 AdminEx 模板中的 main.html 移動到 src/main/resources/templates 中,結(jié)構(gòu)如下圖。
圖1:main 頁面
2. 在 net.bianheng.www.controller 中創(chuàng)建一個 LoginController, 并在其中添加處理登陸請求的方法 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", "用戶名或密碼錯誤"); 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) { //當訪問 “/” 或 “/index.html” 時,都直接跳轉(zhuǎn)到登陸頁面 registry.addViewController("/").setViewName("login"); registry.addViewController("/index.html").setViewName("login"); //添加視圖映射 main.html 指向 dashboard.html registry.addViewController("/main.html").setViewName("main"); } ...... }
4. 在 login.html 適當位置添加以下代碼,顯示錯誤信息。
<p th:text="${msg}" th:if="${not #strings.isEmpty(msg)}"></p>
1. 啟動 Spring Boot,在未登錄的情況下,直接通過“http://localhost:8080/main.html”訪問主頁,結(jié)果如下圖。
圖1:登陸被攔截
2. 在登陸頁用戶名和密碼輸入框內(nèi)分別輸入 “admin”和“admin123”,點擊下方的登陸按鈕,結(jié)果如下圖。
圖2:登陸失敗
3. 在登陸頁用戶名和密碼輸入框內(nèi)分別輸入 “admin”和“123456”,點擊下方的登陸按鈕,結(jié)果如下圖。
圖3:登陸成功
到此,相信大家對“java SpringBoot攔截器如何使用”有了更深的了解,不妨來實際操作一番吧!這里是億速云網(wǎng)站,更多相關(guān)內(nèi)容可以進入相關(guān)頻道進行查詢,關(guān)注我們,繼續(xù)學(xué)習(xí)!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。