SpringBoot中添加线程池

SpringBoot中添加线程池

线程池配置

添加线程池配置类

package com.wisdom.template.configurer.Thread;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;

import java.util.concurrent.Executor;
import java.util.concurrent.ThreadPoolExecutor;

/**
 * 线程池配置类
 * @version 1.0
 * @Description:
 * @Author: Tom
 * @Date: 2021/12/14 0014 14:25
 */
@Slf4j
@Configuration
@EnableAsync
public class ExecutorConfig {
       @Value("${async.executor.thread.core_pool_size}")
       private int corePoolSize;
       @Value("${async.executor.thread.max_pool_size}")
       private int maxPoolSize;
       @Value("${async.executor.thread.queue_capacity}")
       private int queueCapacity;
       @Value("${async.executor.thread.name-prefix}")
	   private String namePrefix;
    
       @Bean(name = "asyncServiceExecutor")
       public Executor asyncServiceExecutor() {
    
           log.info("start asyncServiceExecutor");
    
           ThreadPoolTaskExecutor executor = new VisiableThreadPoolTaskExecutor();
    
           //配置核心线程数
           executor.setCorePoolSize(corePoolSize);
           //配置最大线程数
           executor.setMaxPoolSize(maxPoolSize);
           //配置队列大小
           executor.setQueueCapacity(queueCapacity);
           //配置线程池中的线程的名称前缀
           executor.setThreadNamePrefix(namePrefix);
    
           // rejection-policy：当pool已经达到max size的时候，如何处理新任务
           // CALLER_RUNS：不在新线程中执行任务，而是有调用者所在的线程来执行
           executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
           //执行初始化
           executor.initialize();
           return executor;
       }

   }

添加线程池监控

如果不想使用线程监控，在上一个 ExecutorConfig类中使用 ThreadPoolTaskExecutor 初始化即可。

ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();

package com.wisdom.template.configurer.Thread;

import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.util.concurrent.ListenableFuture;

import java.util.concurrent.Callable;
import java.util.concurrent.Future;
import java.util.concurrent.ThreadPoolExecutor;

/**
 * @version 1.0
 * @Description: 进程监控类
 * @Author: Tom
 * @Date: 2021/12/14 0014 15:28
 */
@Slf4j
public class VisiableThreadPoolTaskExecutor extends ThreadPoolTaskExecutor {

    private void showThreadPoolInfo(String prefix) {
        ThreadPoolExecutor threadPoolExecutor = getThreadPoolExecutor();

        if (null == threadPoolExecutor) {
            return;
        }

        log.info("{}, {},taskCount [{}], completedTaskCount [{}], activeCount [{}], queueSize [{}]",
                this.getThreadNamePrefix(),
                prefix,
                threadPoolExecutor.getTaskCount(),
                threadPoolExecutor.getCompletedTaskCount(),
                threadPoolExecutor.getActiveCount(),
                threadPoolExecutor.getQueue().size());
    }

    @Override
    public void execute(Runnable task) {
        showThreadPoolInfo("1. do execute");
        super.execute(task);
    }

    @Override
    public void execute(Runnable task, long startTimeout) {
        showThreadPoolInfo("2. do execute");
        super.execute(task, startTimeout);
    }

    @Override
    public Future<?> submit(Runnable task) {
        showThreadPoolInfo("1. do submit");
        return super.submit(task);
    }

    @Override
    public <T> Future<T> submit(Callable<T> task) {
        showThreadPoolInfo("2. do submit");
        return super.submit(task);
    }

    @Override
    public ListenableFuture<?> submitListenable(Runnable task) {
        showThreadPoolInfo("1. do submitListenable");
        return super.submitListenable(task);
    }

    @Override
    public <T> ListenableFuture<T> submitListenable(Callable<T> task) {
        showThreadPoolInfo("2. do submitListenable");
        return super.submitListenable(task);
    }

}

线程池使用（示例: 发信接口）

创建Service接口类

package com.wisdom.template.basics.service;

import com.wisdom.template.pojo.vo.UserVO;

/**
 * @version 1.0
 * @Description:
 * @Author: Tom
 * @Date: 2021/12/14 0014 15:06
 */
public interface AsyncService {

    /**
     * @Description 执行消息发送异步任务
     * @param body 消息体
     * @param receivedBy 收件人id
     * @param receivedName 收件人姓名
     * @param operationType 业务类型
     * @param operationId 业务id
     * @param userVO 发信人，未明确发信人时传null
     * @date 2021/12/14 0014 2:52
     * @author Tom
     * @return boolean
     */
    void sendMessage(String body,String receivedBy,String receivedName,String operationType,String operationId, UserVO userVO);

}

接口实现

package com.wisdom.template.basics.service.impl;

import com.wisdom.template.basics.entity.Message;
import com.wisdom.template.basics.service.AsyncService;
import com.wisdom.template.basics.service.MessageService;
import com.wisdom.template.configurer.mvc.SpringBeanUtil;
import com.wisdom.template.pojo.vo.UserVO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import java.util.Date;
import java.util.Objects;

import static com.wisdom.template.pojo.constant.DefaultParameterConstant.DEFAULT_USER_ID;
import static com.wisdom.template.pojo.constant.DefaultParameterConstant.DEFAULT_USER_NAME;

/**
* @version 1.0
* @Description:
* @Author: Tom
* @Date: 2021/12/14 0014 15:09
*/
@Service
@Slf4j
public class AsyncServiceImpl implements AsyncService {

 @Resource
 private MessageService messageService;

 @Override
 @Async("asyncServiceExecutor")
 public void sendMessage(String body, String receivedBy, String receivedName, String operationType, String operationId, UserVO userVO) {
 	
     Message message = new Message();
     message.setBody(body);
     message.setReceivedBy(receivedBy);
     message.setReceivedName(receivedName);
     message.setReceivedDate(new Date());
     message.setOperationType(operationType);
     message.setOperationId(operationId);
     message.setCreateBy(Objects.isNull(userVO) ? DEFAULT_USER_ID: userVO.getId());
     message.setCreateName(Objects.isNull(userVO) ? DEFAULT_USER_NAME : userVO.getName());

     messageService.save(message);
 }
}

使用Controller进行调用测试

package com.wisdom.template.basics.controller;


import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.OrderItem;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.IService;
import com.wisdom.template.basics.entity.Message;
import com.wisdom.template.basics.entity.User;
import com.wisdom.template.basics.service.AsyncService;
import com.wisdom.template.basics.service.MessageService;
import com.wisdom.template.basics.service.UserService;
import com.wisdom.template.core.annotation.CheckToken;
import com.wisdom.template.core.service.CurrentUserService;
import com.wisdom.template.pojo.ResultVO;
import com.wisdom.template.pojo.base.BaseController;
import com.wisdom.template.pojo.enums.MessageStateEnum;
import com.wisdom.template.pojo.vo.UserVO;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.NonNull;
import org.apache.poi.ss.formula.functions.T;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.annotation.Resource;
import java.util.List;

/**
 * <p>
 *  消息接口文档
 * </p>
 * @author Tom
 * @since 2021-12-14
 */
@Api(tags = "消息接口文档")
@RestController
@RequestMapping("/api/basics/message")
public class MessageController {

    @Resource
    private AsyncService asyncService;

    @CheckToken
    @ApiOperation(value = "标记已读", notes = "标记已读")
    @GetMapping("/sendMessage")
    public ResultVO<Message> sendMessage(@RequestParam @NonNull String body,
                                         @RequestParam @NonNull String receivedBy,
                                         @RequestParam @NonNull String receivedName,
                                         @RequestParam @NonNull String operationType,
                                         @RequestParam @NonNull String operationId) {

        UserVO user = currentUserService.getCurrentUser();

        //RequestAttributes对象设置为子线程共享
        ServletRequestAttributes thr = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        RequestContextHolder.setRequestAttributes(thr, true);
        asyncService.sendMessage( body,receivedBy,receivedName,operationType,operationId,null);

        return ResultVO.succeed("查询成功!", null);
    }

}

在调用线程使用时一定要添加子线程共享RequestAttributes，要不会报

org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.exceptions.PersistenceException: 
### Error updating database.  Cause: java.lang.IllegalStateException: No thread-bound request found: Are you referring to request attributes outside of an actual web request, or processing a request outside of the originally receiving thread? If you are actually operating within a web request and still receive this message, your code is probably running outside of DispatcherServlet: In this case, use RequestContextListener or RequestContextFilter to expose the current request.