如何通過(guò)自定義注解進(jìn)行接口匿名訪問(wèn)

例如這樣：

所以想通過(guò)自定義一個(gè)注解，來(lái)進(jìn)行接口匿名訪問(wèn)。在實(shí)現(xiàn)需求前，我們先了解一下security的兩種方行思路。

第一種就是在configure(WebSecurity web)方法中配置放行，像下面這樣：

@Overridepublicvoidconfigure(WebSecurityweb)throwsException{
web.ignoring().antMatchers("/css/**","/js/**","/index.html","/img/**","/fonts/**","/favicon.ico","/verifyCode");
}

第二種方式是在configure(HttpSecurity http)方法中進(jìn)行配置：

@Overrideprotectedvoidconfigure(HttpSecurityhttpSecurity)throwsException
{
httpSecurity
.authorizeRequests()
.antMatchers("/hello").permitAll()
.anyRequest().authenticated()
}

兩種方式最大的區(qū)別在于，第一種方式是不走 Spring Security 過(guò)濾器鏈，而第二種方式走 Spring Security 過(guò)濾器鏈，在過(guò)濾器鏈中，給請(qǐng)求放行。

在我們使用 Spring Security 的時(shí)候，有的資源可以使用第一種方式額外放行，不需要驗(yàn)證，例如前端頁(yè)面的靜態(tài)資源，就可以按照第一種方式配置放行。

有的資源放行，則必須使用第二種方式，例如登錄接口。大家知道，登錄接口也是必須要暴露出來(lái)的，不需要登錄就能訪問(wèn)到的，但是我們卻不能將登錄接口用第一種方式暴露出來(lái)，登錄請(qǐng)求必須要走 Spring Security 過(guò)濾器鏈，因?yàn)樵谶@個(gè)過(guò)程中，還有其他事情要做，具體的登錄流程想了解的可以自行百度。

了解完了security的兩種放行策略后，我們開(kāi)始實(shí)現(xiàn)

首先創(chuàng)建一個(gè)自定義注解

@Target({ElementType.METHOD})//注解放置的目標(biāo)位置,METHOD是可注解在方法級(jí)別上@Retention(RetentionPolicy.RUNTIME)//注解在哪個(gè)階段執(zhí)行@Documented//生成文檔public@interfaceIgnoreAuth{
}

這里說(shuō)明一下，@Target({ElementType.METHOD})我的實(shí)現(xiàn)方式，注解只能標(biāo)記在帶有@RequestMapping注解的方法上。具體為什么下面的實(shí)現(xiàn)方式看完就懂了。

接下來(lái)創(chuàng)建一個(gè)security的配置類(lèi)SecurityConfig并繼承WebSecurityConfigurerAdapter

@EnableGlobalMethodSecurity(prePostEnabled=true,securedEnabled=true)
publicclassSecurityConfigextendsWebSecurityConfigurerAdapter
{

@Autowired
privateRequestMappingHandlerMappingrequestMappingHandlerMapping;

/**
*@description:使用這種方式放行的接口，不走SpringSecurity過(guò)濾器鏈，
*無(wú)法通過(guò)SecurityContextHolder獲取到登錄用戶(hù)信息的，
*因?yàn)樗婚_(kāi)始沒(méi)經(jīng)過(guò) SecurityContextPersistenceFilter 過(guò)濾器鏈。
*@dateTime:2021/7/1910:22
*/
@Override
publicvoidconfigure(WebSecurityweb)throwsException{
WebSecurityand=web.ignoring().and();
MaphandlerMethods=requestMappingHandlerMapping.getHandlerMethods();
handlerMethods.forEach((info,method)->{
//帶IgnoreAuth注解的方法直接放行
if(StringUtils.isNotNull(method.getMethodAnnotation(IgnoreAuth.class))){
//根據(jù)請(qǐng)求類(lèi)型做不同的處理
info.getMethodsCondition().getMethods().forEach(requestMethod->{
switch(requestMethod){
caseGET:
//getPatternsCondition得到請(qǐng)求url數(shù)組，遍歷處理
info.getPatternsCondition().getPatterns().forEach(pattern->{
//放行
and.ignoring().antMatchers(HttpMethod.GET,pattern);
});
break;
casePOST:
info.getPatternsCondition().getPatterns().forEach(pattern->{
and.ignoring().antMatchers(HttpMethod.POST,pattern);
});
break;
caseDELETE:
info.getPatternsCondition().getPatterns().forEach(pattern->{
and.ignoring().antMatchers(HttpMethod.DELETE,pattern);
});
break;
casePUT:
info.getPatternsCondition().getPatterns().forEach(pattern->{
and.ignoring().antMatchers(HttpMethod.PUT,pattern);
});
break;
default:
break;
}
});
}
});
}
}

在這里使用Spring為我們提供的RequestMappingHandlerMapping類(lèi)，我們可以通過(guò)requestMappingHandlerMapping.getHandlerMethods();獲取到所有的RequestMappingInfo信息。

以下是源碼部分，可不看，看了可以加深理解

這里簡(jiǎn)單說(shuō)一下RequestMappingHandlerMapping的工作流程，便于理解。我們通過(guò)翻看源碼

繼承關(guān)系如上圖所示。

AbstractHandlerMethodMapping實(shí)現(xiàn)了InitializingBean接口

publicinterfaceInitializingBean{
voidafterPropertiesSet()throwsException;
}

AbstractHandlerMethodMapping類(lèi)中通過(guò)afterPropertiesSet方法調(diào)用initHandlerMethods進(jìn)行初始化

publicvoidafterPropertiesSet(){
this.initHandlerMethods();
}

protectedvoidinitHandlerMethods(){
String[]var1=this.getCandidateBeanNames();
intvar2=var1.length;

for(intvar3=0;var3if(!beanName.startsWith("scopedTarget.")){
this.processCandidateBean(beanName);
}
}

this.handlerMethodsInitialized(this.getHandlerMethods());
}

再調(diào)用processCandidateBean方法：

protectedvoidprocessCandidateBean(StringbeanName){
ClassbeanType=null;

try{
beanType=this.obtainApplicationContext().getType(beanName);
}catch(Throwablevar4){
if(this.logger.isTraceEnabled()){
this.logger.trace("Couldnotresolvetypeforbean'"+beanName+"'",var4);
}
}

if(beanType!=null&&this.isHandler(beanType)){
this.detectHandlerMethods(beanName);
}

}

通過(guò)調(diào)用方法中的isHandler方法是不是requestHandler方法，可以看到源碼是通過(guò)RequestMapping，Controller 注解進(jìn)行判斷的。

protectedbooleanisHandler(ClassbeanType){
returnAnnotatedElementUtils.hasAnnotation(beanType,Controller.class)||AnnotatedElementUtils.hasAnnotation(beanType,RequestMapping.class);
}

判斷通過(guò)后，調(diào)用detectHandlerMethods方法將handler注冊(cè)到HandlerMethod的緩存中。

protectedvoiddetectHandlerMethods(Objecthandler){
ClasshandlerType=handlerinstanceofString?this.obtainApplicationContext().getType((String)handler):handler.getClass();
if(handlerType!=null){
ClassuserType=ClassUtils.getUserClass(handlerType);
Mapmethods=MethodIntrospector.selectMethods(userType,(method)->{
try{
returnthis.getMappingForMethod(method,userType);
}catch(Throwablevar4){
thrownewIllegalStateException("Invalidmappingonhandlerclass["+userType.getName()+"]:"+method,var4);
}
});
if(this.logger.isTraceEnabled()){
this.logger.trace(this.formatMappings(userType,methods));
}

methods.forEach((method,mapping)->{
MethodinvocableMethod=AopUtils.selectInvocableMethod(method,userType);
this.registerHandlerMethod(handler,invocableMethod,mapping);
});
}

}

通過(guò)registerHandlerMethod方法將handler放到private final Map mappingLookup = new LinkedHashMap();map中。

而requestMappingHandlerMapping.getHandlerMethods()方法就是獲取所有的HandlerMapping。

publicMapgetHandlerMethods(){
this.mappingRegistry.acquireReadLock();

Mapvar1;
try{
var1=Collections.unmodifiableMap(this.mappingRegistry.getMappings());
}finally{
this.mappingRegistry.releaseReadLock();
}

returnvar1;
}

最后就是對(duì)map進(jìn)行遍歷，判斷是否帶有IgnoreAuth.class注解，然后針對(duì)不同的請(qǐng)求方式進(jìn)行放行。

handlerMethods.forEach((info,method)->{
//帶IgnoreAuth注解的方法直接放行
if(StringUtils.isNotNull(method.getMethodAnnotation(IgnoreAuth.class))){
//根據(jù)請(qǐng)求類(lèi)型做不同的處理
info.getMethodsCondition().getMethods().forEach(requestMethod->{
switch(requestMethod){
caseGET:
//getPatternsCondition得到請(qǐng)求url數(shù)組，遍歷處理
info.getPatternsCondition().getPatterns().forEach(pattern->{
//放行
and.ignoring().antMatchers(HttpMethod.GET,pattern);
});
break;
casePOST:
info.getPatternsCondition().getPatterns().forEach(pattern->{
and.ignoring().antMatchers(HttpMethod.POST,pattern);
});
break;
caseDELETE:
info.getPatternsCondition().getPatterns().forEach(pattern->{
and.ignoring().antMatchers(HttpMethod.DELETE,pattern);
});
break;
casePUT:
info.getPatternsCondition().getPatterns().forEach(pattern->{
and.ignoring().antMatchers(HttpMethod.PUT,pattern);
});
break;
default:
break;
}
});
}
});

看到這里就能理解我最開(kāi)始的強(qiáng)調(diào)的需標(biāo)記在帶有@RequestMapping注解的方法上。我這里使用到的是configure(WebSecurity web)的放行方式。它是不走security的過(guò)濾鏈，是無(wú)法通過(guò)SecurityContextHolder獲取到登錄用戶(hù)信息的，這點(diǎn)問(wèn)題是需要注意的。

審核編輯：郭婷