如何優雅地使用Redis之點陣圖操作

作者：黃澤傑 來源：微信公眾號Java架構沉思錄

原文連結： https://mp.weixin.qq.com/s/DBqBcBoVtZhH8rMUwXubow

在進入今天的主題前，先簡單地解釋下Redis中的點陣圖到底是什麼。Redis官方文件對於點陣圖的介紹如下：

點陣圖不是一個真實的資料型別，而是定義在字串型別上的面向位的操作的集合。由於字串型別是二進位制安全的二進位制大物件，並且最大長度是 512MB，適合於設定 2^32個不同的位。

位操作分為兩組：常量時間單個位的操作，像設定一個位為 1 或者 0，或者獲取該位的值。對一組位的操作，例如計算指定範圍位的置位數量。

點陣圖的最大優勢是有時是一種非常顯著的節省空間來儲存資訊的方式。例如，在一個系統中，不同使用者由遞增的使用者 ID 來表示，可以使用 512MB 的記憶體來表示 400 萬使用者的單個位資訊（例如他們是否需要接收信件）。

簡而言之，點陣圖操作是用來操作位元位的，其優點是節省記憶體空間。為什麼可以節省記憶體空間呢？假如我們需要儲存100萬個使用者的登入狀態，使用點陣圖的話最少只需要100萬個位元位（位元位1表示登入，位元位0表示未登入）就可以儲存了，而如果以字串的形式儲存，比如說以userId為key，是否登入（字串“1”表示登入，字串“0”表示未登入）為value進行儲存的話，就需要儲存100萬個字串了，相比之下使用點陣圖儲存佔用的空間要小得多，這就是點陣圖儲存的優勢。

點陣圖常用操作

點陣圖的常用操作如下：

·setbit

設定特定key對應的位元位的值。

·getbit

獲取特定key對應的位元位的值。

·bitcount

統計給定key對應的字串位元位為1的數量。

使用點陣圖儲存使用者登入狀態

點陣圖的常見應用是用來儲存狀態值，比如儲存使用者的登入狀態。

假設我們現在有一個需求，需要記錄使用者註冊以來每天的登入狀態，那麼我們就可以以使用者id為key，然後以日期或者日期的偏移量作為下標，將登入狀態儲存到對應的位元位中，這樣就可以很方便地獲取使用者某一天的登入狀態了。

接下來看程式碼：

public class UserLoginStatusService { 
 
    private static final String host="111.111.111.111"; 
 
    private static final int port=6379; 
 
    private static final Jedis jedis=new Jedis(host,port); 
 
    //日期的初始值（也可以理解為使用者的註冊時間）， 
    //下文需要使用日期的偏移量作為redis點陣圖的offset， 
    //因此需要將要儲存登入狀態的日期減去該初始日期。 
    //這裡使用了Java 8的新日期API 
    private static final LocalDate beginDate=LocalDate.of(2018,1,1); 
 
    static { 
        jedis.connect(); 
    } 
 
    public void setLoginStatus(String userId, LocalDate date,boolean isLogin){ 
        long offset = getDateDuration(beginDate, date); 
        jedis.setbit(userId,offset,isLogin); 
    } 
 
    public boolean getLoginStatus(String userId,LocalDate date){ 
        long offset = getDateDuration(beginDate, date); 
        return jedis.getbit(userId,offset); 
    } 
 
    private long getDateDuration(LocalDate start ,LocalDate end){ 
        return start.until(end, ChronoUnit.DAYS); 
    } 
 
    public static void main(String[] args) { 
        UserLoginStatusService userLoginStatusService=new UserLoginStatusService(); 
        String userId="user_1"; 
        LocalDate today = LocalDate.now(); 
        userLoginStatusService.setLoginStatus(userId,today,true); 
        boolean todayLoginStatus = userLoginStatusService.getLoginStatus(userId, today); 
        System.out.println(String.format("The loginStatus of %s in %s is %s",userId,today,todayLoginStatus)); 
        LocalDate yesterday = LocalDate.now().minusDays(1); 
        boolean yesterdayLoginStatus = userLoginStatusService.getLoginStatus(userId, yesterday); 
        System.out.println(String.format("The loginStatus of %s in %s is %s",userId,yesterday,yesterdayLoginStatus)); 
    } 
 
}

程式碼不復雜，我們在main方法中設定當天的登入狀態為true，然後分別查出當天的登入狀態和昨天的登入狀態，由於redis點陣圖的位元位預設是0，所以該程式碼的正確輸出應該是今天已登入，昨天未登入，我們執行一次看看結果。

從程式執行結果來看，Redis的點陣圖確實滿足了我們的需求，且兼有節省儲存空間的優點。

使用點陣圖統計登入天數

接下來我們有一個新需求，就是統計某個使用者註冊後前10天的登入天數，Redis中有個bitcount命令，可以統計某個字串中的位元位為1的數量，其還有2個引數start和end，表示要統計的範圍，咋一看好像可以用來實現我們這個需求，但是這裡有一個坑需要注意下，bitcount命令的start和end引數指的是位元組的索引，而不是位元位的索引，而我們如果要使用點陣圖來統計某個使用者註冊後前10天的登入天數的話，需要統計的是位元位索引從0到9的位元值為1的數量，所以直接使用bitcount命令顯然是無法滿足要求的。那麼假如說我們一定要用點陣圖來儲存登入狀態呢，應該咋辦呢？其實辦法還是有的。我們可以先拿到位元位索引從0到9所在的位元組陣列，再將該位元組陣列解析成二進位制形式，進而統計出位元位索引從0到9位元值為1的數量。

要拿到位元位索引所在的位元組在位元組陣列中的下標比較簡單，只要將位元位索引除以8（一個位元組包含8個位元位）再向下取整就行了。接下來就是使用redis的getrange命令來擷取位元組陣列了。

拿到了位元組陣列，接下來就是解析位元組陣列，統計其中位元值為1的數量了。我們先從最簡單的單個位元組說起，假設一個位元組的各個位元位的值如下：

我們設位元位索引為index，假如我們要計算位元位為7的位元值，只需要將原值直接跟1進行與運算就行了。要計算位元位為6的位元值，只需要將原值右移1位，再跟1進行與運算。以此類推，要計算第index位的位元值，只需要先右移(7-index)位，再跟1進行與運算即可。

只要能夠統計出擷取出來的的位元組陣列中位元位的值為1的數量，接下來再減去不包含在對應位元索引中的位元值為1的數量，即可統計出給定的位元索引範圍內位元值為1的數量。

這麼說有點拗口，我們以上述例子為例進行講解吧。我們要統計出使用者註冊後前10天的登入天數，如果用點陣圖儲存使用者登入狀態，點陣圖中的索引為註冊天數的話，那麼我們需要統計位元索引從0到9的位元值為1的數量，才能計算出該使用者註冊後前10天的登入天數。

我們先計算出位元索引從0到9包含在哪一段位元組陣列中，前面說了，只需要將對應的索引除以8，再向下取整就行了。從而可以得知位元位索引從0到9對應的是下標從0到1的位元組陣列。

接下來使用getrange命令擷取該位元組陣列，假設其值如下：

假設位元索引0到9對應的位元組陣列的位元值情況如上所示，我們需要統計的是第一個位元組（下標為0）中的0到7位中位元值為1的數量，再加上第二個位元組（下標為1）中的第0到1位中位元值為1的數量。加起來剛好10位，也就是對應使用者註冊前10天的登入天數。當然我們也可以統計出這2個位元組中的位元值為1的總數，再減去第二個位元組的從2到7位（上述表格標紅的地方）中位元值為1的數量，也可統計出該使用者註冊後前10天的登入天數。本文用的是第二種方法。

接下來上程式碼：

private static final int BIT_AMOUNT_IN_ONE_BYTE =8; 
 
    private Jedis jedis; 
 
 
    public int bitCountByBitIndex(String key, long startBitIndex, long endBitIndex) { 
        int startByteIndex = getByteIndexInTheBytes(startBitIndex); 
        int endByteIndex = getByteIndexInTheBytes(endBitIndex); 
        byte[] bytes = jedis.getrange(key.getBytes(), startByteIndex, endByteIndex); 
        int totalBitInBytes = getTotalBitInBytes(bytes); 
        int startBitIndexInFirstByte = getBitIndexInTheByte(startBitIndex); 
        int endBitIndexInLastByte = getBitIndexInTheByte(endBitIndex); 
        byte firstByte = bytes[0]; 
        byte lastByte = bytes[bytes.length-1]; 
        for(int i=7;i>(BIT_AMOUNT_IN_ONE_BYTE-1-startBitIndexInFirstByte);i--){ 
            if(((firstByte>>i)&1)==1){ 
                totalBitInBytes--; 
            } 
        } 
        for(int i=0;i<(BIT_AMOUNT_IN_ONE_BYTE-1-endBitIndexInLastByte);i++){ 
            if(((lastByte>>i)&1)==1){ 
                totalBitInBytes--; 
            } 
        } 
 
        return totalBitInBytes; 
    } 
 
    private int getTotalBitInBytes(byte[] bytes){ 
        int count=0; 
        for(byte b:bytes){ 
            for(int i = 0; i< BIT_AMOUNT_IN_ONE_BYTE; i++){ 
                if(((b>>i)&1)==1){ 
                    count++; 
                } 
            } 
        } 
        return count; 
    } 
 
    private int getByteIndexInTheBytes(long offset){ 
        return (int) offset/ BIT_AMOUNT_IN_ONE_BYTE; 
    } 
 
    private int getBitIndexInTheByte(long offset){ 
        return (int)(offset-offset/ BIT_AMOUNT_IN_ONE_BYTE * BIT_AMOUNT_IN_ONE_BYTE); 
    }

程式碼就不註釋了，整體思路已經在上面講解了。

當然要實現本文所述的功能，也不一定非要這麼做，還是有其他的方案的。比如：可以將放入點陣圖的offset統一乘以8（一個位元組佔8位元），這樣一來就可以直接用redis的bitcount來統計對應索引範圍內的位元值為1的數量了，當然這種方案的缺點也相當明顯，就是浪費記憶體，因為原先只需要1位元儲存的資料，現在需要8位元儲存，所以這種方案不能很好地利用點陣圖索引節省儲存空間的特點。

來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/31473948/viewspace-2212664/，如需轉載，請註明出處，否則將追究法律責任。