SpringBootでInterceptorインターセプターを使用する方法-＆＃＆チュートリアル-php.cn

SpringBootでInterceptorインターセプターを使用する方法

王林

リリース： 2023-05-11 09:13:05

転載

1359 人が閲覧しました

Springboot でのインターセプタの使用も比較的簡単です。HandlerInterceptor または AsyncHandlerInterceptor インターフェイスを実装し、構成からインターセプタを追加します。

AsyncHandlerInterceptor インターフェイスは HandlerInterceptor を継承し、afterConcurrentHandlingStarted メソッドを持ちます。

SpringBootでInterceptorインターセプターを使用する方法

インターフェイス内のメソッド:

preHandle: コントローラーの前に実行され、パラメーターを決定して実行されます。コントローラーメソッドなどの場合、戻り値はブール値で、true を返して実行を継続します (以下のインターセプターとコントローラー)、それ以外の場合はリターン操作を開始します (前のインターセプターのリターンとその他の操作を実行します)。
postHandle: コントローラーの後、ビューが戻る前に実行されます。ModelAndView は戻る前に処理できます。
afterCompletion: リクエストの完了後に実行されます。
afterConcurrentHandlingStarted: このメソッドは、コントローラーの戻り値が java.util.concurrent.Callable の場合にのみ、新しいスレッドを使用して呼び出され、実行されます。
次の 2 つのメソッドがあります。実行順序:

preHandle ->コントローラーの実行 ->postHandle ->afterCompletion;

preHandle ->コントローラーの実行 -> ; afterConcurrentHandlingStarted -> 呼び出し可能スレッドが call() メソッドを実行 -> 新しいスレッドが開始 preHandle -> postHandle -> afterCompletion; (コントローラーメソッドが Callable オブジェクトを返すとき)
インターセプターの構成:

WebMvcConfigurer インターフェイスで addInterceptors メソッドを実装し、パラメーター InterceptorRegistry オブジェクトを使用して独自のインターセプターを追加します。指定したインターセプトパスを追加したり、特定のフィルターパスを削除したりできます。インターセプタの優先順位 (小さいものから大きいものへ) デフォルト 0;

複数のインターセプタの実行順序:

preHandle メソッドは小さいものから大きいものへの順序です。コントローラーが実行された後、その他の;

テストスタートアップクラス、デフォルト構成:

/**
 * 2023年3月16日下午4:56:23
 */
package testspringboot.test9interceptor;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
/**
 * @author XWF
 *
 */
@SpringBootApplication
public class Test9Main {
 
    /**
     * @param args
     */
    public static void main(String[] args) {
        SpringApplication.run(Test9Main.class, args);
    }
 
}

ログイン後にコピー

コントローラークラス:

/**
 * 2023年3月16日下午4:58:02
 */
package testspringboot.test9interceptor;
 
import java.util.concurrent.Callable;
 
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
/**
 * @author XWF
 *
 */
@RestController
@RequestMapping("/interceptor")
public class Test9Controller {
 
    @RequestMapping("/a")
    public String a(String s) {
        System.out.println(">>>a():" + s);
        return "OK";
    }
    
    @RequestMapping("/b")
    public Callable<String> b() {
        Callable<String> callable = new Callable<String>() {
            @Override
            public String call() throws Exception {
                Thread.sleep(2000);
                System.out.println("call() thread id=" + Thread.currentThread().getId());
                Thread.sleep(2000);
                return "abcdefg";
            }
        };
        System.out.println(">>>b()");
        return callable;
    }
    
}

ログイン後にコピー

2 つのカスタムインターセプター 1 および 2:

/**
 * 2023年3月16日下午5:14:14
 */
package testspringboot.test9interceptor;
 
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
 
/**
 * @author XWF
 *
 */
public class MyInterceptor1 implements HandlerInterceptor {
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        System.out.println("preHandle 1, handler=" + handler);
        return request.getQueryString().length() < 10 ? true : false; 
    }
    
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle 1");
    }
    
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println("afterCompletion 1");
    }
    
}

ログイン後にコピー

/**
 * 2023年3月16日下午5:15:28
 */
package testspringboot.test9interceptor;
 
import java.util.Date;
 
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.AsyncHandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
 
/**
 * @author XWF
 *
 */
@Component
public class MyInterceptor2 implements AsyncHandlerInterceptor {
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        System.out.println("preHandle 2 " + new Date() + " ThreadId=" + Thread.currentThread().getId());
        return true;
    }
    
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle 2");
    }
    
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println("afterCompletion 2");
    }
    
    @Override
    public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        System.out.println("afterConcurrentHandlingStarted 2 " + new Date());
    }
    
}

ログイン後にコピー

構成インターセプトデバイス:

/**
 * 2023年3月16日下午5:20:31
 */
package testspringboot.test9interceptor;
 
import javax.annotation.Resource;
 
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
/**
 * @author XWF
 *
 */
@Configuration
public class MyInterceptorConfig implements WebMvcConfigurer {
 
    @Resource
    MyInterceptor2 myinterceptor2;
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor1())
            .addPathPatterns("/interceptor/a")        //添加拦截路径，两种参数List<String>和String ...
            .excludePathPatterns("/interceptor/b")        //排除路径，两种参数List<String>和String ...
            .order(1);        //设置拦截器顺序，由小到大，默认0
        registry.addInterceptor(myinterceptor2);    //也可以使用spring管理的对象
    }
    
}

ログイン後にコピー

ポストテストリクエストを送信: http://192.168.1.30:8080/interceptor/a?s=hello、インターセプター 2 の順序はデフォルトで 0、インターセプタ 1 の順序は 1、preHandle 2 が最初に実行されます。コントローラが実行された後、残りのハンドルが最初に実行され、次に 2 が実行されます。

preHandle のリクエストを送信します。 false を返すには: http://192.168 .1.30:8080/interceptor/a?s=hello123456789、インターセプター 1 の preHandle が false を返した後、2 の afterCompletion を直接実行します; SpringBootでInterceptorインターセプターを使用する方法

テスト呼び出し可能リクエストを送信します: http ://192.168.1.30:8080/interceptor/b?s=hello、インターセプトパス設定はインターセプター 1 をスキップし、インターセプター 2 のみを実行します。 threadid を通して、2 つのスレッドが使用されていることがわかります。前後; SpringBootでInterceptorインターセプターを使用する方法