org.aoju.bus.http.plugin.httpv.Downloads Maven / Gradle / Ivy
The newest version!
/*********************************************************************************
* *
* The MIT License (MIT) *
* *
* Copyright (c) 2015-2022 aoju.org and other contributors. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a copy *
* of this software and associated documentation files (the "Software"), to deal *
* in the Software without restriction, including without limitation the rights *
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *
* copies of the Software, and to permit persons to whom the Software is *
* furnished to do so, subject to the following conditions: *
* *
* The above copyright notice and this permission notice shall be included in *
* all copies or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN *
* THE SOFTWARE. *
* *
********************************************************************************/
package org.aoju.bus.http.plugin.httpv;
import org.aoju.bus.core.exception.InternalException;
import org.aoju.bus.core.toolkit.IoKit;
import org.aoju.bus.http.Callback;
import java.io.*;
/**
* 文件下载
*
* @author Kimi Liu
* @since Java 17+
*/
public class Downloads {
private final Object lock = new Object();
protected boolean nextOnIO = false;
private File file;
private InputStream input;
private Callback onSuccess;
private Callback onFailure;
private CoverTasks.Executor executor;
private long doneBytes;
private int buffSize = 0;
private long seekBytes = 0;
private boolean appended;
private volatile int status;
private boolean sOnIO;
private boolean fOnIO;
private Control control;
public Downloads(File file, InputStream input, CoverTasks.Executor executor, long skipBytes) {
this.file = file;
this.input = input;
this.executor = executor;
this.seekBytes = skipBytes;
this.control = new Control();
}
/**
* 设置缓冲区大小，默认 2K（2048）
*
* @param buffSize 缓冲区大小（单位：字节）
* @return Download
*/
public Downloads setBuffSize(int buffSize) {
if (buffSize > 0) {
this.buffSize = buffSize;
}
return this;
}
/**
* 设置文件追加模式
* 用预断点续传和分块下载
*
* @return Download
*/
public Downloads setAppended() {
this.appended = true;
return this;
}
/**
* 设置文件指针，从文件的 seekBytes 位置追加内容
*
* @param seekBytes 跨越的字节数
* @return Download
*/
public Downloads setFilePointer(long seekBytes) {
this.seekBytes = seekBytes;
return this;
}
/**
* 在IO线程执行
*
* @return Download
*/
public Downloads nextOnIO() {
nextOnIO = true;
return this;
}
/**
* 设置下载成功回调
*
* @param onSuccess 成功回调函数
* @return Download
*/
public Downloads setOnSuccess(Callback onSuccess) {
this.onSuccess = onSuccess;
sOnIO = nextOnIO;
nextOnIO = false;
return this;
}
/**
* 设置下载失败回调
*
* @param onFailure 失败回调函数
* @return Download
*/
public Downloads setOnFailure(Callback onFailure) {
this.onFailure = onFailure;
fOnIO = nextOnIO;
nextOnIO = false;
return this;
}
/**
* 开始下载
*
* @return 下载控制器
*/
public Control start() {
if (buffSize == 0) {
buffSize = Progress.DEFAULT_STEP_BYTES;
}
RandomAccessFile raFile = randomAccessFile();
status = Control.STATUS__DOWNLOADING;
executor.execute(() -> {
doDownload(raFile);
}, true);
return control;
}
/**
* 获取下载控制器
*
* @return Ctrl
*/
public Control getCtrl() {
return control;
}
private RandomAccessFile randomAccessFile() {
try {
return new RandomAccessFile(file, "rw");
} catch (FileNotFoundException e) {
status = Control.STATUS__ERROR;
IoKit.close(input);
throw new InternalException("Can't get file [" + file.getAbsolutePath() + "] Input stream", e);
}
}
private void doDownload(RandomAccessFile raFile) {
try {
if (appended && seekBytes > 0) {
long length = raFile.length();
if (seekBytes <= length) {
raFile.seek(seekBytes);
doneBytes = seekBytes;
} else {
raFile.seek(length);
doneBytes = length;
}
}
while (status != Control.STATUS__CANCELED && status != Control.STATUS__DONE) {
if (status == Control.STATUS__DOWNLOADING) {
byte[] buff = new byte[buffSize];
int len = -1;
while ((len = input.read(buff)) != -1) {
raFile.write(buff, 0, len);
doneBytes += len;
if (status == Control.STATUS__CANCELED
|| status == Control.STATUS__PAUSED) {
break;
}
}
if (len == -1) {
synchronized (lock) {
status = Control.STATUS__DONE;
}
}
}
}
} catch (IOException e) {
synchronized (lock) {
status = Control.STATUS__ERROR;
}
if (null != onFailure) {
executor.execute(() -> {
onFailure.on(new Failure(e));
}, fOnIO);
} else {
throw new InternalException("Streaming failed!", e);
}
} finally {
IoKit.close(raFile);
IoKit.close(input);
if (status == Control.STATUS__CANCELED) {
file.delete();
}
}
if (status == Control.STATUS__DONE
&& null != onSuccess) {
executor.execute(() -> onSuccess.on(file), sOnIO);
}
}
/**
* 下载监听接口
*
* @author Kimi Liu
* @since Java 17+
*/
public static interface Listener {
/**
* 全局下载监听
*
* @param http 所属的 CoverHttp
* @param downloads 下载事件
*/
void listen(CoverHttp http, Downloads downloads);
}
public class Control {
/**
* 已取消
*/
public static final int STATUS__CANCELED = -1;
/**
* 下载中
*/
public static final int STATUS__DOWNLOADING = 1;
/**
* 已暂停
*/
public static final int STATUS__PAUSED = 2;
/**
* 已完成
*/
public static final int STATUS__DONE = 3;
/**
* 错误
*/
public static final int STATUS__ERROR = 4;
/**
* @return 下载状态
* @see #STATUS__CANCELED
* @see #STATUS__DOWNLOADING
* @see #STATUS__PAUSED
* @see #STATUS__DONE
*/
public int status() {
return status;
}
/**
* 暂停下载任务
*/
public void pause() {
synchronized (lock) {
if (status == STATUS__DOWNLOADING) {
status = STATUS__PAUSED;
}
}
}
/**
* 继续下载任务
*/
public void resume() {
synchronized (lock) {
if (status == STATUS__PAUSED) {
status = STATUS__DOWNLOADING;
}
}
}
/**
* 取消下载任务
*/
public void cancel() {
synchronized (lock) {
if (status == STATUS__PAUSED || status == STATUS__DOWNLOADING) {
status = STATUS__CANCELED;
}
}
}
}
public class Failure {
private IOException exception;
Failure(IOException exception) {
this.exception = exception;
}
/**
* @return 下载文件
*/
public File getFile() {
return file;
}
/**
* @return 已下载字节数
*/
public long getDoneBytes() {
return doneBytes;
}
/**
* @return 异常信息
*/
public IOException getException() {
return exception;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy