凭据 JDBC 客户端

注意事项

• 支持的凭据类型：通用凭据、RDS凭据。

  • 如果是 RDS 凭据，建议你使用双账号托管的 RDS 凭据。

  • 如果是通用凭据，凭据值为 JSON 格式且内容格式如下。

    {
        "AccountName":"<您的数据库账号用户名>",
        "AccountPassword":"<您的数据库账号密码>"
    }

• 支持的开发语言：Java（Java 8 及以上版本）。

• 支持的数据库连接池：c3p0、DBCP、HikariCP 和 Druid。

场景一：通过共享网关获取凭据值

网络类型为公网或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;
        }
    }