org.dromara.hutool.http.client

Class HttpDownloader

java.lang.Object

org.dromara.hutool.http.client.HttpDownloader

public class HttpDownloader
extends Object

HTTP下载器，两种使用方式：
1. 一次性使用：

 HttpDownloader.of(url).downloadFile(file)

2. 多次下载复用：

   HttpDownloader downloader = HttpDownloader.of(url).setCloseEngine(false);
   downloader.downloadFile(file);
   downloader.downloadFile(file2);
   downloader.close();
 

Since:

6.0.0

Author:

looly

Constructor Summary

Constructors

Constructor and Description
HttpDownloader(String url) 构造

Method Summary

Modifier and Type	Method and Description
long	download(OutputStream out, boolean isCloseOut) 下载文件
File	downloadFile(File targetFileOrDir) 下载文件
File	downloadFile(File targetFileOrDir, String tempFileSuffix) 下载文件
HttpDownloader	header(Map<String,String> headers) 设置请求头
HttpDownloader	header(String name, String value) 设置请求头，多个请求头则多次调用
static HttpDownloader	of(String url) 创建下载器
HttpDownloader	setCloseEngine(boolean closeEngine) 设置是否关闭引擎，默认为true，即自动关闭引擎
HttpDownloader	setConfig(ClientConfig config) 设置配置
HttpDownloader	setEngine(ClientEngine engine) 设置引擎，用于自定义引擎
HttpDownloader	setStreamProgress(StreamProgress streamProgress) 设置进度条
HttpDownloader	setTimeout(int milliseconds) 设置超时

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpDownloader

public HttpDownloader(String url)

构造

Parameters:

url - 请求地址

Method Detail

of

public static HttpDownloader of(String url)

创建下载器

Parameters:

url - 请求地址

Returns:

下载器

header

public HttpDownloader header(Map<String,String> headers)

设置请求头

Parameters:

headers - 请求头

Returns:

this

header

public HttpDownloader header(String name,
                             String value)

设置请求头，多个请求头则多次调用

Parameters:

name - 请求头名

value - 请求头值

Returns:

this

setConfig

public HttpDownloader setConfig(ClientConfig config)

设置配置

Parameters:

config - 配置

Returns:

this

setTimeout

public HttpDownloader setTimeout(int milliseconds)

设置超时

Parameters:

milliseconds - 超时毫秒数

Returns:

this

setEngine

public HttpDownloader setEngine(ClientEngine engine)

设置引擎，用于自定义引擎

Parameters:

engine - 引擎

Returns:

this

setStreamProgress

public HttpDownloader setStreamProgress(StreamProgress streamProgress)

设置进度条

Parameters:

streamProgress - 进度条

Returns:

this

setCloseEngine

public HttpDownloader setCloseEngine(boolean closeEngine)

设置是否关闭引擎，默认为true，即自动关闭引擎

Parameters:

closeEngine - 是否关闭引擎

Returns:

this

downloadFile

public File downloadFile(File targetFileOrDir)

下载文件

Parameters:

targetFileOrDir - 目标文件或目录，当为目录时，自动使用文件名作为下载文件名

Returns:

下载文件

downloadFile

public File downloadFile(File targetFileOrDir,
                         String tempFileSuffix)

下载文件

Parameters:

targetFileOrDir - 目标文件或目录，当为目录时，自动使用文件名作为下载文件名

tempFileSuffix - 临时文件后缀

Returns:

下载文件

download

public long download(OutputStream out,
                     boolean isCloseOut)

下载文件

Parameters:

out - 输出流

isCloseOut - 是否关闭输出流，true关闭

Returns:

下载的字节数