Cayenne4.1：多源数据管理神器

知识点掌握了，还需要不断练习才能熟练运用。下面golang学习网给大家带来一个文章开发实战，手把手教大家学习《Cayenne 4.1：多数据源统一管理神器》，在实现功能的过程中也带大家重新温习相关知识点，温故而知新，回头看看说不定又有不一样的感悟！

本文详细阐述了在Cayenne 4.1中，如何通过单一的`ServerRuntime`实例管理多个具有不同URL和凭据的数据节点。我们探讨了两种主要方法：一是通过编程方式在`ServerRuntime`构建时贡献数据源属性，二是实现自定义的`DataSourceFactory`来提供更灵活的数据源创建逻辑。这两种方法都能有效解决在同一应用中集成多个数据库的需求，避免了创建多个运行时实例的复杂性。

在现代企业应用中，一个应用程序需要连接并操作多个数据库实例是常见需求。Cayenne ORM框架提供了一种优雅的方式，允许开发者在单一的ServerRuntime实例中配置和管理多个具有独立连接参数（如URL、用户名、密码）的数据节点（DataNode）。这不仅简化了架构，也提高了资源利用率。以下将介绍两种实现此目标的核心方法。

方法一：通过编程方式配置数据源属性

Cayenne 允许在构建 ServerRuntime 时，通过贡献（contribute）属性的方式来定义或覆盖数据节点的连接参数。这种方法适用于数据源配置相对静态，或者可以直接在代码中提供的场景。

实现步骤：

1. 构建 ServerRuntime： 在 ServerRuntime.builder() 链中，使用 addModule() 方法添加一个自定义模块。
2. 贡献属性： 在自定义模块中，通过 ServerModule.contributeProperties() 方法，为每个数据节点设置其特定的连接属性。

示例代码：

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

public class MultiDataNodeConfig {

    public static ServerRuntime createRuntime() {
        return ServerRuntime.builder()
                .addModule(b -> ServerModule.contributeProperties(b)
                        // 配置 project.node1 的 JDBC URL
                        .put("cayenne.jdbc.url.project.node1", "jdbc:postgresql://localhost:5432/database1")
                        // 配置 project.node1 的驱动类
                        .put("cayenne.jdbc.driver.project.node1", "org.postgresql.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:mysql://localhost:3306/database2")
                        // 配置 project.node2 的驱动类
                        .put("cayenne.jdbc.driver.project.node2", "com.mysql.cj.jdbc.Driver")
                        // 配置 project.node2 的用户名
                        .put("cayenne.jdbc.username.project.node2", "user2")
                        // 配置 project.node2 的密码
                        .put("cayenne.jdbc.password.project.node2", "password456")

                        // 可以继续添加其他如连接池大小等属性
                        // .put("cayenne.jdbc.min_connections.project.node1", "5")
                        // .put("cayenne.jdbc.max_connections.project.node1", "20")
                )
                .build();
    }

    public static void main(String[] args) {
        ServerRuntime runtime = createRuntime();
        try {
            System.out.println("Cayenne ServerRuntime with multiple data nodes initialized successfully.");
            // 在这里可以执行数据库操作
            // ObjectContext context1 = runtime.newContext("node1"); // 根据DataNode名称获取上下文
            // ObjectContext context2 = runtime.newContext("node2");
        } finally {
            runtime.shutdown();
        }
    }
}

注意事项：

• 属性命名约定： 属性名遵循 cayenne.jdbc.[property_name].[project_name].[data_node_name] 的格式。其中 project_name 和 data_node_name 应该与在Cayenne Modeler中定义的数据映射和数据节点名称保持一致。
• 灵活性： 这种方法适用于直接在代码中提供配置，或者从外部配置源（如环境变量、配置文件）读取后注入的情况。

方法二：实现自定义 DataSourceFactory

当数据源的创建逻辑更为复杂，例如需要根据运行时环境动态选择数据源、集成第三方连接池库或执行更复杂的初始化逻辑时，实现自定义 DataSourceFactory 是更强大的选择。

实现步骤：

1. 创建自定义工厂类： 实现 org.apache.cayenne.configuration.server.DataSourceFactory 接口。
2. 实现 getDataSource 方法： 在此方法中，根据传入的 DataNodeDescriptor（数据节点描述符）构建并返回一个 javax.sql.DataSource 实例。
3. 在 Modeler 中配置： 对于每个数据节点，在Cayenne Modeler中将其 "DataSource Factory" 属性指向你的自定义工厂类的全限定名。

示例代码：

import org.apache.cayenne.configuration.server.DataSourceFactory;
import org.apache.cayenne.configuration.server.ServerRuntime;
import org.apache.cayenne.dba.DataSourceBuilder;
import org.apache.cayenne.di.Inject;
import org.apache.cayenne.di.ObjectFactory;
import org.apache.cayenne.map.DataNodeDescriptor;
import org.apache.cayenne.map.DataSourceInfo;

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

public class MyCustomDataSourceFactory implements DataSourceFactory {

    // Cayenne 会自动注入 ObjectFactory
    @Inject
    private ObjectFactory objectFactory;

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

        // 从 DataNodeDescriptor 获取基本配置信息
        // 可以根据 DataNodeDescriptor 的名称或其他属性来区分不同的数据源
        String nodeName = nd.getName();
        String url;
        String driverClass;
        String username;
        String password;

        if ("node1".equals(nodeName)) {
            url = "jdbc:postgresql://customhost1:5432/db_custom1";
            driverClass = "org.postgresql.Driver";
            username = "custom_user1";
            password = "custom_password1";
            // 可以在这里加载 node1 特有的配置
        } else if ("node2".equals(nodeName)) {
            url = "jdbc:mysql://customhost2:3306/db_custom2";
            driverClass = "com.mysql.cj.jdbc.Driver";
            username = "custom_user2";
            password = "custom_password2";
            // 可以在这里加载 node2 特有的配置
        } else {
            // 默认或从 info 中获取配置
            url = info.getDataSourceUrl();
            driverClass = info.getJdbcDriver();
            username = info.getUserName();
            password = info.getPassword();
        }

        // 可以根据需要从外部配置源（如Spring配置文件、JNDI、环境变量等）获取这些值
        // 例如：
        // String externalUrl = System.getenv("DB_URL_" + nodeName.toUpperCase());
        // if (externalUrl != null) { url = externalUrl; }

        // 使用 Cayenne 的 DataSourceBuilder 构建 DataSource
        // 注意：Driver 实例需要通过反射或DI容器获取
        Driver driver = (Driver)objectFactory.getJavaClass(driverClass).newInstance();

        return DataSourceBuilder
            .url(url)
            .driver(driver)
            .userName(username)
            .password(password)
            .pool(5, 20) // 设置连接池大小
            .maxQueueWaitTime(5000) // 最大等待时间
            .validationQuery("SELECT 1") // 连接验证查询
            .build();
    }
}

注意事项：

• 灵活性： getDataSource 方法提供了极高的灵活性。你可以在其中实现复杂的逻辑，例如从JNDI查找数据源、集成第三方连接池（如HikariCP、Druid）、或根据环境配置动态调整连接参数。
• Modler 配置： 确保在Cayenne Modeler中为每个数据节点正确设置了 "DataSource Factory" 属性为 MyCustomDataSourceFactory 的全限定名。
• 依赖注入： Cayenne 的 ObjectFactory 可以帮助你实例化驱动类或其他依赖。如果你的工厂类有其他依赖，它们也可以通过 @Inject 自动注入。

总结与选择建议

在Cayenne 4.1中，无论是通过编程方式贡献属性，还是实现自定义的 DataSourceFactory，都能实现在单一 ServerRuntime 中管理多个异构数据源。

• 选择编程方式配置属性： 适用于数据源配置相对简单、固定，且可以直接在代码中提供或从简单配置源读取的场景。这种方法实现起来较为直接。
• 选择自定义 DataSourceFactory： 适用于数据源创建逻辑复杂、需要高度定制、集成第三方连接池、或者需要根据运行时环境动态生成数据源的场景。它提供了最大的灵活性和控制力。

无论采用哪种方法，核心目标都是利用Cayenne的强大配置能力，在不增加运行时实例复杂性的前提下，有效地管理应用程序对多个数据库的访问。这两种方法都避免了创建多个 ServerRuntime 实例的开销和管理复杂性，从而保持了应用架构的简洁和高效。

以上就是《Cayenne4.1：多源数据管理神器》的详细内容，更多关于的资料请关注golang学习网公众号！