App下載

如何使用SpringBoot的攔截器來獲取header的內(nèi)容

猿友 2021-08-02 10:49:54 瀏覽數(shù) (6132)
反饋

本篇文章將為大家詳細(xì)介紹關(guān)于 SpringBoot 中如何自定義一個(gè)攔截器,從而使用這個(gè)攔截器來獲取請(qǐng)求頭 header 的內(nèi)容,下面是詳情內(nèi)容,希望能對(duì)大家的學(xué)習(xí)有所幫助。

分析

既然需要?jiǎng)討B(tài)獲取那么只有兩種方式:要么每次下游請(qǐng)求過來時(shí)從請(qǐng)求頭中獲取,要么定義統(tǒng)一的攔截器自動(dòng)獲取。

實(shí)現(xiàn)

那么我們就先來實(shí)現(xiàn)一下吧。

第一種比較簡(jiǎn)單,直接使用springboot獲取請(qǐng)求頭的方式,從controller方法入口處使用: @RequestHeader(value = "xxxx",required = false) String appUser的方式獲取請(qǐng)求頭

代碼如下:

@RequestMapping(name = "獲取用戶詳情信息",value = "/getUserDetail",method=GET)
 
public String getUserDetail(@RequestHeader(value = "app-user",required = false) String appUser, @RequestParam(name = "search") String search){       
 
    log.info("------>拿到的請(qǐng)求頭是:"+appUser);    
 
    return "SUCCESS";
 
}

此種方法雖然可以獲取,但是太過low b,而且如果有幾十個(gè)接口那么都要這么寫,過于累贅

還是使用攔截器的方式吧

具體如下:

首先,定義一個(gè)攔截器,需要實(shí)現(xiàn)HandlerInterceptor,其中包含preHandler以及afterCompletion分別對(duì)應(yīng)調(diào)用前以及調(diào)用完成后

package com.xxxx.cc.admin.interceptor;
 
 
 
 
 
import com.alibaba.fastjson.JSONObject;
 
import com.ddmc.cc.admin.support.ThreadLocalUtils;
 
import lombok.extern.slf4j.Slf4j;
 
import org.apache.commons.lang.StringUtils;
 
import org.springframework.stereotype.Component;
 
import org.springframework.web.servlet.HandlerInterceptor;
 
 
 
import javax.servlet.http.HttpServletRequest;
 
import javax.servlet.http.HttpServletResponse;
 
 
 
/**
* Copyright (C), 2017-2021 
* Author: sjugg
* Date: 2021/5/19 10:39
* FileName: AuthInterceptor
* Description: 交易前置攔截器
*/
 
@Component
 
@Slf4j
 
public class AuthInfoInterceptor implements HandlerInterceptor {
 
 
 
    @Override
 
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
 
        String userInfo = request.getHeader("app-user");
 
        log.info(">>>>>>>攔截到api相關(guān)請(qǐng)求頭<<<<<<<<"+userInfo);
 
        if(StringUtils.isNotEmpty(userInfo)){
 
            //直接摟下來,放到ThreadLocal中 后續(xù)直接從中獲取
 
           ThreadLocalUtils.set(MaiCaiApiConstants.MAI_CAI_APP_USER,userInfo);
 
        }
 
        return true;//注意 這里必須是true否則請(qǐng)求將就此終止。
 
    }
 
 
    @Override
 
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
 
        //移除app-user
 
        ThreadLocalUtils.remove("app-user");
 
        log.info("移除請(qǐng)求頭中的app-user:"+ThreadLocalUtils.get("app-user"));
 
    }
 
}

后面只要從ThreadLocal中按key去拿就可以了。

另外需要做的是

添加web過濾器

1、添加web 過濾器,管理過濾的類,以及過濾的請(qǐng)求路徑

2、繼承WebMvcConfigurationSupport 類 和上面一樣Generate,復(fù)寫父類的方法 addInterceptors

3、通過registry.addInterceptor攔截類,addPathPatterns攔截路徑,excludePathPatterns添加允許路徑

這里我攔截的是以xxxx開頭的請(qǐng)求。

package com.ddmc.cc.admin.config;
 
 
import com.ddmc.cc.admin.interceptor.AuthInfoInterceptor;
 
import org.springframework.beans.factory.annotation.Autowired;
 
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
 
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
 
 
/**
* 
*
* @author sjugg
* @since 2021/5/13 4:43 下午
*/
 
@Configuration
 
public class WebConfig implements WebMvcConfigurer {
 
 
    @Autowired
 
    private AuthInfoInterceptor authInfoInterceptor;
 
 
    @Override
 
    public void addInterceptors(InterceptorRegistry registry) {
 
        registry.addInterceptor(authInfoInterceptor).addPathPatterns("/xxxx/*");
 
    }
 
}

執(zhí)行效果如下

請(qǐng)求頭里設(shè)置app-user信息

 

可以看到Controller中已經(jīng)拿到請(qǐng)求頭里的信息

獲取head的代碼:

@RequestMapping(name = "獲取用戶詳情信息",value = "/getUserDetail",method=GET)
 
public String getUserDetail(@RequestParam(name = "search") String search){
 
    log.info("-----> heard info here: "+ThreadLocalUtils.get("app-user"));
 
    return "SUCCESS";
}

方法執(zhí)行完之后對(duì)應(yīng)的threadlocal變量也被清除

 

以上就是關(guān)于 SpringBoot 如何通過自定義攔截器的方式來獲取請(qǐng)求頭 header 的詳情內(nèi)容,想要了解更多相關(guān) Springboot 其他的內(nèi)容請(qǐng)搜索W3Cschool以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,也希望大家以后多多支持!


0 人點(diǎn)贊