【Java】初学Vert.x（1）

今天开始将分享自己初学Vert.x的一些经验和看法。里面有不足或想得不周到的地方，还请各位看官多多包涵。为了更贴合实际，本次分享将结合实例进行叙述。实例将提供一个简单的RESTful接口用以收集埋点数据，希望能帮助各位理解。

1. 前言

本人学习Vert.x的初衷是为了找一个Springboot的平替方案。

Spring系列不能说不好，只是这么多年看着它从一个打败EJB的轻量级框架逐渐“发胖”，只感叹“屠龙少年终成恶龙”这并不是我等希望看到的。当然了，Spring团队也意识到这个问题了，后面来了个Springboot，但味儿终究还是变了。

虽然现公司还是用的Springboot，但随着业务扩张带来的“微服务”治理问题大大提升了投入成本，令我一度觉得回归水平扩展的SOA架构也不失为一个较理想的解决方案。“穷”则变变则通，本着“要比Springboot更轻、更快，占用资源更少”这个想法去选型并最终就选择了Vert.x（听上去不太靠谱，但是一开始没有什么方向的时候也只能先这样做了）。

至于Vert.x是什么？这个我就不再多说了，网上的各路大神和官网（https://vertx-china.github.io/）都写得很清楚了。它给我的感受是一开始很惊艳（无论是启动速度上还是性能上）。但用着用着又觉得有点晦涩，毕竟十几年的Spring人很难摆脱Spring的编程风格。而且对于第三方的支持也比Spring少，不支持的第三方对接时还需额外开发。直到现在4.x版本推出后，就觉得很多轻量化的应用直接用Vert.x做，得益于体积小、资源占用少、启动快等优点，Vert.x可以为IoT设备加入一些边缘扩展，对于部分定制化IoT开发非常有帮助。

但话又说回来，企业想使用Vert.x全面替代Springboot也是不太现实的（除非公司的技术选型一开始就是Vert.x，而且招来的开发人员都是响应式开发出身），毕竟在以市场为主导的国内生态，Springboot的地位还是不可撼动的。与其使用较为小众的技术，还不如能快速开发，且社区强大的Springboot回报率更高吧。

2. 结构说明

言归正传，本次是“自我”假设以收集埋点数据为基础需求搭建的，其实就是公开一个对外RESTful接口，让外部调用一下。代码已经上传到Gitee：https://gitee.com/yzh0623/buried-vtx-demo
项目结构如下：

.
|-- pom.xml		# Maven的pom.xml文件
|-- src
|   |-- main
|   |   |-- java
|   |   |   `-- io
|   |   |       `-- kida
|   |   |           |-- App.java	# 启动类
|   |   |           |-- components
|   |   |           |   |-- callback
|   |   |           |   |   `-- BootstrapCallback.java	# 启动回调
|   |   |           |   |-- configs
|   |   |           |   |   |-- BootstrapConfig.java		# 启动配置
|   |   |           |   |   |-- RouterConfig.java				# 路由配置
|   |   |           |   |   `-- YamlConfig.java					# yaml文件工具配置
|   |   |           |   |-- constants
|   |   |           |   |   `-- CommonConstants.java		# 系统常量
|   |   |           |   |-- routers
|   |   |           |   |   `-- RouterSet.java					# 路由通用接口
|   |   |           |   `-- utils
|   |   |           |       |-- db
|   |   |           |       |   `-- JOOQUtil.java				# JOOQ工具
|   |   |           |       |-- http
|   |   |           |       |   |-- IPUtil.java					# IP工具
|   |   |           |       |   `-- RespMsg.java				# 接口返回对象
|   |   |           |       |-- redis			
|   |   |           |       |   `-- RedisUtil.java			# redis客户端
|   |   |           |       |-- ref
|   |   |           |       |   `-- ReflectUtil.java		# ASM映射工具
|   |   |           |       `-- yaml
|   |   |           |           |-- YamlUtil.java				# yaml工具类
|   |   |           |           |-- annotations
|   |   |           |           |   `-- PropLoader.java	# yaml配置注解
|   |   |           |           `-- constants
|   |   |           |               `-- YamlConstants.java	# yaml常量类
|   |   |           |-- model
|   |   |           |   |-- DefaultCatalog.java
|   |   |           |   |-- Indexes.java
|   |   |           |   |-- Keys.java
|   |   |           |   |-- Tables.java
|   |   |           |   |-- Tools.java
|   |   |           |   `-- tables
|   |   |           |       |-- SysUserBuried.java
|   |   |           |       |-- converters
|   |   |           |       |   |-- Bindings.java
|   |   |           |       |   `-- Converters.java
|   |   |           |       |-- daos
|   |   |           |       |   `-- SysUserBuriedDao.java
|   |   |           |       |-- pojos
|   |   |           |       |   `-- SysUserBuried.java
|   |   |           |       `-- records
|   |   |           |           `-- SysUserBuriedRecord.java
|   |   |           |-- router
|   |   |           |   `-- SysUserBuriedRouter.java
|   |   |           `-- service
|   |   |               `-- SysUserBuriedService.java
|   |   `-- resources
|   |       |-- configs																# 配置文件夹
|   |       |   |-- bootstrap.yml											# 启动配置
|   |       |   `-- master														# master分支配置（特意做成类似Springboot的配置模式）
|   |       |       |-- application-datasource.yml		# 数据库配置
|   |       |       `-- application-redis.yml					# redis配置
|   |       |-- db																		# 数据库脚本文件
|   |       |   `-- migrations
|   |       |       `-- V1.0.00001__v20230413.11.23_CREATE_SYS_USER_BURIED.sql
|   |       `-- log4j2.xml														# log4j配置文件
|   `-- test
|       |-- java
|       |   `-- io
|       |       `-- kida
|       |           `-- SysUserBuriedTest.java				# 单元测试类
|       `-- resources
`-- target

项目整体结构如上图所示，在结构上与Springboot极为相似（没办法用了这么多年了，太过于顺手）。Java代码的分层是在io.kida根目录下有一个名为App.java的启动类，分层结构也是io.kida.router独立一层用于真实路由访问也就是Springboot的RestController，io.kida.service独立一层用于逻辑处理。至于io.kida.model是JOOQ组件自己生成的，它将dao、pojo等内容都生成在里面了，不然的话我又会io.kida.dao一层的了…ε=(´ο｀*)))唉。其余的与业务无关的内容都放到io.kida.components一层。

在配置文件方面受Springboot设计影响较深。所有的配置文件都将放在src/main/resources/configs目录底下。其中bootstrap.yml文件为启动配置基础文件，如下图：

server: # 服务器name: buried_vtx_demo # 当前服务名称active: masterport: <<server_port>> # 开放端口context: vtx # 上下文timeout: 120 # eventbus超时时间cron: 30000http:header: # header获取到的变量- x-requested-with- Access-Control-Allow-Origin- Access-Control-Allow-Header- origin- Content-Type- accept- phSessionTokenevent-bus:timeout: 10000 # 毫秒
thread: # 线程配置deploy:init: 16 # 初始化部署线程数max-size: 64 # 最大部署线程数pool-name: vtx-thread-pool # 线程池名称worker: 64 # 程序工作线程数init-pool-size: 32 # 阻塞线程数量，默认20eventloop-pool-size: 128 # Event Loop线程的数量

里面包括server的名称，需要读取的配置文件夹名称，服务端口…至于各个分支不同的配置可以单独提取出来，放到各个以分支命名的文件夹下。如下图：

datasource: # 数据库配置host: <<database_ip>> #数据库地址port: <<database_port>> #数据库端口database-name: tools #操作库名称use-unicode: true #是否使用unicode编码character-encoding: utf8 #文字编码ssl-enable: false # 是否使用安全连接server-timezone: UTC # 指定时区url-head: 'jdbc:mysql:' #jdbc连接头driver-class-name: com.mysql.cj.jdbc.Driver #jdbc驱动类型jooq-name: org.jooq.meta.mysql.MySQLDatabase #数据库方言package-path: io.kida.model # jooq映射路径username: <<username>> #数据库登录用户名password: <<password>> # 数据库登录密码hikari: # hikariCP线程池处理参数（略）is-auto-commit: trueallow-pool-suspension: trueconnection-test-query: SELECT 1pool-name: vtx_hikari_poolminimum-idle: 20maximum-pool-size: 200idle-timeout: 180000connection-timeout: 60000cache-prep-stmts: trueprep-stmt-cache-size: 128prep-stmt-cache-sql-limit: 256use-server-prep-stmts: trueuse-local-session-state: trueuse-local-transaction-state: truerewrite-batched-statements: truecache-result-set-metadata: truecache-server-configuration: trueelide-set-auto-commits: truemaintain-time-stats: falseallow-public-key-retrieval: true

redis: # redis配置max-pool-size: 6000 # 线程池最大线程数max-pool-waiting: -1 # 最大线程池等待时间connection-string: redis://<<redis_ip>>:<<redis_port>>/<<redis_db>> # redis连接地址pool-recycle-timeout: 5000 # 线程池回收超时batch-num: 5000 # 批次处理条数max-waiting-handlers: 7000 # 等待操作

样例里面的数据库配置和redis配置如上图所示。

数据库脚本方面，由于之前是使用了Flyway做数据库版本控制的，但后来因为某些原因没用了。虽然组件没用了，但是脚本存放路径还是保留了src/main/resources/db/migrations。
最后还有log4j2的配置，这里请不要纠结为什么要用log4j，因为当初在学习的时候log4j还没有出事儿呢…只是个Demo还是保留它吧。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="DEBUG"><Properties><Property name="log.level.console">info</Property><Property name="log.path"><<log_path>></Property><Property name="project.name">buried_vtx_demo</Property></Properties><Appenders><Console name="CONSOLE" target="SYSTEM_OUT"><ThresholdFilter level="${log.level.console}"onMatch="ACCEPT" onMismatch="DENY" /><PatternLayoutpattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n" /></Console><RollingFile name="ROLLING_FILE" ignoreExceptions="false"fileName="${log.path}/${project.name}.log"filePattern="${log.path}/$${date:yyyy-MM}/${project.name}-%d{yyyy-MM-dd}-%i.log.gz"><PatternLayoutpattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n" /><Policies><SizeBasedTriggeringPolicy size="300MB" /></Policies><DefaultRolloverStrategy max="100" /></RollingFile></Appenders><Loggers><Root level="${log.level.console}"><AppenderRef ref="CONSOLE" /><AppenderRef ref="ROLLING_FILE" /></Root></Loggers>
</Configuration>

整套项目都是Maven项目，怎么能够不提一下pom.xml呢？

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><groupId>io.kida</groupId><artifactId>buried-vtx-demo</artifactId><version>1.0.0</version><name>buried-vtx-demo</name><description>数据埋点vtx演示</description><properties><encoding.code>UTF-8</encoding.code><project.build.sourceEncoding>${encoding.code}</project.build.sourceEncoding><project.reporting.outputEncoding>${encoding.code}</project.reporting.outputEncoding><vertx.version>3.9.0</vertx.version><junit.version>4.13</junit.version><jooq.version>3.13.2</jooq.version><jooq.rx.version>5.1.1</jooq.rx.version><mysql.version>8.0.19</mysql.version><yaml.version>1.1.3</yaml.version><log4j2.version>2.13.2</log4j2.version><disruptor.version>3.4.2</disruptor.version><jackson.version>4.7.0</jackson.version><reflectasm.version>1.09</reflectasm.version><hikari.version>3.4.5</hikari.version><jdk.version>8</jdk.version><maven.shade.version>2.4.2</maven.shade.version><compiler.version>3.3</compiler.version><main.class>io.kida.App</main.class></properties><dependencies><!-- vertx核心代码包 --><dependency><groupId>io.vertx</groupId><artifactId>vertx-core</artifactId><version>${vertx.version}</version></dependency><!-- vertx web --><dependency><groupId>io.vertx</groupId><artifactId>vertx-web</artifactId><version>${vertx.version}</version></dependency><!-- vertx junit --><dependency><groupId>io.vertx</groupId><artifactId>vertx-unit</artifactId><version>${vertx.version}</version><scope>test</scope></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>${junit.version}</version><scope>test</scope></dependency><!-- vertx redis --><dependency><groupId>io.vertx</groupId><artifactId>vertx-redis-client</artifactId><version>${vertx.version}</version></dependency><!-- vertx jdbc --><dependency><groupId>io.vertx</groupId><artifactId>vertx-jdbc-client</artifactId><version>${vertx.version}</version></dependency><!-- HikariCP --><dependency><groupId>com.zaxxer</groupId><artifactId>HikariCP</artifactId><version>${hikari.version}</version></dependency><!-- yaml配置读取 --><dependency><groupId>io.vertx</groupId><artifactId>vertx-config-yaml</artifactId><version>${vertx.version}</version></dependency><dependency><groupId>io.vertx</groupId><artifactId>vertx-config</artifactId><version>${vertx.version}</version></dependency><!-- log4j2 --><dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-api</artifactId><version>${log4j2.version}</version></dependency><dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-core</artifactId><version>${log4j2.version}</version></dependency><dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-slf4j-impl</artifactId><version>${log4j2.version}</version></dependency><dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-jcl</artifactId><version>${log4j2.version}</version></dependency><dependency><groupId>org.apache.logging.log4j</groupId><artifactId>log4j-jul</artifactId><version>${log4j2.version}</version></dependency><dependency><groupId>com.lmax</groupId><artifactId>disruptor</artifactId><version>${disruptor.version}</version></dependency><!-- jooq --><dependency><groupId>org.jooq</groupId><artifactId>jooq</artifactId><version>${jooq.version}</version></dependency><dependency><groupId>io.github.jklingsporn</groupId><artifactId>vertx-jooq-completablefuture-jdbc</artifactId><version>${jooq.rx.version}</version></dependency><!-- mysql8 连接驱动 --><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>${mysql.version}</version></dependency><!-- jackson --><dependency><groupId>com.englishtown.vertx</groupId><artifactId>vertx-jersey-jackson</artifactId><version>${jackson.version}</version></dependency><!-- reflectasm --><dependency><groupId>com.esotericsoftware.reflectasm</groupId><artifactId>reflectasm</artifactId><version>${reflectasm.version}</version></dependency></dependencies><build><plugins><!-- maven compiler --><plugin><artifactId>maven-compiler-plugin</artifactId><version>${compiler.version}</version><configuration><source>${jdk.version}</source><target>${jdk.version}</target></configuration></plugin><!-- yaml properties maven --><plugin><groupId>it.ozimov</groupId><artifactId>yaml-properties-maven-plugin</artifactId><version>${yaml.version}</version><executions><execution><phase>initialize</phase><goals><goal>read-project-properties</goal></goals><configuration><files><file>src/main/resources/configs/master/application-datasource.yml</file></files></configuration></execution></executions></plugin><!-- jooq codegen --><plugin><groupId>org.jooq</groupId><artifactId>jooq-codegen-maven</artifactId><version>${jooq.version}</version><executions><execution><goals><goal>generate</goal></goals></execution></executions><dependencies><dependency><groupId>io.github.jklingsporn</groupId><artifactId>vertx-jooq-generate</artifactId><version>${jooq.rx.version}</version></dependency></dependencies><configuration><jdbc><driver>${datasource.driver-class-name}</driver><url>${datasource.url-head}//${datasource.host}:${datasource.port}/${datasource.database-name}?useUnicode=${datasource.use-unicode}%26characterEncoding=${datasource.character-encoding}%26useSSL=${datasource.ssl-enable}%26serverTimezone=${datasource.server-timezone}</url><user>${datasource.username}</user><password>${datasource.password}</password></jdbc><generator><name>io.github.jklingsporn.vertx.jooq.generate.completablefuture.CompletableFutureJDBCVertxGenerator</name><database><name>${datasource.jooq-name}</name><includes>.*</includes><excludes>flyway_schema_history</excludes><inputSchema>${datasource.database-name}</inputSchema></database><generate><pojos>true</pojos><javaTimeTypes>true</javaTimeTypes><daos>true</daos><fluentSetters>true</fluentSetters></generate><target><packageName>${datasource.package-path}</packageName><directory>src/main/java</directory></target><strategy><name>io.github.jklingsporn.vertx.jooq.generate.VertxGeneratorStrategy</name></strategy></generator></configuration></plugin><!-- maven shade --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>${maven.shade.version}</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><transformers><transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><manifestEntries><Main-Class>${main.class}</Main-Class></manifestEntries></transformer><transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"><resource>META-INF/services/io.vertx.core.spi.VerticleFactory</resource></transformer></transformers><outputFile>${project.build.directory}/${project.artifactId}-${project.version}-prod.jar</outputFile></configuration></execution></executions></plugin></plugins></build>
</project>

pom文件中用的三个插件需要提一下的，他们分别是yaml-properties-maven-plugin、jooq-codegen-maven和maven-shade-plugin。

先说yaml-properties-maven-plugin，这个插件能让pom中的变量读取配置文件配置，如下图：

<plugin><groupId>it.ozimov</groupId><artifactId>yaml-properties-maven-plugin</artifactId><version>${yaml.version}</version><executions><execution><phase>initialize</phase><goals><goal>read-project-properties</goal></goals><configuration><files><file>src/main/resources/configs/master/application-datasource.yml</file></files></configuration></execution></executions>
</plugin>

如上图所示，execution -> goal中配置了read-project-properties（读取项目配置）参数，在下方就能够通过configuration -> files -> file去指定被读取的文件，这里是“src/main/resources/configs/master/application-datasource.yml”，至于有小伙伴可能会问，这里能不能做成动态的呢？毕竟启动环境不一样路径也不一样。可以的，但是就需要借助一下其他手段了，方法多的是。

配置了yaml-properties-maven-plugin之后，我们怎样将配置文件内容读取到pom里面呢？这时，我们就可以看看jooq-codegen-maven的展示

<!-- jooq -->
<dependency><groupId>org.jooq</groupId><artifactId>jooq</artifactId><version>${jooq.version}</version>
</dependency>
<dependency><groupId>io.github.jklingsporn</groupId><artifactId>vertx-jooq-completablefuture-jdbc</artifactId><version>${jooq.rx.version}</version>
</dependency>......<!-- jooq codegen -->
<plugin><groupId>org.jooq</groupId><artifactId>jooq-codegen-maven</artifactId><version>${jooq.version}</version><executions><execution><goals><goal>generate</goal></goals></execution></executions><dependencies><dependency><groupId>io.github.jklingsporn</groupId><artifactId>vertx-jooq-generate</artifactId><version>${jooq.rx.version}</version></dependency></dependencies><configuration><jdbc><driver>${datasource.driver-class-name}</driver><url>${datasource.url-head}//${datasource.host}:${datasource.port}/${datasource.database-name}?useUnicode=${datasource.use-unicode}%26characterEncoding=${datasource.character-encoding}%26useSSL=${datasource.ssl-enable}%26serverTimezone=${datasource.server-timezone}</url><user>${datasource.username}</user><password>${datasource.password}</password></jdbc><generator><name>io.github.jklingsporn.vertx.jooq.generate.completablefuture.CompletableFutureJDBCVertxGenerator</name><database><name>${datasource.jooq-name}</name><includes>.*</includes><excludes>flyway_schema_history</excludes><inputSchema>${datasource.database-name}</inputSchema></database><generate><pojos>true</pojos><javaTimeTypes>true</javaTimeTypes><daos>true</daos><fluentSetters>true</fluentSetters></generate><target><packageName>${datasource.package-path}</packageName><directory>src/main/java</directory></target><strategy><name>io.github.jklingsporn.vertx.jooq.generate.VertxGeneratorStrategy</name></strategy></generator></configuration>
</plugin>

JOOQ是一个比较优秀的ORM组件，它也能够提供代码生成功能，如上图所示。executions -> execution -> goals -> goal配置成generate表示用于生成代码，在这个基础上加入vertx-jooq-generate依赖。在下方配置jdbc信息。

<configuration><jdbc><driver>${datasource.driver-class-name}</driver><url>${datasource.url-head}//${datasource.host}:${datasource.port}/${datasource.database-name}?useUnicode=${datasource.use-unicode}%26characterEncoding=${datasource.character-encoding}%26useSSL=${datasource.ssl-enable}%26serverTimezone=${datasource.server-timezone}</url><user>${datasource.username}</user><password>${datasource.password}</password></jdbc><generator><name>io.github.jklingsporn.vertx.jooq.generate.completablefuture.CompletableFutureJDBCVertxGenerator</name><database><name>${datasource.jooq-name}</name><includes>.*</includes><excludes>flyway_schema_history</excludes><inputSchema>${datasource.database-name}</inputSchema></database><generate><pojos>true</pojos><javaTimeTypes>true</javaTimeTypes><daos>true</daos><fluentSetters>true</fluentSetters></generate><target><packageName>${datasource.package-path}</packageName><directory>src/main/java</directory></target><strategy><name>io.github.jklingsporn.vertx.jooq.generate.VertxGeneratorStrategy</name></strategy></generator>
</configuration>

在这里面的${datasource.driver-class-name}就是读取配置文件的内容，是不是非常方便呢。在下面只需要配置生成内容和目标路径即可完成自动代码生成配置。如下图；

<generate><pojos>true</pojos><javaTimeTypes>true</javaTimeTypes><daos>true</daos><fluentSetters>true</fluentSetters>
</generate>
<target><packageName>${datasource.package-path}</packageName><directory>src/main/java</directory>
</target>

最后，我们再说一下Vert.x的打包，这里我选用的是maven-shade-plugin插件进行maven打包。通过transformers -> transformer -> manifestEntries -> Main-Class指定启动类，通过outputFile指定宝输出目录和命名。至于META-INF/services/io.vertx.core.spi.VerticleFactory是固定的配置，我这边是没有改的。

3. 开源软件声明

通过上面对pom.xml的介绍大伙儿多多少少都能够看到使用了那些开源组件了