Spring Boot 2.X 如何添加攔截器？

最近使用SpringBoot2.X搭建了一個項目，大部分接口都須要作登陸校驗，因此打算使用註解+攔截器來實現，在此記錄下實現過程。

 

1、實現原理

1. 自定義一個註解@NeedLogin，若是接口須要進行登陸校驗，則在接口方法或類方法上添加該註解。
2. 登陸攔截器LoginInterceptor校驗接口的方法或類上是否有@NeedLogin註解，有註解則進行登陸校驗。

2、主要代碼

1. NeedLogin註解代碼

package com.example.helloSpringBoot.annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 登陸註解 * * @Author: Java碎碎念 */ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface NeedLogin { }

2. 登陸攔截器LoginInterceptor

package com.example.helloSpringBoot.config; import com.example.helloSpringBoot.annotation.NeedLogin; import com.example.helloSpringBoot.util.WxUserInfoContext; import org.springframework.lang.Nullable; import org.springframework.stereotype.Component; import org.springframework.web.method.HandlerMethod; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; /** * 登陸攔截器 * * @Author: Java碎碎念 */ @Component public class LoginInterceptor implements HandlerInterceptor { //這個方法是在訪問接口以前執行的，咱們只須要在這裏寫驗證登錄狀態的業務邏輯，就能夠在用戶調用指定接口以前驗證登錄狀態了
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { if (handler instanceof HandlerMethod) { NeedLogin needLogin = ((HandlerMethod) handler).getMethodAnnotation(NeedLogin.class); if (null == needLogin) { needLogin = ((HandlerMethod) handler).getMethod().getDeclaringClass() .getAnnotation(NeedLogin.class); } // 有登陸驗證註解，則校驗登陸
            if (null != needLogin) { WxUserInfoContext curUserContext = (WxUserInfoContext) request.getSession() .getAttribute("curUserContext"); //若是session中沒有，表示沒登陸
                if (null == curUserContext) { response.setCharacterEncoding("UTF-8"); response.getWriter().write("未登陸！"); return false; } } } return true; } public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception { } public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception { } }

3. 配置攔截器

package com.example.helloSpringBoot.config; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; /** * WebConfig * * @Author: Java碎碎念 * */ @Configuration public class WebConfig implements WebMvcConfigurer { @Autowired private LoginInterceptor loginInterceptor; @Override public void addInterceptors(InterceptorRegistry registry) { // 自定義攔截器，添加攔截路徑和排除攔截路徑
        registry.addInterceptor(loginInterceptor).addPathPatterns("/**"); } }

3、驗證代碼

HelloController中添加兩個方法，testNeedLogin()方法添加登陸攔截，testNoLogin()方法不須要登陸攔截。

package com.example.helloSpringBoot.controller; import com.example.helloSpringBoot.annotation.NeedLogin; import org.springframework.web.bind.annotation.CrossOrigin; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class HelloController { /** * 測試不 須要登陸 * * */ @RequestMapping("/testNoLogin") public String testNoLogin (){ return "調用成功，此接口不須要登陸校驗！-Java碎碎念！"; } /** * 測試須要登陸 * * */ @NeedLogin @RequestMapping("/testNeedLogin") public String testNeedLogin (){ return "testNeedLogin！"; } }

testNeedLogin運行截圖以下：

testNoLogin運行截圖以下：

  

上述三步操做完成後便可實現登陸攔截，有問題歡迎留言溝通哦！

完整源碼地址：https://github.com/suisui2019/helloSpringBoot

 

推薦閱讀

1.Spring Boot 2.X 如何優雅的解決跨域問題？
2.Redis Cluster搭建高可用Redis服務器集羣
3.爲何單線程的Redis這麼快？
4.Spring Boot集成spring session實現session共享
5.Spring Boot入門-快速搭建web項目
6.Spring Boot2.0整合Redis
7.一篇文章搞定SpringMVC參數綁定
8.SpringMVC+Mybatis 如何配置多個數據源並切換？

 

限時領取免費Java相關資料，涵蓋了Java、Redis、MongoDB、MySQL、Zookeeper、Spring Cloud、Dubbo/Kafka、Hadoop、Hbase、Flink等高併發分佈式、大數據、機器學習等技術。

資料傳送門：  https://mp.weixin.qq.com/s/u2b_NVNuMuAPE0w4lc45fw

關注下方公衆號便可免費領取：

原文出處：https://www.cnblogs.com/haha12/p/10730235.html