Analisis kod sumber pemintas SpringBoot

1. Apakah pemintas?

Pemintas dalam Java ialah objek yang memintas secara dinamik panggilan Tindakan. , juga boleh menghalang pelaksanaan Tindakan sebelum ia dilaksanakan, dan juga menyediakan cara untuk mengekstrak bahagian kod yang boleh digunakan semula dalam Tindakan. Dalam AOP, pemintas digunakan untuk memintas kaedah atau medan sebelum ia diakses, dan kemudian menambah operasi tertentu sebelum atau selepas.

Tindakan di atas secara amnya merujuk kepada antara muka lapisan Pengawal kami.

2. Pemintas tersuai

Secara umumnya, menyesuaikan pemintas terbahagi kepada tiga langkah

(1) Tulis pemintas untuk melaksanakan antara muka HandlerInterceptor.

(2) Pemintas didaftarkan di dalam bekas.

(3) Konfigurasikan peraturan pemintasan.

2.1 Menulis pemintas

Kami mencipta projek SpringBoot baharu, dan kemudian menyesuaikan pemintas LoginInterceptor untuk memintas permintaan tertentu dalam keadaan tidak dilog. Bermula dari JDK 1.8, kaedah antara muka dengan kata kunci lalai boleh mempunyai pelaksanaan lalai, jadi untuk melaksanakan antara muka anda hanya perlu melaksanakan kaedah tanpa kata kunci ini.

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * 登录拦截器
 */
@Slf4j
public class LoginInterceptor implements HandlerInterceptor {
    /**
     * 目标方法执行之前执行
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 获取请求路径
        String requestUrl = request.getRequestURI();
        log.info("请求的路径是: {}", requestUrl);

        String username = request.getParameter("username");
        if (username != null) {
            // 放行
            return true;
        }

        request.setAttribute("msg", "请先登录");
        // 携带msg跳转到登录页
        request.getRequestDispatcher("/").forward(request, response);
        return false;
    }

    /**
     * 目标方法完成以后执行
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle执行");
    }

    /**
     * 页面渲染以后执行
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion执行");
    }
}

2.2 Mendaftar dan mengkonfigurasi pemintas

Dalam SpringBoot, apabila kita perlu menyesuaikan konfigurasi, kita hanya perlu melaksanakan kelas WebMvcConfigurer dan mengatasi kaedah yang sepadan. Di sini kita perlu mengkonfigurasi pemintas, jadi tulis semula kaedah addInterceptorsnya.

import com.codeliu.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 WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**")  // 拦截所有路径
                .excludePathPatterns("/","/login","/css/**","/fonts/**","/images/**","/js/**");  // 不拦截这些路径
    }
}

Perhatikan bahawa jika kita mengkonfigurasi untuk memintas semua laluan, kita mesti mengecualikan sumber statik, jika tidak, gaya imej akan dipintas.

Melalui langkah di atas, kami telah menambah pemintas pada sistem. Hanya mulakan pengesahan.

3. Prinsip pemintas

Kami menggunakan penyahpepijatan titik putus untuk melihat cara permintaan penyemak imbas diproses ke bahagian belakang. Letakkan titik putus dalam kaedah doDispatch DispatcherServlet Ini ialah titik masuk permintaan Selepas penyemak imbas menghantar permintaan, ia dimajukan dan diproses dengan kaedah ini.

Mulakan aplikasi dalam mod nyahpepijat, akses mana-mana antara muka dan jejaki aliran kod

3.1 Cari pengendali yang boleh mengendalikan permintaan dan semua pemintas daripada pengendali

Di sini kami menemui HandlerExecutionChain dan rantai pemintas Terdapat tiga pemintas di dalamnya, LoginInterceptor tersuai kami dan dua pemintas lalai sistem.

3.2 Laksanakan kaedah praHandle pemintas

Dalam kaedah doDispatch, terdapat dua baris kod berikut

// 执行拦截器的preHandle方法，如果返回为fasle，则直接return，不执行目标方法
if (!mappedHandler.applyPreHandle(processedRequest, response)) {
    return;
}

// 反射执行目标方法
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

Mari masukkan kaedah applyPreHandle untuk melihat logik kaedah ini

/**
 * Apply preHandle methods of registered interceptors.
 * @return {@code true} if the execution chain should proceed with the
 * next interceptor or the handler itself. Else, DispatcherServlet assumes
 * that this interceptor has already dealt with the response itself.
 */
boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
    // 遍历拦截器
    for (int i = 0; i < this.interceptorList.size(); i++) {
        HandlerInterceptor interceptor = this.interceptorList.get(i);
        // 执行当前拦截器的preHandle方法
        if (!interceptor.preHandle(request, response, this.handler)) {
            // 如果preHandle方法返回为false，则执行当前拦截器的afterCompletion方法
            triggerAfterCompletion(request, response, null);
            return false;
        }
        // 记录当前拦截器的下标
        this.interceptorIndex = i;
    }
    return true;
}

Menerusi kod di atas, kita tahu bahawa jika kaedah praHandle pemintas semasa kembali benar, kaedah praHandle pemintas seterusnya akan terus dilaksanakan, jika tidak kaedah afterCompletion pemintas akan dilaksanakan.

Kemudian mari kita lihat logik kaedah triggerAfterCompletion.

/**
 * Trigger afterCompletion callbacks on the mapped HandlerInterceptors.
 * Will just invoke afterCompletion for all interceptors whose preHandle invocation
 * has successfully completed and returned true.
 */
void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) {
    // 反向遍历拦截器
    for (int i = this.interceptorIndex; i >= 0; i--) {
        HandlerInterceptor interceptor = this.interceptorList.get(i);
        try {
            // 执行当前拦截器的afterCompletion方法
            interceptor.afterCompletion(request, response, this.handler, ex);
        }
        catch (Throwable ex2) {
            logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);
        }
    }
}

Melalui kod di atas, kita tahu bahawa kaedah afterCompletion pemintas dilaksanakan secara terbalik.

3.3 Laksanakan kaedah sasaran

Jika semua kaedah praHandle pemintas di atas kembali benar, maka tidak akan ada pulangan langsung dalam kaedah doDispatch, tetapi kaedah sasaran akan terus dilaksanakan. Jika kaedah preHandle mana-mana pemintas mengembalikan palsu, maka selepas melaksanakan kaedah afterCompletion pemintas (pemintas yang telah melaksanakan kaedah preHandle), kaedah doDispatch akan kembali terus dan kaedah sasaran tidak akan dilaksanakan.

Laksanakan kaedah sasaran melalui kod berikut

// Actually invoke the handler.
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

Saya tidak akan melihat pelaksanaan dalaman tertentu, tetapi melihat logik selepas pelaksanaan.

3.4 Laksanakan kaedah postHandle pemintas

Selepas kaedah sasaran dilaksanakan, kod turun

mappedHandler.applyPostHandle(processedRequest, response, mv);

Lihat logik applyPostHandle

rreee

Laksanakan pemintas dalam susunan terbalik Kaedah postHandle pemintas

3.5 Laksanakan kaedah selepasPenyelesaian pemintas

Teruskan turun

/**
 * Apply postHandle methods of registered interceptors.
 */
void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @Nullable ModelAndView mv)
    throws Exception {
    // 反向遍历
    for (int i = this.interceptorList.size() - 1; i >= 0; i--) {
        HandlerInterceptor interceptor = this.interceptorList.get(i);
        // 执行当前拦截器的postHandle方法
        interceptor.postHandle(request, response, this.handler, mv);
    }
}

Masukkan kaedah ini, yang akan memproses hasil pelaksanaan dan jadikan halaman Kaedah ini Pada akhirnya, laksanakan kod berikut

3.6 Pengendalian pengecualian

Jika pengecualian dilemparkan semasa pelaksanaan kaedah doDispatch, ia akan dicetuskan dalam modul tangkapan Jalankan kaedah selepasPenyelesaian

Atas ialah kandungan terperinci Analisis kod sumber pemintas SpringBoot. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!