云原生-Quarkus配置应用程序

686 阅读1分钟

创建配置文件

默认 Quarkus 读取 application.properties. 用下列内容编辑
src/main/resources/application.properties

`# Your configuration properties`
`greeting.message = hello`
`greeting.name = quarkus`

注入配置项

Quarkus 使用 MicroProfile Config 将配置注入到应用。 注入使用 @ConfigProperty 注解

`@ConfigProperty(name = "greeting.message")` 
`String message;`

注入配置时 可以使用 @Inject @ConfigProperty 或仅 @ConfigProperty 对于标注了 @ConfigProperty 的成员, 注解 @Inject 不是必须的, 这点与 MicroProfile Config 不一样

编辑
org.acme.config.GreetingResource 并加入下列配置属性:

`@ConfigProperty(name = "greeting.message")` 
`String message;`
`@ConfigProperty(name = "greeting.suffix", defaultValue="!")` 
`String suffix;`
`@ConfigProperty(name = "greeting.name")`
`Optional<String> name;` 
  • 如果没有为属性配置值,应用会启动失败报错 javax.enterprise.inject.spi.DeploymentException: No config value of type [class java.lang.String] exists for: greeting.message.
  • 如果没有配置 greeting.suffix 的值会注入默认值.
  • 可选属性 - 如果没有配置 greeting.name 值会注入 Optional.empty() .

修改 hello 方法使用注入的属性:

`@GET`
`@Produces(MediaType.TEXT_PLAIN)`
`public String hello() {`
 `return message + " " + name.orElse("world") + suffix;`
`}`

一旦设置,用下列方式检查:

`$ curl http://localhost:8080/greeting`
`hello quarkus!`

注入多个相关配置值的替代方法,还可以使用@
io.quarkus.arc.config.ConfigProperties注释将这些属性组合在一起。

更新和测试

我们也需要相应调整功能测试。 编辑
src/test/java/org/acme/config/GreetingResourceTest.java 文件修改方法 testHelloEndpoint 的内容为:

`package org.acme.config;`
`import io.quarkus.test.junit.QuarkusTest;`
`import org.junit.jupiter.api.Test;`
`import static io.restassured.RestAssured.given;`
`import static org.hamcrest.CoreMatchers.is;`
`@QuarkusTest`
`public class GreetingResourceTest {`
 `@Test`
 `public void testHelloEndpoint() {`
 `given()`
 `.when().get("/greeting")`
 `.then()`
 `.statusCode(200)`
 `.body(is("hello quarkus!")); // Modified line`
 `}`
`}`

打包并运行应用程序

使用 ./mvnw compile quarkus:dev 运行应用. 并用浏览器打开
http://localhost:8080/greeting.

修改配置文件后马上就能看到变化。 你可以添加 greeting.suffix , 删除其它属性,修改值,等等。

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

编程访问配置

可以通过编程方式访问配置。实现动态查找或从既不是CDI bean也不是JAX-RS资源的类中检索配置的值可能很方便。

可以使用以下方式以编程方式访问配置
org.eclipse.microprofile.config.ConfigProvider.getConfig():

`String databaseName = ConfigProvider.getConfig().getValue("database.name", String.class);`
`Optional<String> maybeDatabaseName = ConfigProvider.getConfig().getOptionalValue("database.name", String.class);`

配置 Profiles

Quarkus支持配置配置文件的概念。这些允许您在同一文件中拥有多个配置值,并通过配置文件名称在它们之间进行选择。

语法为%{profile}.config.key=value。例如,如果我有以下内容:

`quarkus.http.port=9090`
`%dev.quarkus.http.port=8181`

然后,除非dev配置文件处于活动状态,否则Quarkus HTTP端口将为9090 ,在这种情况下,它将为8181。

配置Quarkus

Quarkus本身是通过与应用程序相同的机制配置的。Quarkus保留quarkus.名称空间。例如在里面application.properties 设置HTTP服务器端口

属性前缀quarkus.被有效地保留用于配置Quarkus本身,因此quarkus.应从未被用作前缀应用程序专用属性。

Quarkus在构建时进行大部分配置和引导,并且在构建期间读取并使用了一些配置属性。这些属性_在构建时_是_固定_的,无法在运行时进行更改。始终需要重新打包应用程序,以反映此类属性的更改。

在构建时固定的属性用锁定图标标记()在所有配置选项的列表中。

但是,某些扩展确实定义了_在运行时可覆盖的_属性。一个典型的例子是数据库URL,用户名和密码,仅在目标环境中才知道。

  1. 系统属性
  2. 环境变量
  3. 名为的环境文件.env放置在当前工作目录中
  4. 放置在其中的配置文件 $PWD/config/application.properties