教你用Springboot實現攔截器獲取header內容
分析
既然需要動態獲取那麼隻有兩種方式:要麼每次下遊請求過來時從請求頭中獲取,要麼定義統一的攔截器自動獲取。
實現
那麼我們就先來實現一下吧。
第一種比較簡單,直接使用springboot獲取請求頭的方式,從controller方法入口處使用: @RequestHeader(value = “xxxx”,required = false) String appUser的方式獲取請求頭
代碼如下:
@RequestMapping(name = "獲取用戶詳情信息",value = "/getUserDetail",method=GET) public String getUserDetail(@RequestHeader(value = "app-user",required = false) String appUser, @RequestParam(name = "search") String search){ log.info("------>拿到的請求頭是:"+appUser); return "SUCCESS"; }
此種方法雖然可以獲取,但是太過low b,而且如果有幾十個接口那麼都要這麼寫,過於累贅
還是使用攔截器的方式吧
具體如下:
首先,定義一個攔截器,需要實現HandlerInterceptor,其中包含preHandler以及afterCompletion分別對應調用前以及調用完成後
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相關請求頭<<<<<<<<"+userInfo); if(StringUtils.isNotEmpty(userInfo)){ //直接摟下來,放到ThreadLocal中 後續直接從中獲取 ThreadLocalUtils.set(MaiCaiApiConstants.MAI_CAI_APP_USER,userInfo); } return true;//註意 這裡必須是true否則請求將就此終止。 } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { //移除app-user ThreadLocalUtils.remove("app-user"); log.info("移除請求頭中的app-user:"+ThreadLocalUtils.get("app-user")); } }
後面隻要從ThreadLocal中按key去拿就可以瞭。
另外需要做的是
添加web過濾器
1、添加web 過濾器,管理過濾的類,以及過濾的請求路徑
2、繼承WebMvcConfigurationSupport 類 和上面一樣Generate,復寫父類的方法 addInterceptors
3、通過registry.addInterceptor攔截類,addPathPatterns攔截路徑,excludePathPatterns添加允許路徑
這裡我攔截的是以xxxx開頭的請求。
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/*"); } }
執行效果如下:
請求頭裡設置app-user信息
可以看到Controller中已經拿到請求頭裡的信息
獲取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"; }
方法執行完之後對應的threadlocal變量也被清除
到此這篇關於教你用Springboot實現攔截器獲取header內容的文章就介紹到這瞭,更多相關Springboot獲取header內容內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- springboot使用攔截器判斷是否登錄
- SpringBoot攔截器使用精講
- SpringBoot通過ThreadLocal實現登錄攔截詳解流程
- Java Spring攔截器案例詳解
- SpringMVC攔截器超詳細解讀