首頁 > 軟體

springboot攔截器Interceptor的使用,你都瞭解嗎

2021-07-22 13:01:26

springmvc 中的攔截器可以對請求進行判別, 在請求到達控制器之前, 把非法的請求給攔截掉
下面來說一說, 它在springboot中的使用

攔截器是可以有多個的, 對不同的 url 進行攔截
我們這個例子設想的是, 如果使用者登入過, 就會使用者設定一個 session , 如果session中 有user 的資訊,就說明使用者是登入過的

1.我們先建立一個 User 的範例物件 domain

public class User {
    private Integer id;
    private String name;
    private Integer age;
    public User() {
    }
    public User(Integer id, String name, Integer age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
}

2.建立一個攔截器 LoginInterceptor 實現 HandlerInterceptor 介面,並實現其方法, 主要是 preHandle方法,其它的可以不用管

package com.huang.interceptor;
import com.huang.domain.User;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //如果使用者登入過才可以存取
        HttpSession session = request.getSession();
        User user = (User)session.getAttribute("user");
        if(user == null){
            response.sendRedirect(request.getContextPath()+"/user/login");
            return false;
        }else{
            return true;
        }
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

在我們的springmvc專案中, 建立好攔截器, 下一步就是要在 springmvc的組態檔xml 中去 寫 interceptors > interceptor > bean class=「攔截器的全類名」
但是在 springboot中, 我們不用這樣寫了, 我們可以使用 設定類的方式去完成

所以我們新建一個設定類 InterceptorConfig 去實現 WebMvcConfigurer 介面

package com.huang.configure;
import com.huang.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/user/**").excludePathPatterns("/user/login","/user/logout","/user/setsession");
    }
}

注意 我們要使用一個註解 @Configuration 表示這是一個設定類, springboot 在啟動的時候會自動掃瞄這個類
上面的程式碼可以看出, InterceptorRegistry 是一個 interceptor的註冊器類,使用 addInterceptor(new XXXInterceptor) 來把這個攔截器類註冊好, addPathPatterns("/user/**") 這個方法是被重構過的, 可以接受多個字串引數, 也可以接受一個list的集合, 也就是匹配的 url , excludePathPatterns() 也是重構過的, 表示哪些 url 是排除的, 也就是不經過這個攔截器

上面的攔截器和註冊都完成了, 我們就可以在控制器中寫幾個方法測試了

package com.huang.controller;

import com.huang.domain.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

@Controller
@RequestMapping(value="/user")
public class UserController {

    @RequestMapping(value="/login")
    @ResponseBody
    public String userlogin(){
        return "跳轉到使用者登入的頁面";
    }


    @RequestMapping(value="/gomain")
    @ResponseBody
    public String goMain(){
        return "這是使用者進入後的頁面";
    }

    @RequestMapping(value="/logout")
    @ResponseBody
    public String logout(){
        return "這是使用者登出介面";
    }

    @RequestMapping(value="/setsession")
    @ResponseBody
    public Object setSession(HttpServletRequest request){
        HttpSession session = request.getSession();
        session.setAttribute("user",new User(1,"huang",20));
        return "OK";
    }

}

在使用者沒有請求過 /user/setsession的時候,如果使用者請求了 /user/gomain 攔截器就會發揮作用, 把它跳轉到/user/login的介面上去,如果使用者請求過/user/setsession的話, 再去請求/user/gomain 攔截器就會放行, 請求到相應的結果

到此這篇關於springboot攔截器Interceptor的使用的文章就介紹到這了,更多相關springboot攔截器Interceptor內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com