Spring boot 攔截器寫法 樣例

攔截器寫法：

1.定義攔截器

2.註冊攔截器

3.conf加入掃描

 

 

1.定義攔截器

其實呢就是實現下面這個接口啦~ 不過有封裝好的抽象類 那就用嘍

 AsyncHandlerInterceptor 

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

import org.apache.commons.lang3.StringUtils;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import com.baidu.bce.plat.webframework.exception.BceException;

import lombok.extern.slf4j.Slf4j;


@Slf4j
@Component
public class AuthInterceptor extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        log.debug("[CHECK internal AUTH AOP] begin");
        checkSign(request);
        setUserId(request);
        log.debug("[CHECK internal AUTH AOP] end");
        return true;
    }

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

    private void checkSign(HttpServletRequest request) {
        // 做寫業務
    }

    private void setUserId(HttpServletRequest request) {
        String userId = request.getHeader("user_id"); // 看你的需求
      
        UserIdHolder.setAuthorizedUserId(userId);  // 這個是ThreadLocal
    }
}

2.註冊

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import lombok.extern.slf4j.Slf4j;

@Configuration
@ConditionalOnWebApplication
@ConditionalOnExpression("${auth.enable:false}")
@Slf4j
public class InternalAuthConfig {
    @Configuration
    public static class InternalAuthInterceptorConfigureAdapter extends WebMvcConfigurerAdapter {
        @Value("${auth.interceptor.path:/**}")
        private String path;

        @Value("${auth.interceptor.exclude.path:}")
        private String excludePath;

        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            log.info("add AuthInterceptorAdapter");
            AuthInterceptor interceptor = new AuthInterceptor();
            registry.addInterceptor(interceptor)
                    .addPathPatterns(path)
                    .excludePathPatterns(excludePath.split(";"));
        }
    }
}

 

3.加入spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.test.auth.AuthConfig

路徑類似於這個：

 

 

maven依賴

 

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <optional>true</optional>
</dependency>