SpringBoot中使用单例模式+ScheduledExecutorService实现异步多线程任务(若依源码学习)

场景

若依前后端分离版手把手教你本地搭建环境并运行项目：

若依前后端分离版手把手教你本地搭建环境并运行项目_本地运行若依前后端分离-CSDN博客

设计模式-单例模式-饿汉式单例模式、懒汉式单例模式、静态内部类在Java中的使用示例：

设计模式-单例模式-饿汉式单例模式、懒汉式单例模式、静态内部类在Java中的使用示例_静态类 java 饿汉-CSDN博客

Java中创建线程的方式以及线程池创建的方式、推荐使用ThreadPoolExecutor以及示例：

Java中创建线程的方式以及线程池创建的方式、推荐使用ThreadPoolExecutor以及示例_threadpoolexecutor创建线程-CSDN博客

结合以上，学习并模仿若依登录接口中异步记录登录日志的操作。

在若依登录的SysLoginService中login登录方式有异步记录登录日志的操作。

其中核心代码为：

 AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_SUCCESS, MessageUtils.message("user.login.success")));

代码位置

注：

博客：
霸道流氓气质-CSDN博客

实现

1、先看下若依自己本身的实现

AsyncManager异步任务管理器实现


/**
 * 异步任务管理器
 *
 *
 */
public class AsyncManager {
    private static AsyncManager me = new AsyncManager();
    /**
     * 操作延迟10毫秒
     */
    private final int OPERATE_DELAY_TIME = 10;
    /**
     * 异步操作任务调度线程池
     */
    private ScheduledExecutorService executor = SpringUtils.getBean("scheduledExecutorService");

    /**
     * 单例模式
     */
    private AsyncManager() {
    }

    public static AsyncManager me() {
        return me;
    }

    /**
     * 执行任务
     *
     * @param task 任务
     */
    public void execute(TimerTask task) {
        executor.schedule(task, OPERATE_DELAY_TIME, TimeUnit.MILLISECONDS);
    }

    /**
     * 停止任务线程池
     */
    public void shutdown() {
        Threads.shutdownAndAwaitTermination(executor);
    }
}

syncManager.me()获取一个AsyncManager对象。

执行execute方法，执行任务，传入的是一个task对象，实现了Runnable接口，是一个任务，由线程Thread去执行。

用到了单例模式，具体可参考上面。

task对象通过异步工厂类创建

public class AsyncFactory {
    private static final Logger sys_user_logger = LoggerFactory.getLogger("sys-user");

    /**
     * 记录登录信息
     *
     * @param username 用户名
     * @param status   状态
     * @param message  消息
     * @param args     列表
     * @return 任务task
     */
    public static TimerTask recordLogininfor(final String username, final String status, final String message,
                                             final Object... args) {
        final UserAgent userAgent = UserAgent.parseUserAgentString(ServletUtils.getRequest().getHeader("User-Agent"));
        final String ip = IpUtils.getIpAddr(ServletUtils.getRequest());
        return new TimerTask() {
            @Override
            public void run() {
                String address = AddressUtils.getRealAddressByIP(ip);
                StringBuilder s = new StringBuilder();
                s.append(LogUtils.getBlock(ip));
                s.append(address);
                s.append(LogUtils.getBlock(username));
                s.append(LogUtils.getBlock(status));
                s.append(LogUtils.getBlock(message));
                // 打印信息到日志
                sys_user_logger.info(s.toString(), args);
                // 获取客户端操作系统
                String os = userAgent.getOperatingSystem().getName();
                // 获取客户端浏览器
                String browser = userAgent.getBrowser().getName();
                // 封装对象
                SysLogininfor logininfor = new SysLogininfor();
                logininfor.setUserName(username);
                logininfor.setIpaddr(ip);
                logininfor.setLoginLocation(address);
                logininfor.setBrowser(browser);
                logininfor.setOs(os);
                logininfor.setMsg(message);
                // 日志状态
                if (StringUtils.equalsAny(status, Constants.LOGIN_SUCCESS, Constants.LOGOUT, Constants.REGISTER)) {
                    logininfor.setStatus(Constants.SUCCESS);
                } else if (Constants.LOGIN_FAIL.equals(status)) {
                    logininfor.setStatus(Constants.FAIL);
                }
                // 插入数据
                SpringUtils.getBean(ISysLogininforService.class).insertLogininfor(logininfor);
            }
        };
    }

    /**
     * 操作日志记录
     *
     * @param operLog 操作日志信息
     * @return 任务task
     */
    public static TimerTask recordOper(final SysOperLog operLog) {
        return new TimerTask() {
            @Override
            public void run() {
                // 远程查询操作地点
                operLog.setOperLocation(AddressUtils.getRealAddressByIP(operLog.getOperIp()));
                SpringUtils.getBean(ISysOperLogService.class).insertOperlog(operLog);
            }
        };
    }
}

2、下面模仿上面的实现方式，去除掉无用的业务代码，对流程进行简化。

新建全局异步任务管理器

import com.ruoyi.common.utils.Threads;
import com.ruoyi.common.utils.spring.SpringUtils;
import java.util.TimerTask;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;

/**
 * 全局异步任务管理器
 */
public class GlobalAsyncManager {

    //单例
    private static final GlobalAsyncManager instance = new GlobalAsyncManager();

    //延迟执行时间
    private final int OPERATOR_DELAY_TIME = 10;

    private ScheduledExecutorService executorService = SpringUtils.getBean("scheduledExecutorService");

    private GlobalAsyncManager(){

    }

    public static GlobalAsyncManager getInstance(){
        return  instance;
    }

    //执行任务
    public void executorTask(TimerTask task){
        executorService.schedule(task,OPERATOR_DELAY_TIME, TimeUnit.MILLISECONDS);
    }

    //停止任务线程池
    public void shutdown(){
        Threads.shutdownAndAwaitTermination(executorService);
    }
}

这里创建ScheduledExecutorService是使用的若依封装的spring工具类

停止任务线程池也是用的若依的线程相关工具类

新建异步工厂，产生任务用

import com.ruoyi.common.utils.spring.SpringUtils;
import com.ruoyi.system.domain.BusStudent;
import com.ruoyi.system.service.IBusStudentService;
import java.util.TimerTask;

/**
 * 异步工厂，产生任务用
 */
public class AsyncTaskFactory {
    public static TimerTask recordLogToData(String logText){
        return new TimerTask() {
            @Override
            public void run() {
                BusStudent busStudent = new BusStudent();
                busStudent.setAddress(logText);
                SpringUtils.getBean(IBusStudentService.class).insertBusStudent(busStudent);
            }
        };
    }
}

这里模拟插入日志到数据库中，数据库的表这里随便找了一个表。

调用示例

    @Test
    public void recordLog() throws InterruptedException {
        Thread.sleep(1000);
        GlobalAsyncManager.getInstance().executorTask(AsyncTaskFactory.recordLogToData(LocalDateTime.now()+"日志内容"));
        Thread.sleep(3000);
        System.out.println(LocalDateTime.now());
    }

为了验证其是异步效果，这里模拟线程休眠并记录时间