cn.featherfly.web.servlet.ServletUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of featherfly-web Show documentation
web tool
The newest version!
package cn.featherfly.web.servlet;

import java.util.Enumeration;

import org.apache.commons.lang3.StringUtils;

import cn.featherfly.common.lang.Lang;
import jakarta.servlet.http.HttpServletRequest;

/**
 * ServletUtils.
 *
 * @author 钟冀
 */
public class ServletUtils {

    private static final String XML_HTTP_REQUEST_HEADER_NAME = "X-Requested-With";

    private static final String XML_HTTP_REQUEST_HEADER_VALUE = "XMLHttpRequest";

    /**
     * 
     * 获取请求客户端IP，剥离代理直接找寻原始地址.
     * 
     *
     * @param request HttpServletRequest
     * @return 请求客户端IP
     */
    public static String getIpAddr(HttpServletRequest request) {
        String ip = request.getHeader("x-forwarded-for");
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("WL-Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getRemoteAddr();
        }
        return ip;
    }

    /**
     * 
     * 返回请求是否是XMLHttpRequest
     * 
     *
     * @param request HttpServletRequest
     * @return 请求是否是XMLHttpRequest
     */
    public static boolean isXMLHttpRequest(HttpServletRequest request) {
        return XML_HTTP_REQUEST_HEADER_VALUE.equals(request.getHeader(XML_HTTP_REQUEST_HEADER_NAME));
    }

    /**
     * 
     * 获取请求参数字符串
     * 
     *
     * @param request request
     * @return 请求参数字符串
     */
    public static String getParameters(HttpServletRequest request) {
        StringBuilder params = new StringBuilder();
        Enumeration names = request.getParameterNames();
        while (names.hasMoreElements()) {
            String name = names.nextElement();
            String[] values = request.getParameterValues(name);
            if (Lang.isNotEmpty(values)) {
                for (String value : values) {
                    params.append(name).append("=").append(value).append("&");
                }
            }
        }
        if (params.length() > 0) {
            params.deleteCharAt(params.length() - 1);
        }
        return params.toString();
    }

    /**
     * 
     * 获取请求相对地址，不包含contextPath
     * 
     *
     * @param request request
     * @return 请求相对地址
     */
    public static String getRequestURI(HttpServletRequest request) {
        if (Lang.isEmpty(request)) {
            return "";
        }
        String uri = StringUtils.substringBeforeLast(request.getRequestURI(), ".");
        if (!"".equals(request.getContextPath())) {
            uri = StringUtils.substringAfter(uri, request.getContextPath());
        }
        return uri;
    }
}