借助ThreadPoolExecutor、Future实现线程池带返回值异步任务结果获取

一、概述

Future是java 1.5引入的一个interface，他代表的是异步执行的结果，意思是当异步执行结束之后，返回的结果将会保存在Future中。

ExecutorService 是线程池的接口，执行时需要接受一个Callable参数，Callable需要实现一个call方法，并返回结果。

二、实现过程

为了简化代码，我们这边以普通java工程单元测试代码来演示。

1. maven依赖

主要包含日志、单元测试、lombok、commons-lang3

		<dependency>
			<groupId>org.apache.logging.log4j</groupId>
			<artifactId>log4j-slf4j-impl</artifactId>
			<version>2.12.1</version>
		</dependency>
		<dependency>
			<groupId>org.apache.commons</groupId>
			<artifactId>commons-lang3</artifactId>
			<version>3.10</version>
		</dependency>
		<dependency>
			<groupId>org.junit.jupiter</groupId>
			<artifactId>junit-jupiter-api</artifactId>
			<version>5.5.2</version>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.18.12</version>
			<scope>provided</scope>
		</dependency>

2. 日志配置

log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="off" monitorInterval="0">
	<appenders>
		<console name="Console" target="system_out">
			<patternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p %pid --- [%t] %-30.30c{1.} : %m%n" />
		</console>
	</appenders>
	<loggers>
		<root level="INFO">
			<appender-ref ref="Console" />
		</root>
	</loggers>
</configuration>

3.单元测试代码

ThreadPoolTest

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.stream.LongStream;

import org.apache.commons.lang3.concurrent.BasicThreadFactory;
import org.apache.commons.lang3.time.StopWatch;
import org.junit.jupiter.api.Test;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class ThreadPoolTest
{
    /**
     * 线程池执行数据求和后汇总
     * 
     * @throws InterruptedException
     * @throws ExecutionException
     */
    @Test
    public void testSum()
        throws InterruptedException, ExecutionException
    {
        StopWatch clock = new StopWatch();
        clock.start();
        ThreadFactory namedThreadFactory = new BasicThreadFactory.Builder().namingPattern("sum-thread-%03d").daemon(true).priority(Thread.MAX_PRIORITY).build();
        ExecutorService pool = new ThreadPoolExecutor(10, 10, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<Runnable>(), namedThreadFactory);
        List<Callable<Long>> tasks = new ArrayList<>();
        Callable<Long> task;
        for (int i = 0; i < 10; i++)
        {
            Long start = 1000L * i;
            task = new Callable<Long>()
            {
                @Override
                public Long call()
                    throws InterruptedException
                {
                    long sum = LongStream.range(start, start + 1000L).sum(); // 求和
                    log.info("{} - {}, sum: {}", start, start + 1000L, sum);
                    TimeUnit.MILLISECONDS.sleep(100); // 模拟耗时操作
                    return sum;
                }
            };
            tasks.add(task);
        }
        List<Future<Long>> futures = pool.invokeAll(tasks);
        pool.shutdown();
        long sum = 0;
        for (Future<Long> future : futures)
        {
            long it = future.get();
            sum += it;
            log.info("add: {}, sum: {}", it, sum);
        }
        clock.stop();
        log.info("处理完成，返回数据 {}, 用时: {}ms", sum, clock.getTime());
    }
    
    @Test
    public void testSum2()
        throws InterruptedException
    {
        StopWatch clock = new StopWatch();
        clock.start();
        long sum = 0;
        for (int i = 0; i < 10; i++)
        {
            Long start = 1000L * i;
            for (long j = start; j < start + 1000L; j++)
            {
                sum += j;
            }
            TimeUnit.MILLISECONDS.sleep(100); // 模拟耗时操作
        }
        clock.stop();
        log.info("处理完成，返回数据 {}, 用时: {}ms", sum, clock.getTime());
    }
}

4. 运行结果

三、源码放送

1. 代码结构

2. 源码下载

https://gitcode.com/00fly/ThreadPool

git clone https://gitcode.com/00fly/ThreadPool.git

---

有任何问题和建议，都可以向我提问讨论,大家一起进步，谢谢!

-over-