com.feilong.core.lang.ThreadUtil Maven / Gradle / Ivy
Show all versions of feilong Show documentation
/*
* Copyright (C) 2008 feilong
*
* 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 com.feilong.core.lang;
import static com.feilong.core.bean.ConvertUtil.toLong;
import static com.feilong.core.date.DateUtil.formatDuration;
import static com.feilong.core.date.DateUtil.now;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Callable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.feilong.core.TimeInterval;
import com.feilong.core.Validate;
import com.feilong.core.lang.thread.DefaultPartitionRunnableBuilder;
import com.feilong.core.lang.thread.DefaultPartitionThreadExecutor;
import com.feilong.core.lang.thread.PartitionEachSizeThreadConfigBuilder;
import com.feilong.core.lang.thread.PartitionPerHandler;
import com.feilong.core.lang.thread.PartitionRunnableBuilder;
import com.feilong.core.lang.thread.PartitionThreadConfig;
/**
* 线程相关工具类.
*
* 关于 {@link ThreadGroup}
*
*
*
* 线程组表示一个线程的集合。
*
*
*
* 此外,线程组也可以包含其他线程组。线程组构成一棵树,
* 在树中,除了初始线程组外,每个线程组都有一个父线程组。
* 允许线程访问有关自己的线程组的信息,但是不允许它访问有关其线程组的父线程组或其他任何线程组的信息。
*
*
*
* 所有线程都隶属于一个线程组。那可以是一个默认线程组,亦可是一个创建线程时明确指定的组。
*
*
*
* 在创建之初,线程被限制到一个组里,而且不能改变到一个不同的组。每个应用都至少有一个线程从属于系统线程组。
* 若创建多个线程而不指定一个组,它们就会自动归属于系统线程组。
* 线程组也必须从属于其他线程组。
* 必须在构建器里指定新线程组从属于哪个线程组。
*
* 若在创建一个线程组的时候没有指定它的归属,则同样会自动成为系统线程组的一名属下。
*
*
*
* 因此,一个应用程序中的所有线程组最终都会将系统线程组作为自己的“父”
* 之所以要提出“线程组”的概念,一般认为,是由于“安全”或者“保密”方面的理由。
* 根据Arnold和Gosling的说法：“线程组中的线程可以修改组内的其他线程,包括那些位于分层结构最深处的。一个线程不能修改位于自己所在组或者下属组之外的任何线程”
*
*
*
* {@link Callable}和{@link Runnable}的区别如下:
*
*
* - {@link Callable} since jdk1.5,而{@link Runnable} since jdk1.0.
* - {@link Callable}定义的方法是{@link Callable#call()},而{@link Runnable}定义的方法是{@link Runnable#run()}.
* - {@link Callable}的{@link Callable#call()}方法有返回值,而{@link Runnable}的{@link Runnable#run()}方法没有返回值
* - {@link Callable}的{@link Callable#call()}方法可抛出异常,而{@link Runnable}的{@link Runnable#run()}方法不能抛出异常
*
*
*
*
* @author feilong
* @see "org.springframework.core.task.SimpleAsyncTaskExecutor"
* @see "org.springframework.core.task.SyncTaskExecutor"
* @see "org.springframework.core.task.TaskExecutor"
* @see java.util.concurrent.ThreadFactory
* @since 1.10.3
*/
public final class ThreadUtil{
/** The Constant LOGGER. */
private static final Logger LOGGER = LoggerFactory.getLogger(ThreadUtil.class);
//---------------------------------------------------------------
/** Don't let anyone instantiate this class. */
private ThreadUtil(){
//AssertionError不是必须的. 但它可以避免不小心在类的内部调用构造器. 保证该类在任何情况下都不会被实例化.
//see 《Effective Java》 2nd
throw new AssertionError("No " + getClass().getName() + " instances for you!");
}
//---------------------------------------------------------------
/**
* 强制当前正在执行的线程 休眠(暂停执行) milliseconds 毫秒.
*
*
* 该方法简便的地方在于,捕获了异常和记录了日志,不需要再写这些额外代码
*
*
* 说明:
*
*
*
* - The thread does not lose ownership of any monitors.
* - 当线程睡眠时,它睡在某个地方,在苏醒之前不会返回到可运行状态,
* 当睡眠时间到期,则返回到可运行状态。sleep()方法不能保证该线程睡眠到期后就开始执行
* - sleep()是静态方法,只能控制当前正在运行的线程
* - sonarqube不建议在单元测试中使用 sleep, 参见 "Thread.sleep" should not be used in tests squid:S2925
*
*
*
*
* 示例:
*
*
*
*
*
* public void testNegative1(){
* ThreadUtil.sleep(com.feilong.core.TimeInterval.MILLISECOND_PER_SECONDS * 10);
* }
*
*
*
*
*
* sleep()和wait()方法的最大区别:
*
*
* sleep()睡眠时,保持对象锁,仍然占有该锁；
* 而wait()睡眠时,释放对象锁。
*
*
*
* @param milliseconds
* 睡眠的毫秒数,建议使用 {@link TimeInterval} 常量
* @throws IllegalArgumentException
* 如果 milliseconds 参数是负数
* @see "Thread.sleep" should not be used in tests
* @see 新建 ThreadUtil.sleep int 参数方法 ,避免sonar 扫描问题
* @see java.util.concurrent.TimeUnit#sleep(long) TimeUnit.SECONDS.sleep(3);
* @see java.lang.Thread#sleep(long)
* @since 3.0.5
*/
public static final void sleep(int milliseconds){
sleep(toLong(milliseconds));
}
/**
* 强制当前正在执行的线程 休眠(暂停执行) milliseconds 毫秒.
*
*
* 该方法简便的地方在于,捕获了异常和记录了日志,不需要再写这些额外代码
*
*
* 说明:
*
*
*
* - The thread does not lose ownership of any monitors.
* - 当线程睡眠时,它睡在某个地方,在苏醒之前不会返回到可运行状态,
* 当睡眠时间到期,则返回到可运行状态。sleep()方法不能保证该线程睡眠到期后就开始执行
* - sleep()是静态方法,只能控制当前正在运行的线程
* - sonarqube不建议在单元测试中使用 sleep, 参见 "Thread.sleep" should not be used in tests squid:S2925
*
*
*
*
* 示例:
*
*
*
*
*
* public void testNegative1(){
* ThreadUtil.sleep(com.feilong.core.TimeInterval.MILLISECOND_PER_SECONDS * 10);
* }
*
*
*
*
*
* sleep()和wait()方法的最大区别:
*
*
* sleep()睡眠时,保持对象锁,仍然占有该锁；
* 而wait()睡眠时,释放对象锁。
*
*
*
* @param milliseconds
* 睡眠的毫秒数,建议使用 {@link TimeInterval} 常量
* @throws IllegalArgumentException
* 如果 milliseconds 参数是负数
* @see "Thread.sleep" should not be used in tests
* @see java.util.concurrent.TimeUnit#sleep(long) TimeUnit.SECONDS.sleep(3);
* @see java.lang.Thread#sleep(long)
* @since 1.10.7
*/
public static final void sleep(long milliseconds){
try{
Thread.sleep(milliseconds);
}catch (InterruptedException e){
//if any thread has interrupted the current thread.
//The interrupted status of the current thread is cleared when this exception is thrown.
LOGGER.error("", e);
//see sonar http://127.0.0.1:9000/coding_rules#rule_key=squid%3AS2142
//线程的thread.interrupt()方法是中断线程,将会设置该线程的中断状态位,即设置为true,中断的结果线程是死亡、还是等待新的任务或是继续运行至下一步,就取决于这个程序本身。线程会不时地检测这个中断标示位,以判断线程是否应该被中断（中断标示值是否为true）。它并不像stop方法那样会中断一个正在运行的线程。
Thread.currentThread().interrupt();
}
}
//---------------------------------------------------------------
/**
* 创建指定数量 threadCount 的线程,并执行.
*
* 示例:
*
*
*
* 多线程调用某个 API 20 次
*
*
*
* ThreadUtil.execute(new Runnable(){
*
* public void run(){
* String uri = "http://127.0.0.1:8084?name=jinxin{@code &}age=18";
* LOGGER.debug(HttpClientUtil.get(uri, toMap("country", "china")));
* }
* }, 20);
*
*
*
*
*
*
* 如果 runnable 是null,抛出 {@link NullPointerException}
* 如果 {@code threadCount <=0},抛出 {@link IllegalArgumentException}
*
*
* @param runnable
* the runnable
* @param threadCount
* 线程数量
* @since 1.10.4
*/
public static void execute(Runnable runnable,int threadCount){
Validate.notNull(runnable, "runnable can't be null!");
Validate.isTrue(threadCount > 0, "threadCount must > 0");
//---------------------------------------------------------------
Date beginDate = now();
Thread[] threads = buildThreadArray(runnable, threadCount);
ThreadUtil.startAndJoin(threads);
//---------------------------------------------------------------
if (LOGGER.isInfoEnabled()){
LOGGER.info("runnable:[{}],threadCount:[{}],total use time:{}", runnable, threadCount, formatDuration(beginDate));
}
}
/**
* Builds the thread array.
*
* @param runnable
* the runnable
* @param threadCount
* the thread count
* @return the thread[]
*/
private static Thread[] buildThreadArray(Runnable runnable,int threadCount){
Thread[] threads = new Thread[threadCount];
for (int i = 0; i < threadCount; ++i){
threads[i] = new Thread(runnable);
}
return threads;
}
//---------------------------------------------------------------
/**
* 给定一个待解析的 list,设定每个线程执行多少条 eachSize,使用自定义的
* partitionRunnableBuilder,自动构造多条线程并运行.
*
* 适用场景:
*
*
*
* 比如同步库存,一次从MQ或者其他接口中得到了5000条数据,如果使用单线程做5000次循环,势必会比较慢,并且影响性能; 如果调用这个方法,传入eachSize=100, 那么自动会开启5000/100=50 个线程来跑功能,大大提高同步库存的速度
*
*
* 其他的适用场景还有诸如同步商品主档数据,同步订单等等这类每个独立对象之间没有相关联关系的数据,能提高执行速度和效率
*
*
*
*
* 重构:
*
*
*
* 对于以下代码:模拟10个对象/数字,循环执行任务(可能是操作数据库等)
*
*
*
*
* public void testExecuteTest() throws InterruptedException{
* Date beginDate = now();
*
* List{@code } list = toList(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);
* for (Integer integer : list){
* //------
*
* //模拟 do something
*
* //---------
* Thread.sleep(1 * MILLISECOND_PER_SECONDS);
* }
* LOGGER.info("use time: [{}]", formatDuration(beginDate));
* }
*
*
*
*
* 统计总耗时时间 需要 use time:10秒28毫秒
*
*
* 此时你可以调用此方法,改成多线程执行:
*
*
*
* public void testExecuteTestUsePartitionRunnableBuilder() throws InterruptedException{
* Date beginDate = now();
* List{@code } list = toList(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);
*
* //每个线程执行2条数据, 没有自定义 paramsMap
*
* //将会自动创建 list.size()/2 =5个 线程执行
*
* //每个线程执行的,将会是 PartitionRunnableBuilder build 返回的 Runnable
* ThreadUtil.execute(list, 1, new PartitionRunnableBuilder{@code }(){
*
* @Override
* public Runnable build(final List{@code } perBatchList,PartitionThreadEntity partitionThreadEntity,Map{@code } paramsMap){
*
* return new Runnable(){
*
* @Override
* public void run(){
* for (Integer integer : perBatchList){
* //------
*
* //模拟 do something
*
* //---------
* try{
* Thread.sleep(1 * MILLISECOND_PER_SECONDS);
* }catch (InterruptedException e){
* LOGGER.error("", e);
* }
* }
* }
* };
* }
*
* });
*
* LOGGER.info("use time: [{}]", formatDuration(beginDate));
* }
*
*
*
* 统计总耗时时间 需要 use time:2秒36毫秒
*
*
*
* 对于上述的case,如果将 eachSize 参数由2 改成1, 统计总耗时时间 需要 use time:1秒36毫秒
*
*
*
* 可见 调用该方法,使用多线程能节省执行时间,提高效率; 但是也需要酌情考虑eachSize大小,合理的开启线程数量
*
*
*
* 说明:
*
* 线程是稀缺资源,如果无限制的创建,不仅会消耗系统资源,还会降低系统的稳定性;
* 需要注意合理的评估list 的大小和eachSize 比率;
* 不建议list size很大,比如 20W,而eachSize值很小,比如2 ,那么会开启20W/2=10W个线程;此时建议考虑 线程池的实现方案
*
*
* 异常:
*
*
* 如果 list 是null,抛出 {@link NullPointerException}
* 如果 list 是empty,抛出 {@link IllegalArgumentException}
* 如果 {@code eachSize <=0} ,抛出 {@link IllegalArgumentException}
* 如果 partitionRunnableBuilder 是null,抛出 {@link NullPointerException}
*
*
*
* @param
* the generic type
* @param list
* 执行解析的list
*
*
* 比如 100000个 User,不能为null或者empty
*
* @param eachSize
* 每个线程执行多少个对象
*
*
* 比如 一个线程解析 1000个 User, 那么程序内部 会自动创建 100000/1000个 线程去解析;
* 必须{@code >}0
*
* @param partitionRunnableBuilder
* 每个线程做的事情,不能为null
*
* @see com.feilong.core.lang.thread.DefaultPartitionThreadExecutor
* @see com.feilong.core.lang.thread.DefaultPartitionThreadExecutor#INSTANCE
* @since 1.11.0
*/
public static void execute(List list,int eachSize,PartitionRunnableBuilder partitionRunnableBuilder){
execute(list, eachSize, null, partitionRunnableBuilder);
}
/**
* 给定一个待解析的 list,设定每个线程执行多少条 eachSize,使用自定义的
* partitionRunnableBuilder,自动构造多条线程并运行.
*
*
* 主要是用来简化 {@link #execute(List, int, PartitionRunnableBuilder)} 调用
*
*
* 重构:
*
*
*
* 对于以下代码:
*
*
*
*
* ThreadUtil.execute(list, 5, new PartitionRunnableBuilder{@code }(){
*
* @Override
* public Runnable build(final List{@code } perBatchList,PartitionThreadEntity partitionThreadEntity,Map{@code } paramsMap){
*
* return new Runnable(){
*
* @Override
* public void run(){
* map.putAll(handle(perBatchList, noList));
* }
* };
* }
* });
*
*
*
* 可以重构成:
*
*
* ThreadUtil.execute(list, 5, new PartitionPerHandler{@code }(){
*
* @Override
* public void handle(List{@code } perBatchList,PartitionThreadEntity partitionThreadEntity,Map{@code } paramsMap){
* map.putAll(CopyrightTest.this.handle(perBatchList, noList));
* }
* });
*
*
* 上述事例,可以从 14 行代码, 精简到 7 行代码
*
*
*
*
* 适用场景:
*
*
*
* 比如同步库存,一次从MQ或者其他接口中得到了5000条数据,如果使用单线程做5000次循环,势必会比较慢,并且影响性能; 如果调用这个方法,传入eachSize=100, 那么自动会开启5000/100=50 个线程来跑功能,大大提高同步库存的速度
*
*
* 其他的适用场景还有诸如同步商品主档数据,同步订单等等这类每个独立对象之间没有相关联关系的数据,能提高执行速度和效率
*
*
*
*
*
* 说明:
*
* 线程是稀缺资源,如果无限制的创建,不仅会消耗系统资源,还会降低系统的稳定性;
* 需要注意合理的评估list 的大小和eachSize 比率;
* 不建议list size很大,比如 20W,而eachSize值很小,比如2 ,那么会开启20W/2=10W个线程;此时建议考虑 线程池的实现方案
*
*
* 异常:
*
*
* 如果 list 是null,抛出 {@link NullPointerException}
* 如果 list 是empty,抛出 {@link IllegalArgumentException}
* 如果 {@code eachSize <=0} ,抛出 {@link IllegalArgumentException}
* 如果 partitionPerHandler 是null,抛出 {@link NullPointerException}
*
*
*
* @param
* the generic type
* @param list
* 执行解析的list
*
*
* 比如 100000个 User,不能为null或者empty
*
* @param eachSize
* 每个线程执行多少个对象
*
*
* 比如 一个线程解析 1000个 User, 那么程序内部 会自动创建 100000/1000个 线程去解析;
* 必须{@code >}0
*
* @param partitionPerHandler
* the partition per handler
* @see com.feilong.core.lang.thread.DefaultPartitionThreadExecutor
* @see com.feilong.core.lang.thread.DefaultPartitionThreadExecutor#INSTANCE
* @since 2.0.0
*/
public static void execute(List list,int eachSize,PartitionPerHandler partitionPerHandler){
execute(list, eachSize, null, partitionPerHandler);
}
//---------------------------------------------------------------
/**
* 给定一个待解析的 list,设定每个线程执行多少条 eachSize,传入一些额外的参数 paramsMap,使用自定义的
* partitionRunnableBuilder,自动构造多条线程并运行.
*
* 适用场景:
*
*
*
* 比如同步库存,一次从MQ或者其他接口中得到了5000条数据,如果使用单线程做5000次循环,势必会比较慢,并且影响性能; 如果调用这个方法,传入eachSize=100, 那么自动会开启5000/100=50 个线程来跑功能,大大提高同步库存的速度
*
*
* 其他的适用场景还有诸如同步商品主档数据,同步订单等等这类每个独立对象之间没有相关联关系的数据,能提高执行速度和效率
*
*
*
*
* 重构:
*
*
*
* 对于以下代码:模拟10个对象/数字,循环执行任务(可能是操作数据库等)
*
*
*
*
* public void testExecuteTest() throws InterruptedException{
* Date beginDate = now();
*
* List{@code } list = toList(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);
* for (Integer integer : list){
* //------
*
* //模拟 do something
*
* //---------
* Thread.sleep(1 * MILLISECOND_PER_SECONDS);
* }
* LOGGER.info("use time: [{}]", formatDuration(beginDate));
* }
*
*
*
*
* 统计总耗时时间 需要 use time:10秒28毫秒
*
*
* 此时你可以调用此方法,改成多线程执行:
*
*
*
* public void testExecuteTestUsePartitionRunnableBuilder() throws InterruptedException{
* Date beginDate = now();
* List{@code } list = toList(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);
*
* //每个线程执行2条数据, 没有自定义 paramsMap
*
* //将会自动创建 list.size()/2 =5个 线程执行
*
* //每个线程执行的,将会是 PartitionRunnableBuilder build 返回的 Runnable
* ThreadUtil.execute(list, 1, null, new PartitionRunnableBuilder{@code }(){
*
* @Override
* public Runnable build(final List{@code } perBatchList,PartitionThreadEntity partitionThreadEntity,Map{@code } paramsMap){
*
* return new Runnable(){
*
* @Override
* public void run(){
* for (Integer integer : perBatchList){
* //------
*
* //模拟 do something
*
* //---------
* try{
* Thread.sleep(1 * MILLISECOND_PER_SECONDS);
* }catch (InterruptedException e){
* LOGGER.error("", e);
* }
* }
* }
* };
* }
*
* });
*
* LOGGER.info("use time: [{}]", formatDuration(beginDate));
* }
*
*
*
* 统计总耗时时间 需要 use time:2秒36毫秒
*
*
*
* 对于上述的case,如果将 eachSize 参数由2 改成1, 统计总耗时时间 需要 use time:1秒36毫秒
*
*
*
* 可见 调用该方法,使用多线程能节省执行时间,提高效率; 但是也需要酌情考虑eachSize大小,合理的开启线程数量
*
*
*
* 说明:
*
* 线程是稀缺资源,如果无限制的创建,不仅会消耗系统资源,还会降低系统的稳定性;
* 需要注意合理的评估list 的大小和eachSize 比率;
* 不建议list size很大,比如 20W,而eachSize值很小,比如2 ,那么会开启20W/2=10W个线程;此时建议考虑 线程池的实现方案
*
*
* 对于参数 paramsMap 的使用:
*
*
*
* 比如你需要拿到最终每条数据执行的结果,以便后续进行处理(比如对失败的操作再次执行或者发送汇报邮件等)
*
*
*
*
* public void testExecuteTestUsePartitionRunnableBuilderParamsMap() throws InterruptedException{
* Date beginDate = now();
* List{@code } list = toList(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);
*
* final Map{@code } indexAndResultMap = Collections.synchronizedSortedMap(new TreeMap{@code }());
*
* ThreadUtil.execute(list, 2, null, new PartitionRunnableBuilder{@code }(){
*
* @Override
* public Runnable build(
* final List{@code } perBatchList,
* final PartitionThreadEntity partitionThreadEntity,
* Map{@code } paramsMap){
*
* return new Runnable(){
*
* @Override
* public void run(){
*
* int i = 0;
* for (Integer integer : perBatchList){
* //------
*
* //模拟 do something
*
* //---------
* try{
* Thread.sleep(1 * MILLISECOND_PER_SECONDS);
* }catch (InterruptedException e){
* LOGGER.error("", e);
* }
*
* int indexInTotalList = getIndex(partitionThreadEntity, i);
*
* //模拟 当值是 5 或者8 的时候 操作结果是false
* boolean result = (integer == 5 || integer == 8) ? false : true;
*
* indexAndResultMap.put(indexInTotalList, result);
*
* i++;
* }
* }
*
* private Integer getIndex(PartitionThreadEntity partitionThreadEntity,int i){
* int batchNumber = partitionThreadEntity.getBatchNumber();
* return batchNumber * partitionThreadEntity.getEachSize() + i;
* }
* };
* }
*
* });
*
* LOGGER.debug(JsonUtil.format(indexAndResultMap));
*
* LOGGER.info("use time: [{}]", formatDuration(beginDate));
* }
*
*
*
*
* 输出结果:
*
*
*
29:21 DEBUG (ThreadUtilExample.java:161) [testExecuteTestUsePartitionRunnableBuilderParamsMap()] {
"0": true,
"1": true,
"2": true,
"3": true,
"4": true,
"5": false,
"6": true,
"7": true,
"8": false,
"9": true
}
29:21 INFO (ThreadUtilExample.java:164) [testExecuteTestUsePartitionRunnableBuilderParamsMap()] use time:2秒181毫秒
*
*
*
*
*
* 异常:
*
*
* 如果 list 是null,抛出 {@link NullPointerException}
* 如果 list 是empty,抛出 {@link IllegalArgumentException}
* 如果 {@code eachSize <=0} ,抛出 {@link IllegalArgumentException}
* 如果 partitionRunnableBuilder 是null,抛出 {@link NullPointerException}
*
*
*
* @param
* the generic type
* @param list
* 执行解析的list
*
*
* 比如 100000个 User,不能为null或者empty
*
* @param eachSize
* 每个线程执行多少个对象
*
*
* 比如 一个线程解析 1000个 User, 那么程序内部 会自动创建 100000/1000个 线程去解析;
* 必须{@code >}0
*
* @param paramsMap
* 自定义的相关参数
*
*
* 该参数目的是你可以在自定义的 partitionRunnableBuilder中使用;
* 如果你传入的partitionRunnableBuilder中不需要额外的自定义参数,那么此处可以传入null
*
* @param partitionRunnableBuilder
* 每个线程做的事情,不能为null
*
* @see com.feilong.core.lang.thread.DefaultPartitionThreadExecutor
* @see com.feilong.core.lang.thread.DefaultPartitionThreadExecutor#INSTANCE
*/
public static void execute(List list,int eachSize,Map paramsMap,PartitionRunnableBuilder partitionRunnableBuilder){
DefaultPartitionThreadExecutor.INSTANCE.execute(list, eachSize, paramsMap, partitionRunnableBuilder);
}
/**
* 给定一个待解析的 list,设定每个线程执行多少条 eachSize,传入一些额外的参数 paramsMap,使用自定义的
* partitionPerHandler,自动构造多条线程并运行.
*
* 主要是用来简化 {@link #execute(List, int, Map, PartitionRunnableBuilder)} 调用
*
*
* 重构:
*
*
*
* 对于以下代码:
*
*
*
*
* ThreadUtil.execute(list, 5, new PartitionRunnableBuilder{@code }(){
*
* @Override
* public Runnable build(final List{@code } perBatchList,PartitionThreadEntity partitionThreadEntity,Map{@code } paramsMap){
*
* return new Runnable(){
*
* @Override
* public void run(){
* map.putAll(handle(perBatchList, noList));
* }
* };
* }
* });
*
*
*
* 可以重构成:
*
*
* ThreadUtil.execute(list, 5, new PartitionPerHandler{@code }(){
*
* @Override
* public void handle(List{@code } perBatchList,PartitionThreadEntity partitionThreadEntity,Map{@code } paramsMap){
* map.putAll(CopyrightTest.this.handle(perBatchList, noList));
* }
* });
*
*
* 上述事例,可以从 14 行代码, 精简到 7 行代码
*
*
*
* 适用场景:
*
*
*
* 比如同步库存,一次从MQ或者其他接口中得到了5000条数据,如果使用单线程做5000次循环,势必会比较慢,并且影响性能; 如果调用这个方法,传入eachSize=100, 那么自动会开启5000/100=50 个线程来跑功能,大大提高同步库存的速度
*
*
* 其他的适用场景还有诸如同步商品主档数据,同步订单等等这类每个独立对象之间没有相关联关系的数据,能提高执行速度和效率
*
*
*
*
* 统计总耗时时间 需要 use time:2秒36毫秒
*
*
*
* 对于上述的case,如果将 eachSize 参数由2 改成1, 统计总耗时时间 需要 use time:1秒36毫秒
*
*
*
* 可见 调用该方法,使用多线程能节省执行时间,提高效率; 但是也需要酌情考虑eachSize大小,合理的开启线程数量
*
*
* 说明:
*
* 线程是稀缺资源,如果无限制的创建,不仅会消耗系统资源,还会降低系统的稳定性;
* 需要注意合理的评估list 的大小和eachSize 比率;
* 不建议list size很大,比如 20W,而eachSize值很小,比如2 ,那么会开启20W/2=10W个线程;此时建议考虑 线程池的实现方案
*
*
* 异常:
*
*
* 如果 list 是null,抛出 {@link NullPointerException}
* 如果 list 是empty,抛出 {@link IllegalArgumentException}
* 如果 {@code eachSize <=0} ,抛出 {@link IllegalArgumentException}
* 如果 partitionPerHandler 是null,抛出 {@link NullPointerException}
*
*
*
* @param
* the generic type
* @param list
* 执行解析的list
*
*
* 比如 100000个 User,不能为null或者empty
*
* @param eachSize
* 每个线程执行多少个对象
*
*
* 比如 一个线程解析 1000个 User, 那么程序内部 会自动创建 100000/1000个 线程去解析;
* 必须{@code >}0
*
* @param paramsMap
* 自定义的相关参数
*
*
* 该参数目的是你可以在自定义的 partitionRunnableBuilder中使用;
* 如果你传入的partitionRunnableBuilder中不需要额外的自定义参数,那么此处可以传入null
*
* @param partitionPerHandler
* the partition per handler
* @see com.feilong.core.lang.thread.DefaultPartitionThreadExecutor
* @see com.feilong.core.lang.thread.DefaultPartitionThreadExecutor#INSTANCE
* @since 2.0.0
*/
public static void execute(List list,int eachSize,Map paramsMap,PartitionPerHandler partitionPerHandler){
Validate.notNull(partitionPerHandler, "partitionPerHandler can't be null!");
execute(list, eachSize, paramsMap, new DefaultPartitionRunnableBuilder(partitionPerHandler));
}
//---------------------------------------------------------------
/**
* 给定一个待解析的 list,设定每个线程执行多少条 eachSize,传入一些额外的参数 paramsMap,使用自定义的
* partitionPerHandler,自动构造多条线程并运行.
*
* 适用场景:
*
*
*
* 比如同步库存,一次从MQ或者其他接口中得到了5000条数据,如果使用单线程做5000次循环,势必会比较慢,并且影响性能; 如果调用这个方法,传入eachSize=100, 那么自动会开启5000/100=50 个线程来跑功能,大大提高同步库存的速度
*
*
* 其他的适用场景还有诸如同步商品主档数据,同步订单等等这类每个独立对象之间没有相关联关系的数据,能提高执行速度和效率
*
*
*
*
* 重构:
*
*
*
* 对于以下代码:模拟10个对象/数字,循环执行任务(可能是操作数据库等)
*
*
*
*
* public void testExecuteTest() throws InterruptedException{
* Date beginDate = now();
*
* List{@code } list = toList(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);
* for (Integer integer : list){
* //------
*
* //模拟 do something
*
* //---------
* Thread.sleep(1 * MILLISECOND_PER_SECONDS);
* }
* LOGGER.info("use time: [{}]", formatDuration(beginDate));
* }
*
*
*
*
* 统计总耗时时间 需要 use time:10秒28毫秒
*
*
* 此时你可以调用此方法,改成多线程执行:
*
*
*
* public void testExecuteTestUsePartitionRunnableBuilder() throws InterruptedException{
* Date beginDate = now();
* List{@code } list = toList(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);
*
* //每个线程执行2条数据, 没有自定义 paramsMap
*
* //将会自动创建 list.size()/2 =5个 线程执行
*
* //每个线程执行的,将会是 PartitionRunnableBuilder build 返回的 Runnable
* ThreadUtil.execute(list, 1, null, new PartitionPerHandler{@code }(){
*
* @Override
* public void handle(final List{@code } perBatchList,PartitionThreadEntity partitionThreadEntity,Map{@code } paramsMap){
*
* for (Integer integer : perBatchList){
* //------
*
* //模拟 do something
*
* //---------
* try{
* Thread.sleep(1 * MILLISECOND_PER_SECONDS);
* }catch (InterruptedException e){
* LOGGER.error("", e);
* }
* }
* }
*
* });
*
* LOGGER.info("use time: [{}]", formatDuration(beginDate));
* }
*
*
*
* 统计总耗时时间 需要 use time:2秒36毫秒
*
*
*
* 对于上述的case,如果将 eachSize 参数由2 改成1, 统计总耗时时间 需要 use time:1秒36毫秒
*
*
*
* 可见 调用该方法,使用多线程能节省执行时间,提高效率; 但是也需要酌情考虑eachSize大小,合理的开启线程数量
*
*
*
* 说明:
*
* 线程是稀缺资源,如果无限制的创建,不仅会消耗系统资源,还会降低系统的稳定性;
* 需要注意合理的评估list 的大小和eachSize 比率;
* 不建议list size很大,比如 20W,而eachSize值很小,比如2 ,那么会开启20W/2=10W个线程;此时建议考虑 线程池的实现方案
*
*
* 对于参数 paramsMap 的使用:
*
*
*
* 比如你需要拿到最终每条数据执行的结果,以便后续进行处理(比如对失败的操作再次执行或者发送汇报邮件等)
*
*
*
*
* public void testExecuteTestUsePartitionRunnableBuilderParamsMap() throws InterruptedException{
* Date beginDate = now();
* List{@code } list = toList(0, 1, 2, 3, 4, 5, 6, 7, 8, 9);
*
* final Map{@code } indexAndResultMap = Collections.synchronizedSortedMap(new TreeMap{@code }());
*
* ThreadUtil.execute(list, 2, null, new PartitionRunnableBuilder{@code }(){
*
* @Override
* public Runnable build(
* final List{@code } perBatchList,
* final PartitionThreadEntity partitionThreadEntity,
* Map{@code } paramsMap){
*
* return new Runnable(){
*
* @Override
* public void run(){
*
* int i = 0;
* for (Integer integer : perBatchList){
* //------
*
* //模拟 do something
*
* //---------
* try{
* Thread.sleep(1 * MILLISECOND_PER_SECONDS);
* }catch (InterruptedException e){
* LOGGER.error("", e);
* }
*
* int indexInTotalList = getIndex(partitionThreadEntity, i);
*
* //模拟 当值是 5 或者8 的时候 操作结果是false
* boolean result = (integer == 5 || integer == 8) ? false : true;
*
* indexAndResultMap.put(indexInTotalList, result);
*
* i++;
* }
* }
*
* private Integer getIndex(PartitionThreadEntity partitionThreadEntity,int i){
* int batchNumber = partitionThreadEntity.getBatchNumber();
* return batchNumber * partitionThreadEntity.getEachSize() + i;
* }
* };
* }
*
* });
*
* LOGGER.debug(JsonUtil.format(indexAndResultMap));
*
* LOGGER.info("use time: [{}]", formatDuration(beginDate));
* }
*
*
*
*
* 输出结果:
*
*
*
* 29:21 DEBUG (ThreadUtilExample.java:161) [testExecuteTestUsePartitionRunnableBuilderParamsMap()] {
* "0": true,
* "1": true,
* "2": true,
* "3": true,
* "4": true,
* "5": false,
* "6": true,
* "7": true,
* "8": false,
* "9": true
* }
* 29:21 INFO (ThreadUtilExample.java:164) [testExecuteTestUsePartitionRunnableBuilderParamsMap()] use time:2秒181毫秒
*
*
*
*
*
* 异常:
*
*
* 如果 list 是null,抛出 {@link NullPointerException}
* 如果 list 是empty,抛出 {@link IllegalArgumentException}
* 如果 partitionThreadConfig 是null,抛出 {@link NullPointerException}
* 如果 partitionPerHandler 是null,抛出 {@link NullPointerException}
*
*
*
* @param
* the generic type
* @param list
* 执行解析的list
*
*
* 比如 100000个 User,不能为null或者empty
*
* @param partitionThreadConfig
* the partition config
* @param paramsMap
* 自定义的相关参数
*
*
* 该参数目的是你可以在自定义的 partitionRunnableBuilder中使用;
* 如果你传入的partitionRunnableBuilder中不需要额外的自定义参数,那么此处可以传入null
*
* @param partitionPerHandler
* the partition per handler
* @see com.feilong.core.lang.thread.DefaultPartitionThreadExecutor#INSTANCE
* @since 2.0.0
*/
public static void execute(
List list,
PartitionThreadConfig partitionThreadConfig,
Map paramsMap,
PartitionPerHandler partitionPerHandler){
Validate.notEmpty(list, "list can't be null/empty!");
Validate.notNull(partitionThreadConfig, "partitionConfig can't be null!");
Validate.notNull(partitionPerHandler, "partitionPerHandler can't be null!");
//---------------------------------------------------------------
int eachSize = new PartitionEachSizeThreadConfigBuilder(partitionThreadConfig).build(list.size());
execute(list, eachSize, paramsMap, new DefaultPartitionRunnableBuilder(partitionPerHandler));
}
//---------------------------------------------------------------
/**
* 循环 threads 调用 {@link java.lang.Thread#start()} 再循环 threads 调用 {@link java.lang.Thread#join()}.
*
*
* threads are run concurrently and this method waits for them to finish.
*
*
*
* 如果 threads 是null,抛出 {@link NullPointerException}
* 如果 threads 是empty,抛出 {@link IllegalArgumentException}
*
*
* @param threads
* the threads
* @see "java.lang.ApplicationShutdownHooks#runHooks()"
*/
public static void startAndJoin(Thread[] threads){
Validate.notEmpty(threads, "threads can't be null/empty!");
//---------------------------------------------------------------
for (Thread thread : threads){
thread.start();// 使该线程开始执行；Java 虚拟机调用该线程的 run 方法。
LOGGER.debug("thread [{}] start", thread.getName());
}
//---------------------------------------------------------------
try{
for (Thread thread : threads){
LOGGER.debug("begin thread [{}] join", thread.getName());
thread.join(); //在一个线程中调用 otherThread.join(),将等待 otherThread 执行完后才继续本线程
LOGGER.debug("end thread [{}] join", thread.getName());
}
}catch (InterruptedException e){
LOGGER.error("", e);
// clean up state...
Thread.currentThread().interrupt();
}
}
}