com.livk.commons.util.WebUtils Maven / Gradle / Ivy
/*
* Copyright 2021-2024 spring-boot-extension the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.livk.commons.util;
import com.google.common.collect.Lists;
import com.livk.commons.jackson.util.JsonMapperUtils;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.experimental.UtilityClass;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.util.CollectionUtils;
import org.springframework.util.LinkedCaseInsensitiveMap;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.ErrorResponseException;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.function.Function;
import java.util.stream.Collectors;
/**
*
* web、servlet相关工具类
*
*
* @author livk
*/
@UtilityClass
public class WebUtils extends org.springframework.web.util.WebUtils {
private static final String UNKNOWN = "unknown";
private static final String HTTP_IP_SPLIT = ",";
private ServletRequestAttributes servletRequestAttributes() {
RequestAttributes requestAttributes = RequestContextHolder.currentRequestAttributes();
return (ServletRequestAttributes) requestAttributes;
}
/**
* 获取当前线程的request
* @return http servlet request
*/
public HttpServletRequest request() {
return servletRequestAttributes().getRequest();
}
/**
* 获取当前线程的response.
* @return http servlet response
*/
public HttpServletResponse response() {
return servletRequestAttributes().getResponse();
}
/**
* 将request header转成HttpHeaders
* @param request request
* @return http headers
*/
public HttpHeaders headers(HttpServletRequest request) {
LinkedCaseInsensitiveMap> insensitiveMap = new LinkedCaseInsensitiveMap<>();
Enumeration headerNames = request.getHeaderNames();
while (headerNames.hasMoreElements()) {
String headerName = headerNames.nextElement();
Enumeration headers = request.getHeaders(headerName);
insensitiveMap.put(headerName, Collections.list(headers));
}
return new HttpHeaders(CollectionUtils.toMultiValueMap(insensitiveMap));
}
/**
* 获取当前request所有的attributes
* @param request request
* @return attributes
*/
public Map attributes(HttpServletRequest request) {
return BaseStreamUtils.convert(request.getAttributeNames())
.collect(Collectors.toMap(Function.identity(), request::getAttribute));
}
/**
* 解析request的param,并使用delimiter连接相同key的数据
* @param request request
* @param delimiter 连接符
* @return map
* @deprecated use {@link #params(HttpServletRequest)}
*/
@Deprecated(forRemoval = true)
public Map paramMap(HttpServletRequest request, CharSequence delimiter) {
return params(request).entrySet()
.stream()
.collect(Collectors.toMap(Map.Entry::getKey, entry -> String.join(delimiter, entry.getValue())));
}
/**
* 解析request的param转成MultiValueMap
* @param request request
* @return MultiValueMap
*/
public MultiValueMap params(HttpServletRequest request) {
Map> map = request.getParameterMap()
.entrySet()
.stream()
.collect(Collectors.toMap(Map.Entry::getKey, entry -> Lists.newArrayList(entry.getValue())));
return new LinkedMultiValueMap<>(map);
}
/**
* 解析request获取真实IP
* @param request request
* @return ip
*/
public String realIp(HttpServletRequest request) {
String[] ipHeaders = { "X-Real-IP", "X-Forwarded-For", "Proxy-Client-IP", "WL-Proxy-Client-IP" };
Optional optional = Optional.empty();
for (String header : ipHeaders) {
String headerIp = request.getHeader(header);
if (headerIp != null && !headerIp.isBlank() && !UNKNOWN.equalsIgnoreCase(headerIp)) {
optional = Optional.of(headerIp);
break;
}
}
String ip = optional.orElse(request.getRemoteAddr());
// 处理多IP的情况（只取第一个IP）
return ip != null && ip.contains(HTTP_IP_SPLIT) ? ip.split(HTTP_IP_SPLIT)[0] : ip;
}
/**
* 以JSON的格式写出数据到response
* @param response response
* @param data 需要写出的数据
* @see JsonMapperUtils
*/
public void outJson(HttpServletResponse response, Object data) {
out(response, JsonMapperUtils.writeValueAsString(data), MediaType.APPLICATION_JSON_VALUE);
}
/**
* 根据response写入返回值
* @param response response
* @param message 写入的信息
* @param contentType contentType {@link MediaType}
*/
public void out(HttpServletResponse response, String message, String contentType) {
response.setContentType(contentType);
response.setCharacterEncoding("UTF-8");
try (PrintWriter out = response.getWriter()) {
out.print(message);
out.flush();
}
catch (IOException exception) {
throw new ErrorResponseException(HttpStatus.INTERNAL_SERVER_ERROR, exception);
}
}
}