Cayenne 4.1：单一运行时中配置多个数据节点的高级指南

本文详细介绍了在cayenne 4.1应用中，如何在不创建多个`serverruntime`实例的情况下，配置并管理多个具有不同url和凭据的数据源（datanode）。主要涵盖了两种方法：通过`serverruntime.builder()`进行声明式属性配置，以及实现自定义`datasourcefactory`以获得更精细的控制。这两种方法都能帮助开发者在单一运行时环境中高效地集成和管理多数据库连接。

在现代企业级应用中，一个应用连接多个数据库实例是常见需求。例如，可能需要连接一个主业务数据库和一个日志数据库，或者连接不同部门的独立数据库。Cayenne ORM框架提供了灵活的机制来支持这种场景，允许开发者在单个ServerRuntime实例中配置和管理多个具有不同连接参数（URL、用户名、密码等）的数据节点（DataNode），从而避免了创建多个运行时实例所带来的资源开销和管理复杂性。

方法一：通过运行时属性进行配置

Cayenne允许通过ServerRuntime.builder()在程序启动时动态地贡献配置属性。这种方式适用于数据节点配置相对固定，或者需要从外部源（如配置文件、环境变量）加载连接参数的场景。

实现步骤：

NetGou网店购物系统

NetGou是一款国内知名的购物系统网店系统，它功能强大完善、运行稳定快速、界面友好人性化、可扩展性强。系统支持无限级商品分类管理、商品品牌管理、商品供货商管理、商品可同时加入多个商品分类商品批发价格，购买不同的商品数量可以设置不同的价格。不同的商品选项可以设置不同的价格订单中可以加入商品、删除商品、更改商品数量和价格、更改配送方式和配送费用新闻管理、销售统计、数据备份恢复，不同的会员等级可以设置

下载

1. 在构建ServerRuntime时，使用addModule方法添加一个自定义模块。
2. 在该模块中，通过ServerModule.contributeProperties()方法贡献与数据节点相关的连接属性。

示例代码：

以下代码展示了如何为名为 project 的项目配置两个不同的数据节点 node1 和 node2，它们分别连接到不同的JDBC URL：

import org.apache.cayenne.configuration.server.ServerModule;
import org.apache.cayenne.configuration.server.ServerRuntime;

public class MultiDataNodeConfig {

    public static void main(String[] args) {
        ServerRuntime runtime = ServerRuntime.builder()
                .addModule(b -> ServerModule.contributeProperties(b)
                        // 配置 project 项目下 node1 数据节点的 JDBC URL
                        .put("cayenne.jdbc.url.project.node1", "jdbc:mysql://localhost:3306/db1?useSSL=false")
                        // 配置 project 项目下 node1 数据节点的驱动类
                        .put("cayenne.jdbc.driver.project.node1", "com.mysql.cj.jdbc.Driver")
                        // 配置 project 项目下 node1 数据节点的用户名
                        .put("cayenne.jdbc.username.project.node1", "user1")
                        // 配置 project 项目下 node1 数据节点的密码
                        .put("cayenne.jdbc.password.project.node1", "password123")

                        // 配置 project 项目下 node2 数据节点的 JDBC URL
                        .put("cayenne.jdbc.url.project.node2", "jdbc:postgresql://localhost:5432/db2")
                        // 配置 project 项目下 node2 数据节点的驱动类
                        .put("cayenne.jdbc.driver.project.node2", "org.postgresql.Driver")
                        // 配置 project 项目下 node2 数据节点的用户名
                        .put("cayenne.jdbc.username.project.node2", "user2")
                        // 配置 project 项目下 node2 数据节点的密码
                        .put("cayenne.jdbc.password.project.node2", "secure_pass")
                )
                .build();

        // 此时，runtime 实例已包含配置好的两个数据节点
        // 可以通过 DataContext 获取并使用它们
        // DataContext dataContext = runtime.newDataContext();
        // ...
        runtime.shutdown();
    }
}

注意事项：

• 属性的命名遵循 cayenne.jdbc.[property].[project_name].[node_name] 的格式。其中 [property] 可以是 url、driver、username、password 等。
• 这种方法适用于在代码中直接指定或从外部加载配置，配置逻辑集中且易于管理。

方法二：实现自定义 DataSourceFactory

当需要更复杂的连接池管理、动态数据源选择、或者与现有数据源管理系统集成时，实现自定义DataSourceFactory是更强大的选择。通过这种方式，您可以完全控制数据源的创建过程。

实现步骤：

1. 创建一个Java类，实现org.apache.cayenne.datasource.DataSourceFactory接口。
2. 在getDataSource(DataNodeDescriptor nd)方法中，根据传入的DataNodeDescriptor（数据节点描述符）来创建并返回一个javax.sql.DataSource实例。
3. 在Cayenne Modeler中，为每个数据节点配置其“DataSource Factory”属性，指向您的自定义工厂类。

示例代码：

以下是一个自定义DataSourceFactory的骨架，它展示了如何根据DataNodeDescriptor中的信息构建数据源：

import org.apache.cayenne.configuration.server.DataSourceFactory;
import org.apache.cayenne.configuration.server.ServerRuntime;
import org.apache.cayenne.di.Inject;
import org.apache.cayenne.map.DataNodeDescriptor;
import org.apache.cayenne.map.DataSourceInfo;
import org.apache.cayenne.util.Util;
import org.apache.cayenne.di.Injector; // 可能需要，取决于如何获取对象工厂

import javax.sql.DataSource;
import java.sql.Driver;
import java.util.Properties;

// 假设我们使用一个简单的连接池构建器
// 实际生产环境可能使用 HikariCP, c3p0, Druid等
class DataSourceBuilder {
    private String url;
    private Driver driver;
    private String userName;
    private String password;
    private int minConnections = 1;
    private int maxConnections = 10;
    private long maxQueueWaitTime = 30000; // 30 seconds
    private String validationQuery;

    public static DataSourceBuilder url(String url) {
        DataSourceBuilder builder = new DataSourceBuilder();
        builder.url = url;
        return builder;
    }

    public DataSourceBuilder driver(Driver driver) {
        this.driver = driver;
        return this;
    }

    public DataSourceBuilder userName(String userName) {
        this.userName = userName;
        return this;
    }

    public DataSourceBuilder password(String password) {
        this.password = password;
        return this;
    }

    public DataSourceBuilder pool(int min, int max) {
        this.minConnections = min;
        this.maxConnections = max;
        return this;
    }

    public DataSourceBuilder maxQueueWaitTime(long time) {
        this.maxQueueWaitTime = time;
        return this;
    }

    public DataSourceBuilder validationQuery(String query) {
        this.validationQuery = query;
        return this;
    }

    public DataSource build() {
        // 这是一个简化的示例，实际中会使用成熟的连接池库
        // 例如 HikariCP, c3p0, Druid等
        org.apache.commons.dbcp2.BasicDataSource basicDataSource = new org.apache.commons.dbcp2.BasicDataSource();
        basicDataSource.setUrl(url);
        basicDataSource.setDriver(driver);
        basicDataSource.setUsername(userName);
        basicDataSource.setPassword(password);
        basicDataSource.setMinIdle(minConnections);
        basicDataSource.setMaxTotal(maxConnections);
        basicDataSource.setValidationQuery(validationQuery);
        // 其他连接池配置...
        return basicDataSource;
    }
}


public class MyDataSourceFactory implements DataSourceFactory {

    @Inject
    private Injector injector; // 用于获取其他DI对象，如ObjectFactory

    @Override
    public DataSource getDataSource(DataNodeDescriptor nd) throws Exception {
        DataSourceInfo info = nd.getDataSourceDescriptor();

        // 可以使用 DataSourceInfo 中的配置，也可以根据 DataNodeDescriptor 的名称或其他属性进行自定义
        // 例如，根据 nd.getName() 来决定连接到哪个数据库
        String url = info.getDataSourceUrl();
        String driverClass = info.getJdbcDriver();
        String username = info.getUserName();
        String password = info.getPassword();

        // 假设我们想为特定的数据节点覆盖一些配置
        if ("specialNode".equals(nd.getName())) {
            url = "jdbc:special:db";
            username = "specialUser";
            password = "specialPassword";
        }

        // 动态加载驱动
        Driver driver = (Driver) Class.forName(driverClass).newInstance();

        // 使用连接池构建器创建 DataSource
        return DataSourceBuilder
            .url(url)
            .driver(driver)
            .userName(username)
            .password(password)
            .pool(info.getMinConnections(), info.getMaxConnections()) // 从Modeler配置中获取连接池参数
            .maxQueueWaitTime(info.getMaxQueueWaitTime())
            .validationQuery(info.getValidationQuery())
            .build();
    }
}

配置自定义工厂：

1. 在Cayenne Modeler中打开您的项目。
2. 导航到“DataNodes”视图。
3. 选择您要配置的每个数据节点。
4. 在数据节点的属性面板中，找到“DataSource Factory”字段。
5. 输入您的自定义DataSourceFactory类的完全限定名（例如：com.example.MyDataSourceFactory）。
6. 保存Modeler配置。

当Cayenne启动时，它将使用您指定的工厂类来创建相应数据节点的DataSource。

优势与考虑：

• 极高的灵活性： 允许开发者完全控制数据源的创建和生命周期，可以集成任何第三方连接池库，实现高级连接管理策略。
• 动态性： 可以在getDataSource方法中根据运行时条件、数据节点名称等动态决定连接参数。
• 集中管理： 可以在工厂类中统一处理数据源的创建逻辑。
• 复杂性： 相较于属性配置，需要编写更多的Java代码，并正确处理连接池的初始化和关闭。

总结与最佳实践

在Cayenne 4.1中，无论是通过运行时属性配置还是实现自定义DataSourceFactory，都可以在单一ServerRuntime实例中有效地管理多个数据节点。

• 选择合适的方法：
  • 对于简单的、配置相对固定的多数据源场景，运行时属性配置（方法一）更为简洁高效。
  • 对于需要高级连接池控制、动态数据源选择或与现有数据源管理系统集成的复杂场景，自定义DataSourceFactory（方法二）提供了无与伦比的灵活性。
• 安全性： 无论采用哪种方法，都应确保数据库凭据（用户名和密码）的安全存储和传输。避免在代码中硬编码敏感信息，而是通过安全的环境变量、加密配置文件或密钥管理服务来获取。
• 命名规范： 在使用属性配置时，遵循cayenne.jdbc.[property].[project_name].[node_name]的命名约定至关重要，以确保Cayenne能够正确识别和应用这些配置。
• 测试： 配置多数据节点后，务必进行充分的测试，确保每个数据节点都能正确连接，并且应用程序能够根据业务逻辑正确地访问不同的数据库。

通过以上两种方法，Cayenne为开发者提供了强大的能力，以灵活、高效的方式处理多数据库连接需求，同时保持了ServerRuntime的单一性和管理上的简洁性。