編程思想:巧用位運算重構代碼

来源:https://www.cnblogs.com/OceanEyes/archive/2020/03/22/bitmask.html

開篇 在一門編程語言中,往往會提供大量的運算符。按功能來分的話,有算術運算符、賦值運算符、關係運算符、邏輯運算符、位運算符等。這些對於大家來說都不陌生。但是,本期的主角『位運算』符相對而言是比較少去使用的。因為位運算符主要針對兩個二進位數進行位運算。 巧用位運算能極大的精簡代碼和提高程式效率。所以, ...


開篇

在一門編程語言中,往往會提供大量的運算符。按功能來分的話,有算術運算符、賦值運算符、關係運算符、邏輯運算符、位運算符等。這些對於大家來說都不陌生。但是,本期的主角『位運算』符相對而言是比較少去使用的。因為位運算符主要針對兩個二進位數進行位運算。

巧用位運算能極大的精簡代碼和提高程式效率。所以,在一些優秀的開源代碼中,經常能出現位運算。所以,把位運算這種思想遷移到業務代碼里,有時候往往能起到柳暗花明般的重構。

位運算

在 JAVA 語言中,定義了諸多的位運算符,如下所示:

運算符 描述
&
|
~
^ 異或
<< 左移
>> 右移

&(與)

十進位 二進位
3 0 0 1 1
5 0 1 0 1
& 後結果:1 0 0 0 1

即:對應位都為 1 時,才為 1,否則全為 0。

|(或)

十進位 二進位
3 0 0 1 1
5 0 1 0 1
| 後結果 :7 0 1 1 1

即:對應位只要有 1 時,即為 1,否則全為 0。

~(非)

十進位 二進位
3 0 0 1 1
~ 後結果:12 1 1 0 0

即:對應位取反。

異或 ^

十進位 二進位
3 0 0 1 1
5 0 1 0 1
^ 後結果:6 0 1 1 0

即:只要對應為不同即為 1。

使用位運算重構項目

當前我們需要設計一個許可權模塊,可動態的為用戶指定某個文件的操作許可權。並且,用戶對一個文件的操作許可權分為:讀(R),寫(W),執行(X)。

這是一個很簡單的需求,為了描述這種關係,我們會在資料庫表關係設計時,定義如下的結構:

數據表:user_file_permission

欄位 類型 備註
userId int 用戶
fileId int 文件
readable bit 是否可讀
writable bit 是否可寫
executable bit 是否可執行

映射的模型:UserFilePermission

public class UserFilePermission {
    /**
     * 用戶
     */
    private User user;

    /**
     * 文件
     */
    private File file;

    /**
     * 讀操作
     */
    private Boolean readable;
    /**
     * 寫操作
     */
    private Boolean writable;
    /**
     * 執行操作
     */
    private Boolean executable;
}

這是常見的實現方式。但考慮下,業務需求千變萬化,倘若需要再新增一個下載(D) 操作,是不是需要去額外擴展一個欄位。所以,對於長期來講,有值得重構的空間。

故缺點很明顯:

  • 難擴展
  • 繁瑣,比如判斷是否包含讀和執行的操作許可權,需要這樣寫if(xx.IsReadable() && xx.IsExecutable()),但隨著許可權操作越來越多時,if代碼塊也越來越大。

位運算重構

瞭解 Linux 的同學一定知道利用 chmod 來控制文件如何被他人調用。比如針對一個文件,可分別給 User、Group、Other 設置訪問的許可權。同時許可權操作分為:r(讀),w(寫),x(執行)。很巧,和我們的需求一樣。那我們來看下Linux 是如何實現許可權控制的。

核心是定義一個整數來代表操作許可權,即:r=4,w=2,x=1

  • 若要 rwx 許可權,則:4+2+1=7;
  • 若要 rw- 許可權,則:4+2=6;
  • 若要 r-x 許可權,則:4+1=5。

所以使用 chmod 也可以用數字來表示許可權,如下即給 User、Group、Other 三個維度的對象都設置了代表可讀、可寫、可執行的許可權,代號:7。

chmod 777 file

你可能會想,為什麼 r=4,w=2,x=1?聰明的你,肯定想到了——二進位。

許可權操作 二進位 十進位
r 0100 4
w 0010 2
x 0001 1

所以藉由這個思想,我們對代碼進行重構,去掉了readablewritableexecutable 這三個欄位,而統一由一個 permissoin 欄位來表示,如下所示:

public class UserFilePermission {

    /**
     * 可執行(x):0001
     */
    public static final int OP_EXECUTABLE = 1;

    /**
     * 可寫(w):左移一位:0010
     */
    public static final int OP_WRITABLE = 1 << 1;

    /**
     * 可讀(r):左移二位:0100
     */
    public static final int OP_READABLE = 1 << 2;

    /**
     * 用戶
     */
    private User user;
    /**
     * 文件
     */
    private File file;

    /**
     * 許可權
     */
    private int permission;
}

其中 permission 的可選項如下表格所示:

permission r w x 描述
1(0001) 0 0 1 可執行
2(0010) 0 1 0 可寫
4(0100) 1 0 0 可讀
3(0011) 0 1 1 可寫、可執行
7(0111) 1 1 1 可讀、可寫、可執行
0(0000) 0 0 0 禁止

同時,操作許可權不是一塵不變的,我們往往需要對其新增、刪除、查詢。通過位運算,可以非常方便實現。

為當前許可權新增一個操作:

public void addOp(int op) {
    permission |= op;
}

為當前許可權刪除一個操作:

public void removeOp(int op) {
    permission &= ~op;
}

判斷當前許可權是否包含指定的操作許可權:

public boolean containsOp(int op) {
    return (permission & op) == op;
}

判斷當前許可權是否不包含指定的操作許可權:

public boolean notContainsOp(int op) {
    return (permission & op) == 0;
}

當然,這樣的重構唯一的缺點就是可讀性變差。當然,如果團隊對位運算達成共識之後,大家都有一定的瞭解。相反,可讀性還是可以的。同時,位運算的計算非常快,也在一定程度上提升了執行效率。

位運算在 Netty 中的體現

我們可以在諸多優秀的開源代碼看到位運算的身影。比如 JDK 中有非常多的案例。在此,拋磚引玉,談談在 Netty 的體現。

Netty 的內部提供了 Skip 的註解,用來表明一個 ChannelHandler 的某個方法不需要被執行,即跳過。我們來看下Netty 是如何實現的。

final class ChannelHandlerMask {

    // Using to mask which methods must be called for a ChannelHandler.
    static final int MASK_EXCEPTION_CAUGHT = 1;
    static final int MASK_CHANNEL_REGISTERED = 1 << 1;
    static final int MASK_CHANNEL_UNREGISTERED = 1 << 2;
    static final int MASK_CHANNEL_ACTIVE = 1 << 3;
    static final int MASK_CHANNEL_INACTIVE = 1 << 4;
    static final int MASK_CHANNEL_READ = 1 << 5;
    static final int MASK_CHANNEL_READ_COMPLETE = 1 << 6;
    static final int MASK_USER_EVENT_TRIGGERED = 1 << 7;
    static final int MASK_CHANNEL_WRITABILITY_CHANGED = 1 << 8;
    static final int MASK_BIND = 1 << 9;
    static final int MASK_CONNECT = 1 << 10;
    static final int MASK_DISCONNECT = 1 << 11;
    static final int MASK_CLOSE = 1 << 12;
    static final int MASK_DEREGISTER = 1 << 13;
    static final int MASK_READ = 1 << 14;
    static final int MASK_WRITE = 1 << 15;
    static final int MASK_FLUSH = 1 << 16;

    private static final int MASK_ALL_INBOUND = MASK_EXCEPTION_CAUGHT | MASK_CHANNEL_REGISTERED |
            MASK_CHANNEL_UNREGISTERED | MASK_CHANNEL_ACTIVE | MASK_CHANNEL_INACTIVE | MASK_CHANNEL_READ |
            MASK_CHANNEL_READ_COMPLETE | MASK_USER_EVENT_TRIGGERED | MASK_CHANNEL_WRITABILITY_CHANGED;
    private static final int MASK_ALL_OUTBOUND = MASK_EXCEPTION_CAUGHT | MASK_BIND | MASK_CONNECT | MASK_DISCONNECT |
            MASK_CLOSE | MASK_DEREGISTER | MASK_READ | MASK_WRITE | MASK_FLUSH;

    /**
     * Calculate the {@code executionMask}.
     */
    private static int mask0(Class<? extends ChannelHandler> handlerType) {
        int mask = MASK_EXCEPTION_CAUGHT;
        try {
            if (ChannelInboundHandler.class.isAssignableFrom(handlerType)) {
                mask |= MASK_ALL_INBOUND;

                if (isSkippable(handlerType, "channelRegistered", ChannelHandlerContext.class)) {
                    mask &= ~MASK_CHANNEL_REGISTERED;
                }
                if (isSkippable(handlerType, "channelUnregistered", ChannelHandlerContext.class)) {
                    mask &= ~MASK_CHANNEL_UNREGISTERED;
                }
                if (isSkippable(handlerType, "channelActive", ChannelHandlerContext.class)) {
                    mask &= ~MASK_CHANNEL_ACTIVE;
                }
                if (isSkippable(handlerType, "channelInactive", ChannelHandlerContext.class)) {
                    mask &= ~MASK_CHANNEL_INACTIVE;
                }
                if (isSkippable(handlerType, "channelRead", ChannelHandlerContext.class, Object.class)) {
                    mask &= ~MASK_CHANNEL_READ;
                }
                if (isSkippable(handlerType, "channelReadComplete", ChannelHandlerContext.class)) {
                    mask &= ~MASK_CHANNEL_READ_COMPLETE;
                }
                if (isSkippable(handlerType, "channelWritabilityChanged", ChannelHandlerContext.class)) {
                    mask &= ~MASK_CHANNEL_WRITABILITY_CHANGED;
                }
                if (isSkippable(handlerType, "userEventTriggered", ChannelHandlerContext.class, Object.class)) {
                    mask &= ~MASK_USER_EVENT_TRIGGERED;
                }
            }
           ...

            if (isSkippable(handlerType, "exceptionCaught", ChannelHandlerContext.class, Throwable.class)) {
                mask &= ~MASK_EXCEPTION_CAUGHT;
            }
        } catch (Exception e) {
            // Should never reach here.
            PlatformDependent.throwException(e);
        }

        return mask;
    }
}

上述代碼將主幹代碼剝離出後,其實核心邏輯很簡單:

// 添加了所有
mask |= MASK_ALL_INBOUND;
// 如果該 Handler 的 xx 方法標註了 @Skip 註解,則將他剔除
if (isSkippable(handlerType, "xx", ChannelHandlerContext.class)) {
    mask &= ~xx;
}

因為 Nettypipeline 是個職責鏈,它需要判斷當前的 method是否被允許執行。使用 (ctx.executionMask & mask) == 0 來表示當前是否被禁止調用。如果是的話,則忽略,繼續迭代,直到找到允許被調用的 handler。 如下所示:

private AbstractChannelHandlerContext findContextInbound(int mask) {
    AbstractChannelHandlerContext ctx = this;
    do {
        ctx = ctx.next;
    } while ((ctx.executionMask & mask) == 0);
    return ctx;
}

小結

本文為大家展示瞭如何使用二進位以及位運算來重構代碼。顯而易見,代碼量及其精簡。同時這種思想也大量出現在開源代碼中,值得學習。


您的分享是我們最大的動力!

更多相關文章
  • "最新博客鏈接" "Github鏈接" 查看此文檔前應先瞭解, "vuepress基本操作" 參考官方文檔進行配置: "vuepress theme reco" "VuePress" "SamKirkland / FTP Deploy Action" 最終效果 "最終效果鏈接" 思路 下載vuepr ...
  • 訂單頁效果圖: 目錄結構 order.html <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>order</title> <meta name="viewport" content="width=devic ...
  • [TOC] "最新博客鏈接" "VuePress 線上文檔鏈接_Github Pages" "VuePress 線上文檔鏈接_博客伺服器" (如果上面進不去,可以進這個,伺服器在阿裡雲) "Github鏈接" 最終效果 "最終效果鏈接" 思路 總體 VuePress 在本地完成項目的源文件,推送至 ...
  • 1、環境搭建 基於node.js的http-server伺服器搭建 https://www.npmjs.com/package/http-server cnpm install http-server -g 2、首頁實現 創建一個目錄,叫webapp,在裡面創建一個index.html 打開cmd, ...
  • 利用EasyUI的TreeGrid組件格式化顯示Json數據,首先讀入Json文件,轉成Map對象,迴圈遞歸每一個Map,判斷它的值是基本類型還是Map。如果基本類型,則是屬性節點。如果Map,則是對象,需要再遍歷。 1.Map解析Tree對象 Tree對象 public class Display ...
  • JS 排序演算法之計數和基數排序 [Toc] 計數排序 利用數組的index是天然有序的特征來排序. 例如: 已知一個亂序數組的範圍是0~10,長度未知, 我們只需要遍歷一遍數組,點出每個值出現的次數,並用一個新數組來存儲這個次數,就能做到排序. 假如數字1出現3次, 那麼新數組newAry[1]=3 ...
  • JavaScript 如何複製一個對象?淺拷貝可以複製出原始值屬性,但是對於引用值屬性僅僅複製了一份引用。利用遞歸對每個引用值屬性的屬性進行複製,這種方式稱之為深拷貝 ...
  • 1 完整代碼下載 https://pan.baidu.com/s/1JJyVcP2KqXsd5G6eaYpgHQ 提取碼 3fzt (壓縮包名: 2020-3-20-demo.zip) 2 圖片展示 3 主要代碼 1 /** HandCreate 簡單的 圖形界面 搭建幾何體 2 construct ...
一周排行
  • 1. 雲停車 (開篇)2. 雲停車 (硬體篇)3. 雲停車 (業務篇)4. 雲停車 (平臺篇)5. 雲停車 (源碼篇) 網址:http://42.194.142.223:8091/Home 賬戶:admin 密碼:[email protected] 在場記錄 出入記錄 月租車繳費記錄 臨時車繳費記錄 車場 ...
  • 1.RabbitMQ簡介 因為RabbitMQ是基於開源的AMQP協議來實現的,所以在瞭解MQ時候,首先我們來瞭解下AMQP協議。AMQP,即Advanced Message Queuing Protocol,一個提供統一消息服務的應用層標準高級消息隊列協議,是應用層協議的一個開放標準,為面向消息的 ...
  • 1.AMQP Messaging中的基本概念 Broker:接收和分發消息的應用,RabbitMQ Server就是Message Broker。Virtual Host:出於多租戶和安全因素設計的,把AMQP的基本組件劃分到一個虛擬的分組中,類似於網路中的Namespace概念。當多個不同的用戶使 ...
  • 在顯示或者隱藏視窗的時候,可以利用Windows API中的AnimateWindow函數實現一些特殊的效果。主要的動畫類型有四種:滾動、幻燈片、摺疊或展開和alpha混合漸變。 ##視窗動畫效果 首先定義動畫工具類,引入AnimateWindow函數。 public class WindowsEf ...
  • 泥水佬大佬的地址已經不能下載,所以分享下。 用法很簡單,輸入地址即可。 鏈接:https://pan.baidu.com/s/1OUeybjqY9uGWmxe_ywgwgQ 提取碼:nls9 ...
  • //前提需要 //需要一個 serialPort 工具 可在vs自帶的工具欄中獲得 //源代碼加串口工具地址: //鏈接:https://pan.baidu.com/s/1YbfvdXEmfsJX87D-Jxljyg 提取碼:d32x //記錄用戶打開的串口號 可改為泛型模式 string seri ...
  • 從業務視角還原問題、業務視角抽象問題、二次抽象發現技術問題,作為思考問題的三個還原點。 提煉單點問題解決能力、思考單點問題解決能力,複製、層層遞進思考問題,從深度和廣度出發, 深度以數據作指標,廣度以領域做方向。 腳踏實地的代碼量成長沒有捷徑。 ...
  • Java電子書分類 Java、Spring、SpringBoot、SpringCloud、mybatis、Tomcat、多線程、Git相關、Redis、設計模式、Nginx、Linux、演算法、資料庫、大數據、架構 電子書大概有30G左右 部分電子書截圖 領取方式 加我的微信(s2001sssss)免 ...
  • 一.node啟動js公鑰加密 //需要導入模塊npm install node-forge var arguments = process.argv.splice(2); // console.log('所傳遞的參數是:', arguments); var e = arguments[1]; var ...
  • LeetCode–最長公共首碼 博客說明 文章所涉及的資料來自互聯網整理和個人總結,意在於個人學習和經驗彙總,如有什麼地方侵權,請聯繫本人刪除,謝謝! 說明 leetcode題,14題 最長公共首碼 題目 編寫一個函數來查找字元串數組中的最長公共首碼。 如果不存在公共首碼,返回空字元串 ""。 示例 ...