掌握Payara中@Asynchronous注解的正确用法：避免同步调用的陷阱

本文深入探讨了在payara micro环境下使用java ee `@asynchronous` 注解时常见的误区。我们揭示了直接在同一类中调用异步方法无法生效的原因，并提供了正确的解决方案：通过将异步逻辑封装在enterprise javabean (ejb) 中，并注入ejb实例进行调用，从而确保容器能够拦截并实现真正的异步执行。

在现代企业级应用开发中，异步处理是提升系统响应速度和资源利用率的关键技术之一。Java EE 提供了 @Asynchronous 注解，旨在简化异步方法的实现。然而，在实际使用，尤其是在Payara Micro这样的应用服务器中，开发者可能会遇到一些与预期不符的行为。本文将详细解析 @Asynchronous 注解的正确用法，帮助开发者避免常见的陷阱。

理解 @Asynchronous 注解

@Asynchronous 注解是Java EE规范的一部分，主要用于EJB（Enterprise JavaBeans）方法上。当一个方法被标记为 @Asynchronous 时，它的调用者会立即获得控制权并返回，而方法的实际执行则会在后台由容器管理的线程池中异步进行。这对于执行耗时操作（如发送邮件、生成报告、调用外部服务等）而不想阻塞主业务流程的场景非常有用。

根据Oracle Java EE文档的描述，客户端调用异步方法时，企业级Bean容器会立即将控制权返回给它们。这意味着调用线程不会等待异步方法的完成。

常见的误解：直接方法调用

许多开发者在使用 @Asynchronous 时，可能会尝试在同一个类中直接调用被注解的方法，例如：

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import org.eclipse.microprofile.context.ManagedExecutor;

@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");
      Thread.currentThread().interrupt(); // 恢复中断状态
    }
  }
}

在上述代码中，FooResource 类中的 get() 方法直接通过 this.doSomething() 调用了 doSomething() 方法。尽管 doSomething() 被 @Asynchronous 注解，但其执行结果却并非异步。预期的输出顺序（Request started -> Long task started -> Request ended -> Long task ended）并没有出现，实际观察到的输出是：

Request started
Long task started
Long task ended
Request ended

这表明 get() 方法在 doSomething() 完成之前一直处于阻塞状态。

原因分析：@Asynchronous 注解的生效依赖于Java EE容器的拦截机制。当您通过 this 关键字调用同一个类中的方法时，这仅仅是一个普通的JVM方法调用，完全绕过了Java EE容器的上下文和拦截器链。容器没有机会去处理 @Asynchronous 注解并将其调度到单独的线程中执行。因此，该方法会像普通方法一样同步执行。

正确实践：通过EJB实现异步

要正确利用 @Asynchronous 注解实现异步行为，您必须将其应用于一个由Java EE容器管理的组件，最常见且推荐的方式是将其应用于Enterprise JavaBean (EJB) 的方法。

步骤一：创建EJB并定义异步方法

AppMall应用商店

AI应用商店，提供即时交付、按需付费的人工智能应用服务

56

查看详情

首先，创建一个EJB（例如一个无状态会话Bean @Stateless 或单例Bean @Singleton），并将需要异步执行的逻辑封装在其方法中。然后，使用 @Asynchronous 注解标记这个方法。

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");
      Thread.currentThread().interrupt(); // 恢复中断状态
    }
  }
}

步骤二：注入EJB并调用异步方法

在需要调用异步方法的类（例如JAX-RS资源类、Servlet或其他EJB）中，使用 @Inject 注解注入 MyEJB 实例。然后，通过注入的EJB实例调用 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! ";
  }
}

通过这种方式，当 myEJB.doSomething() 被调用时，Java EE容器会拦截这个调用，识别 @Asynchronous 注解，并将 doSomething() 方法的执行调度到一个独立的线程中。调用 get() 方法的线程会立即返回，而不会等待 doSomething() 完成。

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

Request started
Request ended
Long task started
Long task ended

这正是 @Asynchronous 注解所期望的异步行为。

注意事项与最佳实践

1. EJB上下文是关键： @Asynchronous 注解必须应用于由Java EE容器管理的组件（主要是EJB）的方法。在POJO（Plain Old Java Object）中或通过 this 关键字直接调用，它将不会生效。
2. 返回类型： 异步方法通常返回 void。如果需要获取异步操作的结果或检查其状态，可以返回 java.util.concurrent.Future<?>。例如：

   @Asynchronous
   public Future<String> doSomethingAndReturn() {
       // ... 耗时操作 ...
       return new AsyncResult<>("Task Completed");
   }

   登录后复制

   调用者可以通过 Future 对象查询结果或等待完成。

3. 异常处理： 异步方法中抛出的异常不会直接传播到调用线程。您需要在异步方法内部妥善处理异常，或者通过 Future 对象的 get() 方法来捕获异常。
4. 事务管理： 异步方法通常在一个新的事务上下文中执行，与调用线程的事务是独立的。
5. 线程池配置： Payara等应用服务器通常提供管理和配置用于异步EJB方法的线程池的选项。根据应用负载调整这些配置可以优化性能。
6. 替代方案： 对于不使用EJB的场景，Java EE还提供了其他异步机制，如 @ManagedExecutorDefinition 结合 ManagedExecutor (MicroProfile Concurrency)，或者直接使用 java.util.concurrent 包中的API，但 @Asynchronous 是EJB体系中最简洁的异步实现方式。

总结

@Asynchronous 注解是Java EE平台提供的一个强大工具，用于实现非阻塞的后台任务。然而，其有效性严格依赖于Java EE容器的拦截和管理。通过将异步逻辑封装在EJB中，并确保通过容器注入的EJB实例进行方法调用，开发者可以充分利用 @Asynchronous 的优势，构建更具响应性和伸缩性的企业级应用。理解并遵循这一核心原则，是避免在使用 @Asynchronous 时陷入同步调用陷阱的关键。

以上就是掌握Payara中@Asynchronous注解的正确用法：避免同步调用的陷阱的详细内容，更多请关注php中文网其它相关文章！