All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.dromara.hutool.http.client.HeaderOperation Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* 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
*
* http://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 org.dromara.hutool.http.client;
import org.dromara.hutool.core.array.ArrayUtil;
import org.dromara.hutool.core.collection.CollUtil;
import org.dromara.hutool.core.collection.ListUtil;
import org.dromara.hutool.core.convert.ConvertUtil;
import org.dromara.hutool.core.map.MapUtil;
import org.dromara.hutool.core.text.StrUtil;
import org.dromara.hutool.http.HttpUtil;
import org.dromara.hutool.http.auth.HttpAuthUtil;
import org.dromara.hutool.http.meta.HeaderName;
import java.net.HttpCookie;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
* HTTP请求头的存储和读取相关方法
*
* @param 返回对象类型，方便链式编程
*/
@SuppressWarnings("unchecked")
public interface HeaderOperation> {
// region ----------------------------------------------------------- headers
/**
* 获取headers
*
* @return Headers Map
*/
Map> headers();
/**
* 设置一个header> headerMap, final boolean isOverride) {
if (MapUtil.isNotEmpty(headerMap)) {
String name;
for (final Map.Entry> entry : headerMap.entrySet()) {
name = entry.getKey();
for (final String value : entry.getValue()) {
this.header(name, StrUtil.toStringOrEmpty(value), isOverride);
}
}
}
return (T) this;
}
/**
* 设置请求头 headerMap) {
if (MapUtil.isEmpty(headerMap)) {
return (T) this;
}
final Map> headerMaps = new LinkedHashMap<>(headers().size());
headerMap.forEach((key, value) -> {
headerMaps.put(key, ListUtil.of(value));
});
return header(headerMaps, true);
}
/**
* 设置contentType
*
* @param contentType contentType
* @return T
*/
default T contentType(final String contentType) {
header(HeaderName.CONTENT_TYPE, contentType);
return (T) this;
}
/**
* 设置是否为长连接
*
* @param isKeepAlive 是否长连接
* @return T
*/
default T keepAlive(final boolean isKeepAlive) {
header(HeaderName.CONNECTION, isKeepAlive ? "Keep-Alive" : "Close");
return (T) this;
}
/**
* 获取内容长度，以下情况长度无效：
*
* Transfer-Encoding: Chunked
* Content-Encoding: XXX
*
*
* @return 长度，-1表示服务端未返回或长度无效
* @since 5.7.9
*/
default long contentLength() {
long contentLength = ConvertUtil.toLong(header(HeaderName.CONTENT_LENGTH), -1L);
if (contentLength > 0 && (isChunked() || StrUtil.isNotBlank(contentEncoding()))) {
//按照HTTP协议规范，在 Transfer-Encoding和Content-Encoding设置后 Content-Length 无效。
contentLength = -1;
}
return contentLength;
}
/**
* 是否为Transfer-Encoding:Chunked的内容
*
* @return 是否为Transfer-Encoding:Chunked的内容
* @since 4.6.2
*/
default boolean isChunked() {
return "Chunked".equalsIgnoreCase(header(HeaderName.TRANSFER_ENCODING));
}
/**
* 获取压缩媒体类型
*
* @return 压缩媒体类型
*/
default String contentEncoding() {
return header(HeaderName.CONTENT_ENCODING);
}
// endregion ----------------------------------------------------------- headers
// region ----------------------------------------------------------- auth
/**
* 简单验证，生成的头信息类似于：
*
* Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
*
*
* @param username 用户名
* @param password 密码
* @param charset 编码
* @return this
*/
default T basicAuth(final String username, final String password, final Charset charset) {
return auth(HttpAuthUtil.buildBasicAuth(username, password, charset));
}
/**
* 令牌验证，生成的头类似于："Authorization: Bearer XXXXX"，一般用于JWT
*
* @param token 令牌内容
* @return T this
*/
default T bearerAuth(final String token) {
return auth("Bearer " + token);
}
/**
* 验证，简单插入Authorization头
*
* @param content 验证内容
* @return T this
*/
default T auth(final String content) {
header(HeaderName.AUTHORIZATION, content, true);
return (T) this;
}
/**
* 验证，简单插入Authorization头
*
* @param content 验证内容
* @return T this
*/
default T proxyAuth(final String content) {
header(HeaderName.PROXY_AUTHORIZATION, content, true);
return (T) this;
}
// endregion ----------------------------------------------------------- auth
// region ----------------------------------------------------------- Cookies
/**
* 设置Cookie cookies) {
return cookie(CollUtil.isEmpty(cookies) ? null : cookies.toArray(new HttpCookie[0]));
}
/**
* 设置Cookie
