SpringBoot 併發登錄人數控制

通常系統都會限制同一個賬號的登錄人數，多人登錄要麼限制後者登錄，要麼踢出前者，Spring Security 提供了這樣的功能，本文講解一下在沒有使用Security的時候如何手動實現這個功能

demo 技術選型

• SpringBoot
• JWT
• Filter
• Redis + Redisson

JWT（token）存儲在Redis中，類似 JSessionId-Session的關係，用戶登錄後每次請求在Header中攜帶jwt

如果你是使用session的話，也完全可以借鑒本文的思路，只是代碼上需要加些改動

兩種實現思路

比較時間戳

維護一個 username: jwtToken 這樣的一個 key-value 在Reids中, Filter邏輯如下

public class CompareKickOutFilter extends KickOutFilter {

    @Autowired
    private UserService userService;

    @Override
    public boolean isAccessAllowed(HttpServletRequest request, HttpServletResponse response) {
        String token = request.getHeader("Authorization");
        String username = JWTUtil.getUsername(token);
        String userKey = PREFIX + username;

        RBucket<String> bucket = redissonClient.getBucket(userKey);
        String redisToken = bucket.get();

        if (token.equals(redisToken)) {
            return true;

        } else if (StringUtils.isBlank(redisToken)) {
            bucket.set(token);

        } else {
            Long redisTokenUnixTime = JWTUtil.getClaim(redisToken, "createTime").asLong();
            Long tokenUnixTime = JWTUtil.getClaim(token, "createTime").asLong();

            // token > redisToken 則覆蓋
            if (tokenUnixTime.compareTo(redisTokenUnixTime) > 0) {
                bucket.set(token);

            } else {
                // 註銷當前token
                userService.logout(token);
                sendJsonResponse(response, 4001, "您的賬號已在其他設備登錄");
                return false;

            }

        }

        return true;

    }
}

隊列踢出

public class QueueKickOutFilter extends KickOutFilter {
    /**
     * 踢出之前登錄的/之後登錄的用戶 預設踢出之前登錄的用戶
     */
    private boolean kickoutAfter = false;
    /**
     * 同一個帳號最大會話數 預設1
     */
    private int maxSession = 1;

    public void setKickoutAfter(boolean kickoutAfter) {
        this.kickoutAfter = kickoutAfter;
    }

    public void setMaxSession(int maxSession) {
        this.maxSession = maxSession;
    }

    @Override
    public boolean isAccessAllowed(HttpServletRequest request, HttpServletResponse response) throws Exception {
        String token = request.getHeader("Authorization");
        UserBO currentSession = CurrentUser.get();
        Assert.notNull(currentSession, "currentSession cannot null");
        String username = currentSession.getUsername();
        String userKey = PREFIX + "deque_" + username;
        String lockKey = PREFIX_LOCK + username;

        RLock lock = redissonClient.getLock(lockKey);

        lock.lock(2, TimeUnit.SECONDS);

        try {
            RDeque<String> deque = redissonClient.getDeque(userKey);

            // 如果隊列里沒有此token，且用戶沒有被踢出；放入隊列
            if (!deque.contains(token) && currentSession.isKickout() == false) {
                deque.push(token);
            }

            // 如果隊列里的sessionId數超出最大會話數，開始踢人
            while (deque.size() > maxSession) {
                String kickoutSessionId;
                if (kickoutAfter) { // 如果踢出後者
                    kickoutSessionId = deque.removeFirst();
                } else { // 否則踢出前者
                    kickoutSessionId = deque.removeLast();
                }

                try {
                    RBucket<UserBO> bucket = redissonClient.getBucket(kickoutSessionId);
                    UserBO kickoutSession = bucket.get();

                    if (kickoutSession != null) {
                        // 設置會話的kickout屬性表示踢出了
                        kickoutSession.setKickout(true);
                        bucket.set(kickoutSession);
                    }

                } catch (Exception e) {
                }

            }

            // 如果被踢出了，直接退出，重定向到踢出後的地址
            if (currentSession.isKickout()) {
                // 會話被踢出了
                try {
                    // 註銷
                    userService.logout(token);
                    sendJsonResponse(response, 4001, "您的賬號已在其他設備登錄");

                } catch (Exception e) {
                }

                return false;

            }

        } finally {
            if (lock.isHeldByCurrentThread()) {
                lock.unlock();
                LOGGER.info(Thread.currentThread().getName() + " unlock");

            } else {
                LOGGER.info(Thread.currentThread().getName() + " already automatically release lock");
            }
        }

        return true;
    }

}

比較兩種方法

1. 第一種方法邏輯簡單粗暴, 只維護一個key-value 不需要使用鎖，非要說缺點的話沒有第二種方法靈活。
2. 第二種方法我很喜歡，代碼很優雅靈活，但是邏輯相對麻煩一些，而且為了保證線程安全地操作隊列，要使用分散式鎖。目前我們項目中使用的是第一種方法

本人免費整理了Java高級資料，涵蓋了Java、Redis、MongoDB、MySQL、Zookeeper、Spring Cloud、Dubbo高併發分散式等教程，一共30G，需要自己領取。
傳送門：https://mp.weixin.qq.com/s/osB-BOl6W-ZLTSttTkqMPQ