深入理解@Asynchronous：Payara中EJB异步方法调用的正确实践

@asynchronous注解旨在实现非阻塞方法调用，但在payara等java ee环境中，其异步行为仅对ejb容器管理的ejb方法调用生效。直接通过`this`进行的本地方法调用会绕过容器的拦截处理，导致注解失效，方法依然同步执行。本文将详细阐述这一机制，并提供正确的ejb异步方法实现范例。

理解@Asynchronous注解及其工作原理

Java EE（现在称为Jakarta EE）提供了@Asynchronous注解，允许开发者将普通方法标记为异步执行。当客户端调用一个被@Asynchronous注解的方法时，企业级Bean容器（如EJB容器）会立即将控制权返回给客户端，而该方法则在独立的线程中异步执行。这对于执行耗时操作而又不阻塞主业务流程的场景非常有用，例如发送邮件、生成报告或处理后台任务。

根据Oracle官方文档的解释，客户端调用异步方法后，企业级Bean容器会立即返回控制权。然而，在实际开发中，开发者可能会遇到@Asynchronous注解失效，方法仍然同步执行的情况。这通常是由于对该注解的适用范围和调用机制存在误解。

常见误区：本地方法调用导致异步失效

许多开发者在使用@Asynchronous时，可能会将其直接应用于一个类（例如JAX-RS资源类）的内部方法，并尝试通过this关键字进行调用。示例如下：

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ejb.Asynchronous; // 注意：此处的@Asynchronous是EJB的注解

@Path("foo")
public class FooResource {
  @GET
  public String get() {
    System.out.println("Request started");
    this.doSomething(); // 本地方法调用
    System.out.println("Request ended");
    return "Hello world! ";
  }

  @Asynchronous
  public void doSomething() {
    try {
      System.out.println("Long task started");
      Thread.sleep(2000); // 模拟耗时操作
      System.out.println("Long task ended");
    } catch (InterruptedException e) {
      System.out.println("Long task failed");
    }
  }
}

在上述代码中，尽管doSomething()方法被@Asynchronous注解，但当get()方法通过this.doSomething()调用它时，实际的执行顺序会是：

Request started
Long task started
Long task ended
Request ended

这表明doSomething()方法是同步执行的，而不是预期的异步行为。其根本原因在于，@Asynchronous注解是由EJB容器进行处理和拦截的。当通过this关键字调用方法时，这仅仅是一个普通的Java方法调用，它完全绕过了EJB容器的拦截机制，因此容器无法介入并将其调度为异步任务。换句话说，容器并不知道这个本地方法调用应该被特殊处理。

正确实践：通过EJB容器管理进行异步调用

要实现真正的异步方法调用，被@Asynchronous注解的方法必须是企业级Bean（EJB）的一部分，并且该EJB实例必须通过容器进行管理和注入，而不是直接创建或通过this调用。EJB容器会为EJB组件创建代理对象，所有的EJB方法调用都是通过这些代理进行的，从而使容器能够拦截方法调用并应用诸如事务管理、安全检查以及异步执行等特性。

以下是实现正确异步调用的步骤和代码示例：

钉钉 AI 助理

钉钉AI助理汇集了钉钉AI产品能力，帮助企业迈入智能新时代。

21

查看详情

1. 创建一个EJB组件

首先，需要创建一个EJB（例如一个无状态会话Bean @Stateless），并将异步方法放置其中。

import javax.ejb.Asynchronous;
import javax.ejb.Stateless;

@Stateless // 声明为一个无状态会话Bean
public class MyEJB {

  @Asynchronous // 标记为异步方法
  public void doSomething() {
    try {
      System.out.println("Long task started");
      Thread.sleep(2000); // 模拟耗时操作
      System.out.println("Long task ended");
    } catch (InterruptedException e) {
      System.out.println("Long task failed");
    }
  }
}

2. 在调用方注入EJB并调用其方法

接下来，在需要调用异步方法的类中（例如JAX-RS资源类），通过@Inject注解注入MyEJB的实例，然后通过这个注入的实例来调用doSomething()方法。

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.inject.Inject; // 用于依赖注入

@Path("foo")
public class FooResource {

  @Inject // 注入MyEJB实例
  MyEJB myEJB;

  @GET
  public String get() {
    System.out.println("Request started");
    myEJB.doSomething(); // 通过注入的EJB实例调用异步方法
    System.out.println("Request ended");
    return "Hello world! ";
  }
}

通过这种方式，当get()方法调用myEJB.doSomething()时，EJB容器会拦截这个调用，并根据@Asynchronous注解的指示，在一个单独的线程中执行doSomething()方法，同时立即将控制权返回给get()方法。因此，预期的执行顺序将是：

Request started
Long task started
Request ended
Long task ended

这正是我们期望的异步行为。

总结与最佳实践

• EJB是关键：@Asynchronous注解是EJB规范的一部分，它依赖于EJB容器的运行时管理。因此，被@Asynchronous注解的方法必须属于一个EJB组件（如@Stateless、@Singleton等）。
• 容器注入：在其他组件（如JAX-RS资源、Servlet或另一个EJB）中调用异步EJB方法时，务必通过@Inject（或@EJB）注解注入EJB实例，并通过该注入的实例进行方法调用。直接使用this调用同一类中的方法，或者手动创建EJB实例，都将绕过容器的拦截，导致异步失效。
• 返回类型：异步方法可以有void返回类型，也可以返回java.util.concurrent.Future<V>。如果需要获取异步操作的结果或检查其状态，应使用Future作为返回类型。
• 异常处理：异步方法中的异常处理需要特别注意。如果异步方法抛出未捕获的运行时异常，这些异常通常不会传播回调用方，而是由容器记录或以其他方式处理。使用Future可以更方便地捕获和处理异步操作中的异常。

正确理解和使用@Asynchronous注解对于构建高效、响应迅速的Java EE/Jakarta EE应用至关重要。通过将异步逻辑封装在EJB中并依赖容器进行管理，开发者可以充分利用平台提供的强大功能，避免常见的异步陷阱。

以上就是深入理解@Asynchronous：Payara中EJB异步方法调用的正确实践的详细内容，更多请关注php中文网其它相关文章！