Java EE @Asynchronous 注解：EJB上下文与异步方法调用指南

本文深入探讨了Java EE中@Asynchronous注解的正确使用方法。许多开发者误以为该注解可以直接应用于任何方法以实现异步执行，但实际上，它必须应用于EJB（Enterprise JavaBean）的方法，并且该方法必须通过EJB容器进行调用才能生效。文章通过示例代码详细解释了本地方法调用与EJB容器调用之间的关键区别，并提供了实现真正异步行为的正确实践。

1. @Asynchronous 注解概述

在Java EE（现Jakarta EE）环境中，@Asynchronous 注解是EJB规范的一部分，旨在允许企业级应用程序中的方法以非阻塞方式执行。当一个EJB方法被标记为 @Asynchronous 时，客户端调用该方法后会立即返回，而方法的实际执行则由EJB容器在后台线程中异步完成。这对于执行耗时操作（如发送邮件、生成报告或复杂计算）非常有用，可以避免阻塞调用线程，从而提高应用程序的响应性和吞吐量。

根据Oracle官方文档的描述，客户端调用异步方法后，企业级Bean容器会立即将控制权返回给客户端。然而，要实现这种行为，必须遵循特定的调用模式。

2. 常见误区：本地方法调用与非异步行为

许多开发者在初次使用 @Asynchronous 时，可能会遇到一个常见问题：即使方法被标记为 @Asynchronous，其行为仍然是同步的。这通常发生在尝试在同一个类内部直接调用被注解的方法时。

立即学习“Java免费学习笔记（深入）”；

考虑以下示例代码，其中 doSomething() 方法被标记为 @Asynchronous，但在 get() 方法中通过 this.doSomething() 进行了本地调用：

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import org.eclipse.microprofile.concurrent.Asynchronous; // 或 javax.ejb.Asynchronous

@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");
    }
  }
}

在这种情况下，当客户端请求 /foo 路径时，期望的输出顺序是：

Request started
Long task started
Request ended
Long task ended

然而，实际的输出顺序却是：

Request started
Long task started
Long task ended
Request ended

这表明 doSomething() 方法是同步执行的，Request ended 语句在 Long task ended 之后才被打印，这与 @Asynchronous 注解的预期行为不符。

原因分析：

问题的根源在于，@Asynchronous 注解是EJB容器提供的一项服务。当你在同一个类内部通过 this 关键字直接调用一个方法时，这仅仅是一个普通的Java方法调用，完全绕过了EJB容器的拦截和处理机制。EJB容器无法感知到这个本地调用，因此也无法应用 @Asynchronous 注解所定义的异步行为。要使 @Asynchronous 生效，方法必须通过EJB容器进行调用。

3. 正确实践：通过EJB容器实现异步

要正确利用 @Asynchronous 注解实现异步执行，你需要将异步方法定义在一个EJB中（例如一个 @Stateless 无状态会话Bean），并通过依赖注入（@Inject）的方式获取该EJB的实例，然后调用其方法。这样，EJB容器才能拦截到方法调用，并在后台线程中执行异步任务。

法语写作助手

法语助手旗下的AI智能写作平台，支持语法、拼写自动纠错，一键改写、润色你的法语作文。

31

查看详情

以下是修正后的代码示例：

步骤一：创建EJB

首先，定义一个EJB，将耗时的异步方法放在其中。我们使用 @Stateless 注解将其声明为一个无状态会话Bean。

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");
    }
  }
}

步骤二：在资源类中注入并调用EJB

接下来，在你的JAX-RS资源类中，通过 @Inject 注解注入 MyEJB 的实例，然后调用其 doSomething() 方法。

import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.Path;

@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! ";
  }
}

正确执行流程与预期输出：

通过上述修改，当 FooResource 中的 get() 方法被调用时，myEJB.doSomething() 调用会被EJB容器拦截。容器会立即返回控制权给 get() 方法，并在一个独立的线程中异步执行 doSomething() 方法。

此时，预期的输出顺序将是：

Request started
Request ended
Long task started
Long task ended

（注意：Long task started 和 Long task ended 可能在 Request ended 之后或在 Request started 和 Request ended 之间出现，具体取决于线程调度，但 Request ended 会在 Long task started 之前打印，表明异步执行成功。）

4. 关键点与注意事项

• EJB上下文是核心： @Asynchronous 注解仅在EJB（Enterprise JavaBean）的上下文中有效。这意味着它必须应用于一个EJB的方法，并且该EJB必须由容器管理和实例化。
• 通过容器调用： 异步方法必须通过EJB容器的代理实例进行调用。最常见的实现方式是通过 @Inject 注入EJB实例，然后调用其方法。直接通过 new MyEJB().doSomething() 或 this.doSomething() 这样的本地调用会绕过容器，导致 @Asynchronous 失效。
• 返回类型： @Asynchronous 方法可以返回 void，也可以返回 java.util.concurrent.Future<V> 类型，其中 V 是方法的实际返回值类型。返回 Future 允许客户端在稍后获取异步操作的结果或检查其状态。
• 异常处理： 在异步方法内部发生的异常通常不会直接传播到调用线程。如果需要处理异步方法的异常，可以通过返回 Future 对象并在 Future.get() 调用时捕获异常，或者通过EJB的异常处理机制（如异步方法中发送事件或记录日志）。
• 事务管理： @Asynchronous 方法的事务行为与普通EJB方法类似，可以由容器管理事务（CMT）或程序化事务（BMT）。通常，异步方法会在一个新的事务上下文中执行，或者继承调用者的事务上下文，具体行为取决于配置。

总结

@Asynchronous 注解是Java EE/Jakarta EE中实现异步处理的强大工具，但其有效性严格依赖于EJB容器的管理和调用机制。理解其必须通过EJB上下文和容器代理进行调用的原理，是正确使用该注解的关键。通过将耗时操作封装在 @Stateless EJB中并通过 @Inject 注入调用，开发者可以确保应用程序的异步行为符合预期，从而提升系统的响应性和用户体验。

以上就是Java EE @Asynchronous 注解：EJB上下文与异步方法调用指南的详细内容，更多请关注php中文网其它相关文章！