云原生-Quarkus应用程序初始化和终止

1,500 阅读4分钟

通常需要在应用程序启动时执行自定义操作,并在应用程序停止时清理所有内容。

主要方法

默认情况下,Quarkus将自动生成一个main方法,该方法将引导Quarkus,然后仅等待启动关闭。需要创建自己的main方法

`package om.acme;`
`import io.quarkus.runtime.annotations.QuarkusMain;`
`import io.quarkus.runtime.Quarkus;`
`@QuarkusMain` 
`public class Main {`
 `public static void main(String ... args) {`
 `System.out.println("Running main method");`
 `Quarkus.run(args);` 
 `}`
`}`
  • 该注释告诉Quarkus将此方法用作主要方法,除非它在配置中被覆盖
  • 从这启动Quarkus

这个主类将引导Quarkus并运行它直到停止。这与自动生成的主类没有什么不同,但是具有的优点是,可以直接从IDE直接启动它,而无需运行Maven或Gradle命令。

不建议在此主要方法中执行任何业务逻辑,因为尚未设置Quarkus,并且Quarkus可以在其他ClassLoader中运行。如果要在启动时执行逻辑,请使用,
io.quarkus.runtime.QuarkusApplication 如下所述。

如果想在启动时实际执行业务逻辑(或编写完成任务然后退出的应用程序),则需要为
io.quarkus.runtime.QuarkusApplicationrun方法提供一个类。在启动Quarkus之后run,将调用该应用程序的方法。当此方法返回时,Quarkus应用程序将退出。

如果要在启动时执行逻辑,则应调用Quarkus.waitForExit(),该方法将等待直到请求关闭为止(从外部信号(如按时Ctrl+C或由于线程已调用Quarkus.asyncExit()))。

`package com.acme;`
`import io.quarkus.runtime.Quarkus;`
`import io.quarkus.runtime.QuarkusApplication;`
`import io.quarkus.runtime.annotations.QuarkusMain;`
`@QuarkusMain`
`public class Main {`
 `public static void main(String... args) {`
 `Quarkus.run(MyApp.class, args);`
 `}`
 `public static class MyApp implements QuarkusApplication {`
 `@Override`
 `public int run(String... args) throws Exception {`
 `System.out.println("Do startup logic here");`
 `Quarkus.waitForExit();`
 `return 0;`
 `}`
 `}`
`}`

注入命令行参数

可以注入在命令行中传递的参数:

`@Inject`
`@CommandLineArguments`
`String[] args;`

监听启动和关闭事件

在 org.acme.lifecycle 包中创建类 AppLifecycleBean (或者用别的名字 ) ,然后复制下列内容:

`package org.acme.lifecycle;`
`import javax.enterprise.context.ApplicationScoped;`
`import javax.enterprise.event.Observes;`
`import io.quarkus.runtime.ShutdownEvent;`
`import io.quarkus.runtime.StartupEvent;`
`import org.jboss.logging.Logger;`
`@ApplicationScoped`
`public class AppLifecycleBean {`
 `private static final Logger LOGGER = Logger.getLogger("ListenerBean");`
 `void onStart(@Observes StartupEvent ev) {` 
 `LOGGER.info("The application is starting...");`
 `}`
 `void onStop(@Observes ShutdownEvent ev) {` 
 `LOGGER.info("The application is stopping...");`
 `}`
`}`
  1. 应用程序启动时调用的方法
  2. 应用程序终止时调用的方法

这些事件也会在 开发模式(dev mode) 每次重新部署时调用。

这些方法可以注入 beans. 详情查看类 AppLifecycleBean.java

@Initialized(ApplicationScoped.class)和和有什么区别@Destroyed(ApplicationScoped.class)

JVM 模式中,没有真正的差别,除了 StartupEvent 总是在 @Initialized(ApplicationScoped.class) 触发 ShutdownEvent 在 @Destroyed(ApplicationScoped.class) 触发.

但是构建成原生执行文件时,@Initialized(ApplicationScoped.class) 在 原生构建处理过程 触发, StartupEvent 是在原生镜像执行时触发。 详情参考: 启动的三个阶段及 Quarkus 理念 .

在 CDI 应用中, 注解了 @Initialized(ApplicationScoped.class) 的事件是在 CDI 容器初始化时触发的。

用 @Startup 在程序启动时初始化一个 CDI bean

生产者方法或带有注释的字段表示的Bean@Startup在应用程序启动时初始化:

`package org.acme.lifecycle;`
`import javax.enterprise.context.ApplicationScoped;`
`@Startup` 
`@ApplicationScoped`
`public class EagerAppBean {`
 `private final String name;`
 `EagerAppBean(NameGenerator generator) {` 
 `this.name = generator.createName();`
 `}`
`}`
  1. 注解了 @Startup 的每个 bean 会自动合成 StartupEvent 监听器。使用默认优先级。
  2. 程序启动时会调用 bean 的构造函数,并将 bean 保存到应用上下文(译者:保存到 CDI 容器)

@Dependent 类型的监听 beans 会在执行完后立即销毁.

如果类注解了 @Startup 但是没有注解范围会自动设置为 @ApplicationScoped .

打包并运行应用程序

使用 ./mvnw compile quarkus:dev 运行应用, 会输出日志. 应用停止时,输出第二处日志。

一般,应用可以使用 ./mvnw clean package 打包并用 -runner.jar 文件来运行。 也可以用 ./mvnw clean package -Pnative 生成原生执行程序。

运行模式

Quarkus具有3种不同的启动模式NORMAL(即生产)DEVELOPMENT和TEST。如果正在运行,quarkus:dev 则模式为DEVELOPMENT;如果正在运行JUnit测试,则模式为TEST,否则为NORMAL。

您的应用程序可以通过将
io.quarkus.runtime.LaunchMode枚举注入CDI bean或调用static方法来获得启动模式
io.quarkus.runtime.LaunchMode.current()。

优雅的关闭

Quarkus支持平稳关闭,这使Quarkus可以等待运行请求完成,直到设置的超时时间为止。默认情况下,它是禁用的,但是您可以通过设置quarkus.shutdown.timeout config属性来配置它。设置此选项后,直到所有正在运行的请求都已完成,或者直到该超时时间结束,才会发生关机。此配置属性是一个持续时间,可以使用标准java.time.Duration格式设置 ,如果仅指定数字,则将其解释为秒。

接受请求的扩展需要单独添加对此的支持。目前只有HTTP扩展支持此功能,因此当邮件请求处于活动状态时,关闭仍可能发生。