io.github.dengchen2020.core.utils.IPUtils Maven / Gradle / Ivy
package io.github.dengchen2020.core.utils;
import jakarta.servlet.http.HttpServletRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.StringUtils;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.Objects;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
/**
* 获取客户端IP
*
* @author dengchen
* @since 2022/7/13
*/
public abstract class IPUtils {
private static final Logger log = LoggerFactory.getLogger(IPUtils.class);
private static final String UNKNOWN = "unknown";
private static final String LOCALHOST_IP1 = "127.0.0.1";
private static String LOCAL_HOST_IP;
private static final String REAL_CLIENT_IP_HEADER = System.getProperty("dc.real.client.ip.header") == null ? "X-Real-IP" : System.getProperty("dc.real.client.ip.header");
private static ScheduledExecutorService scheduledExecutorService;
public static final String LOCAL_IP_LISTENER_ENABLED = "dc.local.ip.listener.enabled";
static {
if(Objects.equals(System.getProperty(LOCAL_IP_LISTENER_ENABLED), Boolean.TRUE.toString())){
scheduledExecutorService = Executors.newScheduledThreadPool(1, Thread.ofVirtual().name("local-ip-listener").factory());
scheduledExecutorService.scheduleAtFixedRate(()-> {
try {
LOCAL_HOST_IP = InetAddress.getLocalHost().getHostAddress();
} catch (UnknownHostException e) {
if(LOCAL_HOST_IP == null){
LOCAL_HOST_IP = LOCALHOST_IP1;
if (log.isWarnEnabled()) log.warn("获取本机IP失败：{}，回退为：{}", e.getMessage(), LOCAL_HOST_IP);
}
scheduledExecutorService.shutdown();
}
},30,30, TimeUnit.SECONDS);
}
try {
LOCAL_HOST_IP = InetAddress.getLocalHost().getHostAddress();
} catch (UnknownHostException e) {
if(LOCAL_HOST_IP == null){
LOCAL_HOST_IP = LOCALHOST_IP1;
if (log.isWarnEnabled()) log.warn("获取本机IP失败：{}，回退为：{}", e.getMessage(), LOCAL_HOST_IP);
}
scheduledExecutorService.shutdown();
}
}
/**
* 获取IP地址
*
* 使用Nginx等反向代理软件， 则不能通过request.getRemoteAddr()获取IP地址
* 如果使用了多级反向代理的话，X-Forwarded-For的值并不止一个，而是一串IP地址，X-Forwarded-For中第一个非unknown的有效IP字符串，则为真实IP地址
*
*/
public static String getIpAddr(HttpServletRequest request) {
String ip = null;
try {
//获取nginx等代理服务器配置的自定义ip请求头的ip
ip = request.getHeader(REAL_CLIENT_IP_HEADER);
if (StringUtils.hasText(ip) && !UNKNOWN.equals(ip)) {
return ip;
}
ip = request.getRemoteAddr();
} catch (Exception e) {
log.error("获取客户端IP失败: {}", e.getMessage());
}
return ip;
}
/**
* 获取IP地址
*
* 使用Nginx等反向代理软件， 则不能通过request.getRemoteAddr()获取IP地址
* 如果使用了多级反向代理的话，X-Forwarded-For的值并不止一个，而是一串IP地址，X-Forwarded-For中第一个非unknown的有效IP字符串，则为真实IP地址
*
*/
public static String getIpAddr() {
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
if (requestAttributes == null) {
return "";
}
ServletRequestAttributes servletRequestAttributes =
(ServletRequestAttributes) requestAttributes;
HttpServletRequest request = servletRequestAttributes.getRequest();
return getIpAddr(request);
}
/**
* 获取本机IP
*
* @return 本机IP
*/
public static String getLocalhostIp() {
return LOCAL_HOST_IP;
}
/**
* 获取最新的本机IP
*
* @return 本机IP
*/
public static String getLocalhostIpLatest() {
try {
String localhostIp = InetAddress.getLocalHost().getHostAddress();
LOCAL_HOST_IP = localhostIp;
return localhostIp;
} catch (UnknownHostException e) {
return LOCAL_HOST_IP;
}
}
}