CodeIgniter多数据库动态连接方法

一分耕耘，一分收获！既然都打开这篇《CodeIgniter多数据库动态连接技巧》，就坚持看下去，学下去吧！本文主要会给大家讲到等等知识点，如果大家对本文有好的建议或者看到有不足之处，非常欢迎大家积极提出！在后续文章我会继续更新文章相关的内容，希望对大家都有所帮助！

1. 理解CodeIgniter的数据库配置机制

CodeIgniter框架默认的数据库连接配置存储在 application/config/database.php 文件中。通常，我们会在该文件中定义一个名为 default 的连接，作为应用程序的主要数据库连接。例如：

// application/config/database.php
$db['default'] = array(
    'dsn'      => '',
    'hostname' => 'localhost',
    'username' => 'root',
    'password' => '',
    'database' => 'first_db', // 主数据库
    'dbdriver' => 'mysqli',
    'dbprefix' => '',
    'pconnect' => FALSE,
    'db_debug' => (ENVIRONMENT !== 'production'),
    'cache_on' => FALSE,
    'cachedir' => '',
    'char_set' => 'utf8',
    'dbcollat' => 'utf8_general_ci',
    'swap_pre' => '',
    'encrypt' => FALSE,
    'compress' => FALSE,
    'stricton' => FALSE,
    'failover' => array(),
    'save_queries' => TRUE
);

// 如果有其他固定连接，也可以在此定义
$db['another_static_db'] = array(
    // ... 另一个数据库的配置 ...
);

对于需要根据用户输入或其他动态条件连接到不同数据库的场景，例如从外部数据库导入数据，仅仅依靠 database.php 中的静态配置是不够的。这时，我们需要在运行时动态构建数据库连接配置。

2. 动态构建数据库连接配置

在CodeIgniter中，你可以在控制器、模型或自定义的库/辅助函数中，根据动态获取的参数（例如用户在表单中输入的数据库凭据）来构建一个数据库连接配置数组。这个数组的结构必须与 database.php 中定义的配置数组完全一致。

以下是一个示例，展示如何在模型或控制器中动态构建一个数据库连接配置数组：

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

class Data_import_model extends CI_Model {

    public function __construct() {
        parent::__construct();
        $this->load->database(); // 确保加载了默认数据库
    }

    /**
     * 根据动态参数构建并返回一个数据库连接配置数组
     *
     * @param array $credentials 包含 'hostname', 'username', 'password', 'database' 等键的数组
     * @return array 数据库连接配置数组
     */
    private function _build_dynamic_db_config($credentials) {
        return array(
            'dsn'      => '',
            'hostname' => $credentials['hostname'],
            'username' => $credentials['username'],
            'password' => $credentials['password'],
            'database' => $credentials['database'],
            'dbdriver' => 'mysqli', // 根据实际情况选择驱动
            'dbprefix' => '',
            'pconnect' => FALSE,
            'db_debug' => (ENVIRONMENT !== 'production'),
            'cache_on' => FALSE,
            'cachedir' => '',
            'char_set' => 'utf8',
            'dbcollat' => 'utf8_general_ci',
            'swap_pre' => '',
            'encrypt' => FALSE,
            'compress' => FALSE,
            'stricton' => FALSE,
            'failover' => array(),
            'save_queries' => TRUE
        );
    }

    // ... 其他方法 ...
}

在实际应用中，$credentials 数组的数据通常来源于用户提交的表单数据。

3. 加载与切换数据库连接

CodeIgniter提供了 $this->load->database() 方法来加载数据库连接。当需要连接到非默认或动态配置的数据库时，你可以将配置数组作为第一个参数传递给此方法，并将第二个参数设置为 TRUE，以确保该连接被返回为一个独立的数据库对象，而不是覆盖默认连接。

加载动态数据库连接：

// 在控制器或模型中
public function connect_and_query_external_db() {
    // 假设从表单获取了这些凭据
    $user_input_credentials = array(
        'hostname' => $this->input->post('external_db_host'),
        'username' => $this->input->post('external_db_user'),
        'password' => $this->input->post('external_db_pass'),
        'database' => $this->input->post('external_db_name')
    );

    // 构建动态配置
    $dynamic_db_config = $this->_build_dynamic_db_config($user_input_credentials);

    // 加载并获取外部数据库连接对象
    // 第二个参数 TRUE 表示返回数据库对象，而不是将其设置为默认连接
    $external_db_obj = $this->load->database($dynamic_db_config, TRUE);

    if ($external_db_obj) {
        echo "成功连接到外部数据库！<br>";
        // 现在可以使用 $external_db_obj 来执行针对外部数据库的操作
        $query = $external_db_obj->get('some_table_in_external_db');
        if ($query) {
            $results = $query->result();
            echo "外部数据库数据：<pre>";
            print_r($results);
            echo "

切换回主数据库或另一个命名连接：

当完成了对外部数据库的操作后，你可能需要切换回应用程序的主数据库。如果你之前没有覆盖默认连接（即 $this->db 仍然指向默认数据库），那么直接使用 $this->db 即可。如果需要显式地切换到一个在 database.php 中定义的命名连接，可以这样操作：

// 假设你已经连接了动态数据库 $external_db_obj
// ... 对 $external_db_obj 的操作 ...

// 切换回默认数据库（如果需要）
// $this->load->database('default', TRUE); // 这会重新加载并返回默认连接对象
// 或者直接使用 $this->db，它通常指向默认连接

// 切换到另一个在 database.php 中定义的命名连接
// $another_db_obj = $this->load->database('another_static_db', TRUE);

4. 实际应用：从外部数据库导入数据

结合上述概念，我们可以实现一个从动态连接的外部数据库读取数据，并将其导入到主数据库的功能。

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

class Import_controller extends CI_Controller {

    public function __construct() {
        parent::__construct();
        $this->load->model('data_import_model'); // 加载模型
    }

    public function index() {
        // 加载视图，让用户输入数据库凭据
        $this->load->view('import_form');
    }

    public function process_import() {
        // 1. 获取用户输入的数据库凭据
        $user_input_credentials = array(
            'hostname' => $this->input->post('hostname'),
            'username' => $this->input->post('username'),
            'password' => $this->input->post('password'),
            'database' => $this->input->post('database_name')
        );

        // 2. 尝试连接到外部数据库并导入数据
        $result = $this->data_import_model->import_data_from_external($user_input_credentials);

        if ($result['status'] === 'success') {
            echo "数据导入成功！共导入 " . $result['rows_imported'] . " 条记录。";
        } else {
            echo "数据导入失败：" . $result['message'];
        }
    }
}

// application/models/Data_import_model.php
class Data_import_model extends CI_Model {

    public function __construct() {
        parent::__construct();
        $this->load->database(); // 确保加载了默认数据库
    }

    /**
     * 根据动态参数构建并返回一个数据库连接配置数组
     */
    private function _build_dynamic_db_config($credentials) {
        // ... 同上文所示的 _build_dynamic_db_config 方法 ...
        return array(
            'dsn'      => '',
            'hostname' => $credentials['hostname'],
            'username' => $credentials['username'],
            'password' => $credentials['password'],
            'database' => $credentials['database'],
            'dbdriver' => 'mysqli',
            'dbprefix' => '',
            'pconnect' => FALSE,
            'db_debug' => (ENVIRONMENT !== 'production'),
            'cache_on' => FALSE,
            'cachedir' => '',
            'char_set' => 'utf8',
            'dbcollat' => 'utf8_general_ci',
            'swap_pre' => '',
            'encrypt' => FALSE,
            'compress' => FALSE,
            'stricton' => FALSE,
            'failover' => array(),
            'save_queries' => TRUE
        );
    }

    /**
     * 从外部数据库导入数据到主数据库
     *
     * @param array $credentials 外部数据库连接凭据
     * @return array 导入结果，包含 'status', 'message', 'rows_imported'
     */
    public function import_data_from_external($credentials) {
        $dynamic_db_config = $this->_build_dynamic_db_config($credentials);
        $external_db = $this->load->database($dynamic_db_config, TRUE);

        if (!$external_db) {
            return ['status' => 'error', 'message' => '无法连接到外部数据库，请检查凭据。'];
        }

        try {
            // 从外部数据库读取数据（例如，读取 'users' 表）
            $query = $external_db->get('source_users_table');
            if ($query->num_rows() > 0) {
                $external_users = $query->result_array();

                // 导入数据到主数据库（例如，插入到 'main_users_table'）
                // 确保主数据库连接仍然是 $this->db
                $this->db->insert_batch('main_users_table', $external_users);
                $rows_affected = $this->db->affected_rows();

                return ['status' => 'success', 'message' => '数据导入成功。', 'rows_imported' => $rows_affected];
            } else {
                return ['status' => 'success', 'message' => '外部数据库没有数据可导入。', 'rows_imported' => 0];
            }
        } catch (Exception $e) {
            return ['status' => 'error', 'message' => '导入过程中发生错误：' . $e->getMessage()];
        } finally {
            // 重要的：关闭外部数据库连接以释放资源
            if (isset($external_db) && is_object($external_db)) {
                $external_db->close();
            }
        }
    }
}

5. 注意事项与最佳实践

• 安全性：
  • 输入验证： 始终对用户输入的数据库凭据进行严格验证，防止恶意注入或无效连接尝试。
  • 敏感信息处理： 避免在日志或错误信息中直接暴露敏感的数据库凭据。
  • 权限最小化： 为用于动态连接的数据库用户设置最小必要的权限。
• 错误处理：
  • $this->load->database() 在连接失败时会返回 FALSE。务必检查返回值并进行适当的错误处理，例如向用户显示友好的错误消息。
  • 使用 try-catch 块来捕获数据库操作中可能抛出的异常。
• 资源管理：
  • 在完成对动态数据库的操作后，建议显式调用 $external_db->close() 方法来关闭连接，释放数据库资源，尤其是在处理大量动态连接时。
• 性能考量：
  • 频繁地建立和关闭数据库连接会带来性能开销。如果可以，考虑使用持久连接（pconnect 设置为 TRUE），但这需要谨慎评估其对服务器资源的影响。
  • 避免在循环中重复建立连接。
• 代码组织：
  • 将动态构建配置和数据库操作的逻辑封装在模型（Model）中，保持控制器（Controller）的轻量级。
  • 如果动态连接逻辑在多个地方复用，可以考虑将其封装到自定义的库（Library）或辅助函数（Helper）中。

总结

CodeIgniter提供了灵活的机制来处理多数据库连接，包括动态连接。通过在运行时构建数据库配置数组并使用 $this->load->database($config_array, TRUE) 方法，开发者可以轻松地连接到由用户提供凭据的外部数据库，并执行数据导入等操作。遵循安全性、错误处理和资源管理的最佳实践，可以确保此类功能的稳定和高效运行。

以上就是《CodeIgniter多数据库动态连接方法》的详细内容，更多关于的资料请关注golang学习网公众号！