Vert.x Console 项目启动与配置教程

1. 项目目录结构及介绍

Vert.x Console 是一个为 Vert.x 应用程序提供的可配置、可扩展的管理控制台。以下是项目的目录结构及其简要介绍：

vertx-console/
├── .gitignore             # Git 忽略文件列表
├── .gitmodules            # Git 子模块配置文件
├── LICENSE                # 项目许可证文件
├── README.md              # 项目说明文件
├── pom.xml                # Maven 项目配置文件
├── vertx-console-base/     # 控制台基础模块
├── vertx-console-circuit-breakers/ # 电路断路器模块
├── vertx-console-eventbus/ # 事件总线模块
├── vertx-console-health/   # 健康检查模块
├── vertx-console-http-clients/ # HTTP 客户端模块
├── vertx-console-logging/  # 日志管理模块
├── vertx-console-metrics/  # 应用性能指标模块
├── vertx-console-pools/    # 连接池模块
├── vertx-console-services/ # 服务发现模块
└── vertx-console-shell/    # 命令行交互模块

• vertx-console-base: 控制台的基础功能模块。
• vertx-console-circuit-breakers: 提供电路断路器状态显示的模块。
• vertx-console-eventbus: 事件总线相关功能模块。
• vertx-console-health: 应用健康检查功能模块。
• vertx-console-http-clients: HTTP 客户端模块。
• vertx-console-logging: 日志管理功能模块。
• vertx-console-metrics: 应用性能指标显示模块。
• vertx-console-pools: 管理不同类型的连接池模块。
• vertx-console-services: 服务发现和显示模块。
• vertx-console-shell: 提供命令行交互的模块。

2. 项目的启动文件介绍

项目的启动主要通过 pom.xml 文件配置。以下是 pom.xml 文件中的一些关键配置：

<dependencies>
    <!-- 控制台基础依赖 -->
    <dependency>
        <groupId>com.github.yunyu.vertx-console</groupId>
        <artifactId>vertx-console-base</artifactId>
        <version>${vertx.console.version}</version>
    </dependency>
    <!-- 其他模块依赖，根据需要添加 -->
</dependencies>

<properties>
    <!-- 定义控制台版本 -->
    <vertx.console.version>ed3ad105f3</vertx.console.version>
</properties>

在应用程序的启动类中，你需要创建一个 WebConsoleRegistry 实例，并添加你希望显示的页面。以下是一个简单的启动示例：

WebConsoleRegistry.create("/admin")
    .addPage(MetricsConsolePage.create(dropwizardRegistry))
    .addPage(ServicesConsolePage.create(discovery))
    .addPage(LoggingConsolePage.create())
    .addPage(CircuitBreakersConsolePage.create())
    .addPage(ShellConsolePage.create())
    .addPage(HealthConsolePage.create(healthChecks))
    .setCacheBusterEnabled(true)
    .mount(vertx, router);

确保你已经正确配置了 Vert.x Web 和相关的页面依赖。

3. 项目的配置文件介绍

项目的配置主要通过 pom.xml 文件进行。在 pom.xml 中，你可以定义项目依赖、插件和属性。以下是一些配置示例：

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<properties>
    <vertx.console.version>ed3ad105f3</vertx.console.version>
</properties>

<dependencies>
    <!-- 控制台基础依赖 -->
    <dependency>
        <groupId>com.github.yunyu.vertx-console</groupId>
        <artifactId>vertx-console-base</artifactId>
        <version>${vertx.console.version}</version>
    </dependency>
    <!-- 根据需要添加其他模块的依赖 -->
</dependencies>

对于性能指标页面 vertx-console-metrics，你需要在启动时配置 Dropwizard Metrics 和 Prometheus：

System.setProperty("vertx.metrics.options.enabled", "true");
System.setProperty("vertx.metrics.options.registryName", "vertx-dw");

MetricRegistry dropwizardRegistry = SharedMetricRegistries.getOrCreate("vertx-dw");

// 然后将 dropwizardRegistry 传递给 MetricsConsolePage.create 方法

确保在生产环境中配置了认证机制和 CSRF 保护，并且开启了 gzip 压缩以优化性能。