Springboot 构建异步TaskManager的优雅处理线程任务

1. 首先定义一个TaskManager管理类

import lombok.extern.slf4j.Slf4j;

import java.util.concurrent.BlockingQueue;
import java.util.concurrent.Executors;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;

@Slf4j
public class DataSyncTaskManager {
    private static DataSyncTaskManager taskManager = null;
    private static BlockingQueue<Runnable> taskQueue = new LinkedBlockingQueue<>();

    private ThreadPoolExecutor taskExecutorPool;

    private DataSyncTaskManager() {
        XXXConfig xxxConfig = SpringContextUtil.getBean(XXXConfig.class);
        this.taskExecutorPool = (ThreadPoolExecutor) Executors.newFixedThreadPool(xxxConfig .getDataSyncThreadNum());
    }

    /**
     * 构建唯一Manager对象单例
     *
     * @return
     */
    public static synchronized DataSyncTaskManager getManager() {
        if (null == taskManager) {
            taskManager = new DataSyncTaskManager();
        }
        return taskManager;
    }

    /**
     * 提交需要运行的任务
     * @param task
     */
    public void submitTask(DataSyncTask task) {
        taskQueue.add(task);
        log.info("[DataSyncTaskManager] submitTask size={}", taskQueue.size());
    }

    public void runTaskDaemon(){
        log.info("[DataSyncTaskManager] runTaskDaemon start");
        Thread thread = new Thread(() -> {
            while (true) {
                try {
                    Runnable task = taskQueue.take();
                    taskExecutorPool.submit(task);
                    log.info("[DataSyncTaskManager] runTaskDaemon submit task={}", task);
                    Thread.sleep(3000);
                } catch (Exception e) {
                    log.error("[startTaskRunningDaemon] task run error", e);
                }
            }
        });
        thread.start();
    }
}

2. 构建一个Task对象，作为线程池的运行实体，由Manager进行管理

import lombok.Data;
import lombok.extern.slf4j.Slf4j;

import java.io.PrintWriter;
import java.io.StringWriter;


@Data
@Slf4j
public class DataSyncTask implements Runnable{
    private String stuid;
    private String displayId;

    public DataSyncTask(String stuid, String displayId) {
        this.stuid = stuid;
        this.displayId = displayId;
    }

    /**
     * When an object implementing interface <code>Runnable</code> is used
     * to create a thread, starting the thread causes the object's
     * <code>run</code> method to be called in that separately executing
     * thread.
     * <p>
     * The general contract of the method <code>run</code> is that it may
     * take any action whatsoever.
     *
     * @see Thread#run()
     */
    @Override
    public void run() {
        log.info("[DataSyncTask] run task start, stuid={}, displayId={}", stuid, displayId);
        DataSyncComponent syncComponent = SpringContextUtil.getBean(DataSyncComponent.class);
        try {
            syncComponent.syncData(stuid, displayId);
        }catch (Exception e){
            log.error("[DataSyncTask] error", e);
        }

        log.info("[DataSyncTask] run task end, stuid={}, displayId={}", stuid, displayId);
    }

    public static String getStackTrace(Exception e){
        StringWriter stringWriter = new StringWriter();
        PrintWriter printWriter = new PrintWriter(stringWriter);
        e.printStackTrace(printWriter);
        printWriter.close();

        try {
            stringWriter.close();
        }catch (Exception e1){
            log.error("[getStackTrace] failed", e1);
        }

        return stringWriter.toString();
    }
}

3. 核心的业务处理对象

import javax.annotation.Resource;
import java.io.File;
import java.time.LocalDateTime;
import java.util.HashMap;
import java.util.Map;

@Slf4j
@Component
public class DataSyncComponent {
    @Resource
    XXXMapper xxxMapper;
    
    @Resource
    RedisUtils redisUtils;


    public void syncData(String stuid, String displayId){
        log.info("[do something]");
    }
}

4. 服务启动的时候，启动taskManager线程

@Slf4j
@Component
public class DataSyncRunner implements ApplicationRunner {

    /**
     * Callback used to run the bean.
     *
     * @param args incoming application arguments
     * @throws Exception on error
     */
    @Override
    public void run(ApplicationArguments args) throws Exception {
        //运行任务执行器
        DataSyncTaskManager dataSyncTaskManager = DataSyncTaskManager.getManager();
        dataSyncTaskManager.runTaskDaemon();
    }
}

5. 后续的业务只需要触发新增提交task即可自动执行异步任务

DataSyncTask dataSyncTask = new DataSyncTask(stuid, displayId);
DataSyncTaskManager.getManager().submitTask(dataSyncTask);

6. 其他：手动获取bean的对象类

@Component
public class SpringContextUtil implements ApplicationContextAware {
    private static ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringContextUtil.applicationContext = applicationContext;
    }

    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    public static <T> T getBean(Class<T> clazz) {
        return getApplicationContext().getBean(clazz);
    }

    public static <T> T getBean(String name, Class<T> clazz) {
        return getApplicationContext().getBean(name, clazz);
    }
}