前言

我們?cè)谑褂胹pring security的時(shí)候可以通過好幾種方法獲取用戶信息, 但是今天這篇文章介紹的是一個(gè)筆者覺得最優(yōu)雅的實(shí)現(xiàn); 借鑒現(xiàn)有的spring security controller自動(dòng)注入?yún)?shù)的方法, 我們來進(jìn)一步的實(shí)現(xiàn)更適合我們業(yè)務(wù)的用戶信息獲取方法;

思路

現(xiàn)在spring security會(huì)在controller自動(dòng)注入Authentication/Userdetails等參數(shù), 我們拿到這些對(duì)象之后還需要一些處理才可以拿到我們需要的信息, 例如用戶ID; 那獲取用戶ID這個(gè)步驟其實(shí)可以切片的, 我們直接在controller的參數(shù)綁定之前, 獲取到我們需要的用戶信息, 然后添加到request的param里面, 就可以實(shí)現(xiàn)獲取用戶信息, controller里面使用參數(shù)名可以直接接收參數(shù);

少啰嗦, 看代碼

首先我們這個(gè)功能的實(shí)現(xiàn)遇到額第一個(gè)障礙就是默認(rèn)的HttpServletRequest是沒有提供修改Parameter的方法的, 那么我們即使獲取到用戶信息也無法寫入request; 解決這個(gè)問題就需要自己實(shí)現(xiàn)一個(gè)HttpServletRequestWrapper, 再使用一個(gè)Filter替換原來的request;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
import java.util.Vector;

/**
 * @author sunhao
 * @date create in 2019-12-09 14:39:52
 */
public class UserInfoRequest extends HttpServletRequestWrapper {

    private Map<String, String[]> params = new HashMap<>();

    /**
     * Constructs a request object wrapping the given request.
     *
     * @param request The request to wrap
     *
     * @throws IllegalArgumentException if the request is null
     */
    public UserInfoRequest(HttpServletRequest request) {

        super(request);
        //將參數(shù)表，賦予給當(dāng)前的Map以便于持有request中的參數(shù)
        this.params.putAll(request.getParameterMap());
    }

    /**
     * 在獲取所有的參數(shù)名,必須重寫此方法，否則對(duì)象中參數(shù)值映射不上
     */
    @Override
    public Enumeration<String> getParameterNames() {
        return new Vector<>(params.keySet()).elements();
    }

    /**
     * 重寫getParameter方法
     *
     * @param name 參數(shù)名
     * @return 返回參數(shù)值
     */
    @Override
    public String getParameter(String name) {
        String[] values = params.get(name);
        if (values == null || values.length == 0) {
            return null;
        }
        return values[0];
    }

    @Override
    public String[] getParameterValues(String name) {
        String[] values = params.get(name);
        if (values == null || values.length == 0) {
            return null;
        }
        return values;
    }


    /**
     * 增加參數(shù)
     *
     * @param name  參數(shù)名
     * @param value 參數(shù)值
     */
    public void addParameter(String name, Object value) {
        if (value != null) {
            if (value instanceof String[]) {
                params.put(name, (String[]) value);
            } else if (value instanceof String) {
                params.put(name, new String[]{(String) value});
            } else {
                params.put(name, new String[]{String.valueOf(value)});
            }
        }
    }
}

這段代碼使用了樂傻驢用戶的代碼, 在此表示感謝; 然后使用Filter將原有的request替換;

@Component
public class UserInfoFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
        filterChain.doFilter(new UserInfoRequest(request), response);
    }
}

現(xiàn)在我們可以獲取用戶信息然后寫入request的parameter了, 這個(gè)邏輯是在filter里實(shí)現(xiàn)還是在interceptor里實(shí)現(xiàn)就看讀者自己的想法了; 筆者系統(tǒng)里面有多種用戶, 獲取用戶信息的邏輯有所不同, 所以筆者選擇使用interceptor來實(shí)現(xiàn), 可以通過自定義注解來控制注入哪種用戶信息;

@Component
public class UserInfoInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {

        Method method = ((HandlerMethod) handler).getMethod();
        AdminUserInfo adminUserInfo = method.getDeclaredAnnotation(AdminUserInfo.class);
        if (adminUserInfo != null) {
            
            // 獲取用戶信息的邏輯 自由發(fā)揮
            Long userId = ((Admin) ((OAuth2Authentication) request.getUserPrincipal()).getPrincipal()).getId();
            
            // 將用戶信息寫入request的parameter
            ((UserInfoRequest)request).addParameter("userId", userId);
            return true;
        }

        EmployeeUserInfo employeeUserInfo = method.getDeclaredAnnotation(EmployeeUserInfo.class);
        if (employeeUserInfo != null) {
            Long userId = ((Employee) ((OAuth2Authentication) request.getUserPrincipal()).getPrincipal()).getId();
            ((UserInfoRequest)request).addParameter("userId", userId);
            return true;
        }

        return true;
    }
}

上面我自己寫了兩個(gè)注解, 這兩個(gè)注解的代碼我就不貼出來了, 寫這兩個(gè)注解完全就是為了注入不同的用戶信息; 大家可以各自發(fā)揮, 注解不是必須的, 如果大家系統(tǒng)里面只有一種用戶或者由于其他原因可以直接注入parameter; 接下來配置interceptor

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    private final UserInfoInterceptor userInfoInterceptor;

    public WebMvcConfig(UserInfoInterceptor userInfoInterceptor) {

        this.userInfoInterceptor = userInfoInterceptor;
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(userInfoInterceptor);
    }
}

代碼寫到這里功能已經(jīng)做完了, 我們可以在controller里面這樣獲取用戶信息

  @EmployeeUserInfo // 自定義注解
  @GetMapping
  public void testObtainUserInfo(Long userId) {

    System.out.println("userId = " + userId);
  }

寫EmployeeUserInfo注解注入的就是employee的用戶信息, 寫AdminUserInfo注解注入的就是admin的用戶信息