SpringBoot異步處理的方法有哪些

小編給大家分享一下SpringBoot異步處理的方法有哪些，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

異步請求與同步請求

我們先通過一張圖來區分一下異步請求和同步請求的區別：

在上圖中有三個角色：客戶端、Web容器和業務處理線程。

兩個流程中客戶端對Web容器的請求，都是同步的。因為它們在請求客戶端時都處于阻塞等待狀態，并沒有進行異步處理。

在Web容器部分，第一個流程采用同步請求，第二個流程采用異步回調的形式。

通過異步處理，可以先釋放容器分配給請求的線程與相關資源，減輕系統負擔，從而增加了服務器對客戶端請求的吞吐量。但并發請求量較大時，通常會通過負載均衡的方案來解決，而不是異步。

Servlet3.0中的異步

Servlet 3.0之前，Servlet采用Thread-Per-Request的方式處理請求，即每一次Http請求都由一個線程從頭到尾處理。當涉及到耗時操作時，性能問題便比較明顯。

Servlet 3.0中提供了異步處理請求。可以先釋放容器分配給請求的線程與相關資源，減輕系統負擔，從而增加服務的吞吐量。

Servlet 3.0的異步是通過AsyncContext對象來完成的，它可以從當前線程傳給另一個線程，并歸還初始線程。新的線程處理完業務可以直接返回結果給客戶端。

AsyncContext對象可以從HttpServletRequest中獲取：

@RequestMapping("/async")
public void async(HttpServletRequest request) {
    AsyncContext asyncContext = request.getAsyncContext();
}

在AsyncContext中提供了獲取ServletRequest、ServletResponse和添加監聽（addListener）等功能：

public interface AsyncContext {

    ServletRequest getRequest();

    ServletResponse getResponse();

    void addListener(AsyncListener var1);

    void setTimeout(long var1);

    // 省略其他方法
}

不僅可以通過AsyncContext獲取Request和Response等信息，還可以設置異步處理超時時間。通常，超時時間（單位毫秒）是需要設置的，不然無限等下去不就與同步處理一樣了。

通過AsyncContext的addListener還可以添加監聽事件，用來處理異步線程的開始、完成、異常、超時等事件回調。

addListener方法的參數AsyncListener的源碼如下：

public interface AsyncListener extends EventListener {
    // 異步執行完畢時調用
    void onComplete(AsyncEvent var1) throws IOException;
    // 異步線程執行超時調用
    void onTimeout(AsyncEvent var1) throws IOException;
    // 異步線程出錯時調用
    void onError(AsyncEvent var1) throws IOException;
    // 異步線程開始時調用
    void onStartAsync(AsyncEvent var1) throws IOException;
}

通常，異常或超時時返回調用方錯誤信息，而異常時會處理一些清理和關閉操作或記錄異常日志等。

基于Servlet方式實現異步請求

下面直接看一個基于Servlet方式的異步請求示例：

@GetMapping(value = "/email/send")
public void servletReq(HttpServletRequest request) {
    AsyncContext asyncContext = request.startAsync();
    // 設置監聽器:可設置其開始、完成、異常、超時等事件的回調處理
    asyncContext.addListener(new AsyncListener() {
        @Override
        public void onTimeout(AsyncEvent event) {
            System.out.println("處理超時了...");
        }

        @Override
        public void onStartAsync(AsyncEvent event) {
            System.out.println("線程開始執行");
        }

        @Override
        public void onError(AsyncEvent event) {
            System.out.println("執行過程中發生錯誤：" + event.getThrowable().getMessage());
        }

        @Override
        public void onComplete(AsyncEvent event) {
            System.out.println("執行完成，釋放資源");
        }
    });
    //設置超時時間
    asyncContext.setTimeout(6000);
    asyncContext.start(new Runnable() {
        @Override
        public void run() {
            try {
                Thread.sleep(5000);
                System.out.println("內部線程：" + Thread.currentThread().getName());
                asyncContext.getResponse().getWriter().println("async processing");
            } catch (Exception e) {
                System.out.println("異步處理發生異常：" + e.getMessage());
            }
            // 異步請求完成通知，整個請求完成
            asyncContext.complete();
        }
    });
    //此時request的線程連接已經釋放了
    System.out.println("主線程：" + Thread.currentThread().getName());
}

啟動項目，訪問對應的URL，打印日志如下：

主線程：http-nio-8080-exec-4
內部線程：http-nio-8080-exec-5
執行完成，釋放資源

可以看出，上述代碼先執行完了主線程，也就是程序的最后一行代碼的日志打印，然后才是內部線程的執行。內部線程執行完成，AsyncContext的onComplete方法被調用。

如果通過瀏覽器訪問對應的URL，還可以看到該方法的返回值“async processing”。說明內部線程的結果同樣正常的返回到客戶端了。

基于Spring實現異步請求

基于Spring可以通過Callable、DeferredResult或者WebAsyncTask等方式實現異步請求。

基于Callable實現

對于一次請求（/email），基于Callable的處理流程如下：

1、Spring MVC開啟副線程處理業務(將Callable提交到TaskExecutor)；

2、DispatcherServlet和所有的Filter退出Web容器的線程，但是response保持打開狀態；

3、Callable返回結果，SpringMVC將原始請求重新派發給容器(再重新請求一次/email)，恢復之前的處理；

4、DispatcherServlet重新被調用，將結果返回給用戶；

代碼實現示例如下：

@GetMapping("/email")
public Callable<String> order() {
    System.out.println("主線程開始：" + Thread.currentThread().getName());
    Callable<String> result = () -> {
        System.out.println("副線程開始：" + Thread.currentThread().getName());
        Thread.sleep(1000);
        System.out.println("副線程返回：" + Thread.currentThread().getName());
        return "success";
    };

    System.out.println("主線程返回：" + Thread.currentThread().getName());
    return result;
}

訪問對應URL，控制臺輸入日志如下：

主線程開始：http-nio-8080-exec-1
主線程返回：http-nio-8080-exec-1
副線程開始：task-1
副線程返回：task-1

通過日志可以看出，主線程已經完成了，副線程才進行執行。同時，URL返回結果“success”。這也說明一個問題，服務器端的異步處理對客戶端來說是不可見的。

Callable默認使用SimpleAsyncTaskExecutor類來執行，這個類非常簡單而且沒有重用線程。在實踐中，需要使用AsyncTaskExecutor類來對線程進行配置。

這里通過實現WebMvcConfigurer接口來完成線程池的配置。

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Resource
    private ThreadPoolTaskExecutor myThreadPoolTaskExecutor;

    /**
     * 配置線程池
     */
    @Bean(name = "asyncPoolTaskExecutor")
    public ThreadPoolTaskExecutor getAsyncThreadPoolTaskExecutor() {
        ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
        taskExecutor.setCorePoolSize(2);
        taskExecutor.setMaxPoolSize(10);
        taskExecutor.setQueueCapacity(25);
        taskExecutor.setKeepAliveSeconds(200);
        taskExecutor.setThreadNamePrefix("thread-pool-");
        // 線程池對拒絕任務（無線程可用）的處理策略，目前只支持AbortPolicy、CallerRunsPolicy；默認為后者
        taskExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        taskExecutor.initialize();
        return taskExecutor;
    }

    @Override
    public void configureAsyncSupport(final AsyncSupportConfigurer configurer) {
        // 處理callable超時
        configurer.setDefaultTimeout(60 * 1000);
        configurer.setTaskExecutor(myThreadPoolTaskExecutor);
        configurer.registerCallableInterceptors(timeoutCallableProcessingInterceptor());
    }

    @Bean
    public TimeoutCallableProcessingInterceptor timeoutCallableProcessingInterceptor() {
        return new TimeoutCallableProcessingInterceptor();
    }
}

為了驗證打印的線程，我們將實例代碼中的System.out.println替換成日志輸出，會發現在使用線程池之前，打印日志如下：

2021-02-21 09:45:37.144  INFO 8312 --- [nio-8080-exec-1] c.s.learn.controller.AsynController      : 主線程開始：http-nio-8080-exec-1
2021-02-21 09:45:37.144  INFO 8312 --- [nio-8080-exec-1] c.s.learn.controller.AsynController      : 主線程返回：http-nio-8080-exec-1
2021-02-21 09:45:37.148  INFO 8312 --- [         task-1] c.s.learn.controller.AsynController      : 副線程開始：task-1
2021-02-21 09:45:38.153  INFO 8312 --- [         task-1] c.s.learn.controller.AsynController      : 副線程返回：task-1

線程名稱為“task-1”。讓線程池生效之后，打印日志如下：

2021-02-21 09:50:28.950  INFO 8339 --- [nio-8080-exec-1] c.s.learn.controller.AsynController      : 主線程開始：http-nio-8080-exec-1
2021-02-21 09:50:28.951  INFO 8339 --- [nio-8080-exec-1] c.s.learn.controller.AsynController      : 主線程返回：http-nio-8080-exec-1
2021-02-21 09:50:28.955  INFO 8339 --- [  thread-pool-1] c.s.learn.controller.AsynController      : 副線程開始：thread-pool-1
2021-02-21 09:50:29.956  INFO 8339 --- [  thread-pool-1] c.s.learn.controller.AsynController      : 副線程返回：thread-pool-1

線程名稱為“thread-pool-1”，其中前面的“thread-pool”正是我們配置的線程池前綴。

除了線程池的配置，還可以配置統一異常處理，這里就不再演示了。

基于WebAsyncTask實現

Spring提供的WebAsyncTask是對Callable的包裝，提供了更強大的功能，比如：處理超時回調、錯誤回調、完成回調等。

@GetMapping("/webAsyncTask")
public WebAsyncTask<String> webAsyncTask() {
    log.info("外部線程：" + Thread.currentThread().getName());
    WebAsyncTask<String> result = new WebAsyncTask<>(60 * 1000L, new Callable<String>() {
        @Override
        public String call() {
            log.info("內部線程：" + Thread.currentThread().getName());
            return "success";
        }
    });
    result.onTimeout(new Callable<String>() {
        @Override
        public String call() {
            log.info("timeout callback");
            return "timeout callback";
        }
    });
    result.onCompletion(new Runnable() {
        @Override
        public void run() {
            log.info("finish callback");
        }
    });
    return result;
}

訪問對應請求，打印日志：

2021-02-21 10:22:33.028  INFO 8547 --- [nio-8080-exec-1] c.s.learn.controller.AsynController      : 外部線程：http-nio-8080-exec-1
2021-02-21 10:22:33.033  INFO 8547 --- [  thread-pool-1] c.s.learn.controller.AsynController      : 內部線程：thread-pool-1
2021-02-21 10:22:33.055  INFO 8547 --- [nio-8080-exec-2] c.s.learn.controller.AsynController      : finish callback

基于DeferredResult實現

DeferredResult使用方式與Callable類似，但在返回結果時不一樣，它返回的時實際結果可能沒有生成，實際的結果可能會在另外的線程里面設置到DeferredResult中去。

DeferredResult的這個特性對實現服務端推技術、訂單過期時間處理、長輪詢、模擬MQ的功能等高級應用非常重要。

關于DeferredResult的使用先來看一下官方的例子和說明：

@RequestMapping("/quotes")
@ResponseBody
public DeferredResult<String> quotes() {
  DeferredResult<String> deferredResult = new DeferredResult<String>();
  // Save the deferredResult in in-memory queue ...
  return deferredResult;
}

// In some other thread...
deferredResult.setResult(data);

上述示例中我們可以發現DeferredResult的調用并不一定在Spring MVC當中，它可以是別的線程。官方的解釋也是如此：

In this case the return value will also be produced from a separate thread. However, that thread is not known to Spring MVC. For example the result may be produced in response to some external event such as a JMS message, a scheduled task, etc.

也就是說，DeferredResult返回的結果也可能是由MQ、定時任務或其他線程觸發。來個實例：

@Controller
@RequestMapping("/async/controller")
public class AsyncHelloController {

    private List<DeferredResult<String>> deferredResultList = new ArrayList<>();

    @ResponseBody
    @GetMapping("/hello")
    public DeferredResult<String> helloGet() throws Exception {
        DeferredResult<String> deferredResult = new DeferredResult<>();

        //先存起來，等待觸發
        deferredResultList.add(deferredResult);
        return deferredResult;
    }

    @ResponseBody
    @GetMapping("/setHelloToAll")
    public void helloSet() throws Exception {
        // 讓所有hold住的請求給與響應
        deferredResultList.forEach(d -> d.setResult("say hello to all"));
    }
}

第一個請求/hello，會先將deferredResult存起來，前端頁面是一直等待（轉圈）狀態。直到發第二個請求：setHelloToAll，所有的相關頁面才會有響應。

整個執行流程如下：

• controller返回一個DeferredResult，把它保存到內存里或者List里面（供后續訪問）；

• Spring MVC調用request.startAsync()，開啟異步處理；與此同時將DispatcherServlet里的攔截器、Filter等等都馬上退出主線程，但是response仍然保持打開的狀態；

• 應用通過另外一個線程（可能是MQ消息、定時任務等）給DeferredResult#setResult值。然后SpringMVC會把這個請求再次派發給servlet容器；

• DispatcherServlet再次被調用，然后處理后續的標準流程；

通過上述流程可以發現：利用DeferredResult可實現一些長連接的功能，比如當某個操作是異步時，可以先保存對應的DeferredResult對象，當異步通知回來時，再找到這個DeferredResult對象，在setResult處理結果即可。從而提高性能。

SpringBoot中的異步實現

在SpringBoot中將一個方法聲明為異步方法非常簡單，只需兩個注解即可@EnableAsync和@Async。其中@EnableAsync用于開啟SpringBoot支持異步的功能，用在SpringBoot的啟動類上。@Async用于方法上，標記該方法為異步處理方法。

需要注意的是@Async并不支持用于被@Configuration注解的類的方法上。同一個類中，一個方法調用另外一個有@Async的方法，注解也是不會生效的。

@EnableAsync的使用示例：

@SpringBootApplication
@EnableAsync
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

@Async的使用示例：

@Service
public class SyncService {

    @Async
    public void asyncEvent() {
        // 業務處理
    }
}

@Async注解的使用與Callable有類似之處，在默認情況下使用的都是SimpleAsyncTaskExecutor線程池，可參考Callable中的方式來自定義線程池。

下面通過一個實例來驗證一下，啟動類上使用@EnableAsync，然后定義Controller類：

@RestController
public class IndexController {

    @Resource
    private UserService userService;

    @RequestMapping("/async")
    public String async(){
        System.out.println("--IndexController--1");
        userService.sendSms();
        System.out.println("--IndexController--4");
        return "success";
    }
}

定義Service及異步方法：

@Service
public class UserService {

    @Async
    public void sendSms(){
        System.out.println("--sendSms--2");
        IntStream.range(0, 5).forEach(d -> {
            try {
                Thread.sleep(1000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        });
        System.out.println("--sendSms--3");
    }
}

如果先注釋掉@EnableAsync和@Async注解，即正常情況下的業務請求，打印日志為：

--IndexController--1
--sendSms--2
--sendSms--3
--IndexController--4

使用@EnableAsync和@Async注解時，打印日志如下：

--IndexController--1
--IndexController--4
--sendSms--2
--sendSms--3

通過日志的對比我們可以看出，使用了@Async的方法，會被當成一個子線程。所以，整個sendSms方法會在主線程執行完了之后執行。

這樣的效果是不是跟我們上面使用的其他形式的異步異曲同工？所以在文章最開始已經說到，網絡上所謂的“異步調用與異步請求的區別”是并不存儲在的，本質上都是一回事，只不過實現形式不同而已。這里所提到異步方法，也就是將方法進行異步處理而已。

@Async、WebAsyncTask、Callable、DeferredResult的區別

所在的包不同：

• @Async：org.springframework.scheduling.annotation;

• WebAsyncTask：org.springframework.web.context.request.async;

• Callable：java.util.concurrent；

• DeferredResult：org.springframework.web.context.request.async;

通過所在的包，我們應該隱隱約約感到一些區別，比如@Async是位于scheduling包中，而WebAsyncTask和DeferredResult是用于Web（Spring MVC）的，而Callable是用于concurrent（并發）處理的。

對于Callable，通常用于Controller方法的異步請求，當然也可以用于替換Runable的方式。在方法的返回上與正常的方法有所區別：

// 普通方法
public String aMethod(){
}

// 對照Callable方法
public Callable<String>  aMethod(){
}

而WebAsyncTask是對Callable的封裝，提供了一些事件回調的處理，本質上區別不大。

DeferredResult使用方式與Callable類似，重點在于跨線程之間的通信。

@Async也是替換Runable的一種方式，可以代替我們自己創建線程。而且適用的范圍更廣，并不局限于Controller層，而可以是任何層的方法上。

當然，大家也可以從返回結果，異常處理等角度來分析一下，這里就不再展開了。

springboot是什么

springboot一種全新的編程規范，其設計目的是用來簡化新Spring應用的初始搭建以及開發過程，SpringBoot也是一個服務于框架的框架，服務范圍是簡化配置文件。

以上是“SpringBoot異步處理的方法有哪些”這篇文章的所有內容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內容對大家有所幫助，如果還想學習更多知識，歡迎關注億速云行業資訊頻道！