文档首页
MySQL Connector/J 开发者指南
相关文档 下载本手册
PDF (US Ltr) - 1.2Mb
PDF (A4) - 1.2Mb


MySQL Connector/J 开发者指南  /  ...  /  X 协议和 X DevAPI

6.3.18 X 协议和 X DevAPI

  • xdevapi.auth

    用于 X 协议的身份验证机制。允许的值为“SHA256_MEMORY”、“MYSQL41”、“PLAIN”和“EXTERNAL”。值不区分大小写。如果未设置该属性,则根据连接类型选择机制:TLS 连接使用“PLAIN”,未加密连接使用“SHA256_MEMORY”或“MYSQL41”。

    默认值 PLAIN
    自版本 8.0.8
  • xdevapi.compression

    X DevAPI 特定的网络流量压缩。此选项接受以下三个值之一:“PREFERRED”、“REQUIRED”和“DISABLED”。将此选项设置为“PREFERRED”或“REQUIRED”将启用连接器和服务器之间的压缩算法协商,并在客户端和服务器就使用的压缩算法达成一致的情况下,启用大型 X 协议包的压缩。如果无法达成一致,则在将选项设置为“REQUIRED”时连接将失败,而在将选项设置为“PREFERRED”时连接将继续而不进行压缩。将此选项设置为“DISABLED”将跳过压缩协商阶段,并禁止客户端和服务器之间交换压缩消息。

    默认值 PREFERRED
    自版本 8.0.20
  • xdevapi.compression-algorithms

    以逗号分隔的压缩算法列表,每个算法都由其名称和操作模式标识(例如“lz4_message”;有关受支持和启用的算法列表,请参阅 MySQL 全局变量“mysqlx_compression_algorithms”的说明),该列表定义了在与服务器协商连接压缩时尝试的顺序和算法。

    本机支持压缩算法“deflate_stream”。其他压缩算法需要使用第三方库并使用连接属性“xdevapi.compression-extensions”启用它们。

    仅当使用连接属性“xdevapi.compression”启用网络流量压缩时,此选项才有意义。

    作为默认算法名称(其中包含对压缩操作模式的引用)的替代方法,可以使用别名“zstd”、“lz4”和“deflate”代替“zstd_stream”、“lz4_message”和“deflate_stream”。

    默认值 zstd_stream,lz4_message,deflate_stream
    自版本 8.0.22
  • xdevapi.compression-extensions

    以逗号分隔的三元组列表,其元素以冒号分隔,用于支持其他压缩算法。每个三元组必须包含:首先,算法名称和操作模式(例如“lz4_message”;有关受支持和启用的算法列表,请参阅 MySQL 全局变量“mysqlx_compression_algorithms”的说明);其次,实现接口“java.io.InputStream”的类的完全限定类名,该类将用于解压缩使用指定算法压缩的数据;第三,实现接口“java.io.OutputStream”的类的完全限定类名,该类将用于使用指定算法压缩数据。除此之外,应用程序的类路径中必须提供包含指定类的实现的库。

    可以提供任意数量的三元组来定义压缩算法及其解压缩器和压缩器实现,但只能使用 MySQL 服务器上受支持和启用的那些。

    本机支持压缩算法“deflate_stream”。其他压缩算法需要使用第三方库。

    仅当使用连接属性“xdevapi.compression”启用网络流量压缩时,此选项才有意义。

    作为默认算法名称(其中包含对压缩操作模式的引用)的替代方法,可以使用别名“zstd”、“lz4”和“deflate”代替“zstd_stream”、“lz4_message”和“deflate_stream”。

    自版本 8.0.22
  • xdevapi.connect-timeout

    X DevAPI 特定的套接字连接超时时间(以毫秒为单位),“0”表示无超时。如果未显式设置“xdevapi.connect-timeout”而设置了“connectTimeout”,则“xdevapi.connect-timeout”将采用“connectTimeout”的值。

    默认值 10000
    自版本 8.0.13
  • xdevapi.connection-attributes

    除了标准 X 协议定义的“key=value”对之外,还要传递给 MySQL 服务器的 X DevAPI 特定用户定义的“key=value”对的逗号分隔列表,以在“PERFORMANCE_SCHEMA”表“session_account_connect_attrs”和“session_connect_attrs”中显示为连接属性。示例用法:“xdevapi.connection-attributes=key1=value1,key2=value2”或“xdevapi.connection-attributes=[key1=value1,key2=value2]”。此功能仅适用于 MySQL 服务器 8.0.16 或更高版本。早期版本的 X 协议不支持连接属性,因此会导致忽略此配置选项。对于会话创建/初始化速度至关重要的情况,设置“xdevapi.connection-attributes=false”将导致绕过连接属性处理。

    自版本 8.0.16
  • xdevapi.dns-srv

    X DevAPI 特定的选项,用于指示驱动程序使用给定的主机名查找 DNS SRV 记录,并在多主机故障转移连接中使用生成的主机列表。请注意,启用此选项时,必须提供单个主机名,并且不提供端口。

    默认值 false
    自版本 8.0.19
  • xdevapi.fallback-to-system-keystore

    X DevAPI 特定的开关,用于指定在未设置“xdevapi.ssl-keystore”(或“clientCertificateKeyStoreUrl”)值的情况下,Connector/J 是否回退到使用通过系统属性“javax.net.ssl.keyStore*”定义的系统范围的密钥库。如果未指定,则使用“fallbackToSystemKeyStore”的值。

    默认值 true
    自版本 8.0.22
  • xdevapi.fallback-to-system-truststore

    X DevAPI 特定的开关,用于指定在未设置“xdevapi.ssl-truststore”(或“trustCertificateKeyStoreUrl”)值的情况下,Connector/J 是否回退到使用系统范围的默认信任库或通过系统属性“javax.net.ssl.trustStore*”定义的信任库。如果未指定,则使用“fallbackToSystemTrustStore”的值。

    默认值 true
    自版本 8.0.22
  • xdevapi.ssl-keystore

    客户端证书密钥库的 X DevAPI 特定 URL。如果未指定,则使用“clientCertificateKeyStoreUrl”值。

    自版本 8.0.22
  • xdevapi.ssl-keystore-password

    客户端证书密钥库的 X DevAPI 特定密码。如果未指定,则使用“clientCertificateKeyStorePassword”值。

    自版本 8.0.22
  • xdevapi.ssl-keystore-type

    客户端证书密钥库的 X DevAPI 特定类型。如果未指定,则使用“clientCertificateKeyStoreType”值。

    默认值 JKS
    自版本 8.0.22
  • xdevapi.ssl-mode

    X DevAPI 特定的 SSL 模式设置。如果未指定,则使用“sslMode”。因为“PREFERRED”模式不适用于 X 协议,所以如果未设置“xdevapi.ssl-mode”而将“sslMode”设置为“PREFERRED”,则会将“xdevapi.ssl-mode”设置为“REQUIRED”。

    默认值 REQUIRED
    自版本 8.0.7
  • xdevapi.ssl-truststore

    受信任 CA 证书密钥库的 X DevAPI 特定 URL。如果未指定,则使用“trustCertificateKeyStoreUrl”值。

    自版本 6.0.6
  • xdevapi.ssl-truststore-password

    受信任 CA 证书密钥库的 X DevAPI 特定密码。如果未指定,则使用“trustCertificateKeyStorePassword”值。

    自版本 6.0.6
  • xdevapi.ssl-truststore-type

    X DevAPI 专用的可信 CA 证书密钥库类型。如果未指定,则使用“trustCertificateKeyStoreType”值。

    默认值 JKS
    自版本 6.0.6
  • xdevapi.tls-ciphersuites

    X DevAPI 专用属性,用于覆盖在基础 SSL 套接字上启用的密码套件。如果未指定,则使用“enabledSSLCipherSuites”的值。

    自版本 8.0.19
  • xdevapi.tls-versions

    X DevAPI 专用属性,它采用一个 TLS 协议列表,用于在创建安全会话时允许使用。覆盖基础 SSL 套接字中启用的 TLS 协议。如果未指定,则使用“tlsVersions”的值。允许的值和默认值为“TLSv1.2”和“TLSv1.3”。

    自版本 8.0.19