SpringBoot快速設(shè)置攔截器并實(shí)現(xiàn)權(quán)限驗(yàn)證的方法
一、概述
攔截器的使用場(chǎng)景越來(lái)越多,尤其是面向切片編程流行之后。那通常攔截器可以做什么呢?
之前我們?cè)贏gent介紹中,提到過統(tǒng)計(jì)函數(shù)的調(diào)用耗時(shí)。這個(gè)思路其實(shí)和AOP的環(huán)繞增強(qiáng)如出一轍。
那一般來(lái)說(shuō),場(chǎng)景如下:
- 函數(shù)增強(qiáng):比如對(duì)一個(gè)函數(shù)進(jìn)行參數(shù)檢查,或者結(jié)果過濾等。甚至可以對(duì)函數(shù)就行權(quán)限認(rèn)證。
- 性能監(jiān)控:統(tǒng)計(jì)函數(shù)性能。
- 日志打點(diǎn):比如在用戶登錄函數(shù)之前,打點(diǎn)統(tǒng)計(jì)PV等信息。
以及其他等等。
二、Spring的攔截器
無(wú)論是SpringMVC或者SpringBoot中,關(guān)于攔截器不得不提:
org.springframework.web.servlet.handler.HandlerInterceptorAdapter
public abstract class HandlerInterceptorAdapter implements AsyncHandlerInterceptor { // 在目標(biāo)方法執(zhí)行前執(zhí)行 @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { return true; } // 在目標(biāo)方法執(zhí)行后執(zhí)行,但在請(qǐng)求返回前,我們?nèi)匀豢梢詫?duì) ModelAndView進(jìn)行修改 @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {} // 在請(qǐng)求已經(jīng)返回之后執(zhí)行 @Override public void afterCompletion( HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {} // 用來(lái)處理異步請(qǐng)求, 當(dāng)Controller中有異步請(qǐng)求方法的時(shí)候會(huì)觸發(fā)該方法 @Override public void afterConcurrentHandlingStarted( HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {} }
三、實(shí)現(xiàn)一個(gè)用于驗(yàn)證簡(jiǎn)單權(quán)限的攔截器
1、自定義一個(gè)權(quán)限注解 @Auth
@Inherited @Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Auth { String user() default ""; }
- @Inherited:在使用此自定義注解時(shí),如果注解在類上面時(shí),子類會(huì)自動(dòng)繼承此注解,否則,子類不會(huì)繼承此注解。這里一定要記住,使用Inherited聲明出來(lái)的注解,只有在類上使用時(shí)才會(huì)有效,對(duì)方法,屬性等其他無(wú)效。
- @Target:表示此注解可以放置的位置。常見的位置有:TYPE=枚舉或注解上,F(xiàn)IELD=字段上,METHOD=方法上,PARAMETER=函數(shù)形參列表中,CONSTRUCTOR=構(gòu)造函數(shù)上,LOCAL_VARIABLE=局部變量上 等等其他位置。
- @Retention:此注解的生命周期。常見的有:SOURCE=源碼時(shí)期;CLASS=字節(jié)碼時(shí)期(已編譯);RUNTIME=運(yùn)行時(shí)期,通常是用這個(gè)的時(shí)候要多。
- @Documentd:生成注解文檔。
2、在Controller的方法上添加注解
上一步添加完注解后,之后要在你所使用的方法上添加相關(guān)注解,如下。
@RestController @EnableAutoConfiguration public class DemoController { @Auth(user = "admin") @RequestMapping(value = "/hello", method = RequestMethod.GET) public String sayHello() { return "hello world."; } }
3、實(shí)現(xiàn)攔截器功能
需求:我們?cè)谟脩敉ㄟ^/hello這個(gè)URI訪問時(shí),對(duì)其進(jìn)行驗(yàn)證,如果為admin則放行,否則拒絕,假設(shè)用戶的身份在URL參數(shù)中。
思路:因此我們要在執(zhí)行sayHello()之前,對(duì)用戶做出驗(yàn)證。如果其身份與注解中的身份相同,則放行。因此我們要在preHandle()中做文章。
難點(diǎn):我們?cè)趺茨玫紺ontroller 方法上的@Auth這個(gè)注解呢?看PreHandle()的三個(gè)參數(shù),貌似也沒有哪個(gè)可以提供Controller類中的注解。
其實(shí),第三個(gè)參數(shù)handler,一般情況下其類型為:org.springframework.web.method.HandlerMethod類型,而這里面含有注解的相關(guān)信息。
為什么這么說(shuō)呢?
在SpringBoot中,注解的默認(rèn)類型為函數(shù)級(jí),而在SpringMVC其默認(rèn)類型為Controller對(duì)象級(jí)別。
因此,如果在SpringMVC中需要在dispatcher-servlet.xml中配置:
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping"/>,這樣其類型才為HandlerMethod。
我們看下具體實(shí)現(xiàn)邏輯:
@Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("preHandle"); if (!handler.getClass().isAssignableFrom(HandlerMethod.class)) { System.out.println("cat cast handler to HandlerMethod.class"); return true; } // 獲取注解 Auth auth = ((HandlerMethod) handler).getMethod().getAnnotation(Auth.class); if (auth == null) { System.out.println("cant find @Auth in this uri:" + request.getRequestURI()); return true; } // 從參數(shù)中取出用戶身份并驗(yàn)證 String admin = auth.user(); if (!admin.equals(request.getParameter("user"))) { System.out.println("permission denied"); response.setStatus(403); return false; } return true; }
其實(shí)實(shí)現(xiàn)邏輯就兩點(diǎn):從參數(shù)中取出身份,和注解中的進(jìn)行比對(duì)。
4、配置攔截器
那怎么讓剛才的這個(gè)攔截器生效呢?
這個(gè)時(shí)候,需要我們配置:WebMvcConfigurerAdapter
具體實(shí)現(xiàn)如下:
@Configuration public class ConfigAdapter extends WebMvcConfigurerAdapter { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/hello"); } }
注意:這里有兩點(diǎn)需要注意,一個(gè)是@Configuration這個(gè)注解,這樣才能讓SpringBoot服務(wù)發(fā)現(xiàn)這個(gè)配置;另一個(gè)是配置匹配項(xiàng),這里是對(duì)"/hello"這個(gè)進(jìn)行攔截。("/**"是對(duì)所有的訪問攔截)
四、運(yùn)行
訪問 http://127.0.0.1:8080/hello?user=admin就可以看到結(jié)果啦。
本文中的代碼詳見:https://github.com/hawkingfoo/springboot-interceptor
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
JDK動(dòng)態(tài)代理過程原理及手寫實(shí)現(xiàn)詳解
這篇文章主要為大家介紹了JDK動(dòng)態(tài)代理過程原理及手寫實(shí)現(xiàn)詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-09-09簡(jiǎn)單易懂的Java Map數(shù)據(jù)添加指南
Java提供了多種方法來(lái)往Map中添加數(shù)據(jù),開發(fā)者可以根據(jù)具體需求選擇合適的方法,需要的朋友可以參考下2023-11-11SpringBoot校園綜合管理系統(tǒng)實(shí)現(xiàn)流程分步講解
這篇文章主要介紹了SpringBoot+Vue實(shí)現(xiàn)校園綜合管理系統(tǒng)流程分步講解,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)吧2022-09-09Spring Cloud Alibaba和Dubbo融合實(shí)現(xiàn)
這篇文章主要介紹了Spring Cloud Alibaba和Dubbo融合實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-04-04利用Java實(shí)現(xiàn)word導(dǎo)入導(dǎo)出富文本(含圖片)的詳細(xì)代碼
這篇文章主要為大家詳細(xì)介紹了利用Java實(shí)現(xiàn)word導(dǎo)入導(dǎo)出富文本(含圖片),文中的示例代碼講解詳細(xì),對(duì)大家的學(xué)習(xí)或工作有一定的幫助,感興趣的小伙伴可以學(xué)習(xí)一下2024-02-02Java調(diào)用opencv實(shí)現(xiàn)圖片矯正功能
這篇文章主要為大家詳細(xì)介紹了Java如何調(diào)用opencv實(shí)現(xiàn)圖片矯正功能,文中的示例代碼簡(jiǎn)潔易懂,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-09-09Java?使用geotools讀取tiff數(shù)據(jù)的示例代碼
這篇文章主要介紹了Java?通過geotools讀取tiff,一般對(duì)于tiff數(shù)據(jù)的讀取,都會(huì)借助于gdal,本文結(jié)合示例代碼給大家介紹的非常詳細(xì),需要的朋友可以參考下2022-04-04JAVA實(shí)現(xiàn)基于Tcp協(xié)議的簡(jiǎn)單Socket通信實(shí)例
本篇文章主要介紹了JAVA實(shí)現(xiàn)基于Tcp協(xié)議的簡(jiǎn)單Socket通信實(shí)例,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來(lái)看看吧2017-01-01