mirror of
https://gitee.com/dromara/hutool.git
synced 2025-06-28 13:34:09 +08:00
532 lines
14 KiB
Java
532 lines
14 KiB
Java
package cn.hutool.http;
|
||
|
||
import cn.hutool.core.convert.Convert;
|
||
import cn.hutool.core.io.FastByteArrayOutputStream;
|
||
import cn.hutool.core.io.FileUtil;
|
||
import cn.hutool.core.io.IORuntimeException;
|
||
import cn.hutool.core.io.IoUtil;
|
||
import cn.hutool.core.io.StreamProgress;
|
||
import cn.hutool.core.lang.Assert;
|
||
import cn.hutool.core.util.CharsetUtil;
|
||
import cn.hutool.core.util.ReUtil;
|
||
import cn.hutool.core.util.StrUtil;
|
||
import cn.hutool.core.util.URLUtil;
|
||
import cn.hutool.http.cookie.GlobalCookieManager;
|
||
|
||
import java.io.ByteArrayInputStream;
|
||
import java.io.Closeable;
|
||
import java.io.EOFException;
|
||
import java.io.File;
|
||
import java.io.FileNotFoundException;
|
||
import java.io.IOException;
|
||
import java.io.InputStream;
|
||
import java.io.OutputStream;
|
||
import java.net.HttpCookie;
|
||
import java.nio.charset.Charset;
|
||
import java.util.List;
|
||
import java.util.Map.Entry;
|
||
|
||
/**
|
||
* Http响应类<br>
|
||
* 非线程安全对象
|
||
*
|
||
* @author Looly
|
||
*/
|
||
public class HttpResponse extends HttpBase<HttpResponse> implements Closeable {
|
||
|
||
/**
|
||
* 持有连接对象
|
||
*/
|
||
protected HttpConnection httpConnection;
|
||
/**
|
||
* Http请求原始流
|
||
*/
|
||
protected InputStream in;
|
||
/**
|
||
* 是否异步，异步下只持有流，否则将在初始化时直接读取body内容
|
||
*/
|
||
private volatile boolean isAsync;
|
||
/**
|
||
* 响应状态码
|
||
*/
|
||
protected int status;
|
||
/**
|
||
* 是否忽略读取Http响应体
|
||
*/
|
||
private final boolean ignoreBody;
|
||
/**
|
||
* 从响应中获取的编码
|
||
*/
|
||
private Charset charsetFromResponse;
|
||
|
||
/**
|
||
* 构造
|
||
*
|
||
* @param httpConnection {@link HttpConnection}
|
||
* @param charset 编码，从请求编码中获取默认编码
|
||
* @param isAsync 是否异步
|
||
* @param isIgnoreBody 是否忽略读取响应体
|
||
* @since 3.1.2
|
||
*/
|
||
protected HttpResponse(HttpConnection httpConnection, Charset charset, boolean isAsync, boolean isIgnoreBody) {
|
||
this.httpConnection = httpConnection;
|
||
this.charset = charset;
|
||
this.isAsync = isAsync;
|
||
this.ignoreBody = isIgnoreBody;
|
||
initWithDisconnect();
|
||
}
|
||
|
||
/**
|
||
* 获取状态码
|
||
*
|
||
* @return 状态码
|
||
*/
|
||
public int getStatus() {
|
||
return this.status;
|
||
}
|
||
|
||
/**
|
||
* 请求是否成功，判断依据为：状态码范围在200~299内。
|
||
*
|
||
* @return 是否成功请求
|
||
* @since 4.1.9
|
||
*/
|
||
public boolean isOk() {
|
||
return this.status >= 200 && this.status < 300;
|
||
}
|
||
|
||
/**
|
||
* 同步<br>
|
||
* 如果为异步状态，则暂时不读取服务器中响应的内容，而是持有Http链接的{@link InputStream}。<br>
|
||
* 当调用此方法时，异步状态转为同步状态，此时从Http链接流中读取body内容并暂存在内容中。如果已经是同步状态，则不进行任何操作。
|
||
*
|
||
* @return this
|
||
*/
|
||
public HttpResponse sync() {
|
||
return this.isAsync ? forceSync() : this;
|
||
}
|
||
|
||
// ---------------------------------------------------------------- Http Response Header start
|
||
|
||
/**
|
||
* 获取内容编码
|
||
*
|
||
* @return String
|
||
*/
|
||
public String contentEncoding() {
|
||
return header(Header.CONTENT_ENCODING);
|
||
}
|
||
|
||
/**
|
||
* 是否为gzip压缩过的内容
|
||
*
|
||
* @return 是否为gzip压缩过的内容
|
||
*/
|
||
public boolean isGzip() {
|
||
final String contentEncoding = contentEncoding();
|
||
return "gzip".equalsIgnoreCase(contentEncoding);
|
||
}
|
||
|
||
/**
|
||
* 是否为zlib(Defalte)压缩过的内容
|
||
*
|
||
* @return 是否为zlib(Defalte)压缩过的内容
|
||
* @since 4.5.7
|
||
*/
|
||
public boolean isDeflate() {
|
||
final String contentEncoding = contentEncoding();
|
||
return "deflate".equalsIgnoreCase(contentEncoding);
|
||
}
|
||
|
||
/**
|
||
* 是否为Transfer-Encoding:Chunked的内容
|
||
*
|
||
* @return 是否为Transfer-Encoding:Chunked的内容
|
||
* @since 4.6.2
|
||
*/
|
||
public boolean isChunked() {
|
||
final String transferEncoding = header(Header.TRANSFER_ENCODING);
|
||
return "Chunked".equalsIgnoreCase(transferEncoding);
|
||
}
|
||
|
||
/**
|
||
* 获取本次请求服务器返回的Cookie信息
|
||
*
|
||
* @return Cookie字符串
|
||
* @since 3.1.1
|
||
*/
|
||
public String getCookieStr() {
|
||
return header(Header.SET_COOKIE);
|
||
}
|
||
|
||
/**
|
||
* 获取Cookie
|
||
*
|
||
* @return Cookie列表
|
||
* @since 3.1.1
|
||
*/
|
||
public List<HttpCookie> getCookies() {
|
||
return GlobalCookieManager.getCookies(this.httpConnection);
|
||
}
|
||
|
||
/**
|
||
* 获取Cookie
|
||
*
|
||
* @param name Cookie名
|
||
* @return {@link HttpCookie}
|
||
* @since 4.1.4
|
||
*/
|
||
public HttpCookie getCookie(String name) {
|
||
List<HttpCookie> cookie = getCookies();
|
||
if (null != cookie) {
|
||
for (HttpCookie httpCookie : cookie) {
|
||
if (httpCookie.getName().equals(name)) {
|
||
return httpCookie;
|
||
}
|
||
}
|
||
}
|
||
return null;
|
||
}
|
||
|
||
/**
|
||
* 获取Cookie值
|
||
*
|
||
* @param name Cookie名
|
||
* @return Cookie值
|
||
* @since 4.1.4
|
||
*/
|
||
public String getCookieValue(String name) {
|
||
HttpCookie cookie = getCookie(name);
|
||
return (null == cookie) ? null : cookie.getValue();
|
||
}
|
||
// ---------------------------------------------------------------- Http Response Header end
|
||
|
||
// ---------------------------------------------------------------- Body start
|
||
|
||
/**
|
||
* 获得服务区响应流<br>
|
||
* 异步模式下获取Http原生流，同步模式下获取获取到的在内存中的副本<br>
|
||
* 如果想在同步模式下获取流，请先调用{@link #sync()}方法强制同步<br>
|
||
* 流获取后处理完毕需关闭此类
|
||
*
|
||
* @return 响应流
|
||
*/
|
||
public InputStream bodyStream() {
|
||
if (isAsync) {
|
||
return this.in;
|
||
}
|
||
return new ByteArrayInputStream(this.bodyBytes);
|
||
}
|
||
|
||
/**
|
||
* 获取响应流字节码<br>
|
||
* 此方法会转为同步模式
|
||
*
|
||
* @return byte[]
|
||
*/
|
||
public byte[] bodyBytes() {
|
||
sync();
|
||
return this.bodyBytes;
|
||
}
|
||
|
||
/**
|
||
* 获取响应主体
|
||
*
|
||
* @return String
|
||
* @throws HttpException 包装IO异常
|
||
*/
|
||
public String body() throws HttpException {
|
||
return HttpUtil.getString(bodyBytes(), this.charset, null == this.charsetFromResponse);
|
||
}
|
||
|
||
/**
|
||
* 将响应内容写出到{@link OutputStream}<br>
|
||
* 异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出<br>
|
||
* 写出后会关闭Http流（异步模式）
|
||
*
|
||
* @param out 写出的流
|
||
* @param isCloseOut 是否关闭输出流
|
||
* @param streamProgress 进度显示接口，通过实现此接口显示下载进度
|
||
* @return 写出bytes数
|
||
* @since 3.3.2
|
||
*/
|
||
public long writeBody(OutputStream out, boolean isCloseOut, StreamProgress streamProgress) {
|
||
if (null == out) {
|
||
throw new NullPointerException("[out] is null!");
|
||
}
|
||
try {
|
||
return IoUtil.copyByNIO(bodyStream(), out, IoUtil.DEFAULT_BUFFER_SIZE, streamProgress);
|
||
} finally {
|
||
IoUtil.close(this);
|
||
if (isCloseOut) {
|
||
IoUtil.close(out);
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* 将响应内容写出到文件<br>
|
||
* 异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出<br>
|
||
* 写出后会关闭Http流（异步模式）
|
||
*
|
||
* @param destFile 写出到的文件
|
||
* @param streamProgress 进度显示接口，通过实现此接口显示下载进度
|
||
* @return 写出bytes数
|
||
* @since 3.3.2
|
||
*/
|
||
public long writeBody(File destFile, StreamProgress streamProgress) {
|
||
Assert.notNull(destFile, "[destFile] is null!");
|
||
|
||
final File outFile = completeFileNameFromHeader(destFile);
|
||
return writeBody(FileUtil.getOutputStream(outFile), true, streamProgress);
|
||
}
|
||
|
||
/**
|
||
* 将响应内容写出到文件<br>
|
||
* 异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出<br>
|
||
* 写出后会关闭Http流（异步模式）
|
||
*
|
||
* @param destFile 写出到的文件
|
||
* @param streamProgress 进度显示接口，通过实现此接口显示下载进度
|
||
* @return 写出的文件
|
||
* @since 5.6.4
|
||
*/
|
||
public File writeBodyForFile(File destFile, StreamProgress streamProgress) {
|
||
Assert.notNull(destFile, "[destFile] is null!");
|
||
|
||
final File outFile = completeFileNameFromHeader(destFile);
|
||
writeBody(FileUtil.getOutputStream(outFile), true, streamProgress);
|
||
|
||
return outFile;
|
||
}
|
||
|
||
/**
|
||
* 将响应内容写出到文件<br>
|
||
* 异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出<br>
|
||
* 写出后会关闭Http流（异步模式）
|
||
*
|
||
* @param destFile 写出到的文件
|
||
* @return 写出bytes数
|
||
* @since 3.3.2
|
||
*/
|
||
public long writeBody(File destFile) {
|
||
return writeBody(destFile, null);
|
||
}
|
||
|
||
/**
|
||
* 将响应内容写出到文件<br>
|
||
* 异步模式下直接读取Http流写出，同步模式下将存储在内存中的响应内容写出<br>
|
||
* 写出后会关闭Http流（异步模式）
|
||
*
|
||
* @param destFilePath 写出到的文件的路径
|
||
* @return 写出bytes数
|
||
* @since 3.3.2
|
||
*/
|
||
public long writeBody(String destFilePath) {
|
||
return writeBody(FileUtil.file(destFilePath));
|
||
}
|
||
// ---------------------------------------------------------------- Body end
|
||
|
||
@Override
|
||
public void close() {
|
||
IoUtil.close(this.in);
|
||
this.in = null;
|
||
// 关闭连接
|
||
this.httpConnection.disconnectQuietly();
|
||
}
|
||
|
||
@Override
|
||
public String toString() {
|
||
StringBuilder sb = StrUtil.builder();
|
||
sb.append("Response Headers: ").append(StrUtil.CRLF);
|
||
for (Entry<String, List<String>> entry : this.headers.entrySet()) {
|
||
sb.append(" ").append(entry).append(StrUtil.CRLF);
|
||
}
|
||
|
||
sb.append("Response Body: ").append(StrUtil.CRLF);
|
||
sb.append(" ").append(this.body()).append(StrUtil.CRLF);
|
||
|
||
return sb.toString();
|
||
}
|
||
|
||
/**
|
||
* 从响应头补全下载文件名
|
||
*
|
||
* @param destFile 目标文件夹或者目标文件
|
||
* @return File 保存的文件
|
||
* @since 5.4.1
|
||
*/
|
||
public File completeFileNameFromHeader(File destFile) {
|
||
if (false == destFile.isDirectory()) {
|
||
// 非目录直接返回
|
||
return destFile;
|
||
}
|
||
|
||
// 从头信息中获取文件名
|
||
String fileName = getFileNameFromDisposition();
|
||
if (StrUtil.isBlank(fileName)) {
|
||
final String path = httpConnection.getUrl().getPath();
|
||
// 从路径中获取文件名
|
||
fileName = StrUtil.subSuf(path, path.lastIndexOf('/') + 1);
|
||
if (StrUtil.isBlank(fileName)) {
|
||
// 编码后的路径做为文件名
|
||
fileName = URLUtil.encodeQuery(path, CharsetUtil.CHARSET_UTF_8);
|
||
}
|
||
}
|
||
return FileUtil.file(destFile, fileName);
|
||
}
|
||
|
||
// ---------------------------------------------------------------- Private method start
|
||
|
||
/**
|
||
* 初始化Http响应，并在报错时关闭连接。<br>
|
||
* 初始化包括：
|
||
*
|
||
* <pre>
|
||
* 1、读取Http状态
|
||
* 2、读取头信息
|
||
* 3、持有Http流，并不关闭流
|
||
* </pre>
|
||
*
|
||
* @return this
|
||
* @throws HttpException IO异常
|
||
*/
|
||
private HttpResponse initWithDisconnect() throws HttpException {
|
||
try {
|
||
init();
|
||
} catch (HttpException e) {
|
||
this.httpConnection.disconnectQuietly();
|
||
throw e;
|
||
}
|
||
return this;
|
||
}
|
||
|
||
/**
|
||
* 初始化Http响应<br>
|
||
* 初始化包括：
|
||
*
|
||
* <pre>
|
||
* 1、读取Http状态
|
||
* 2、读取头信息
|
||
* 3、持有Http流，并不关闭流
|
||
* </pre>
|
||
*
|
||
* @return this
|
||
* @throws HttpException IO异常
|
||
*/
|
||
private HttpResponse init() throws HttpException {
|
||
// 获取响应状态码
|
||
try {
|
||
this.status = httpConnection.responseCode();
|
||
} catch (IOException e) {
|
||
if (false == (e instanceof FileNotFoundException)) {
|
||
throw new HttpException(e);
|
||
}
|
||
// 服务器无返回内容，忽略之
|
||
}
|
||
|
||
|
||
// 读取响应头信息
|
||
try {
|
||
this.headers = httpConnection.headers();
|
||
} catch (IllegalArgumentException e) {
|
||
// ignore
|
||
// StaticLog.warn(e, e.getMessage());
|
||
}
|
||
|
||
// 存储服务端设置的Cookie信息
|
||
GlobalCookieManager.store(httpConnection);
|
||
|
||
// 获取响应编码
|
||
final Charset charset = httpConnection.getCharset();
|
||
this.charsetFromResponse = charset;
|
||
if (null != charset) {
|
||
this.charset = charset;
|
||
}
|
||
|
||
// 获取响应内容流
|
||
this.in = new HttpInputStream(this);
|
||
|
||
// 同步情况下强制同步
|
||
return this.isAsync ? this : forceSync();
|
||
}
|
||
|
||
/**
|
||
* 读取主体，忽略EOFException异常
|
||
*
|
||
* @param in 输入流
|
||
* @throws IORuntimeException IO异常
|
||
*/
|
||
private void readBody(InputStream in) throws IORuntimeException {
|
||
if (ignoreBody) {
|
||
return;
|
||
}
|
||
|
||
int contentLength = Convert.toInt(header(Header.CONTENT_LENGTH), 0);
|
||
final FastByteArrayOutputStream out = contentLength > 0 ? new FastByteArrayOutputStream(contentLength) : new FastByteArrayOutputStream();
|
||
try {
|
||
IoUtil.copy(in, out);
|
||
} catch (IORuntimeException e) {
|
||
//noinspection StatementWithEmptyBody
|
||
if (e.getCause() instanceof EOFException || StrUtil.containsIgnoreCase(e.getMessage(), "Premature EOF")) {
|
||
// 忽略读取HTTP流中的EOF错误
|
||
} else {
|
||
throw e;
|
||
}
|
||
}
|
||
this.bodyBytes = out.toByteArray();
|
||
}
|
||
|
||
/**
|
||
* 强制同步，用于初始化<br>
|
||
* 强制同步后变化如下：
|
||
*
|
||
* <pre>
|
||
* 1、读取body内容到内存
|
||
* 2、异步状态设为false（变为同步状态）
|
||
* 3、关闭Http流
|
||
* 4、断开与服务器连接
|
||
* </pre>
|
||
*
|
||
* @return this
|
||
*/
|
||
private HttpResponse forceSync() {
|
||
// 非同步状态转为同步状态
|
||
try {
|
||
this.readBody(this.in);
|
||
} catch (IORuntimeException e) {
|
||
//noinspection StatementWithEmptyBody
|
||
if (e.getCause() instanceof FileNotFoundException) {
|
||
// 服务器无返回内容，忽略之
|
||
} else {
|
||
throw new HttpException(e);
|
||
}
|
||
} finally {
|
||
if (this.isAsync) {
|
||
this.isAsync = false;
|
||
}
|
||
this.close();
|
||
}
|
||
return this;
|
||
}
|
||
|
||
/**
|
||
* 从Content-Disposition头中获取文件名
|
||
*
|
||
* @return 文件名，empty表示无
|
||
*/
|
||
private String getFileNameFromDisposition() {
|
||
String fileName = null;
|
||
final String disposition = header(Header.CONTENT_DISPOSITION);
|
||
if (StrUtil.isNotBlank(disposition)) {
|
||
fileName = ReUtil.get("filename=\"(.*?)\"", disposition, 1);
|
||
if (StrUtil.isBlank(fileName)) {
|
||
fileName = StrUtil.subAfter(disposition, "filename=", true);
|
||
}
|
||
}
|
||
return fileName;
|
||
}
|
||
|
||
// ---------------------------------------------------------------- Private method end
|
||
}
|