引言

Spring Cloud Connectors 库自 2011 年 Cloud Foundry 启动之初就已存在。连接器库和 Cloud Foundry 的 Java buildpack 的主要目标之一是“减少入门 Cloud Foundry 的初始投入”。连接器库会创建连接后端服务（如数据库）所需的 Spring bean 定义，并使用 VCAP_SERVICES 环境变量中包含的信息。然后，buildpack 会通过一个名为“自动重新配置”的功能，将应用程序中的这些 bean 定义替换为连接器库创建的 bean 定义。当您将应用程序推送到 Cloud Foundry 时，您可能在日志中看到过相关的提及…

-----> Downloading Spring Auto Reconfiguration 2.5.0_RELEASE from https://java-buildpack.cloudfoundry.org/auto-reconfiguration/auto-reconfiguration-2.5.0_RELEASE.jar

自动重新配置对于入门非常有用。然而，当您需要更多控制时，例如更改与 DataSource 关联的连接池大小，它就不那么理想了。这需要编写特定于连接器的代码，而且它不像 Spring Boot 那样暴露许多连接池选项。同样的限制也适用于其他后端服务。

这就引出了一个问题：为什么我们有两个竞争机制来创建服务基础设施 bean？我们不能让 Spring Boot 来处理这一切吗？这就是创建我们新的 java-cfenv 库的初衷。

java-cfenv 简介

java-cfenv 库受到了 Cloud Foundry 生态系统中其他地方使用的 node-cfenv 和 py-cfenv 库的启发。这些库提供了简单的 API，用于从 VCAP_SERVICES 环境变量中的 JSON 字符串中检索凭据。我们将从 Java API 的演练开始（我们不期望它会被经常使用），然后展示它如何与 Spring 和 Spring Boot 的自动配置功能集成。

核心 API 由五个类组成

• CfEnv 负责解析 VCAP_SERVICES 和 VCAP_APPLICATION 环境变量的内容。
• CfApplication 提供对 VCAP_APPLICATION 环境变量内容的访问器。
• CfEnv 上的查找方法返回 CfService 类的实例。
• CfService 提供对服务名称、标签、tags 和 plan 的访问器，以及一个 CfCredentials 对象。
• CfCredentials 提供获取用户名、密码、主机、端口和 URI 的访问器。URI 使用 UriInfo 类表示。

例如，如果您将 MySql 服务绑定到 Cloud Foundry 中的应用程序，VCAP_SERVICES 环境变量将包含一个如下所示的条目

{
 "p-mysql": [
    {
      "credentials": {
        "hostname": "10.0.4.35",
        "port": 3306,
        "name": "cf_2e23d10a_8738_8c3c_66cf_13e44422698c",
        "username": "8McHri7aKbuTEGCR",
        "password": "J2BNJYkeXAH9idkG",
        "uri": "mysql://8McHri7aKbuTEGCR:[email protected]:3306/cf_2e23d10a_8738_8c3c_66cf_13e44422698c?reconnect=true",
        "jdbcUrl": "jdbc:mysql://10.0.4.35:3306/cf_2e23d10a_8738_8c3c_66cf_13e44422698c?user=8McHri7aKbuTEGCR&password=J2BNJYkeXAH9idkG"
      },
      "syslog_drain_url": null,
      "volume_mounts": [],
      "label": "p-mysql",
      "provider": null,
      "plan": "100mb",
      "name": "mysql",
      "tags": [
        "mysql",
        "relational"
      ]
    }
  ]
}

使用 java-cfenv API 时，我们可以通过几次简单的函数调用来获取凭据信息，然后以编程方式创建与数据库的连接。

CfEnv cfEnv = new CfEnv();
CfService cfService = cfEnv.findServiceByName(“mysql”);
String plan = cfService.getPlan(); // 100mb
CfCredentials cfCredentials = cfService.getCredentials();
String password = cfCredentials.getPassword(); // J2BNJYkeXAH9idkG
UriInfo uriInfo = cfCredentials.getUriInfo();
String username = uriInfo.getUsername(); // 8McHri7aKbuTEGCR

findServiceByName 方法接受一个正则表达式，以帮助在可能以略微不同的方式命名服务的不同 Cloud Foundry 环境之间提供一些可移植性。还有其他查找方法，可以帮助您从 tags 和 labels 等中进行选择。

数据库支持

在前面的示例中，您可能只想获取 jdbcUrl JSON 字段，以便将其传递给 DataSource。您可以使用 API 来完成此操作

String jdbcUrl = cfCredentials.getString(“jdbcUrl”);

然而，并非 Cloud Foundry 上的所有数据库服务都提供此方便的字段。事实上，Cloud Foundry 上各种数据库服务提供的字段可能相当随意。现有的连接器库已开发出启发式方法来处理这种差异，并且此功能已移植到新的 java-cfenv 库中。它在 CfEnvJdbc 类中可用

CfEnvJdbc cfEnvJdbc = new CfEnvJdbc();
CfJdbcService cfJdbcService = cfEnvJdbc.findJdbcService();
String jdbcUrl = cfJdbcService.getUrl();

如果应用程序绑定了多个数据库服务，findJdbcService 方法将抛出异常。在这种情况下，您可以使用 findJdbcServiceByName 方法在多个数据库服务之间进行选择。

String jdbcUrl1 = cfEnvJdbc.findJdbcServiceByName('mysqlA').getUrl();
String jdbcUrl2 = cfEnvJdbc.findJdbcServiceByName('mysqlB').getUrl();

与 Spring 结合使用

如果您正在使用 Spring 而不是 Spring Boot，您可以将 CfJdbcEnv 实例注册为 bean，然后使用 Spring 表达式语言调用其方法来设置应用程序属性。

@Bean
public CfJdbcEnv cfJdbcEnv() {
  return new CfJdbcEnv();
}

然后，在属性文件中，访问 CfJdbcEnv 实例

myDatasourceUrl=#{ cfJdbcEnv.findJdbcService().getUrl() }

与 Spring Boot 结合使用

大多数 Spring Boot 用户无需直接使用 java-cfenv API。java-cfenv 库包含 Spring Boot EnvironmentPostProcessor 实现，这些实现会自动设置众所周知的 Spring Boot 属性。这使得 Spring Boot 的自动配置能够生效，同时仍然可以从环境变量或其他优先级更高的环境属性源覆盖值。

从 start.spring.io 生成项目后，您需要做的就是将 java-cfenv-boot 依赖项手动添加到项目中，并在将应用程序推送到 Cloud Foundry 时禁用自动重新配置。对于 maven，依赖项是

<dependency>
  <groupId>io.pivotal.cfenv</groupId>
  <artifactId>java-cfenv-boot</artifactId>
  <version>1.0.0.M1</version>
</dependency>

由于这目前是一个里程碑版本，您需要添加一个里程碑 <repository> 配置，例如

<repository>
   <id>spring-milestones</id>
   <name>Spring Milestones</name>
   <url>http://repo.spring.io/libs-milestone-local</url>
</repository>

要禁用自动重新配置，请使用以下命令或其在 manifest 文件中的等效命令。

cf set-env <APP> JBP_CONFIG_SPRING_AUTO_RECONFIGURATION '{enabled: false}'

由于自动重新配置还会设置许多应用程序已依赖的 cloud profile，因此您可能还需要显式设置此 profile。

cf set-env <APP> SPRING_PROFILES_ACTIVE cloud

如果您使用的是 manifest 文件，条目将是

env:
 SPRING_PROFILES_ACTIVE: cloud
 JBP_CONFIG_SPRING_AUTO_RECONFIGURATION: '{enabled: false}'

值得注意的是，在生产环境中，您很可能也应该这样做。

要设置连接池属性，您现在可以使用标准的 Spring Boot 属性，如 spring.datasource.maxActive=10 以及其他更具体的连接池属性。

下一步是什么？

有关如何使用 java-cfenv 库的更多信息，请访问 GitHub。当前版本是 1.0.0.M1，并且将很快发布 GA 版本，因为它将于本月晚些时候纳入 Data Flow 2.0 GA 版本。一如既往，我们欢迎您的反馈和贡献，即使它们导致需要合并到 java-cfenv 2.0 版本中的 API 更改（紧随 1.0 版本之后）。

java-cfenv 的 1.0 GA 版本将支持 Spring Cloud Connectors 项目中包含的所有服务，因为它们得到了 Spring Boot 自动配置的良好支持。届时，现有的 Connectors 库将进入维护模式。 当然，关键错误和安全问题将得到解决，但不会添加新功能。在 java-cfenv 1.0 GA 版本发布时，将提供一份将应用程序从 Spring Cloud Connectors 迁移到 java-cfenv 的指南。

项目页面上列出了基于核心 Connectors 项目的其他库。这些扩展项目可以继续使用 Connectors，但我们鼓励维护者迁移到以 Boot 为中心的方法。