Key Management Service:Secrets JDBC クライアント

注意事項

• サポートされるシークレットタイプ: 汎用シークレットと RDS シークレット。

  • RDS シークレットを使用する場合は、デュアルアカウントで管理される RDS シークレットを使用することをお勧めします。

  • 汎用シークレットを使用する場合、シークレット値は次の JSON フォーマットである必要があります。

    {
        "AccountName":"<your_database_account_username>",
        "AccountPassword":"<your_database_account_password>"
    }

• サポートされるプログラミング言語: Java 8 以降。

• サポートされるデータベース接続プール: c3p0、DBCP、および Druid。

  重要

  Spring Boot のデフォルトの HikariCP 接続プールは、JDBC エラーコードを標準的な方法で処理しません。これにより、KMS シークレットのリフレッシュが失敗する可能性があります。

シナリオ 1: 共有ゲートウェイを使用してシークレット値を取得する

インターネットまたは VPC (Virtual Private Cloud) を使用できます。サポートされている RAM ベースの認証方式には、Elastic Compute Service (ECS) インスタンスのインスタンス RAM ロール、RamRoleArn、セキュリティトークンサービス (STS) トークン、および AccessKey が含まれます。詳細については、「アクセス資格情報の管理」をご参照ください。

シナリオ 2: 専用ゲートウェイを使用してシークレット値を取得する (非推奨)

このシナリオでは、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 {
          // Alibaba Cloud secrets JDBC クライアント 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();
          }
      }
  }

• SQL Server データベース

  説明

  サンプルコードの #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{
          // Alibaba Cloud secrets JDBC クライアント 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 {
          // Alibaba Cloud secrets JDBC クライアント 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{
  		// Alibaba Cloud secrets JDBC クライアント 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.properties 構成ファイルで c3p0.user、c3p0.driverClass、および c3p0.jdbcUrl を設定します。c3p0.user をシークレットの名前に設定し、c3p0.driverClass を Alibaba Cloud secrets JDBC ドライバークラスの名前に設定します。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>

• SQL Server データベース

  説明

  サンプルコードの #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>

データソースを使用してデータベースに接続する

この例では、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 データベースを使用します。構成ファイルで次のプロパティを変更する必要があります。

• プロパティ構成ファイルの使用

  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 構成の使用

  • 方法 1: 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>
    

  • 方法 2: プロパティインジェクション

    アプリケーションでドライバークラスを作成して、データベース接続情報をロードします。

    @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;
        }
    }