关于后端:quarkus实战之七使用配置

欢送拜访我的GitHub

这里分类和汇总了欣宸的全副原创(含配套源码)：https://github.com/zq2599/blog_demos

本篇概览

本文是《quarkus实战》系列的第七篇，前文讲述了如何在将配置信息传入quarkus利用，明天要练习的是如何应用这些配置信息
整篇文章由以下内容形成：
创立工程，作为演示应用配置项操作的代码
演示最根本的应用配置项操作
展现配置项不存时会导致什么问题
演示如何设置默认值，这样配置项不存在也不会出错
默认值是字符串，而理论的变量能够是多种类型，它们之间的关系
Optional类型的配置注入
不必注解注入，也能够写代码获取配置
针对雷同前缀的配置项，应用配置接口简化代码
应用配置接口嵌套，简化多级的雷同前缀配置项
用map承受配置信息（缩小配置项相干代码量）
quarkus及其扩大组件的内置配置项
接下来从创立demo工程开始吧
演示代码

创立一个demo工程，参考上面的命令，这样的工程会自带一个web服务类HobbyResource.java

mvn "io.quarkus:quarkus-maven-plugin:create" \-DprojectGroupId="com.bolingcavalry" \-DprojectArtifactId="hello-quarkus" \-DprojectVersion="1.0-SNAPSHOT" \-DclassName="HobbyResource" \-Dpath="actions"

最根本的配置

先来看看最罕用最根本的配置文件应用形式
关上文件src/main/resources/application.properties，减少上面这行配置
```
greeting.message = hello from application.properties
```
关上HobbyResource.java，减少如下成员变量，应用了注解ConfigProperty
```
@ConfigProperty(name = "greeting.message") String message;
```
以上就是最简略的应用配置项的形式，程序运行后，application.properties中greeting.message的值就会被quarkus框架注入到message成员变量中
配置项不存在导致的异样
如果ConfigProperty注解的配置项在配置文件中不存在，利用启动会报错，来看看是什么谬误

将HobbyResource.java的代码改成上面这样，成员变量notExistsConfig的配置项是not.exists.config，这个配置项在配置文件中并不存在

@Path("/actions")public class HobbyResource {  // 配置文件中不存在名为not.exists.config的配置项  @ConfigProperty(name = "not.exists.config")  String notExistsConfig;  @GET  @Produces(MediaType.TEXT_PLAIN)  public String hello() {      return "Hello RESTEasy, " + LocalDateTime.now() + ", [" + notExistsConfig + "]";  }}

启动利用时报错如下图所示，红框中提醒加载配置项失败
带默认值的配置
对于下面演示的配置项不存在导致启动失败问题，能够给ConfigProperty注解设置默认值，这样一旦找不到配置项，就应用默认值注入，能够防止启动失败了

HobbyResource.java的源码如下，成员变量notExistsConfig的注解了减少属性defaultValue

@Path("/actions")public class HobbyResource {  // 配置文件中不存在名为not.exists.config的配置项  @ConfigProperty(name = "not.exists.config", defaultValue = "112233")  String notExistsConfig;  @GET  @Produces(MediaType.TEXT_PLAIN)  public String hello() {      return "Hello RESTEasy, " + LocalDateTime.now() + ", [" + notExistsConfig + "]";  }}

再次启动利用，这次不报错了，浏览器拜访后果如下图，defaultValue曾经失效
defaultValue属性的主动转换
对于ConfigProperty注解的defaultValue属性还有一点要留神，来看ConfigProperty的源码，如下图，红框显示defaultValue的类型是String
上图中，defaultValue的正文有阐明：如果ConfigProperty注解润饰的变量并非String型，那么defaultValue的字符串就会被主动quarkus字符转换
例如润饰的变量是int型，那么defaultValue的String类型的值会被转为int型再赋给变量，如下所示，notExistsConfig是int型，defaultValue的字符串能够被转为int：
```
// 配置文件中不存在名为not.exists.config的配置项@ConfigProperty(name = "not.exists.config", defaultValue = "123")int notExistsConfig;
```
如果把下面代码中的defaultValue的值从123改为xxx，此时利用启动就会失败，因为“xxx”转为int的过程中抛出了异样，如下图：
除了上面试过的int，还有很多种类型都反对从defaultValue的字符串值被主动转换，它们是：
根底类型：如boolean, byte, short
装箱类型：如java.lang.Boolean, java.lang.Byte, java.lang.Short
Optional类型：java.util.Optional, java.util.OptionalInt, java.util.OptionalLong, and java.util.OptionalDouble
java枚举
java.time.Duration
JDK网络对象：如java.net.SocketAddress, java.net.InetAddress

例如，上面是字符串主动转InetAddress的例子，能够失常运行：

@ConfigProperty(name = "server.address", defaultValue = "192.168.1.1")InetAddress serverAddress;

如果ConfigProperty润饰的变量是boolean型，或者Boolean型，则defaultValue值的主动转换逻辑有些特地： "true", "1", "YES", "Y" "ON"这些都会被转为true(而且不辨别大小写，"on"也被转为true)，其余值会被转为false
还有一处要留神的：defaultValue的值如果是空字符串，就相当于没有设置defaultValue，此时如果在配置文件中没有该配置项，启动利用会报错
反对Optional
反对Optional这个个性很赞，首先Optional类型的成员变量可间接用于函数式编程，其次配置项不存在时又能防止启动失败
接下来试试用ConfigProperty注解润饰Optional类型的成员变量

HobbyResource.java的源码如下，optionalMessage是Optional类型的成员变量，配置项optional.message就算不存在，利用也能失常启动，并且optionalMessage间接用于函数式编程中（optionalMessage.ifPresent）

@Path("/actions")public class HobbyResource {  // 配置文件中存在名为greeting.message的配置项  @ConfigProperty(name = "greeting.message")  String message;  // 配置文件中，不管是否存在名为optional.message的配置项，利用都不会抛出异样  @ConfigProperty(name = "optional.message")  Optional<String> optionalMessage;  @GET  @Produces(MediaType.TEXT_PLAIN)  public String hello() {      List<String> list = new ArrayList<>();      list.add(message);      // 只有配置项optional.message存在的时候，才会执行list.add办法      optionalMessage.ifPresent(list::add);      return "Hello RESTEasy, " + LocalDateTime.now() + ", " + list;  }}

先看配置项optional.message存在的状况，如下图红框所示，optional.message在配置文件中是个失常的配置项
启动利用，浏览器拜访web接口，如下图，optional info是配置项optional.message的值
当初将optional info从文件application.properties中删除，重启利用，再次拜访浏览器，如下图，利用仍然失常响应，list中只有成员变量message的内容：
编码获取配置项
除了用ConfigProperty注解来获取配置项的值，还能够用写代码的形式获取

上面的代码展现了通过API获取配置项的操作，请留神代码中的正文

@Path("/actions")public class HobbyResource {  @GET  @Produces(MediaType.TEXT_PLAIN)  public String hello() {      List<String> list = new ArrayList<>();      // 能够用静态方法获得Config实例      Config config = ConfigProvider.getConfig();      // getValue可获得指定配置项的指定类型值      String greet = config.getValue("greeting.message", String.class);      list.add(greet);      // getOptionalValue能够将配置项的值包状为Optional对象，如果配置项不存在，也不会报错      Optional<String> optional = config.getOptionalValue("not.exists.config", String.class);      // 函数式编程：只用optional中有对象时，才会执行list.add办法      optional.ifPresent(list::add);      return "Hello RESTEasy, " + LocalDateTime.now() + ", " + list;  }}

当配置项not.exists.config不存在时，页面响应如下，只有greeting.message配置项的值：
配置项not.exists.config=123456时，页面响应如下，两个配置项的值都能胜利获取：
另外，官网倡议不要应用System.getProperty(String) 和 System.getEnv(String)去获取配置项了，它们并非quarkus的API，因而quarkus配置相干的性能与它们并无关系（例如感知配置变动、主动转换类型等）
配置接口
假如配置项如下，都是雷同的前缀student

student.name=Tomstudent.age=11student.description=He is a good boy

针对上述配置项，能够用注解ConfigMapping将这些它们集中在一个接口类中获取，接口类StudentConfiguration.java如下

package com.bolingcavalry;import io.smallrye.config.ConfigMapping;import io.smallrye.config.WithDefault;import io.smallrye.config.WithName;@ConfigMapping(prefix = "student")public interface StudentConfiguration {    /**     * 名字与配置项统一     * @return     */    String name();    /**     * 名字与配置项统一，主动转为int型     * @return     */    int age();    /**     * 名字与配置项不统一时，用WithName注解指定配置项     * @return     */    @WithName("description")    String desc();    /**     * 用WithDefault注解设置默认值，如果配置项"student.favorite"不存在，则默认值失效     * @return     */    @WithDefault("default from code")    String favorite();}

从上述代码可见，一个接口即可实现所有配置项的注入，在应用这些配置项的时候，只有注入StudentConfiguration实例即可
首先要用ConfigMapping指明配置项的前缀，该接口中的办法都对应具备此前缀的配置项
个别状况下，办法名就等于配置项的名称，也能够用WithName指定配置项名称
用WithDefault指定默认值，如果找不到配置项就用此默认值
来看看如何应用这个配置接口，web服务代码如下，只有依赖注入StudentConfiguration即可，不在须要为每个配置项都用成员变量和ConfigProperty注解了

package com.bolingcavalry;import javax.inject.Inject;import javax.ws.rs.GET;import javax.ws.rs.Path;import javax.ws.rs.Produces;import javax.ws.rs.core.MediaType;import java.time.LocalDateTime;@Path("/actions")public class HobbyResource {    @Inject    StudentConfiguration student;    @GET    @Produces(MediaType.TEXT_PLAIN)    public String hello() {        return "Hello RESTEasy, "                + LocalDateTime.now()                + " [" + student.name() + "], "                + " [" + student.age() + "], "                + " [" + student.desc() + "], "                + " [" + student.favorite() + "]";    }}

运行代码，用浏览器拜访web接口试试，如下图，所有配置项都能正确获取

配置项是多个单词时，如何对应配置接口的办法？

回顾方才的配置，name、age、description这些都是单个单词，当初如果有个配置项是多个单词，例如学号的英文是student number，应该如何转为StudentConfiguration接口的办法呢？
首先要看您的匹配项的命名格调，对多个单词是如何分隔的，个别有这三种：
减号分隔：student-number
下划线分隔：student_number
驼峰命名：studentNumber
ConfigMapping注解提供了namingStrategy的属性，其值有三种，别离对应上述三种命名格调，您依据本身状况选用即可

KEBAB_CASE（默认值）：减号分隔的配置项转为驼峰命令的办法，配置项student-number对应的办法是studentNumber
SNAKE_CASE：下划线分隔的配置项转为驼峰命令的办法，配置项student_number对应的办法是studentNumber
VERBATIM：齐全对应，不做任何转换，配置项student_number对应的办法是student_number

应用namingStrategy属性的示例代码如下

@ConfigMapping(prefix = "student", namingStrategy = ConfigMapping.NamingStrategy.SNAKE_CASE)public interface StudentConfiguration {    /**     * 名字与配置项统一     * @return     */    String name();    ...

配置接口嵌套

再来看上面的配置，有两个配置项的前缀都是student.address，给人的感觉像是student对象外面有个成员变量是address类型的，而address有两个字段：province和city

student.name=Tomstudent.age=11student.description=He is a good boystudent.address.province=guangdongstudent.address.city=shenzhen

针对上述配置，quarkus反对用接口嵌套来导入，具体做法分为两步，首先新增一个接口Address.java，源码如下

package com.bolingcavalry;public interface Address {    String province();    String city();}

第二步，在配置接口StudentConfiguration.java中，减少下图红框中的一行代码（接口中返回接口，造成接口嵌套）

最初，批改HobbyResource.java代码，减少下图红框中的两行，验证是否失常获得address前缀的配置我的项目

重启利用，如下图，配置项能够失常获取

配置项转为map

后面的接口嵌套，尽管将多层级的配置以对象的模式清晰的表达出来，但也引出一个问题：配置越多，接口定义或者接口办法就越多，代码随之减少
如果配置项的层级简略，还有种简略的形式将其映射到配置接口中：转为map
仍然以上面的配置项为例

student.address.province=guangdongstudent.address.city=shenzhen

对应的代码改变如下图，只有把address办法的返回值从Address改为Map<String, String>即可，这样批改后，address层级上面再减少配置项，也不必批改配置项无关的代码了：

应用配置的业务代码也要改，如下图，改为从map中获取

部署运行验证，能够失常取值

内置配置项

quarkus有很多内置的配置项，例如web服务的端口quarkus.http.port就是其中一个，如果您相熟SpringBoot的话，对这些内置配置项应该很好了解，数据库、音讯、缓存，都有对应配置项
篇幅所限就不在此解说quarkus内置的配置项了，您能够参考这份官网提供的配置项列表，外面有具体阐明：https://quarkus.io/guides/all-config
上述文档中，有很多配置项带有加锁的图标，如下图红框所示，有这个图标的配置项，其值在利用构建的时候曾经固定了，在利用运行期间始终保持只读状态
这种带有加锁图标的配置项的值，在利用运行期间真的不能扭转了吗？其实还是有方法的，官网文档指明，如果业务的状况非凡，肯定要变，就走热部署的路径，您能够参考《quarkus实战之四：近程热部署》
官网对开发者的倡议：在开发quarkus利用的时候，不要应用quarkus作为配置项的前缀，因为目前quarkus框架及其插件们的配置项的前缀都是quarkus，利用开发应该防止和框架应用雷同的配置项前缀，免得抵触
至此，咱们曾经学习了如何在quarkus利用中应用配置项，接下来还会一起实际更多的quarkus基础知识，锁定《quarkus实战》专辑，欣宸不会辜负您的期待

欢送关注思否：程序员欣宸

学习路上，你不孤独，欣宸原创一路相伴...

欢送拜访我的GitHub

本篇概览

演示代码

最根本的配置

配置项不存在导致的异样

带默认值的配置

defaultValue属性的主动转换

反对Optional

编码获取配置项

配置接口

配置项是多个单词时，如何对应配置接口的办法？

配置接口嵌套

配置项转为map

内置配置项

欢送关注思否：程序员欣宸