SpringBoot使用Redis的zset統計在線(xiàn)用戶(hù)信息

目錄

統計在線(xiàn)用戶(hù)的數量，是應用很常見(jiàn)的需求了。如果需要精準的統計到用戶(hù)是在線(xiàn)，離線(xiàn)狀態(tài)，我想只有客戶(hù)端和服務(wù)器通過(guò)保持一個(gè)TCP長(cháng)連接來(lái)實(shí)現。如果應用本身并非一個(gè)IM應用的話(huà)，這種方式成本極高。

現在的應用都趨向于使用心跳包來(lái)標識用戶(hù)是否在線(xiàn)。用戶(hù)登錄后，每隔一段時(shí)間，往服務(wù)器推送一個(gè)消息，表示當前用戶(hù)在線(xiàn)。服務(wù)器則可以定義一個(gè)時(shí)間差，例如：5分鐘內收到過(guò)客戶(hù)端心跳消息，視為在線(xiàn)用戶(hù)。

在線(xiàn)用戶(hù)統計的實(shí)現

基于數據庫實(shí)現

最簡(jiǎn)單的辦法，就是在用戶(hù)表，添加一個(gè)最后心跳包的日期時(shí)間字段 last_active。服務(wù)器收到心跳后，每次都去更新這個(gè)字段為當前的最新時(shí)間。

如果要查詢(xún)最近5分鐘活躍的用戶(hù)數量，就可以簡(jiǎn)單的通過(guò)一句SQL完成。

SELECT COUNT(1) AS `online_user_count` FROM `user` WHERE `last_active` BETWEEN  '2020-12-22 13:00:00' AND '020-12-22 13:05:00';

弊端也是顯而易見(jiàn)，為了提高檢索效率，不得不為last_active字段添加索引，而因為心跳的更新，會(huì )導致頻繁的重新維護索引樹(shù)，效率極其低下。

基于Redis實(shí)現

這是比較理想的一種實(shí)現方式了，Redis基于內存進(jìn)行讀寫(xiě)，性能自然比關(guān)系型數據庫好得多，而且它所提供的Zset可以很方便的構建出一個(gè)在線(xiàn)用戶(hù)的統計服務(wù)。

Redis的Zset

這里不會(huì )涉及太多redis的東西，簡(jiǎn)單說(shuō)明以下zset。它是一個(gè)有序的set集合，集合中的每個(gè)元素由2個(gè)東西組成

• member 既然是集合，那么它便是集合中的元素，并且不能重復
• score  既然是有序的，它就是用于排序的權重字段
  

Zset的部分操作

添加元素

ZADD key score member [score member ...]

一次性添加一個(gè)或者多個(gè)元素到集合，如果member已經(jīng)存在則會(huì )使用當前score進(jìn)行覆蓋

統計所有的元素數量

ZCARD key

統計score值在min和max之間元素數量

ZCOUNT key min max

刪除score值在min和max之間的元素

ZREMRANGEBYSCORE key min max

一個(gè)示例

我打算，用一個(gè)zset存儲我內心中編程語(yǔ)言的評分排名，這個(gè)key叫做lang

添加信息，返回新添加的元素個(gè)數

> zadd lang 999 php 10 java 9 go 8 python 7 javascript
"5"

查看添加的數量

> zcard lang
"5"

查看評分在8 - 10之間的元素個(gè)數，有3個(gè)

> zcount lang 8 10
"3"

刪除評分在8 - 1000的元素，返回刪除的個(gè)數

> ZREMRANGEBYSCORE lang 8 1000
"4"

在線(xiàn)用戶(hù)服務(wù)的實(shí)現

知道了zset后，就可以實(shí)現一個(gè)在線(xiàn)用戶(hù)的統計服務(wù)了。

實(shí)現思路

客戶(hù)端每隔5分鐘發(fā)送一個(gè)心跳到服務(wù)器，服務(wù)器根據會(huì )話(huà)獲取到用戶(hù)的ID，作為zset的member
存入zset，score便是當前收到心跳的時(shí)間戳，當同一個(gè)用戶(hù)第二次發(fā)送心跳的時(shí)候，就會(huì )更新他對應的score值，由于更新是在內存，這個(gè)速度相當快。

zadd users 1608616915109 10000

需要統計出在線(xiàn)用戶(hù)的數量，本質(zhì)上就是需要統計出，最近5分鐘有發(fā)送心跳的用戶(hù)，通過(guò)zcount可以很輕松的統計出來(lái)。通過(guò)程序獲取到當前的時(shí)間戳，作為maxScore，時(shí)間戳減去5分鐘后作為minScore。

zcount users 1608616615109 1608616915109 

因為某些用戶(hù)可能長(cháng)時(shí)間沒(méi)有登錄過(guò)了，可以通過(guò)ZREMRANGEBYSCORE進(jìn)行清理。通過(guò)程序獲取到當前的時(shí)間戳，減去5分鐘后作為maxScore，使用0， 作為minScore，表示清理所有超過(guò)5分鐘沒(méi)有發(fā)送過(guò)心跳包的用戶(hù)。

ZREMRANGEBYSCORE users 0 1608616615109 

實(shí)現代碼

import java.time.Duration;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;

import javax.annotation.Resource;

import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;

/**
 * 
 * 
 * 在線(xiàn)用戶(hù)統計
 * 
 * @author Administrator
 *
 */
@Component
public class OnlineUserStatsService {
    
    private static final String ONLINE_USERS = "onlie_users";

    @Resource
    private StringRedisTemplate stringRedisTemplate;

    /**
     * 添加用戶(hù)在線(xiàn)信息
     * @param userId
     * @return 
     */
    public Boolean online(Integer userId) {
        return this.stringRedisTemplate.opsForZSet().add(ONLINE_USERS, userId.toString(), Instant.now().toEpochMilli());
    }
    
    /**
     * 獲取一定時(shí)間內，在線(xiàn)的用戶(hù)數量
     * @param duration
     * @return
     */
    public Long count(Duration duration) {
        LocalDateTime now = LocalDateTime.now();
        return this.stringRedisTemplate.opsForZSet().count(ONLINE_USERS, 
                                    now.minus(duration).atZone(ZoneId.systemDefault()).toInstant().toEpochMilli(), 
                                    now.atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
    }
    
    /**
     * 獲取所有在線(xiàn)過(guò)的用戶(hù)數量，不論時(shí)間
     * @return
     */
    public Long count() {
        return this.stringRedisTemplate.opsForZSet().zCard(ONLINE_USERS);
    }
    
    /**
     * 清除超過(guò)一定時(shí)間沒(méi)在線(xiàn)的用戶(hù)數據
     * @param duration
     * @return
     */
    public Long clear(Duration duration) {
        return this.stringRedisTemplate.opsForZSet().removeRangeByScore(ONLINE_USERS, 0, 
                LocalDateTime.now().minus(duration).atZone(ZoneId.systemDefault()).toInstant().toEpochMilli());
    }
}

使用示例

@Resource
private OnlineUserStatsService onlineUserStatsService;

@Test
public void test() {
    
    // ID為1的用戶(hù)發(fā)送了心跳包
    boolean result = this.onlineUserStatsService.online(1);
    System.out.println("online=" + result);
    
    // 獲取5分鐘內，發(fā)送過(guò)心跳包的用戶(hù)數量，也就是在線(xiàn)用戶(hù)的數量
    Long count = this.onlineUserStatsService.count(Duration.ofMinutes(5));
    System.out.println("oneline count=" + count);
    
    // 獲取所有發(fā)送過(guò)心跳包的用戶(hù)數量
    count = this.onlineUserStatsService.count();
    System.out.println("all count=" + count);
    
    // 清除超過(guò)1天都沒(méi)發(fā)送過(guò)心跳包的用戶(hù)
    Long clear = this.onlineUserStatsService.clear(Duration.ofDays(1));
    System.out.println("clear=" + clear);
}

內存消耗分析

可以通過(guò) 預算Redis的內存消耗

我對Redis的內存分配并不熟悉，只是按照自己的想法去填寫(xiě)了一些數據，所以我在這里理解的東西，可能是錯誤的。但是我想這并不耽誤證明 - 在這種場(chǎng)景使用Zset對內存消耗極低的事實(shí)

設想onlie_users需要存儲1億個(gè)用戶(hù)的狀態(tài)信息，每個(gè)元素score和member需要10個(gè)字節存儲，那么一共大約需要20G內存。20G的內存對于現在的服務(wù)器來(lái)說(shuō)，并不是大問(wèn)題。

最后

• 心跳協(xié)議不一定非要HTTP，如果客戶(hù)端支持的話(huà)UDP就很適合，可以節約一些系統開(kāi)銷(xiāo)。
• zset的key，不一定非要用String，可以修改序列化方式，以固定的字節的形式存儲用戶(hù)ID，在用戶(hù)ID過(guò)大的時(shí)候，可以節約一些存儲空間。

String userId = "10010";
System.out.println(userId.getBytes().length); // 以字符串形式存儲 => 需要5個(gè)字節

byte[] bin = ByteBuffer.allocate(4).putInt(Integer.valueOf(userId)).array();
System.out.println(bin.length);                    // 序列化為字節形式存儲 => 需要4個(gè)字節

System.out.println(ByteBuffer.wrap(bin).getInt());    // 反序列化為ID => 10010

以上就是SpringBoot使用Redis的zset統計在線(xiàn)用戶(hù)信息的詳細內容，更多關(guān)于SpringBoot統計在線(xiàn)用戶(hù)信息的資料請關(guān)注腳本之家其它相關(guān)文章！