com.livk.commons.web.HttpParameters 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 org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
import org.springframework.util.LinkedCaseInsensitiveMap;
import org.springframework.util.MultiValueMap;

import java.io.Serial;
import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.stream.Collectors;

/**
 * 
 * 根据{@link org.springframework.http.HttpHeaders}改造
 * 

 * 用于HttpParam，适用于Query和FORM请求数据存储
 * 
 *
 * @author livk
 * @see org.springframework.http.HttpHeaders
 * @since 1.3.5
 */
public final class HttpParameters implements MultiValueMap, Serializable {

	@Serial
	private static final long serialVersionUID = -578554704772377436L;

	final MultiValueMap parameters;

	public HttpParameters() {
		this(CollectionUtils.toMultiValueMap(new LinkedCaseInsensitiveMap<>(8, Locale.ENGLISH)));
	}

	public HttpParameters(MultiValueMap parameters) {
		Assert.notNull(parameters, "MultiValueMap must not be null");
		this.parameters = parameters;
	}

	public List getOrEmpty(Object parameterName) {
		List values = get(parameterName);
		return (values != null ? values : Collections.emptyList());
	}

	@Override
	@Nullable
	public String getFirst(@NonNull String parameterName) {
		return this.parameters.getFirst(parameterName);
	}

	@Override
	public void add(@NonNull String parameterName, @Nullable String parameterValue) {
		this.parameters.add(parameterName, parameterValue);
	}

	@Override
	public void addAll(@NonNull String key, @NonNull List values) {
		this.parameters.addAll(key, values);
	}

	@Override
	public void addAll(@NonNull MultiValueMap values) {
		this.parameters.addAll(values);
	}

	@Override
	public void set(@NonNull String parameterName, @Nullable String parameterValue) {
		this.parameters.set(parameterName, parameterValue);
	}

	@Override
	public void setAll(@NonNull Map values) {
		this.parameters.setAll(values);
	}

	@NonNull
	@Override
	public Map toSingleValueMap() {
		return this.parameters.toSingleValueMap();
	}

	@Override
	public int size() {
		return this.parameters.size();
	}

	@Override
	public boolean isEmpty() {
		return this.parameters.isEmpty();
	}

	@Override
	public boolean containsKey(Object key) {
		return this.parameters.containsKey(key);
	}

	@Override
	public boolean containsValue(Object value) {
		return this.parameters.containsValue(value);
	}

	@Override
	@Nullable
	public List get(Object key) {
		return this.parameters.get(key);
	}

	@Override
	public List put(String key, List value) {
		return this.parameters.put(key, value);
	}

	@Override
	public List remove(Object key) {
		return this.parameters.remove(key);
	}

	@Override
	public void putAll(@NonNull Map> map) {
		this.parameters.putAll(map);
	}

	@Override
	public void clear() {
		this.parameters.clear();
	}

	@NonNull
	@Override
	public Set keySet() {
		return this.parameters.keySet();
	}

	@NonNull
	@Override
	public Collection> values() {
		return this.parameters.values();
	}

	@NonNull
	@Override
	public Set>> entrySet() {
		return this.parameters.entrySet();
	}

	@Override
	public void forEach(BiConsumer> action) {
		this.parameters.forEach(action);
	}

	@Override
	public List putIfAbsent(String key, List value) {
		return this.parameters.putIfAbsent(key, value);
	}

	@Override
	public boolean equals(@Nullable Object other) {
		return (this == other || (other instanceof HttpParameters that && unwrap(this).equals(unwrap(that))));
	}

	@Override
	public int hashCode() {
		return this.parameters.hashCode();
	}

	@Override
	public String toString() {
		return formatParameters(this.parameters);
	}

	private static MultiValueMap unwrap(HttpParameters parameters) {
		while (parameters.parameters instanceof HttpParameters httpParameters) {
			parameters = httpParameters;
		}
		return parameters.parameters;
	}

	public static String formatParameters(MultiValueMap parameters) {
		return parameters.entrySet().stream().map(entry -> {
			List values = entry.getValue();
			return entry.getKey() + ":" + (values.size() == 1 ? "\"" + values.getFirst() + "\""
					: values.stream().map(s -> "\"" + s + "\"").collect(Collectors.joining(", ")));
		}).collect(Collectors.joining(", ", "[", "]"));
	}

}