執行緒池相關工具類
阿新 • • 發佈：2019-01-21
import android.support.annotation.IntDef;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
public final class ThreadPoolUtils {
public static final int FixedThread = 0;
public static final int CachedThread = 1;
public static final int SingleThread = 2;
@IntDef({FixedThread, CachedThread, SingleThread})
@Retention(RetentionPolicy.SOURCE)
public @interface Type {
}
private ExecutorService exec;
private ScheduledExecutorService scheduleExec;
private ThreadPoolUtils() {
throw new UnsupportedOperationException("u can't instantiate me...");
}
/**
* ThreadPoolUtils建構函式
*
* @param type 執行緒池型別
* @param corePoolSize 只對Fixed和Scheduled執行緒池起效
*/
public ThreadPoolUtils(@Type int type, int corePoolSize) {
// 構造有定時功能的執行緒池
// ThreadPoolExecutor(corePoolSize, Integer.MAX_VALUE, 10L, TimeUnit.MILLISECONDS, new BlockingQueue<Runnable>)
scheduleExec = Executors.newScheduledThreadPool(corePoolSize);
switch (type) {
case FixedThread:
// 構造一個固定執行緒數目的執行緒池
// ThreadPoolExecutor(corePoolSize, corePoolSize, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>());
exec = Executors.newFixedThreadPool(corePoolSize);
break;
case SingleThread:
// 構造一個只支援一個執行緒的執行緒池,相當於newFixedThreadPool(1)
// ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>())
exec = Executors.newSingleThreadExecutor();
break;
case CachedThread:
// 構造一個緩衝功能的執行緒池
// ThreadPoolExecutor(0, Integer.MAX_VALUE, 60L, TimeUnit.SECONDS, new SynchronousQueue<Runnable>());
exec = Executors.newCachedThreadPool();
break;
}
}
/**
* 在未來某個時間執行給定的命令
* <p>該命令可能在新的執行緒、已入池的執行緒或者正呼叫的執行緒中執行，這由 Executor 實現決定。</p>
*
* @param command 命令
*/
public void execute(Runnable command) {
exec.execute(command);
}
/**
* 在未來某個時間執行給定的命令連結串列
* <p>該命令可能在新的執行緒、已入池的執行緒或者正呼叫的執行緒中執行，這由 Executor 實現決定。</p>
*
* @param commands 命令連結串列
*/
public void execute(List<Runnable> commands) {
for (Runnable command : commands) {
exec.execute(command);
}
}
/**
* 待以前提交的任務執行完畢後關閉執行緒池
* <p>啟動一次順序關閉，執行以前提交的任務，但不接受新任務。
* 如果已經關閉，則呼叫沒有作用。</p>
*/
public void shutDown() {
exec.shutdown();
}
/**
* 試圖停止所有正在執行的活動任務
* <p>試圖停止所有正在執行的活動任務，暫停處理正在等待的任務，並返回等待執行的任務列表。</p>
* <p>無法保證能夠停止正在處理的活動執行任務，但是會盡力嘗試。</p>
*
* @return 等待執行的任務的列表
*/
public List<Runnable> shutDownNow() {
return exec.shutdownNow();
}
/**
* 判斷執行緒池是否已關閉
*
* @return {@code true}: 是<br>{@code false}: 否
*/
public boolean isShutDown() {
return exec.isShutdown();
}
/**
* 關閉執行緒池後判斷所有任務是否都已完成
* <p>注意，除非首先呼叫 shutdown 或 shutdownNow，否則 isTerminated 永不為 true。</p>
*
* @return {@code true}: 是<br>{@code false}: 否
*/
public boolean isTerminated() {
return exec.isTerminated();
}
/**
* 請求關閉、發生超時或者當前執行緒中斷
* <p>無論哪一個首先發生之後，都將導致阻塞，直到所有任務完成執行。</p>
*
* @param timeout 最長等待時間
* @param unit 時間單位
* @return {@code true}: 請求成功<br>{@code false}: 請求超時
* @throws InterruptedException 終端異常
*/
public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException {
return exec.awaitTermination(timeout, unit);
}
/**
* 提交一個Callable任務用於執行
* <p>如果想立即阻塞任務的等待，則可以使用{@code result = exec.submit(aCallable).get();}形式的構造。</p>
*
* @param task 任務
* @param <T> 泛型
* @return 表示任務等待完成的Future, 該Future的{@code get}方法在成功完成時將會返回該任務的結果。
*/
public <T> Future<T> submit(Callable<T> task) {
return exec.submit(task);
}
/**
* 提交一個Runnable任務用於執行
*
* @param task 任務
* @param result 返回的結果
* @param <T> 泛型
* @return 表示任務等待完成的Future, 該Future的{@code get}方法在成功完成時將會返回該任務的結果。
*/
public <T> Future<T> submit(Runnable task, T result) {
return exec.submit(task, result);
}
/**
* 提交一個Runnable任務用於執行
*
* @param task 任務
* @return 表示任務等待完成的Future, 該Future的{@code get}方法在成功完成時將會返回null結果。
*/
public Future<?> submit(Runnable task) {
return exec.submit(task);
}
/**
* 執行給定的任務
* <p>當所有任務完成時，返回保持任務狀態和結果的Future列表。
* 返回列表的所有元素的{@link Future#isDone}為{@code true}。
* 注意，可以正常地或通過丟擲異常來終止已完成任務。
* 如果正在進行此操作時修改了給定的 collection，則此方法的結果是不確定的。</p>
*
* @param tasks 任務集合
* @param <T> 泛型
* @return 表示任務的 Future 列表，列表順序與給定任務列表的迭代器所生成的順序相同，每個任務都已完成。
* @throws InterruptedException 如果等待時發生中斷，在這種情況下取消尚未完成的任務。
*/
public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) throws InterruptedException {
return exec.invokeAll(tasks);
}
/**
* 執行給定的任務
* <p>當所有任務完成或超時期滿時(無論哪個首先發生)，返回保持任務狀態和結果的Future列表。
* 返回列表的所有元素的{@link Future#isDone}為{@code true}。
* 一旦返回後，即取消尚未完成的任務。
* 注意，可以正常地或通過丟擲異常來終止已完成任務。
* 如果此操作正在進行時修改了給定的 collection，則此方法的結果是不確定的。</p>
*
* @param tasks 任務集合
* @param timeout 最長等待時間
* @param unit 時間單位
* @param <T> 泛型
* @return 表示任務的 Future 列表，列表順序與給定任務列表的迭代器所生成的順序相同。如果操作未超時，則已完成所有任務。如果確實超時了，則某些任務尚未完成。
* @throws InterruptedException 如果等待時發生中斷，在這種情況下取消尚未完成的任務
*/
public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws
InterruptedException {
return exec.invokeAll(tasks, timeout, unit);
}
/**
* 執行給定的任務
* <p>如果某個任務已成功完成（也就是未丟擲異常），則返回其結果。
* 一旦正常或異常返回後，則取消尚未完成的任務。
* 如果此操作正在進行時修改了給定的collection，則此方法的結果是不確定的。</p>
*
* @param tasks 任務集合
* @param <T> 泛型
* @return 某個任務返回的結果
* @throws InterruptedException 如果等待時發生中斷
* @throws ExecutionException 如果沒有任務成功完成
*/
public <T> T invokeAny(Collection<? extends Callable<T>> tasks) throws InterruptedException, ExecutionException {
return exec.invokeAny(tasks);
}
/**
* 執行給定的任務
* <p>如果在給定的超時期滿前某個任務已成功完成（也就是未丟擲異常），則返回其結果。
* 一旦正常或異常返回後，則取消尚未完成的任務。
* 如果此操作正在進行時修改了給定的collection，則此方法的結果是不確定的。</p>
*
* @param tasks 任務集合
* @param timeout 最長等待時間
* @param unit 時間單位
* @param <T> 泛型
* @return 某個任務返回的結果
* @throws InterruptedException 如果等待時發生中斷
* @throws ExecutionException 如果沒有任務成功完成
* @throws TimeoutException 如果在所有任務成功完成之前給定的超時期滿
*/
public <T> T invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws
InterruptedException, ExecutionException, TimeoutException {
return exec.invokeAny(tasks, timeout, unit);
}
/**
* 延遲執行Runnable命令
*
* @param command 命令
* @param delay 延遲時間
* @param unit 單位
* @return 表示掛起任務完成的ScheduledFuture，並且其{@code get()}方法在完成後將返回{@code null}
*/
public ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit) {
return scheduleExec.schedule(command, delay, unit);
}
/**
* 延遲執行Callable命令
*
* @param callable 命令
* @param delay 延遲時間
* @param unit 時間單位
* @param <V> 泛型
* @return 可用於提取結果或取消的ScheduledFuture
*/
public <V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit) {
return scheduleExec.schedule(callable, delay, unit);
}
/**
* 延遲並迴圈執行命令
*
* @param command 命令
* @param initialDelay 首次執行的延遲時間
* @param period 連續執行之間的週期
* @param unit 時間單位
* @return 表示掛起任務完成的ScheduledFuture，並且其{@code get()}方法在取消後將丟擲異常
*/
public ScheduledFuture<?> scheduleWithFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit) {
return scheduleExec.scheduleAtFixedRate(command, initialDelay, period, unit);
}
/**
* 延遲並以固定休息時間迴圈執行命令
*
* @param command 命令
* @param initialDelay 首次執行的延遲時間
* @param delay 每一次執行終止和下一次執行開始之間的延遲
* @param unit 時間單位
* @return 表示掛起任務完成的ScheduledFuture，並且其{@code get()}方法在取消後將丟擲異常
*/
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit) {
return scheduleExec.scheduleWithFixedDelay(command, initialDelay, delay, unit);
}
}
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
public final class ThreadPoolUtils {
public static final int FixedThread = 0;
public static final int CachedThread = 1;
public static final int SingleThread = 2;
@IntDef({FixedThread, CachedThread, SingleThread})
@Retention(RetentionPolicy.SOURCE)
public @interface Type {
}
private ExecutorService exec;
private ScheduledExecutorService scheduleExec;
private ThreadPoolUtils() {
throw new UnsupportedOperationException("u can't instantiate me...");
}
/**
* ThreadPoolUtils建構函式
*
* @param type 執行緒池型別
* @param corePoolSize 只對Fixed和Scheduled執行緒池起效
*/
public ThreadPoolUtils(@Type int type, int corePoolSize) {
// 構造有定時功能的執行緒池
// ThreadPoolExecutor(corePoolSize, Integer.MAX_VALUE, 10L, TimeUnit.MILLISECONDS, new BlockingQueue<Runnable>)
scheduleExec = Executors.newScheduledThreadPool(corePoolSize);
switch (type) {
case FixedThread:
// 構造一個固定執行緒數目的執行緒池
// ThreadPoolExecutor(corePoolSize, corePoolSize, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>());
exec = Executors.newFixedThreadPool(corePoolSize);
break;
case SingleThread:
// 構造一個只支援一個執行緒的執行緒池,相當於newFixedThreadPool(1)
// ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>())
exec = Executors.newSingleThreadExecutor();
break;
case CachedThread:
// 構造一個緩衝功能的執行緒池
// ThreadPoolExecutor(0, Integer.MAX_VALUE, 60L, TimeUnit.SECONDS, new SynchronousQueue<Runnable>());
exec = Executors.newCachedThreadPool();
break;
}
}
/**
* 在未來某個時間執行給定的命令
* <p>該命令可能在新的執行緒、已入池的執行緒或者正呼叫的執行緒中執行，這由 Executor 實現決定。</p>
*
* @param command 命令
*/
public void execute(Runnable command) {
exec.execute(command);
}
/**
* 在未來某個時間執行給定的命令連結串列
* <p>該命令可能在新的執行緒、已入池的執行緒或者正呼叫的執行緒中執行，這由 Executor 實現決定。</p>
*
* @param commands 命令連結串列
*/
public void execute(List<Runnable> commands) {
for (Runnable command : commands) {
exec.execute(command);
}
}
/**
* 待以前提交的任務執行完畢後關閉執行緒池
* <p>啟動一次順序關閉，執行以前提交的任務，但不接受新任務。
* 如果已經關閉，則呼叫沒有作用。</p>
*/
public void shutDown() {
exec.shutdown();
}
/**
* 試圖停止所有正在執行的活動任務
* <p>試圖停止所有正在執行的活動任務，暫停處理正在等待的任務，並返回等待執行的任務列表。</p>
* <p>無法保證能夠停止正在處理的活動執行任務，但是會盡力嘗試。</p>
*
* @return 等待執行的任務的列表
*/
public List<Runnable> shutDownNow() {
return exec.shutdownNow();
}
/**
* 判斷執行緒池是否已關閉
*
* @return {@code true}: 是<br>{@code false}: 否
*/
public boolean isShutDown() {
return exec.isShutdown();
}
/**
* 關閉執行緒池後判斷所有任務是否都已完成
* <p>注意，除非首先呼叫 shutdown 或 shutdownNow，否則 isTerminated 永不為 true。</p>
*
* @return {@code true}: 是<br>{@code false}: 否
*/
public boolean isTerminated() {
return exec.isTerminated();
}
/**
* 請求關閉、發生超時或者當前執行緒中斷
* <p>無論哪一個首先發生之後，都將導致阻塞，直到所有任務完成執行。</p>
*
* @param timeout 最長等待時間
* @param unit 時間單位
* @return {@code true}: 請求成功<br>{@code false}: 請求超時
* @throws InterruptedException 終端異常
*/
public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException {
return exec.awaitTermination(timeout, unit);
}
/**
* 提交一個Callable任務用於執行
* <p>如果想立即阻塞任務的等待，則可以使用{@code result = exec.submit(aCallable).get();}形式的構造。</p>
*
* @param task 任務
* @param <T> 泛型
* @return 表示任務等待完成的Future, 該Future的{@code get}方法在成功完成時將會返回該任務的結果。
*/
public <T> Future<T> submit(Callable<T> task) {
return exec.submit(task);
}
/**
* 提交一個Runnable任務用於執行
*
* @param task 任務
* @param result 返回的結果
* @param <T> 泛型
* @return 表示任務等待完成的Future, 該Future的{@code get}方法在成功完成時將會返回該任務的結果。
*/
public <T> Future<T> submit(Runnable task, T result) {
return exec.submit(task, result);
}
/**
* 提交一個Runnable任務用於執行
*
* @param task 任務
* @return 表示任務等待完成的Future, 該Future的{@code get}方法在成功完成時將會返回null結果。
*/
public Future<?> submit(Runnable task) {
return exec.submit(task);
}
/**
* 執行給定的任務
* <p>當所有任務完成時，返回保持任務狀態和結果的Future列表。
* 返回列表的所有元素的{@link Future#isDone}為{@code true}。
* 注意，可以正常地或通過丟擲異常來終止已完成任務。
* 如果正在進行此操作時修改了給定的 collection，則此方法的結果是不確定的。</p>
*
* @param tasks 任務集合
* @param <T> 泛型
* @return 表示任務的 Future 列表，列表順序與給定任務列表的迭代器所生成的順序相同，每個任務都已完成。
* @throws InterruptedException 如果等待時發生中斷，在這種情況下取消尚未完成的任務。
*/
public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) throws InterruptedException {
return exec.invokeAll(tasks);
}
/**
* 執行給定的任務
* <p>當所有任務完成或超時期滿時(無論哪個首先發生)，返回保持任務狀態和結果的Future列表。
* 返回列表的所有元素的{@link Future#isDone}為{@code true}。
* 一旦返回後，即取消尚未完成的任務。
* 注意，可以正常地或通過丟擲異常來終止已完成任務。
* 如果此操作正在進行時修改了給定的 collection，則此方法的結果是不確定的。</p>
*
* @param tasks 任務集合
* @param timeout 最長等待時間
* @param unit 時間單位
* @param <T> 泛型
* @return 表示任務的 Future 列表，列表順序與給定任務列表的迭代器所生成的順序相同。如果操作未超時，則已完成所有任務。如果確實超時了，則某些任務尚未完成。
* @throws InterruptedException 如果等待時發生中斷，在這種情況下取消尚未完成的任務
*/
public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws
InterruptedException {
return exec.invokeAll(tasks, timeout, unit);
}
/**
* 執行給定的任務
* <p>如果某個任務已成功完成（也就是未丟擲異常），則返回其結果。
* 一旦正常或異常返回後，則取消尚未完成的任務。
* 如果此操作正在進行時修改了給定的collection，則此方法的結果是不確定的。</p>
*
* @param tasks 任務集合
* @param <T> 泛型
* @return 某個任務返回的結果
* @throws InterruptedException 如果等待時發生中斷
* @throws ExecutionException 如果沒有任務成功完成
*/
public <T> T invokeAny(Collection<? extends Callable<T>> tasks) throws InterruptedException, ExecutionException {
return exec.invokeAny(tasks);
}
/**
* 執行給定的任務
* <p>如果在給定的超時期滿前某個任務已成功完成（也就是未丟擲異常），則返回其結果。
* 一旦正常或異常返回後，則取消尚未完成的任務。
* 如果此操作正在進行時修改了給定的collection，則此方法的結果是不確定的。</p>
*
* @param tasks 任務集合
* @param timeout 最長等待時間
* @param unit 時間單位
* @param <T> 泛型
* @return 某個任務返回的結果
* @throws InterruptedException 如果等待時發生中斷
* @throws ExecutionException 如果沒有任務成功完成
* @throws TimeoutException 如果在所有任務成功完成之前給定的超時期滿
*/
public <T> T invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws
InterruptedException, ExecutionException, TimeoutException {
return exec.invokeAny(tasks, timeout, unit);
}
/**
* 延遲執行Runnable命令
*
* @param command 命令
* @param delay 延遲時間
* @param unit 單位
* @return 表示掛起任務完成的ScheduledFuture，並且其{@code get()}方法在完成後將返回{@code null}
*/
public ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit) {
return scheduleExec.schedule(command, delay, unit);
}
/**
* 延遲執行Callable命令
*
* @param callable 命令
* @param delay 延遲時間
* @param unit 時間單位
* @param <V> 泛型
* @return 可用於提取結果或取消的ScheduledFuture
*/
public <V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit) {
return scheduleExec.schedule(callable, delay, unit);
}
/**
* 延遲並迴圈執行命令
*
* @param command 命令
* @param initialDelay 首次執行的延遲時間
* @param period 連續執行之間的週期
* @param unit 時間單位
* @return 表示掛起任務完成的ScheduledFuture，並且其{@code get()}方法在取消後將丟擲異常
*/
public ScheduledFuture<?> scheduleWithFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit) {
return scheduleExec.scheduleAtFixedRate(command, initialDelay, period, unit);
}
/**
* 延遲並以固定休息時間迴圈執行命令
*
* @param command 命令
* @param initialDelay 首次執行的延遲時間
* @param delay 每一次執行終止和下一次執行開始之間的延遲
* @param unit 時間單位
* @return 表示掛起任務完成的ScheduledFuture，並且其{@code get()}方法在取消後將丟擲異常
*/
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit) {
return scheduleExec.scheduleWithFixedDelay(command, initialDelay, delay, unit);
}
}