com.livk.commons.web.RequestWrapper Maven / Gradle / Ivy

Go to download
/*
 * 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.web;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.livk.commons.util.ObjectUtils;
import com.livk.commons.util.WebUtils;
import jakarta.servlet.ReadListener;
import jakarta.servlet.ServletInputStream;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletRequestWrapper;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.lang.Nullable;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StreamUtils;

import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * Request包装器
 * 
 * 用于修改body、添加header、添加param
 *
 * @author livk
 */
public class RequestWrapper extends HttpServletRequestWrapper {

	private final HttpHeaders headers = new HttpHeaders();

	private final HttpParameters parameter = new HttpParameters();

	@Nullable
	private byte[] body;

	private boolean bodyReviseStatus = false;

	private String contentType;

	/**
	 * 构建一个RequestWrapper
	 * @param request the request
	 */
	public RequestWrapper(HttpServletRequest request) {
		super(request);
		headers.putAll(WebUtils.headers(request));
		parameter.putAll(WebUtils.params(request));
		contentType = request.getContentType();
	}

	/**
	 * 设置request body
	 * @param body the body
	 */
	public void body(byte[] body) {
		body(body, MediaType.APPLICATION_JSON_VALUE);
	}

	public void body(byte[] body, String contentType) {
		bodyReviseStatus = true;
		this.body = body;
		this.contentType = contentType;
	}

	/**
	 * 添加http header.
	 * @param name the name
	 * @param values the values
	 */
	public void addHeader(String name, String[] values) {
		addHeader(name, Lists.newArrayList(values));
	}

	/**
	 * 添加http header.
	 * @param name the name
	 * @param values the values
	 */
	public void addHeader(String name, List values) {
		parameter.addAll(name, values);
	}

	/**
	 * 添加http header
	 * @param name the name
	 * @param value the value
	 */
	public void addHeader(String name, String value) {
		headers.add(name, value);
	}

	/**
	 * 添加http parameter.
	 * @param name the name
	 * @param values the values
	 */
	public void addParameter(String name, String[] values) {
		addParameter(name, Lists.newArrayList(values));
	}

	/**
	 * 添加http parameter.
	 * @param name the name
	 * @param values the values
	 */
	public void addParameter(String name, List values) {
		parameter.addAll(name, values);
	}

	/**
	 * 添加http parameter.
	 * @param name the name
	 * @param value the value
	 */
	public void addParameter(String name, String value) {
		parameter.add(name, value);
	}

	@Override
	public ServletInputStream getInputStream() throws IOException {
		if (ObjectUtils.isEmpty(body)) {
			body = StreamUtils.copyToByteArray(super.getInputStream());
		}
		return new ByteArrayServletInputStream(body);
	}

	@Override
	public BufferedReader getReader() {
		return new BufferedReader(new ByteArrayReader(body));
	}

	@Override
	public int getContentLength() {
		return bodyReviseStatus && !ObjectUtils.isEmpty(body) ? body.length : super.getContentLength();
	}

	@Override
	public long getContentLengthLong() {
		return bodyReviseStatus && !ObjectUtils.isEmpty(body) ? body.length : super.getContentLengthLong();
	}

	@Override
	public String getContentType() {
		return contentType;
	}

	@Override
	public String getParameter(String name) {
		String[] values = getParameterValues(name);
		return ObjectUtils.isEmpty(values) ? null : values[0];
	}

	@Override
	public Map getParameterMap() {
		return Maps.transformValues(parameter, parameterValues -> parameterValues.toArray(String[]::new));
	}

	@Override
	public Enumeration getParameterNames() {
		return Collections.enumeration(parameter.keySet());
	}

	@Override
	public String[] getParameterValues(String name) {
		return getParameterMap().get(name);
	}

	@Override
	public String getHeader(String name) {
		if (HttpHeaders.CONTENT_TYPE.equalsIgnoreCase(name) && bodyReviseStatus) {
			return getContentType();
		}
		return headers.getFirst(name);
	}

	@Override
	public Enumeration getHeaderNames() {
		Set headerNames = headers.keySet();
		if (bodyReviseStatus) {
			headerNames.add(HttpHeaders.CONTENT_TYPE);
		}
		return Collections.enumeration(headers.keySet());
	}

	@Override
	public Enumeration getHeaders(String name) {
		Set headerValues = new HashSet<>();
		if (HttpHeaders.CONTENT_TYPE.equalsIgnoreCase(name) && bodyReviseStatus) {
			headerValues.add(getContentType());
		}
		List list = headers.get(name);
		if (!CollectionUtils.isEmpty(list)) {
			headerValues.addAll(list);
		}
		return Collections.enumeration(headerValues);
	}

	private static class ByteArrayReader extends InputStreamReader {

		/**
		 * 创建ByteArrayReader
		 * @param bytes the bytes
		 */
		public ByteArrayReader(byte[] bytes) {
			super(new ByteArrayInputStream(bytes));
		}

	}

	private static class ByteArrayServletInputStream extends ServletInputStream {

		private final InputStream in;

		/**
		 * 创建ByteArrayServletInputStream
		 * @param body the json
		 */
		public ByteArrayServletInputStream(byte[] body) {
			in = new ByteArrayInputStream(body);
		}

		@Override
		public boolean isFinished() {
			return false;
		}

		@Override
		public boolean isReady() {
			return false;
		}

		@Override
		public void setReadListener(ReadListener listener) {
			throw new UnsupportedOperationException();
		}

		@Override
		public int read() throws IOException {
			return in.read();
		}

	}

}