跳到主要内容
跳到主要内容

Java 客户端概述

ClickHouse 客户端

Java 客户端是一个实现自己 API 的库,抽象了与 ClickHouse 服务器的网络通信细节。目前仅支持 HTTP 接口。该库提供了处理不同 ClickHouse 格式和其他相关功能的实用工具。

Java 客户端早在 2015 年就已开发。它的代码库变得非常难以维护,API 令人困惑,进一步优化变得困难。因此,我们在 2024 年对其进行了重构,形成了一个新组件 client-v2。它具有清晰的 API、更轻的代码库和更多的性能改进,更好地支持 ClickHouse 格式(主要是 RowBinary 和 Native)。JDBC 将在不久的将来使用此客户端。

支持的数据类型

数据类型客户端 V2 支持客户端 V1 支持
Int8
Int16
Int32
Int64
Int128
Int256
UInt8
UInt16
UInt32
UInt64
UInt128
UInt256
Float32
Float64
Decimal
Decimal32
Decimal64
Decimal128
Decimal256
Bool
String
FixedString
Nullable
Date
Date32
DateTime
DateTime32
DateTime64
Interval
Enum
Enum8
Enum16
Array
Map
Nested
Tuple
UUID
IPv4
IPv6
Object
Point
Nothing
MultiPolygon
Ring
Polygon
SimpleAggregateFunction
AggregateFunction
Variant
Dynamic
JSON

ClickHouse 数据类型

备注
  • AggregatedFunction - ⚠️ 不支持 SELECT * FROM table ...
  • Decimal - SET output_format_decimal_trailing_zeros=1 在 21.9+ 中以保持一致性
  • Enum - 可以被视为字符串和整数
  • UInt64 - 在 client-v1 中映射为 long

特性

客户端特性的表格:

名称客户端 V2客户端 V1备注
Http 连接
Http 压缩 (LZ4)
服务器响应压缩 - LZ4
客户端请求压缩 - LZ4
HTTPS
客户端 SSL 证书 (mTLS)
Http 代理
POJO 序列化与反序列化
连接池当使用 Apache HTTP Client 时
命名参数
失败时重试
故障转移
负载均衡
服务器自动发现
日志注释
会话角色
SSL 客户端身份验证
会话时区

JDBC 驱动程序继承与底层客户端实现相同的特性。其他 JDBC 特性列在其 页面 上。

兼容性

  • 此仓库中的所有项目都与所有 活动 LTS 版本 的 ClickHouse 进行了测试。
  • 支持政策
  • 我们建议不断升级客户端,以免错过安全修复和新改进。
  • 如果您在迁移到 v2 API 时遇到问题 - 创建一个问题,我们会作出回应!

日志记录

我们的 Java 语言客户端使用 SLF4J 进行日志记录。您可以使用任何与 SLF4J 兼容的日志框架,例如 LogbackLog4j。 例如,如果您使用 Maven,您可以在 pom.xml 文件中添加以下依赖:

<dependencies>
    <!-- SLF4J API -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>2.0.16</version> <!-- Use the latest version -->
    </dependency>

    <!-- Logback Core -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-core</artifactId>
        <version>1.5.16</version> <!-- Use the latest version -->
    </dependency>

    <!-- Logback Classic (bridges SLF4J to Logback) -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.5.16</version> <!-- Use the latest version -->
    </dependency>
</dependencies>

配置日志记录

这将取决于您使用的日志框架。例如,如果您使用 Logback,您可以在名为 logback.xml 的文件中配置日志记录:

<configuration>
    <!-- Console Appender -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>[%d{yyyy-MM-dd HH:mm:ss}] [%level] [%thread] %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- File Appender -->
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>logs/app.log</file>
        <append>true</append>
        <encoder>
            <pattern>[%d{yyyy-MM-dd HH:mm:ss}] [%level] [%thread] %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- Root Logger -->
    <root level="info">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>

    <!-- Custom Log Levels for Specific Packages -->
    <logger name="com.clickhouse" level="info" />
</configuration>

变更日志