文件首頁
MySQL Connector/J 開發人員指南
相關文件 下載本手冊
PDF (美國信紙) - 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」配對之外,X DevAPI 特有的以逗號分隔的使用者定義「key=value」配對清單,將傳遞到 MySQL 伺服器,以在「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 Protocol,因此若未設定 '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

    受信任的 CA 憑證金鑰儲存區的 X DevAPI 特定類型。若未指定,則使用 'trustCertificateKeyStoreType' 的值。

    預設值 JKS
    起始版本 6.0.6
  • xdevapi.tls-ciphersuites

    覆寫基礎 SSL Socket 上啟用之加密套件的 X DevAPI 特定屬性。若未指定,則使用 'enabledSSLCipherSuites' 的值。

    起始版本 8.0.19
  • xdevapi.tls-versions

    X DevAPI 特定屬性,用於指定建立安全連線時允許的 TLS 通訊協定清單。會覆寫基礎 SSL Socket 中啟用的 TLS 通訊協定。若未指定,則改為使用 'tlsVersions' 的值。允許的預設值為 "TLSv1.2" 和 "TLSv1.3"。

    起始版本 8.0.19