Class UUID

java.lang.Object
org.aoju.bus.core.key.UUID
All Implemented Interfaces:
Serializable, Comparable<UUID>

public class UUID extends Object implements Serializable, Comparable<UUID>
提供通用唯一识别码(universally unique identifier)(UUID)实现,UUID表示一个128位的值 此类拷贝自java.util.UUID,用于生成不带-的UUID字符串 这些通用标识符具有不同的变体 此类的方法用于操作 Leach-Salz 变体,不过构造方法允许创建任何 UUID 变体(将在下面进行描述) 变体 2 (Leach-Salz) UUID 的布局如下: long 型数据的最高有效位由以下无符号字段组成:
 0xFFFFFFFF00000000 time_low
 0x00000000FFFF0000 time_mid
 0x000000000000F000 version
 0x0000000000000FFF time_hi
 
long 型数据的最低有效位由以下无符号字段组成:
 0xC000000000000000 variant
 0x3FFF000000000000 clock_seq
 0x0000FFFFFFFFFFFF node
 
variant 字段包含一个表示 UUID 布局的值 以上描述的位布局仅在 UUID 的 variant 值为 2(表示 Leach-Salz 变体)时才有效 version 字段保存描述此 UUID 类型的值 有 4 种不同的基本 UUID 类型:基于时间的 UUID、DCE 安全 UUID、基于名称的 UUID 和随机生成的 UUID 这些类型的 version 值分别为 1、2、3 和 4
Since:
Java 17+
Author:
Kimi Liu
See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
    UUID(long mostSigBits, long leastSigBits)
    使用指定的数据构造新的 UUID
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    与此 UUID 相关联的时钟序列值
    int
    将此 UUID 与指定的 UUID 比较
    boolean
    将此对象与指定对象比较
    static UUID
    获取类型 4(伪随机生成的)UUID 的静态工厂 使用加密的本地线程伪随机数生成器生成该 UUID
    static UUID
    根据 toString() 方法中描述的字符串标准表示形式创建UUID
    long
    返回此 UUID 的 128 位值中的最低有效 64 位
    long
    返回此 UUID 的 128 位值中的最高有效 64 位
    int
    返回此 UUID 的哈希码
    static UUID
    nameUUIDFromBytes(byte[] name)
    根据指定的字节数组获取类型 3(基于名称的)UUID 的静态工厂
    long
    与此 UUID 相关的节点值
    static int
    random(int min, int max)
    根据一个范围,生成一个随机的整数
    static UUID
    获取类型 4(伪随机生成的)UUID 的静态工厂 使用加密的强伪随机数生成器生成该 UUID
    static UUID
    randomUUID(boolean isSecure)
    获取类型 4(伪随机生成的)UUID 的静态工厂 使用加密的强伪随机数生成器生成该 UUID
    static String
    获取15位的UUID(精度有所损失)
    static long
    获取15位的Long型UUID(精度有所损失)
    static String
    获取19位的UUID
    static String
    获取32位UUID
    static String
     
    long
    与此 UUID 相关联的时间戳值
    返回此UUID 的字符串表现形式
    toString(boolean isSimple)
    返回此UUID 的字符串表现形式
    int
    与此 UUID 相关联的变体号 变体号描述 UUID 的布局
    int
    与此 UUID 相关联的版本号.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • UUID

      public UUID(long mostSigBits, long leastSigBits)
      使用指定的数据构造新的 UUID
      Parameters:
      mostSigBits - 用于 UUID 的最高有效 64 位
      leastSigBits - 用于 UUID 的最低有效 64 位
  • Method Details

    • random

      public static int random(int min, int max)
      根据一个范围,生成一个随机的整数
      Parameters:
      min - 最小值(包括)
      max - 最大值(包括)
      Returns:
      随机数
    • fastUUID

      public static UUID fastUUID()
      获取类型 4(伪随机生成的)UUID 的静态工厂 使用加密的本地线程伪随机数生成器生成该 UUID
      Returns:
      随机生成的 UUID
    • randomUUID

      public static UUID randomUUID()
      获取类型 4(伪随机生成的)UUID 的静态工厂 使用加密的强伪随机数生成器生成该 UUID
      Returns:
      随机生成的 UUID
    • randomUUID32

      public static String randomUUID32()
      获取32位UUID
      Returns:
      随机生成ID
    • randomUUID19

      public static String randomUUID19()
      获取19位的UUID
      Returns:
      随机生成ID
    • randomUUID15

      public static String randomUUID15()
      获取15位的UUID(精度有所损失)
      Returns:
      随机生成ID
    • randomUUID15Long

      public static long randomUUID15Long()
      获取15位的Long型UUID(精度有所损失)
      Returns:
      随机生成ID
    • randomUUIDBase64

      public static String randomUUIDBase64()
    • randomUUID

      public static UUID randomUUID(boolean isSecure)
      获取类型 4(伪随机生成的)UUID 的静态工厂 使用加密的强伪随机数生成器生成该 UUID
      Parameters:
      isSecure - 是否使用SecureRandom如果是可以获得更安全的随机码,否则可以得到更好的性能
      Returns:
      随机生成的 UUID
    • nameUUIDFromBytes

      public static UUID nameUUIDFromBytes(byte[] name)
      根据指定的字节数组获取类型 3(基于名称的)UUID 的静态工厂
      Parameters:
      name - 用于构造 UUID 的字节数组
      Returns:
      根据指定数组生成的 UUID
    • fromString

      public static UUID fromString(String name)
      根据 toString() 方法中描述的字符串标准表示形式创建UUID
      Parameters:
      name - 指定 UUID 字符串
      Returns:
      具有指定值的 UUID
      Throws:
      IllegalArgumentException - 如果 name 与 toString() 中描述的字符串表示形式不符抛出此异常
    • getLeastSignificantBits

      public long getLeastSignificantBits()
      返回此 UUID 的 128 位值中的最低有效 64 位
      Returns:
      此 UUID 的 128 位值中的最低有效 64 位
    • getMostSignificantBits

      public long getMostSignificantBits()
      返回此 UUID 的 128 位值中的最高有效 64 位
      Returns:
      此 UUID 的 128 位值中最高有效 64 位
    • version

      public int version()
      与此 UUID 相关联的版本号. 版本号描述此 UUID 是如何生成的

      版本号具有以下含意:

      • 1 基于时间的 UUID
      • 2 DCE 安全 UUID
      • 3 基于名称的 UUID
      • 4 随机生成的 UUID
      Returns:
      UUID 的版本号
    • variant

      public int variant()
      与此 UUID 相关联的变体号 变体号描述 UUID 的布局

      变体号具有以下含意:

      • 0 为 NCS 向后兼容保留
      • 2 IETF RFC 4122(Leach-Salz), 用于此类
      • 6 保留,微软向后兼容
      • 7 保留供以后定义使用
      Returns:
      UUID 相关联的变体号
    • timestamp

      public long timestamp() throws UnsupportedOperationException
      与此 UUID 相关联的时间戳值

      60 位的时间戳值根据此 UUID 的 time_low、time_mid 和 time_hi 字段构造 所得到的时间戳以 100 毫微秒为单位,从 UTC(通用协调时间) 1582 年 10 月 15 日零时开始

      时间戳值仅在在基于时间的 UUID(其 version 类型为 1)中才有意义 如果此 UUID 不是基于时间的 UUID,则此方法抛出 UnsupportedOperationException

      Returns:
      the long
      Throws:
      UnsupportedOperationException - 如果此 UUID 不是 version 为 1 的 UUID
    • clockSequence

      public int clockSequence() throws UnsupportedOperationException
      与此 UUID 相关联的时钟序列值

      14 位的时钟序列值根据此 UUID 的 clock_seq 字段构造 clock_seq 字段用于保证在基于时间的 UUID 中的时间唯一性

      clockSequence 值仅在基于时间的 UUID(其 version 类型为 1)中才有意义 如果此 UUID 不是基于时间的 UUID,则此方法抛出 UnsupportedOperationException

      Returns:
      UUID 的时钟序列
      Throws:
      UnsupportedOperationException - 如果此 UUID 的 version 不为 1
    • node

      public long node() throws UnsupportedOperationException
      与此 UUID 相关的节点值

      48 位的节点值根据此 UUID 的 node 字段构造 此字段旨在用于保存机器的 IEEE 802 地址,该地址用于生成此 UUID 以保证空间唯一性

      节点值仅在基于时间的 UUID(其 version 类型为 1)中才有意义 如果此 UUID 不是基于时间的 UUID,则此方法抛出 UnsupportedOperationException

      Returns:
      UUID 的节点值
      Throws:
      UnsupportedOperationException - 如果此 UUID 的 version 不为 1
    • toString

      public String toString()
      返回此UUID 的字符串表现形式

      UUID 的字符串表示形式由此 BNF 描述:

       
       UUID                   = <time_low>-<time_mid>-<time_high_and_version>-<variant_and_sequence>-<node>
       time_low               = 4*<hexOctet>
       time_mid               = 2*<hexOctet>
       time_high_and_version  = 2*<hexOctet>
       variant_and_sequence   = 2*<hexOctet>
       node                   = 6*<hexOctet>
       hexOctet               = <hexDigit><hexDigit>
       hexDigit               = [0-9a-fA-F]
       
       
      Overrides:
      toString in class Object
      Returns:
      UUID 的字符串表现形式
      See Also:
    • toString

      public String toString(boolean isSimple)
      返回此UUID 的字符串表现形式

      UUID 的字符串表示形式由此 BNF 描述:

       
       UUID                   = <time_low>-<time_mid>-<time_high_and_version>-<variant_and_sequence>-<node>
       time_low               = 4*<hexOctet>
       time_mid               = 2*<hexOctet>
       time_high_and_version  = 2*<hexOctet>
       variant_and_sequence   = 2*<hexOctet>
       node                   = 6*<hexOctet>
       hexOctet               = <hexDigit><hexDigit>
       hexDigit               = [0-9a-fA-F]
       
       
      Parameters:
      isSimple - 是否简单模式,简单模式为不带'-'的UUID字符串
      Returns:
      UUID 的字符串表现形式
    • hashCode

      public int hashCode()
      返回此 UUID 的哈希码
      Overrides:
      hashCode in class Object
      Returns:
      UUID 的哈希码值
    • equals

      public boolean equals(Object obj)
      将此对象与指定对象比较

      当且仅当参数不为 null、而是一个 UUID 对象、具有与此 UUID 相同的 varriant、包含相同的值(每一位均相同)时,结果才为 true

      Overrides:
      equals in class Object
      Parameters:
      obj - 要与之比较的对象
      Returns:
      如果对象相同, 则返回 true;否则返回 false
    • compareTo

      public int compareTo(UUID val)
      将此 UUID 与指定的 UUID 比较

      如果两个 UUID 不同,且第一个 UUID 的最高有效字段大于第二个 UUID 的对应字段,则第一个 UUID 大于第二个 UUID

      Specified by:
      compareTo in interface Comparable<UUID>
      Parameters:
      val - 与此 UUID 比较的 UUID
      Returns:
      在此 UUID 小于、等于或大于 val 时,分别返回 -1、0 或 1