NetUtil (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.core.net.NetUtil

```
public class NetUtil
extends Object
```
网络相关工具

Author:

looly

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`LOCAL_IP` 本地IPv4地址
`static String`	`localhostName` 本地主机名称
`static int`	`PORT_RANGE_MAX` 默认最大端口，65535
`static int`	`PORT_RANGE_MIN` 默认最小端口，1024

Constructor Summary

Constructors
Constructor and Description

NetUtil()

Constructors
Constructor and Description
`NetUtil()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static String`	`bigIntegerToIPv6(BigInteger bigInteger)` 将大整数转换成ipv6字符串
`static InetSocketAddress`	`buildInetSocketAddress(String host, int defaultPort)` 构建InetSocketAddress 当host中包含端口时（用“：”隔开），使用host中的端口，否则使用默认端口给定host为空时使用本地host（127.0.0.1）
`static InetSocketAddress`	`createAddress(String host, int port)` 创建 `InetSocketAddress`
`static List<String>`	`getDnsInfo(String hostName, String... attrNames)` 获取DNS信息，如TXT信息： NetUtil.attrNames("hutool.cn", "TXT")
`static byte[]`	`getHardwareAddress(InetAddress inetAddress)` 获得指定地址信息中的硬件地址
`static String`	`getIpByHost(String hostName)` 通过域名得到IP
`static byte[]`	`getLocalHardwareAddress()` 获得本机物理地址
`static InetAddress`	`getLocalhost()` 获取本机网卡IP地址，规则如下： 1.
`static String`	`getLocalHostName()` 获取主机名称，一次获取会缓存名称注意此方法会触发反向DNS解析，导致阻塞，阻塞时间取决于网络！
`static String`	`getLocalhostStr()` 获取本机网卡IP地址，这个地址为所有网卡中非回路地址的第一个如果获取失败调用 `InetAddress.getLocalHost()`方法获取。
`static String`	`getLocalMacAddress()` 获得本机MAC地址
`static String`	`getMacAddress(InetAddress inetAddress)` 获得指定地址信息中的MAC地址，使用分隔符“-”
`static String`	`getMacAddress(InetAddress inetAddress, String separator)` 获得指定地址信息中的MAC地址
`static String`	`getMultistageReverseProxyIp(String ip)` 从多级反向代理中获得第一个非unknown IP地址
`static NetworkInterface`	`getNetworkInterface(String name)` 获取指定名称的网卡信息
`static Collection<NetworkInterface>`	`getNetworkInterfaces()` 获取本机所有网卡
`static int`	`getUsableLocalPort()` 查找1024~65535范围内的可用端口此方法只检测给定范围内的随机一个端口，检测65535-1024次来自org.springframework.util.SocketUtils
`static int`	`getUsableLocalPort(int minPort)` 查找指定范围内的可用端口，最大值为65535 此方法只检测给定范围内的随机一个端口，检测65535-minPort次来自org.springframework.util.SocketUtils
`static int`	`getUsableLocalPort(int minPort, int maxPort)` 查找指定范围内的可用端口此方法只检测给定范围内的随机一个端口，检测maxPort-minPort次来自org.springframework.util.SocketUtils
`static TreeSet<Integer>`	`getUsableLocalPorts(int numRequested, int minPort, int maxPort)` 获取多个本地可用端口来自org.springframework.util.SocketUtils
`static String`	`hideIpPart(long ip)` 隐藏掉IP地址的最后一部分为 * 代替
`static String`	`hideIpPart(String ip)` 隐藏掉IP地址的最后一部分为 * 代替
`static String`	`idnToASCII(String unicode)` Unicode域名转puny code
`static long`	`ipv4ToLong(String strIP)` 根据ip地址计算出long型的数据
`static BigInteger`	`ipv6ToBigInteger(String ipv6Str)` 将IPv6地址字符串转为大整数
`static BigInteger`	`ipv6ToBitInteger(String ipv6Str)` Deprecated. 拼写错误，请使用`ipv6ToBigInteger(String)`
`static boolean`	`isInnerIP(String ipAddress)` 判定是否为内网IPv4 私有IP： A类 10.0.0.0-10.255.255.255 B类 172.16.0.0-172.31.255.255 C类 192.168.0.0-192.168.255.255 当然，还有127这个网段是环回地址
`static boolean`	`isInRange(String ip, String cidr)` 是否在CIDR规则配置范围内方法来自：【成都】小邓
`static boolean`	`isOpen(InetSocketAddress address, int timeout)` 检查远程端口是否开启
`static boolean`	`isUnknown(String checkString)` 检测给定字符串是否为未知，多用于检测HTTP请求相关
`static boolean`	`isUsableLocalPort(int port)` 检测本地端口可用性来自org.springframework.util.SocketUtils
`static boolean`	`isValidPort(int port)` 是否为有效的端口此方法并不检查端口是否被占用
`static LinkedHashSet<InetAddress>`	`localAddressList(Filter<InetAddress> addressFilter)` 获取所有满足过滤条件的本地IP地址对象
`static LinkedHashSet<InetAddress>`	`localAddressList(Filter<NetworkInterface> networkInterfaceFilter, Filter<InetAddress> addressFilter)` 获取所有满足过滤条件的本地IP地址对象
`static LinkedHashSet<String>`	`localIps()` 获得本机的IP地址列表（包括Ipv4和Ipv6）返回的IP列表有序，按照系统设备顺序
`static LinkedHashSet<String>`	`localIpv4s()` 获得本机的IPv4地址列表返回的IP列表有序，按照系统设备顺序
`static LinkedHashSet<String>`	`localIpv6s()` 获得本机的IPv6地址列表返回的IP列表有序，按照系统设备顺序
`static String`	`longToIpv4(long longIP)` 根据long值获取ip v4地址
`static void`	`netCat(String host, int port, boolean isBlock, ByteBuffer data)` 简易的使用Socket发送数据
`static void`	`netCat(String host, int port, byte[] data)` 使用普通Socket发送数据
`static List<HttpCookie>`	`parseCookies(String cookieStr)` 解析Cookie信息
`static boolean`	`ping(String ip)` 检测IP地址是否能ping通
`static boolean`	`ping(String ip, int timeout)` 检测IP地址是否能ping通
`static void`	`setGlobalAuthenticator(Authenticator authenticator)` 设置全局验证
`static void`	`setGlobalAuthenticator(String user, char[] pass)` 设置全局验证
`static String`	`toAbsoluteUrl(String absoluteBasePath, String relativePath)` 相对URL转换为绝对URL
`static LinkedHashSet<String>`	`toIpList(Set<InetAddress> addressList)` 地址列表转换为IP地址列表

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOCAL_IP
```
public static final String LOCAL_IP
```
    本地IPv4地址
    
    See Also:
    
    Constant Field Values
  - localhostName
```
public static String localhostName
```
    本地主机名称
  - PORT_RANGE_MIN
```
public static final int PORT_RANGE_MIN
```
    默认最小端口，1024
    
    See Also:
    
    Constant Field Values
  - PORT_RANGE_MAX
```
public static final int PORT_RANGE_MAX
```
    默认最大端口，65535
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NetUtil
```
public NetUtil()
```
- Method Detail
  - longToIpv4
```
public static String longToIpv4(long longIP)
```
    根据long值获取ip v4地址
    
    Parameters:
    
    longIP - IP的long表示形式
    
    Returns:
    
    IP V4 地址
    
    See Also:
    
    Ipv4Util.longToIpv4(long)
  - ipv4ToLong
```
public static long ipv4ToLong(String strIP)
```
    根据ip地址计算出long型的数据
    
    Parameters:
    
    strIP - IP V4 地址
    
    Returns:
    
    long值
    
    See Also:
    
    Ipv4Util.ipv4ToLong(String)
  - ipv6ToBitInteger
```
@Deprecated
public static BigInteger ipv6ToBitInteger(String ipv6Str)
```
    Deprecated. 拼写错误，请使用ipv6ToBigInteger(String)
    
    将IPv6地址字符串转为大整数
    
    Parameters:
    
    ipv6Str - 字符串
    
    Returns:
    
    大整数, 如发生异常返回 null
    
    Since:
    
    5.5.7
  - ipv6ToBigInteger
```
public static BigInteger ipv6ToBigInteger(String ipv6Str)
```
    将IPv6地址字符串转为大整数
    
    Parameters:
    
    ipv6Str - 字符串
    
    Returns:
    
    大整数, 如发生异常返回 null
    
    Since:
    
    5.5.7
  - bigIntegerToIPv6
```
public static String bigIntegerToIPv6(BigInteger bigInteger)
```
    将大整数转换成ipv6字符串
    
    Parameters:
    
    bigInteger - 大整数
    
    Returns:
    
    IPv6字符串, 如发生异常返回 null
    
    Since:
    
    5.5.7
  - isUsableLocalPort
```
public static boolean isUsableLocalPort(int port)
```
    检测本地端口可用性
    来自org.springframework.util.SocketUtils
    
    Parameters:
    
    port - 被检测的端口
    
    Returns:
    
    是否可用
  - isValidPort
```
public static boolean isValidPort(int port)
```
    是否为有效的端口
    此方法并不检查端口是否被占用
    
    Parameters:
    
    port - 端口号
    
    Returns:
    
    是否有效
  - getUsableLocalPort
```
public static int getUsableLocalPort()
```
    查找1024~65535范围内的可用端口
    此方法只检测给定范围内的随机一个端口，检测65535-1024次
    来自org.springframework.util.SocketUtils
    
    Returns:
    
    可用的端口
    
    Since:
    
    4.5.4
  - getUsableLocalPort
```
public static int getUsableLocalPort(int minPort)
```
    查找指定范围内的可用端口，最大值为65535
    此方法只检测给定范围内的随机一个端口，检测65535-minPort次
    来自org.springframework.util.SocketUtils
    
    Parameters:
    
    minPort - 端口最小值（包含）
    
    Returns:
    
    可用的端口
    
    Since:
    
    4.5.4
  - getUsableLocalPort
```
public static int getUsableLocalPort(int minPort,
                                     int maxPort)
```
    查找指定范围内的可用端口
    此方法只检测给定范围内的随机一个端口，检测maxPort-minPort次
    来自org.springframework.util.SocketUtils
    
    Parameters:
    
    minPort - 端口最小值（包含）
    
    maxPort - 端口最大值（包含）
    
    Returns:
    
    可用的端口
    
    Since:
    
    4.5.4
  - getUsableLocalPorts
```
public static TreeSet<Integer> getUsableLocalPorts(int numRequested,
                                                   int minPort,
                                                   int maxPort)
```
    获取多个本地可用端口
    来自org.springframework.util.SocketUtils
    
    Parameters:
    
    numRequested - 尝试次数
    
    minPort - 端口最小值（包含）
    
    maxPort - 端口最大值（包含）
    
    Returns:
    
    可用的端口
    
    Since:
    
    4.5.4
  - isInnerIP
```
public static boolean isInnerIP(String ipAddress)
```
    判定是否为内网IPv4
    私有IP：
```
 A类 10.0.0.0-10.255.255.255
 B类 172.16.0.0-172.31.255.255
 C类 192.168.0.0-192.168.255.255
 
```
    当然，还有127这个网段是环回地址
    Parameters:
    
    ipAddress - IP地址
    
    Returns:
    
    是否为内网IP
    
    See Also:
    
    Ipv4Util.isInnerIP(String)
  - toAbsoluteUrl
```
public static String toAbsoluteUrl(String absoluteBasePath,
                                   String relativePath)
```
    相对URL转换为绝对URL
    
    Parameters:
    
    absoluteBasePath - 基准路径，绝对
    
    relativePath - 相对路径
    
    Returns:
    
    绝对URL
  - hideIpPart
```
public static String hideIpPart(String ip)
```
    隐藏掉IP地址的最后一部分为 * 代替
    
    Parameters:
    
    ip - IP地址
    
    Returns:
    
    隐藏部分后的IP
  - hideIpPart
```
public static String hideIpPart(long ip)
```
    隐藏掉IP地址的最后一部分为 * 代替
    
    Parameters:
    
    ip - IP地址
    
    Returns:
    
    隐藏部分后的IP
  - buildInetSocketAddress
```
public static InetSocketAddress buildInetSocketAddress(String host,
                                                       int defaultPort)
```
    构建InetSocketAddress
    当host中包含端口时（用“：”隔开），使用host中的端口，否则使用默认端口
    给定host为空时使用本地host（127.0.0.1）
    
    Parameters:
    
    host - Host
    
    defaultPort - 默认端口
    
    Returns:
    
    InetSocketAddress
  - getIpByHost
```
public static String getIpByHost(String hostName)
```
    通过域名得到IP
    
    Parameters:
    
    hostName - HOST
    
    Returns:
    
    ip address or hostName if UnknownHostException
  - getNetworkInterface
```
public static NetworkInterface getNetworkInterface(String name)
```
    获取指定名称的网卡信息
    
    Parameters:
    
    name - 网络接口名，例如Linux下默认是eth0
    
    Returns:
    
    网卡，未找到返回null
    
    Since:
    
    5.0.7
  - getNetworkInterfaces
```
public static Collection<NetworkInterface> getNetworkInterfaces()
```
    获取本机所有网卡
    
    Returns:
    
    所有网卡，异常返回null
    
    Since:
    
    3.0.1
  - localIpv4s
```
public static LinkedHashSet<String> localIpv4s()
```
    获得本机的IPv4地址列表
    返回的IP列表有序，按照系统设备顺序
    
    Returns:
    
    IP地址列表 LinkedHashSet
  - localIpv6s
```
public static LinkedHashSet<String> localIpv6s()
```
    获得本机的IPv6地址列表
    返回的IP列表有序，按照系统设备顺序
    
    Returns:
    
    IP地址列表 LinkedHashSet
    
    Since:
    
    4.5.17
  - toIpList
```
public static LinkedHashSet<String> toIpList(Set<InetAddress> addressList)
```
    地址列表转换为IP地址列表
    
    Parameters:
    
    addressList - 地址Inet4Address 列表
    
    Returns:
    
    IP地址字符串列表
    
    Since:
    
    4.5.17
  - localIps
```
public static LinkedHashSet<String> localIps()
```
    获得本机的IP地址列表（包括Ipv4和Ipv6）
    返回的IP列表有序，按照系统设备顺序
    
    Returns:
    
    IP地址列表 LinkedHashSet
  - localAddressList
```
public static LinkedHashSet<InetAddress> localAddressList(Filter<InetAddress> addressFilter)
```
    获取所有满足过滤条件的本地IP地址对象
    
    Parameters:
    
    addressFilter - 过滤器，null表示不过滤，获取所有地址
    
    Returns:
    
    过滤后的地址对象列表
    
    Since:
    
    4.5.17
  - localAddressList
```
public static LinkedHashSet<InetAddress> localAddressList(Filter<NetworkInterface> networkInterfaceFilter,
                                                          Filter<InetAddress> addressFilter)
```
    获取所有满足过滤条件的本地IP地址对象
    
    Parameters:
    
    addressFilter - 过滤器，null表示不过滤，获取所有地址
    
    networkInterfaceFilter - 过滤器，null表示不过滤，获取所有网卡
    
    Returns:
    
    过滤后的地址对象列表
  - getLocalhostStr
```
public static String getLocalhostStr()
```
    获取本机网卡IP地址，这个地址为所有网卡中非回路地址的第一个
    如果获取失败调用 InetAddress.getLocalHost()方法获取。
    此方法不会抛出异常，获取失败将返回null
    
    参考：http://stackoverflow.com/questions/9481865/getting-the-ip-address-of-the-current-machine-using-java
    
    Returns:
    
    本机网卡IP地址，获取失败返回null
    
    Since:
    
    3.0.7
  - getLocalhost
```
public static InetAddress getLocalhost()
```
    获取本机网卡IP地址，规则如下：
```
 1. 查找所有网卡地址，必须非回路（loopback）地址、非局域网地址（siteLocal）、IPv4地址
 2. 如果无满足要求的地址，调用 InetAddress.getLocalHost() 获取地址
 
```
    此方法不会抛出异常，获取失败将返回null
    
    见：https://github.com/dromara/hutool/issues/428
    Returns:
    
    本机网卡IP地址，获取失败返回null
    
    Since:
    
    3.0.1
  - getLocalMacAddress
```
public static String getLocalMacAddress()
```
    获得本机MAC地址
    
    Returns:
    
    本机MAC地址
  - getMacAddress
```
public static String getMacAddress(InetAddress inetAddress)
```
    获得指定地址信息中的MAC地址，使用分隔符“-”
    
    Parameters:
    
    inetAddress - InetAddress
    
    Returns:
    
    MAC地址，用-分隔
  - getMacAddress
```
public static String getMacAddress(InetAddress inetAddress,
                                   String separator)
```
    获得指定地址信息中的MAC地址
    
    Parameters:
    
    inetAddress - InetAddress
    
    separator - 分隔符，推荐使用“-”或者“:”
    
    Returns:
    
    MAC地址，用-分隔
  - getHardwareAddress
```
public static byte[] getHardwareAddress(InetAddress inetAddress)
```
    获得指定地址信息中的硬件地址
    
    Parameters:
    
    inetAddress - InetAddress
    
    Returns:
    
    硬件地址
    
    Since:
    
    5.7.3
  - getLocalHardwareAddress
```
public static byte[] getLocalHardwareAddress()
```
    获得本机物理地址
    
    Returns:
    
    本机物理地址
    
    Since:
    
    5.7.3
  - getLocalHostName
```
public static String getLocalHostName()
```
    获取主机名称，一次获取会缓存名称
    注意此方法会触发反向DNS解析，导致阻塞，阻塞时间取决于网络！
    
    Returns:
    
    主机名称
    
    Since:
    
    5.4.4
  - createAddress
```
public static InetSocketAddress createAddress(String host,
                                              int port)
```
    创建 InetSocketAddress
    
    Parameters:
    
    host - 域名或IP地址，空表示任意地址
    
    port - 端口，0表示系统分配临时端口
    
    Returns:
    
    InetSocketAddress
    
    Since:
    
    3.3.0
  - netCat
```
public static void netCat(String host,
                          int port,
                          boolean isBlock,
                          ByteBuffer data)
                   throws IORuntimeException
```
    简易的使用Socket发送数据
    
    Parameters:
    
    host - Server主机
    
    port - Server端口
    
    isBlock - 是否阻塞方式
    
    data - 需要发送的数据
    
    Throws:
    
    IORuntimeException - IO异常
    
    Since:
    
    3.3.0
  - netCat
```
public static void netCat(String host,
                          int port,
                          byte[] data)
                   throws IORuntimeException
```
    使用普通Socket发送数据
    
    Parameters:
    
    host - Server主机
    
    port - Server端口
    
    data - 数据
    
    Throws:
    
    IORuntimeException - IO异常
    
    Since:
    
    3.3.0
  - isInRange
```
public static boolean isInRange(String ip,
                                String cidr)
```
    是否在CIDR规则配置范围内
    方法来自：【成都】小邓
    
    Parameters:
    
    ip - 需要验证的IP
    
    cidr - CIDR规则
    
    Returns:
    
    是否在范围内
    
    Since:
    
    4.0.6
  - idnToASCII
```
public static String idnToASCII(String unicode)
```
    Unicode域名转puny code
    
    Parameters:
    
    unicode - Unicode域名
    
    Returns:
    
    puny code
    
    Since:
    
    4.1.22
  - getMultistageReverseProxyIp
```
public static String getMultistageReverseProxyIp(String ip)
```
    从多级反向代理中获得第一个非unknown IP地址
    
    Parameters:
    
    ip - 获得的IP地址
    
    Returns:
    
    第一个非unknown IP地址
    
    Since:
    
    4.4.1
  - isUnknown
```
public static boolean isUnknown(String checkString)
```
    检测给定字符串是否为未知，多用于检测HTTP请求相关
    
    Parameters:
    
    checkString - 被检测的字符串
    
    Returns:
    
    是否未知
    
    Since:
    
    5.2.6
  - ping
```
public static boolean ping(String ip)
```
    检测IP地址是否能ping通
    
    Parameters:
    
    ip - IP地址
    
    Returns:
    
    返回是否ping通
  - ping
```
public static boolean ping(String ip,
                           int timeout)
```
    检测IP地址是否能ping通
    
    Parameters:
    
    ip - IP地址
    
    timeout - 检测超时（毫秒）
    
    Returns:
    
    是否ping通
  - parseCookies
```
public static List<HttpCookie> parseCookies(String cookieStr)
```
    解析Cookie信息
    
    Parameters:
    
    cookieStr - Cookie字符串
    
    Returns:
    
    cookie字符串
    
    Since:
    
    5.2.6
  - isOpen
```
public static boolean isOpen(InetSocketAddress address,
                             int timeout)
```
    检查远程端口是否开启
    
    Parameters:
    
    address - 远程地址
    
    timeout - 检测超时
    
    Returns:
    
    远程端口是否开启
    
    Since:
    
    5.3.2
  - setGlobalAuthenticator
```
public static void setGlobalAuthenticator(String user,
                                          char[] pass)
```
    设置全局验证
    
    Parameters:
    
    user - 用户名
    
    pass - 密码，考虑安全，此处不使用String
    
    Since:
    
    5.7.2
  - setGlobalAuthenticator
```
public static void setGlobalAuthenticator(Authenticator authenticator)
```
    设置全局验证
    
    Parameters:
    
    authenticator - 验证器
    
    Since:
    
    5.7.2
  - getDnsInfo
```
public static List<String> getDnsInfo(String hostName,
                                      String... attrNames)
```
    获取DNS信息，如TXT信息：
```
     NetUtil.attrNames("hutool.cn", "TXT")
 
```
    Parameters:
    
    hostName - 主机域名
    
    attrNames - 属性
    
    Returns:
    
    DNS信息
    
    Since:
    
    5.7.7

Class NetUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCAL_IP

localhostName

PORT_RANGE_MIN

PORT_RANGE_MAX

Constructor Detail

NetUtil

Method Detail

longToIpv4

ipv4ToLong

ipv6ToBitInteger

ipv6ToBigInteger

bigIntegerToIPv6

isUsableLocalPort

isValidPort

getUsableLocalPort

getUsableLocalPort

getUsableLocalPort

getUsableLocalPorts

isInnerIP

toAbsoluteUrl

hideIpPart

hideIpPart

buildInetSocketAddress

getIpByHost

getNetworkInterface

getNetworkInterfaces

localIpv4s

localIpv6s

toIpList

localIps

localAddressList

localAddressList

getLocalhostStr

getLocalhost

getLocalMacAddress

getMacAddress

getMacAddress

getHardwareAddress

getLocalHardwareAddress

getLocalHostName

createAddress

netCat

netCat

isInRange

idnToASCII

getMultistageReverseProxyIp

isUnknown

ping

ping

parseCookies

isOpen

setGlobalAuthenticator

setGlobalAuthenticator

getDnsInfo