Key Management Service：憑據JDBC用戶端

注意事項

• 支援的憑據類型：通用憑據、RDS憑據。

  • 如果是RDS憑據，建議您使用雙帳號託管的RDS憑據。

  • 如果是通用憑據，憑據值為JSON格式且內容格式如下。

    {
        "AccountName":"<您的資料庫帳號使用者名稱>",
        "AccountPassword":"<您的資料庫帳號密碼>"
    }

• 支援的開發語言：Java（Java 8及以上版本）。

• 支援的資料庫連接池：c3p0、DBCP 和 Druid。

  重要

  Spring Boot 預設的 HikariCP 串連池存在 JDBC 錯誤碼處理不規範問題，可能導致 KMS 憑據重新整理失敗。

情境一：通過共用網關擷取憑據值

網路類型為公網或VPC網路。支援ECS執行個體RAM角色、RamRoleArn、STS Token、AccessKey等基於RAM的身份認證方式。詳細內容，請參見管理訪問憑據。

情境二：通過專屬網關擷取憑據值（不推薦）

網路類型為KMS私人網路。訪問憑證僅支援ClientKey。

通過JDBC方式串連資料庫

• MySQL資料庫

  說明

  請將#your-mysql-secret-name#、<your-mysql-ip>、<your-mysql-port>、<your-database-name>替換為您實際使用的憑據名稱、伺服器IP地址、連接埠、資料庫名稱。

  import java.sql.Connection;
  import java.sql.DriverManager;
  import java.sql.SQLException;
  
  public class SecretManagerJDBCSample {
      public static void main(String[] args) throws Exception {
          // 載入阿里雲憑據JDBC用戶端 Load the JDBC Driver com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver
          Class.forName("com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver");
          Connection connect = null;
          try {
              connect = DriverManager.getConnection("secrets-manager:mysql://<your-mysql-ip>:<your-mysql-port>/<your-database-name>", "#your-mysql-secret-name#","");
          } catch(SQLException e) {
              e.printStackTrace();
          }
      }
  }

• SQLServer資料庫

  說明

  請將#your-sqlserver-secret-name#、<your-sqlserver-ip>、<your-sqlserver-port>、<your-database-name>替換為您實際使用的憑據名稱、伺服器IP地址、連接埠、資料庫名稱。

  import java.sql.Connection;
  import java.sql.DriverManager;
  import java.sql.SQLException;
  
  public class SecretManagerJDBCSqlServerSample {
  
      public static void main(String[] args) throws Exception{
          // 載入阿里雲憑據JDBC用戶端 Load the JDBC Driver com.aliyun.kms.secretsmanager.MssqlSecretsManagerSimpleDriver
          Class.forName("com.aliyun.kms.secretsmanager.MssqlSecretsManagerSimpleDriver");
          Connection connect = null;
          try {
              connect = DriverManager.getConnection("secrets-manager:sqlserver://<your-sqlserver-ip>:<your-sqlserver-port>;databaseName=<your-database-name>", "#your-sqlserver-secret-name#", "");
          }  catch (SQLException e) {
              e.printStackTrace();
          }
      }
  }

• PostgreSQL資料庫

  說明

  請將#your-postgresql-secret-name#、<your-postgresql-ip>、<your-postgresql-port>、<your-database-name>替換為您實際使用的憑據名稱、伺服器IP地址、連接埠、資料庫名稱。

  import java.sql.Connection;
  import java.sql.DriverManager;
  import java.sql.SQLException;
  
  public class SecretManagerJDBCPostgreSQLSample {
      public static void main(String[] args) throws Exception {
          // 載入阿里雲憑據JDBC用戶端 Load the JDBC Driver com.aliyun.kms.secretsmanager.PostgreSQLSecretManagerSimpleDriver
          Class.forName("com.aliyun.kms.secretsmanager.PostgreSQLSecretManagerSimpleDriver");
          Connection connect = null;
          try {
              connect = DriverManager.getConnection("secrets-manager:postgresql://<your-postgresql-ip>:<your-postgresql-port>/<your-database-name>", "#your-postgresql-secret-name#", "");
          } catch (SQLException e) {
              e.printStackTrace();
          }
      }
  }

• MariaDB資料庫

  說明

  請將#your-mariadb-secret-name#、<your-mariadb-ip>、<your-mariadb-port>、<your-database-name>替換為您實際使用的憑據名稱、伺服器IP地址、連接埠、資料庫名稱。

  import java.sql.Connection;
  import java.sql.DriverManager;
  import java.sql.SQLException;
  
  public class SecretManagerJDBCMarialDBSample {
  
  	public static void main(String[] args) throws Exception{
  		// 載入阿里雲憑據JDBC用戶端 Load the JDBC Driver com.aliyun.kms.secretsmanager.MariaDBSecretManagerSimpleDriver
  		Class.forName("com.aliyun.kms.secretsmanager.MariaDBSecretManagerSimpleDriver");
  		Connection connect = null;
  		try {
  			connect = DriverManager.getConnection("secrets-manager:mariadb://<your-mariadb-ip>:<your-mariadb-port>/<your-database-name>", "#your-mariadb-secret-name#", "");
  		}  catch (SQLException e) {
  			e.printStackTrace();
  		}
  	}
  }

通過資料庫連接池串連資料庫

請按如下方式設定c3p0設定檔（c3p0.properties）中的c3p0.user、c3p0.driverClass和c3p0.jdbcUrl。c3p0.user為憑據名稱，c3p0.driverClass為阿里雲憑據JDBC Driver類名稱，c3p0.jdbcUrl需要以secrets-manager開頭。

• MySQL資料庫

  說明

  請將#your-mysql-secret-name#、<your-mysql-ip>、<your-mysql-port>、<your-database-name>替換為您實際使用的憑據名稱、伺服器IP地址、連接埠、資料庫名稱。

  c3p0.user=#your-mysql-secret-name#
  c3p0.driverClass=com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver
  c3p0.jdbcUrl=secrets-manager:mysql://<your-mysql-ip>:<your-mysql-port>/<your-database-name>

• SQLServer資料庫

  說明

  請將#your-sqlserver-secret-name#、<your-sqlserver-ip>、<your-sqlserver-port>、<your-database-name>替換為您實際使用的憑據名稱、伺服器IP地址、連接埠、資料庫名稱。

  c3p0.user=#your-sqlserver-secret-name#
  c3p0.driverClass=com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver
  c3p0.jdbcUrl=secrets-manager:sqlserver://<your-sqlserver-ip>:<your-sqlserver-port>/<your-database-name>

• PostgreSQL資料庫

  說明

  請將#your-postgresql-secret-name#、<your-postgresql-ip>、<your-postgresql-port>、<your-database-name>替換為您實際使用的憑據名稱、伺服器IP地址、連接埠、資料庫名稱。

  c3p0.user=#your-postgresql-secret-name#
  c3p0.driverClass=com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver
  c3p0.jdbcUrl=secrets-manager:postgresql://<your-postgresql-ip>:<your-postgresql-port>/<your-database-name>

• MariaDB資料庫

  說明

  請將#your-mariadb-secret-name#、<your-mariadb-ip>、<your-mariadb-port>、<your-database-name>替換為您實際使用的憑據名稱、伺服器IP地址、連接埠、資料庫名稱。

  c3p0.user=#your-mariadb-secret-name#
  c3p0.driverClass=com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver
  c3p0.jdbcUrl=secrets-manager:mariadb://<your-mariadb-ip>:<your-mariadb-port>/<your-database-name>

通過資料來源（DataSource）串連資料庫

以使用c3p0 ComboPooledDataSource、MySQL資料庫為例，在Spring設定檔中增加如下配置。

<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource" >
      <property name="driverClass" value="com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver" />
      <property name="user" value="#your-mysql-secret-name#" />
      <property name="jdbcUrl" value="secrets-manager:mysql://<your-mysql-ip>:<your-mysql-port>/<your-database-name>" />
      <property name="maxPoolSize" value="***" />
      <property name="minPoolSize" value="***" />
      <property name="initialPoolSize" value="***" />
  </bean>
  <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate" >
      <property name="dataSource" ref="dataSource" />
  </bean>

通過Druid串連池串連資料庫

以MySQL資料庫為例，您需要修改設定檔中的如下屬性。

• properties設定檔方式

  username=#your-mysql-secret-name#
  driverClassName=com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver
  url=secrets-manager:mysql://<your-mysql-ip>:<your-mysql-port>/<your-database-name>

• bean配置方式

  • 方式一：XML設定檔

    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close"> 
         <property name="username" value="${your-mysql-secret-name}" />
         <property name="driverClassName" value="com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver" />
         <property name="url" value="secrets-manager:mysql://<your-mysql-ip>:<your-mysql-port>/<your-database-name>" />
    </bean>
    

  • 方式二：配置屬性注入

    在應用中建立一個載入資料庫連接資訊的驅動類。

    @Configuration
    public class DataConfig {
    
        @Value("${your-mysql-secret-name}")
        private String username;
    
        @Value("com.aliyun.kms.secretsmanager.MysqlSecretsManagerSimpleDriver")
        private String driverClassName;
    
        @Value("secrets-manager:mysql://<your-mysql-ip>:<your-mysql-port>/<your-database-name>")
        private String url;
    
        @Bean(name = "dataSource",initMethod = "init",destroyMethod = "close")
        public DruidDataSource dataSource(){
            DruidDataSource druidDataSource = new DruidDataSource();
            druidDataSource.setUsername(username);
            druidDataSource.setDriverClassName(driverClassName);
            druidDataSource.setUrl(url);
            return druidDataSource;
        }
    }