从Java App Engine连接GCP Cloud SQL MySQL：INSTANCE_UNIX_SOCKET解析

问题描述 #

我在Java App Engine项目中连接GCP Cloud SQL MySQL实例时，搞不懂配置代码里的INSTANCE_UNIX_SOCKET参数是什么意思，已经把mysqlsocketfactoryconnector jar添加到项目构建路径了，相关配置代码如下：

import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import javax.sql.DataSource;

public class ConnectorConnectionPoolFactory extends ConnectionPoolFactory {

  // Note: Saving credentials in environment variables is convenient, but not
  // secure - consider a more secure solution such as
  // Cloud Secret Manager to help keep secrets safe.
  private static final String INSTANCE_CONNECTION_NAME =
      System.getenv("INSTANCE_CONNECTION_NAME");
  private static final String INSTANCE_UNIX_SOCKET = System.getenv("INSTANCE_UNIX_SOCKET");
  private static final String DB_USER = System.getenv("DB_USER");
  private static final String DB_PASS = System.getenv("DB_PASS");
  private static final String DB_NAME = System.getenv("DB_NAME");

  public static DataSource createConnectionPool() {
    // The configuration object specifies behaviors for the connection pool.
    HikariConfig config = new HikariConfig();

    // The following URL is equivalent to setting the config options below:
    // jdbc:mysql:///<DB_NAME>?cloudSqlInstance=<INSTANCE_CONNECTION_NAME>&
    // socketFactory=com.google.cloud.sql.mysql.SocketFactory&user=<DB_USER>&password=<DB_PASS>
    // See the link below for more info on building a JDBC URL for the Cloud SQL JDBC Socket Factory

    // Configure which instance and what database user to connect with.
    config.setJdbcUrl(String.format("jdbc:mysql:///%s", DB_NAME));
    config.setUsername(DB_USER); // e.g. "root", "mysql"
    config.setPassword(DB_PASS); // e.g. "my-password"

    config.addDataSourceProperty("socketFactory", "com.google.cloud.sql.mysql.SocketFactory");
    config.addDataSourceProperty("cloudSqlInstance", INSTANCE_CONNECTION_NAME);

    // Unix sockets are not natively supported in Java, so it is necessary to use the Cloud SQL
    // Java Connector to connect. When setting INSTANCE_UNIX_SOCKET, the connector will 
    // call an external package that will enable Unix socket connections.
    // Note: For Java users, the Cloud SQL Java Connector can provide authenticated connections
    // which is usually preferable to using the Cloud SQL Proxy with Unix sockets.
    if (INSTANCE_UNIX_SOCKET != null) {
      config.addDataSourceProperty("unixSocketPath", INSTANCE_UNIX_SOCKET);
    }


    // ... Specify additional connection properties here.
    // ...

    // Initialize the connection pool using the configuration object.
    return new HikariDataSource(config);
  }
}

参数解释 #

INSTANCE_UNIX_SOCKET是一个环境变量，用来指定Unix域套接字的文件路径，核心作用是让Cloud SQL JDBC Socket Factory通过本地Unix套接字来连接Cloud SQL实例，具体细节如下：

• Unix套接字是一种本地进程间通信的方式，不同于TCP/IP通过端口连接，它依赖文件系统中的路径建立连接，在GCP部分托管环境（如App Engine）中，会提供预配置的Unix套接字路径，用于直接访问Cloud SQL实例。
• Java本身不原生支持Unix套接字，所以你引入的mysqlsocketfactoryconnector jar（Cloud SQL Java Connector）会处理底层逻辑：当这个参数不为空时，连接器会调用外部组件启用Unix套接字连接能力，把JDBC的连接通道从默认的TCP/IP切换为本地Unix套接字。
• 这个参数是可选的：代码里的非空判断说明如果不设置它，Cloud SQL Java Connector会自动使用带身份验证的TCP/IP方式连接，这也是官方更推荐的Java连接方案（无需依赖Unix套接字或额外的Cloud SQL Proxy）。

内容的提问来源于stack exchange，提问作者Surya Sikha Rej