從JDK原始碼角度看Long

超人汪小建發表於2019-03-01

概況

Java的Long類主要的作用就是對基本型別long進行封裝,提供了一些處理long型別的方法,比如long到String型別的轉換方法或String型別到long型別的轉換方法,當然也包含與其他型別之間的轉換方法。除此之外還有一些位相關的操作。

繼承結構

--java.lang.Object
  --java.lang.Number
    --java.lang.Long複製程式碼

主要屬性

public static final long MIN_VALUE = 0x8000000000000000L;
public static final long MAX_VALUE = 0x7fffffffffffffffL;
public static final int BYTES = SIZE / Byte.SIZE;
public static final int SIZE = 64;
public static final Class<Long>     TYPE = (Class<Long>) Class.getPrimitiveClass("long");複製程式碼
  • MIN_VALUE靜態變數表示long能取的最小值,為-2的63次方,被final修飾說明不可變。
  • 類似的還有MAX_VALUE,表示long最大值為2的63次方減1。
  • SIZE用來表示二進位制補碼形式的long值的位元數,值為64,靜態變數且不可變。
  • BYTES用來表示二進位制補碼形式的long值的位元組數,值為SIZE除於Byte.SIZE,結果為8。
  • TYPE的toString的值是long
    Class的getPrimitiveClass是一個native方法,在Class.c中有個Java_java_lang_Class_getPrimitiveClass方法與之對應,所以JVM層面會通過JVM_FindPrimitiveClass函式根據"long"字串獲得jclass,最終到Java層則為Class<Long>
JNIEXPORT jclass JNICALL
Java_java_lang_Class_getPrimitiveClass(JNIEnv *env,
                                       jclass cls,
                                       jstring name)
{
    const char *utfName;
    jclass result;

    if (name == NULL) {
        JNU_ThrowNullPointerException(env, 0);
        return NULL;
    }

    utfName = (*env)->GetStringUTFChars(env, name, 0);
    if (utfName == 0)
        return NULL;

    result = JVM_FindPrimitiveClass(env, utfName);

    (*env)->ReleaseStringUTFChars(env, name, utfName);

    return result;
}複製程式碼

TYPE執行toString時,邏輯如下,則其實是getName函式決定其值,getName通過native方法getName0從JVM層獲取名稱,

public String toString() {
        return (isInterface() ? "interface " : (isPrimitive() ? "" : "class "))
            + getName();
    }複製程式碼

getName0根據一個陣列獲得對應的名稱,JVM根據Java層的Class可得到對應型別的陣列下標,比如這裡下標為11,則名稱為"long"。

const char* type2name_tab[T_CONFLICT+1] = {
  NULL, NULL, NULL, NULL,
  "boolean",
  "char",
  "float",
  "double",
  "byte",
  "short",
  "int",
  "long",
  "object",
  "array",
  "void",
  "*address*",
  "*narrowoop*",
  "*conflict*"
};複製程式碼

LongCache內部類

private static class LongCache {
        private LongCache(){}

        static final Long cache[] = new Long[-(-128) + 127 + 1];

        static {
            for(int i = 0; i < cache.length; i++)
                cache[i] = new Long(i - 128);
        }
    }複製程式碼

LongCache是Long的一個內部類,它包含了long可能值的Long陣列,預設範圍是[-128,127],它不會像Byte類將所有可能值快取起來,因為long型別範圍很大,將它們全部快取起來代價太高,而Byte型別就是從-128到127,一共才256個。這裡預設只例項化256個Long物件,當Long的值範圍在[-128,127]時則直接從快取中獲取對應的Long物件,不必重新例項化。這些快取值都是靜態且final的,避免重複的例項化和回收。

主要方法

parseLong方法

    public static long parseLong(String s) throws NumberFormatException {
        return parseLong(s, 10);
    }

    public static long parseLong(String s, int radix)
              throws NumberFormatException
    {
        if (s == null) {
            throw new NumberFormatException("null");
        }

        if (radix < Character.MIN_RADIX) {
            throw new NumberFormatException("radix " + radix +
                                            " less than Character.MIN_RADIX");
        }
        if (radix > Character.MAX_RADIX) {
            throw new NumberFormatException("radix " + radix +
                                            " greater than Character.MAX_RADIX");
        }

        long result = 0;
        boolean negative = false;
        int i = 0, len = s.length();
        long limit = -Long.MAX_VALUE;
        long multmin;
        int digit;

        if (len > 0) {
            char firstChar = s.charAt(0);
            if (firstChar < '0') { // Possible leading "+" or "-"
                if (firstChar == '-') {
                    negative = true;
                    limit = Long.MIN_VALUE;
                } else if (firstChar != '+')
                    throw NumberFormatException.forInputString(s);

                if (len == 1) // Cannot have lone "+" or "-"
                    throw NumberFormatException.forInputString(s);
                i++;
            }
            multmin = limit / radix;
            while (i < len) {
                // Accumulating negatively avoids surprises near MAX_VALUE
                digit = Character.digit(s.charAt(i++),radix);
                if (digit < 0) {
                    throw NumberFormatException.forInputString(s);
                }
                if (result < multmin) {
                    throw NumberFormatException.forInputString(s);
                }
                result *= radix;
                if (result < limit + digit) {
                    throw NumberFormatException.forInputString(s);
                }
                result -= digit;
            }
        } else {
            throw NumberFormatException.forInputString(s);
        }
        return negative ? result : -result;
    }複製程式碼

兩個parseLong方法,主要看第二個即可,第一個引數是待轉換的字串,第二個參數列示進位制數。怎麼更好理解這個引數呢?舉個例子,Long.parseLong("100",10)表示十進位制的100,所以值為100,而Long.parseLong("100",2)表示二進位制的100,所以值為4。另外如果Long.parseLong("10000000000000000000",10)會丟擲java.lang.NumberFormatException異常。

該方法的邏輯是首先判斷字串不為空且進位制數在Character.MIN_RADIXCharacter.MAX_RADIX之間,即2到36。然後判斷輸入的字串的長度必須大於0,再根據第一個字元可能為數字或負號或正號進行處理。核心處理邏輯是字串轉換數字,n進位制轉成十進位制辦法基本大家都知道的了,假如357為8進位制,則結果為$3*8^2+5*8^1+7*8^0 = 239$,假如357為十進位制,則結果為$3*10^2+5*10^1+7*10^0 = 357$,上面的轉換方法也差不多是根據此方法,只是稍微轉變了思路,方式分別為$((3*8+5)*8+7) = 239$$((3*10+5)*10+7)=357$。從中可以推出規則了,從左到右遍歷字串的每個字元,然後乘以進位制數,再加上下一個字元,接著再乘以進位制數,再加上下個字元,不斷重複,直到最後一個字元。除此之外另外一個不同就是上面的轉換不使用加法來做,全都轉成負數來運算,其實可以看成是等價了,這個很好理解,而為什麼要這麼做就要歸咎到long型別的範圍了,因為負數Long.MIN_VALUE變化為正數時會導致數值溢位,所以全部都用負數來運算。

建構函式

public Long(String s) throws NumberFormatException {
        this.value = parseLong(s, 10);
    }
public Long(long value) {
        this.value = value;
    }複製程式碼

包含兩種建構函式,分別可以傳入long和String型別。它是通過呼叫parseLong方法進行轉換的,所以轉換邏輯與上面的parseLong方法一樣。

###

    static void getChars(long i, int index, char[] buf) {
        long q;
        int r;
        int charPos = index;
        char sign = 0;

        if (i < 0) {
            sign = '-';
            i = -i;
        }

        while (i > Integer.MAX_VALUE) {
            q = i / 100;
            // really: r = i - (q * 100);
            r = (int)(i - ((q << 6) + (q << 5) + (q << 2)));
            i = q;
            buf[--charPos] = Integer.DigitOnes[r];
            buf[--charPos] = Integer.DigitTens[r];
        }

        int q2;
        int i2 = (int)i;
        while (i2 >= 65536) {
            q2 = i2 / 100;
            r = i2 - ((q2 << 6) + (q2 << 5) + (q2 << 2));
            i2 = q2;
            buf[--charPos] = Integer.DigitOnes[r];
            buf[--charPos] = Integer.DigitTens[r];
        }

        for (;;) {
            q2 = (i2 * 52429) >>> (16+3);
            r = i2 - ((q2 << 3) + (q2 << 1));  
            buf[--charPos] = Integer.digits[r];
            i2 = q2;
            if (i2 == 0) break;
        }
        if (sign != 0) {
            buf[--charPos] = sign;
        }
    }複製程式碼

該方法主要做的事情是將某個long型數值放到char陣列裡面,比如把357按順序放到char陣列中。這裡面處理用了較多技巧,將long拆成高位4個位元組和低位4個位元組處理分開處理,while (i >= Integer.MAX_VALUE)部分就是處理高位的4個位元組,每次處理2位數,這裡有個特殊的地方((q << 6) + (q << 5) + (q << 2))其實等於q*100,Integer.DigitTensInteger.DigitOnes陣列在前面Integer文章中已經講過它的作用了,用來獲取十位和個位。

接著看怎麼處理低4個位元組,它繼續將4個位元組分為高位2個位元組和低位2個位元組,while (i >= 65536)部分就是處理高位的兩個位元組,每次處理2位數,處理邏輯與高位4個位元組的處理邏輯一樣。

再看接下去的低位的兩個位元組怎麼處理,其實本質也是求餘思想,但又用了一些技巧,比如(i * 52429) >>> (16+3)其實約等於i/10((q << 3) + (q << 1))其實等於q*10,然後再通過Integer.digits陣列獲取到對應的字元。可以看到低位處理時它儘量避開了除法,取而代之的是用乘法和右移來實現,可見除法是一個比較耗時的操作,比起乘法和移位。另外也可以看到能用移位和加法來實現乘法的地方也儘量不用乘法,這也說明乘法比起它們更加耗時。而高位處理時沒有用移位是因為做乘法後可能會溢位。

toString方法

public static String toString(long i) {
        if (i == Long.MIN_VALUE)
            return "-9223372036854775808";
        int size = (i < 0) ? stringSize(-i) + 1 : stringSize(i);
        char[] buf = new char[size];
        getChars(i, size, buf);
        return new String(buf, true);
    }
public String toString() {
        return toString(value);
    }
public static String toString(long i, int radix) {
        if (radix < Character.MIN_RADIX || radix > Character.MAX_RADIX)
            radix = 10;
        if (radix == 10)
            return toString(i);
        char[] buf = new char[65];
        int charPos = 64;
        boolean negative = (i < 0);

        if (!negative) {
            i = -i;
        }

        while (i <= -radix) {
            buf[charPos--] = Integer.digits[(int)(-(i % radix))];
            i = i / radix;
        }
        buf[charPos] = Integer.digits[(int)(-i)];

        if (negative) {
            buf[--charPos] = '-';
        }

        return new String(buf, charPos, (65 - charPos));
    }複製程式碼

一共有3個toString方法,兩個靜態方法一個是非靜態方法,第一個toString方法很簡單,就是先用stringSize得到數字是多少位,再用getChars獲取數字對應的char陣列,最後返回一個String型別。第二個toString呼叫第一個toString,沒啥好說。第三個toString方法是帶了進位制資訊的,它會轉換成對應進位制的字串。凡是不在2到36進位制範圍之間的都會被處理成10進位制,我們都知道從十進位制轉成其他進位制時就是不斷地除於進位制數得到餘數,然後把餘數反過來串起來就是最後結果,所以這裡其實也是這樣子做的,得到餘數後通過digits陣列獲取到對應的字元,而且這裡是用負數的形式來運算的。

valueOf方法

public static Long valueOf(long l) {
        final int offset = 128;
        if (l >= -128 && l <= 127) { // will cache
            return LongCache.cache[(int)l + offset];
        }
        return new Long(l);
    }
public static Long valueOf(String s) throws NumberFormatException
    {
        return Long.valueOf(parseLong(s, 10));
    }
public static Long valueOf(String s, int radix) throws NumberFormatException {
        return Long.valueOf(parseLong(s, radix));
    }複製程式碼

有三個valueOf方法,核心邏輯在第一個valueOf方法中,因為LongCache快取了[-128,127]值的Long物件,對於在範圍內的直接從LongCache的陣列中獲取對應的Long物件即可,而在範圍外的則需要重新例項化了。

decode方法

    public static Long decode(String nm) throws NumberFormatException {
        int radix = 10;
        int index = 0;
        boolean negative = false;
        Long result;

        if (nm.length() == 0)
            throw new NumberFormatException("Zero length string");
        char firstChar = nm.charAt(0);
        if (firstChar == '-') {
            negative = true;
            index++;
        } else if (firstChar == '+')
            index++;
        if (nm.startsWith("0x", index) || nm.startsWith("0X", index)) {
            index += 2;
            radix = 16;
        }
        else if (nm.startsWith("#", index)) {
            index ++;
            radix = 16;
        }
        else if (nm.startsWith("0", index) && nm.length() > 1 + index) {
            index ++;
            radix = 8;
        }

        if (nm.startsWith("-", index) || nm.startsWith("+", index))
            throw new NumberFormatException("Sign character in wrong position");

        try {
            result = Long.valueOf(nm.substring(index), radix);
            result = negative ? Long.valueOf(-result.longValue()) : result;
        } catch (NumberFormatException e) {
            String constant = negative ? ("-" + nm.substring(index))
                                       : nm.substring(index);
            result = Long.valueOf(constant, radix);
        }
        return result;
    }複製程式碼

decode方法主要作用是解碼字串轉成Long型,比如Long.decode("11")的結果為11;Long.decode("0x11")Long.decode("#11")結果都為17,因為0x和#開頭的會被處理成十六進位制;Long.decode("011")結果為9,因為0開頭會被處理成8進位制。

xxxValue方法

    public byte byteValue() {
        return (byte)value;
    }
public short shortValue() {
        return (short)value;
    }
public int intValue() {
        return (int)value;
    }
public long longValue() {
        return value;
    }
public float floatValue() {
        return (float)value;
    }
public double doubleValue() {
        return (double)value;
    }複製程式碼

包括shortValue、intValue、longValue、byteValue、floatValue和doubleValue等方法,其實就是轉換成對應的型別。

hashCode方法

public int hashCode() {
        return Long.hashCode(value);
    }
public static int hashCode(long value) {
        return (int)(value ^ (value >>> 32));
    }複製程式碼

可以看到hashCode方法返回的事int型別,首先將long型值無符號右移32位,再和原來的值進行異或運算,最後返回int型別值。

hashCode方法

public boolean equals(Object obj) {
        if (obj instanceof Long) {
            return value == ((Long)obj).longValue();
        }
        return false;
    }複製程式碼

比較是否相同時先判斷是不是Long型別再比較值。

compare方法

public static int compare(long x, long y) {
        return (x < y) ? -1 : ((x == y) ? 0 : 1);
    }複製程式碼

x小於y則返回-1,相等則返回0,否則返回1。

無符號轉換

private static BigInteger toUnsignedBigInteger(long i) {
        if (i >= 0L)
            return BigInteger.valueOf(i);
        else {
            int upper = (int) (i >>> 32);
            int lower = (int) i;
            return (BigInteger.valueOf(Integer.toUnsignedLong(upper))).shiftLeft(32).
                add(BigInteger.valueOf(Integer.toUnsignedLong(lower)));
        }
    }
public static String toUnsignedString(long i) {
        return toUnsignedString(i, 10);
    }
public static String toUnsignedString(long i, int radix) {
        if (i >= 0)
            return toString(i, radix);
        else {
            switch (radix) {
            case 2:
                return toBinaryString(i);

            case 4:
                return toUnsignedString0(i, 2);

            case 8:
                return toOctalString(i);

            case 10:
                long quot = (i >>> 1) / 5;
                long rem = i - quot * 10;
                return toString(quot) + rem;

            case 16:
                return toHexString(i);

            case 32:
                return toUnsignedString0(i, 5);

            default:
                return toUnsignedBigInteger(i).toString(radix);
            }
        }
    }複製程式碼

toUnsignedBigInteger方法將long轉成BigInteger型別,主要用BigInteger.valueOf進行轉換,如果小於0則需要先轉成高4位元組和低4位元組,然後再轉換。
toUnsignedString方法中,對於大於0的long值直接用toString轉換,而小於0的則要按照進位制不同分別做不同處理。

bitCount方法

public static int bitCount(long i) {
        // HD, Figure 5-14
        i = i - ((i >>> 1) & 0x5555555555555555L);
        i = (i & 0x3333333333333333L) + ((i >>> 2) & 0x3333333333333333L);
        i = (i + (i >>> 4)) & 0x0f0f0f0f0f0f0f0fL;
        i = i + (i >>> 8);
        i = i + (i >>> 16);
        i = i + (i >>> 32);
        return (int)i & 0x7f;
     }複製程式碼

該方法主要用於計算二進位制數中1的個數。一看有點懵,都是移位和加減操作。先將重要的列出來,0x5555555555555555L等於01010101010101010101010101010101010101010101010101010101010101010x3333333333333333L等於00110011001100110011001100110011001100110011001100110011001100110x0f0f0f0f0f0f0f0fL等於0000111100001111000011110000111100001111000011110000111100001111。它的核心思想就是先每兩位一組統計看有多少個1,比如10011111則每兩位有1、1、2、2個1,記為01011010,然後再算每四位一組看有多少個1,而01011010則每四位有2、4個1,記為00100100,接著每8位一組就為00000110,接著16位,32位,64位,最終在與0x7f進行與運算,得到的數即為1的個數。

highestOneBit方法

public static long highestOneBit(long i) {
        // HD, Figure 3-1
        i |= (i >>  1);
        i |= (i >>  2);
        i |= (i >>  4);
        i |= (i >>  8);
        i |= (i >> 16);
        i |= (i >> 32);
        return i - (i >>> 1);
    }複製程式碼

該方法返回i的二進位制中最高位的1,其他全為0的值。比如i=10時,二進位制即為1010,最高位的1,其他為0,則是1000。如果i=0,則返回0。如果i為負數則固定返回-2147483648,因為負數的最高位一定是1,即有1000,0000,0000,0000,0000,0000,0000,0000。這一堆移位操作是什麼意思?其實也不難理解,將i右移一位再或操作,則最高位1的右邊也為1了,接著再右移兩位並或操作,則右邊1+2=3位都為1了,接著1+2+4=7位都為1,直到1+2+4+8+16+32=63都為1,最後用i - (i >>> 1)自然得到最終結果。

lowestOneBit方法

public static long lowestOneBit(long i) {
        return i & -i;
    }複製程式碼

與highestOneBit方法對應,lowestOneBit獲取最低位1,其他全為0的值。這個操作較簡單,先取負數,這個過程需要對正數的i取反碼然後再加1,得到的結果和i進行與操作,剛好就是最低位1其他為0的值了。

numberOfLeadingZeros方法

public static int numberOfLeadingZeros(long i) {
         if (i == 0)
            return 64;
        int n = 1;
        int x = (int)(i >>> 32);
        if (x == 0) { n += 32; x = (int)i; }
        if (x >>> 16 == 0) { n += 16; x <<= 16; }
        if (x >>> 24 == 0) { n +=  8; x <<=  8; }
        if (x >>> 28 == 0) { n +=  4; x <<=  4; }
        if (x >>> 30 == 0) { n +=  2; x <<=  2; }
        n -= x >>> 31;
        return n;
    }複製程式碼

該方法返回i的二進位制從頭開始有多少個0。i為0的話則有64個0。這裡處理其實是體現了二分查詢思想的,先看高32位是否為0,是的話則至少有32個0,否則左移16位繼續往下判斷,接著右移24位看是不是為0,是的話則至少有16+8=24個0,以此類推,直到最後得到結果。

numberOfTrailingZeros方法

public static int numberOfTrailingZeros(long i) {
        int x, y;
        if (i == 0) return 64;
        int n = 63;
        y = (int)i; if (y != 0) { n = n -32; x = y; } else x = (int)(i>>>32);
        y = x <<16; if (y != 0) { n = n -16; x = y; }
        y = x << 8; if (y != 0) { n = n - 8; x = y; }
        y = x << 4; if (y != 0) { n = n - 4; x = y; }
        y = x << 2; if (y != 0) { n = n - 2; x = y; }
        return n - ((x << 1) >>> 31);
    }複製程式碼

與前面的numberOfLeadingZeros方法對應,該方法返回i的二進位制從尾開始有多少個0。它的思想和前面的類似,也是基於二分查詢思想,詳細步驟不再贅述。

reverse方法

public static long reverse(long i) {
        i = (i & 0x5555555555555555L) << 1 | (i >>> 1) & 0x5555555555555555L;
        i = (i & 0x3333333333333333L) << 2 | (i >>> 2) & 0x3333333333333333L;
        i = (i & 0x0f0f0f0f0f0f0f0fL) << 4 | (i >>> 4) & 0x0f0f0f0f0f0f0f0fL;
        i = (i & 0x00ff00ff00ff00ffL) << 8 | (i >>> 8) & 0x00ff00ff00ff00ffL;
        i = (i << 48) | ((i & 0xffff0000L) << 16) |
            ((i >>> 16) & 0xffff0000L) | (i >>> 48);
        return i;
    }複製程式碼

該方法即是將i進行反轉,反轉就是第1位與第64位對調,第二位與第63位對調,以此類推。它的核心思想是先將相鄰兩位進行對換,比如10100111對換01011011,接著再將相鄰四位進行對換,對換後為10101101,接著將相鄰八位進行對換,最後把64位中中間的32位對換,然後最高16位再和最低16位對換。

toHexString和toOctalString方法

public static String toHexString(long i) {
        return toUnsignedString0(i, 4);
    }
public static String toOctalString(long i) {
        return toUnsignedString0(i, 3);
    }
public static String toBinaryString(long i) {
        return toUnsignedString0(i, 1);
    }
static String toUnsignedString0(long val, int shift) {
        int mag = Long.SIZE - Long.numberOfLeadingZeros(val);
        int chars = Math.max(((mag + (shift - 1)) / shift), 1);
        char[] buf = new char[chars];

        formatUnsignedLong(val, shift, buf, 0, chars);
        return new String(buf, true);
    }
static int formatUnsignedLong(long val, int shift, char[] buf, int offset, int len) {
        int charPos = len;
        int radix = 1 << shift;
        int mask = radix - 1;
        do {
            buf[offset + --charPos] = Integer.digits[((int) val) & mask];
            val >>>= shift;
        } while (val != 0 && charPos > 0);

        return charPos;
    }複製程式碼

這幾個方法類似,合到一起講。看名字就知道轉成2進位制、8進位制和16進位制的字串。可以看到都是間接呼叫toUnsignedString0方法,該方法會先計算轉換成對應進位制需要的字元數,然後再通過formatUnsignedInt方法來填充字元陣列,該方法做的事情就是使用進位制之間的轉換方法來獲取對應的字元。

以下是廣告相關閱讀

========廣告時間========

鄙人的新書《Tomcat核心設計剖析》已經在京東銷售了,有需要的朋友可以到 item.jd.com/12185360.ht… 進行預定。感謝各位朋友。

為什麼寫《Tomcat核心設計剖析》

=========================

相關閱讀:

從JDK原始碼角度看Object

談談Java基礎資料型別

從JDK原始碼角度看併發鎖的優化

從JDK原始碼角度看執行緒的阻塞和喚醒

從JDK原始碼角度看併發競爭的超時

從JDK原始碼角度看java併發執行緒的中斷

從JDK原始碼角度看Java併發的公平性

從JDK原始碼角度看java併發的原子性如何保證

從JDK原始碼角度看Byte

從JDK原始碼角度看Boolean

從JDK原始碼角度看Short

從JDK原始碼角度看Integer

歡迎關注:

這裡寫圖片描述
這裡寫圖片描述

相關文章