yii2 資料庫讀寫分離設定範例

開始使用資料庫首先需要配置資料庫連接元件，透過將db 元件新增至應用程式設定實作（"基礎的" Web 應用程式是config/web.PHP），DSN( Data Source Name )是資料來源名稱，用於指定資料庫訊息.如下圖所示：

return [
  // ...
  'components' => [
    // ...
    'db' => [
      'class' => 'yii\db\Connection',
      'dsn' => 'mysql:host=localhost;dbname=mydatabase', // MySQL, MariaDB
      //'dsn' => 'sqlite:/path/to/database/file', // SQLite
      //'dsn' => 'pgsql:host=localhost;port=5432;dbname=mydatabase', // PostgreSQL
      //'dsn' => 'cubrid:dbname=demodb;host=localhost;port=33000', // CUBRID
      //'dsn' => 'sqlsrv:Server=localhost;Database=mydatabase', // MS SQL Server, sqlsrv driver
      //'dsn' => 'dblib:host=localhost;dbname=mydatabase', // MS SQL Server, dblib driver
      //'dsn' => 'mssql:host=localhost;dbname=mydatabase', // MS SQL Server, mssql driver
      //'dsn' => 'oci:dbname=//localhost:1521/mydatabase', // Oracle
      'username' => 'root', //数据库用户名
      'password' => '', //数据库密码
      'charset' => 'utf8',
    ],
  ],
  // ...
];

請參考PHP manual以取得更多有關DSN 格式資訊。 設定連線元件後可以使用下列語法存取：

$connection = \Yii::$app->db;

請參考[[yiidbConnection]]取得可設定的屬性清單。 如果你想要透過ODBC連接資料庫，則需要設定[[yiidbConnection::driverName]] 屬性，例如:

'db' => [
  'class' => 'yii\db\Connection',
  'driverName' => 'mysql',
  'dsn' => 'odbc:Driver={MySQL};Server=localhost;Database=test',
  'username' => 'root',
  'password' => '',
],

注意:如果需要同時使用多個資料庫可以定義多個連接元件：

注意:如果需要同時使用多個資料庫可以定義多個連線元件：

在程式碼中透過以下方式使用:

return [
  // ...
  'components' => [
    // ...
    'db' => [
      'class' => 'yii\db\Connection',
      'dsn' => 'mysql:host=localhost;dbname=mydatabase', 
      'username' => 'root',
      'password' => '',
      'charset' => 'utf8',
    ],
    'secondDb' => [
      'class' => 'yii\db\Connection',
      'dsn' => 'sqlite:/path/to/database/file', 
    ],
  ],
  // ...
];

如果不想定義資料庫連接為全域應用元件，可以在程式碼中直接初始化使用：

$primaryConnection = \Yii::$app->db;
$secondaryConnection = \Yii::$app->secondDb;

連線後需要執行額外的SQL 查詢，可以加入以下程式碼到應用程式設定檔：

$connection = new \yii\db\Connection([
  'dsn' => $dsn,
   'username' => $username,
   'password' => $password,
]);
$connection->open();

SQL 基礎查詢

一旦有了連線實例就可以透過[[yiidbCommand]執行查詢

SELECT 查詢

查詢返回多行：

return [
  // ...
  'components' => [
    // ...
    'db' => [
      'class' => 'yii\db\Connection',
      // ...
      'on afterOpen' => function($event) {
        $event->sender->createCommand("SET time_zone = 'UTC'")->execute();
      }
    ],
  ],
  // ...
];

返回單行：

reee

返回單行：

查詢標量值/計算值：

$command = $connection->createCommand('SELECT * FROM post');
$posts = $command->queryAll();

UPDATE, INSERT, DELETE 更新、插入和刪除等

如果執行SQL 不回傳任何資料可使用指令中的execute 方法： delete 方法，這些方法會根據參數產生適當的SQL並執行.

$command = $connection->createCommand('SELECT * FROM post WHERE id=1');
$post = $command->queryOne();

引用的表名和列名

大多數時間都使用以下語法來安全地引用表名和列名

$command = $connection->createCommand('SELECT title FROM post');
$titles = $command->queryColumn();

以上代碼[[$column]] 會轉變為引用恰當的列名，而{{table}} 就轉變為引用恰當的表名。 表名有一個特殊的變數{{%Y}} ，如果設定了表前綴使用該變體可以自動在表名前添加前綴：

$command = $connection->createCommand('SELECT COUNT(*) FROM post');
$postCount = $command->queryScalar();

如果在配置文件如下設置了表前綴，以上代碼將在tbl_table 這個表格查詢結果：

$command = $connection->createCommand('UPDATE post SET status=1 WHERE id=1');
$command->execute();

手動引用表名和列名的另一個選擇是使用[[yiidbConnection::quoteTableName()]] 和[[yiidbConnection::quoteColumnName()]:

]

// INSERT
$connection->createCommand()->insert('user', [
  'name' => 'Sam',
  'age' => 30,
])->execute();

// INSERT 一次插入多行
$connection->createCommand()->batchInsert('user', ['name', 'age'], [
  ['Tom', 30],
  ['Jane', 20],
  ['Linda', 25],
])->execute();

// UPDATE
$connection->createCommand()->update('user', ['status' => 1], 'age > 30')->execute();

// DELETE
$connection->createCommand()->delete('user', 'status = 0')->execute();

預處理語句

為安全傳遞查詢參數可以使用預處理語句,首先應當使用:placeholder佔位，再將變數綁定到對應佔位符：綁定到

另一種用法是準備一次預處理語句而執行多次查詢：

$sql = "SELECT COUNT([[$column]]) FROM {{table}}";
$rowCount = $connection->createCommand($sql)->queryScalar();

提示，在執行前綁定變量，然後在每個執行中改變變量的值（一般用在循環中）比較高效.

事務

當你需要順序執行多個相關的的query時，你可以把他們封裝到一個事務中去保護數據一致性.Yii提供了一個簡單的接口來實現事務操作.如下執行SQL 事務查詢語句：

$sql = "SELECT COUNT([[$column]]) FROM {{%$table}}";
$rowCount = $connection->createCommand($sql)->queryScalar();

我們透過[[yiidbConnection::beginTransaction()|beginTransaction()]]開始一個事務，透過try catch 捕獲異常.當執行成功，透過[yiidbTransaction:: commit()|commit()]]提交事務並結束，當發生異常失敗通過[[yiidbTransaction::rollBack()|rollBack()]]進行事務回滾.

如需要也可以嵌套多個事務：

return [
  // ...
  'components' => [
    // ...
    'db' => [
      // ...
      'tablePrefix' => 'tbl_',
    ],
  ],
];

注意你使用的資料庫必須支援Savepoints才能正確地執行，以上程式碼在所有關聯式資料中都可以執行，但是只有支援Savepoints才能保證安全性。

Yii 也支援為事務設定隔離級別isolation levels，當執行事務時會使用資料庫預設的隔離級別，你也可以為事物指定隔離級別. Yii 提供了以下常數作為常用的隔離級別

[[yiidbTransaction ::READ_UNCOMMITTED]] - 允許讀取改變了的尚未提交的資料,可能導致髒讀、不可重複讀取和幻讀

[[yiidbTransaction::READ_COMMITTED]] - 允許並發事務提交之後讀取，可以避免髒讀，可能導致重複讀和幻讀。

[[yiidbTransaction::REPEATABLE_READ]] - 相同欄位的多次讀取結果一致，可導致幻讀。

[[yiidbTransaction::SERIALIZABLE]] - 完全服從ACID的原則，確保不會發生髒讀、不可重複讀和幻讀。

你可以使用以上常數或使用string字串指令，在對應資料庫中執行該指令用以設定隔離級別，例如對於postgres有效的指令為SERIALIZABLE READ ONLY DEFERRABLE.

注意:某些数据库只能针对连接来设置事务隔离级别，所以你必须要为连接明确制定隔离级别.目前受影响的数据库:MSSQL SQLite

注意:SQLite 只支持两种事务隔离级别，所以你只能设置READ UNCOMMITTED 和 SERIALIZABLE.使用其他隔离级别会抛出异常.

注意:PostgreSQL 不允许在事务开始前设置隔离级别，所以你不能在事务开始时指定隔离级别.你可以在事务开始之后调用[[yii\db\Transaction::setIsolationLevel()]] 来设置.

数据库复制和读写分离

很多数据库支持数据库复制 database replication来提高可用性和响应速度. 在数据库复制中，数据总是从主服务器 到 从服务器. 所有的插入和更新等写操作在主服务器执行，而读操作在从服务器执行.

通过配置[[yii\db\Connection]]可以实现数据库复制和读写分离.

[
  'class' => 'yii\db\Connection',

  // 配置主服务器
  'dsn' => 'dsn for master server',
  'username' => 'master',
  'password' => '',

  // 配置从服务器
  'slaveConfig' => [
    'username' => 'slave',
    'password' => '',
    'attributes' => [
      // use a smaller connection timeout
      PDO::ATTR_TIMEOUT => 10,
    ],
  ],

  // 配置从服务器组
  'slaves' => [
    ['dsn' => 'dsn for slave server 1'],
    ['dsn' => 'dsn for slave server 2'],
    ['dsn' => 'dsn for slave server 3'],
    ['dsn' => 'dsn for slave server 4'],
  ],
]

以上的配置实现了一主多从的结构，从服务器用以执行读查询，主服务器执行写入查询，读写分离的功能由后台代码自动完成.调用者无须关心.例如：

// 使用以上配置创建数据库连接对象
$db = Yii::createObject($config);

// 通过从服务器执行查询操作
$rows = $db->createCommand('SELECT * FROM user LIMIT 10')->queryAll();

// 通过主服务器执行更新操作
$db->createCommand("UPDATE user SET username='demo' WHERE id=1")->execute();

注意:通过[[yii\db\Command::execute()]] 执行的查询被认为是写操作，所有使用[[yii\db\Command]]来执行的其他查询方法被认为是读操作.你可以通过$db->slave得到当前正在使用能够的从服务器.

Connection组件支持从服务器的负载均衡和故障转移，当第一次执行读查询时，会随即选择一个从服务器进行连接，如果连接失败则又选择另一个，如果所有从服务器都不可用，则会连接主服务器。你可以配置[[yii\db\Connection::serverStatusCache|server status cache]]来记住那些不能连接的从服务器，使Yii 在一段时间[[yii\db\Connection::serverRetryInterval].内不会重复尝试连接那些根本不可用的从服务器.

注意:在上述配置中，每个从服务器连接超时时间被指定为10s. 如果在10s内不能连接，则被认为该服务器已经挂掉.你也可以自定义超时参数.
你也可以配置多主多从的结构，例如:

[
  'class' => 'yii\db\Connection',

  // 配置主服务器
  'masterConfig' => [
    'username' => 'master',
    'password' => '',
    'attributes' => [
      // use a smaller connection timeout
      PDO::ATTR_TIMEOUT => 10,
    ],
  ],

  // 配置主服务器组
  'masters' => [
    ['dsn' => 'dsn for master server 1'],
    ['dsn' => 'dsn for master server 2'],
  ],

  // 配置从服务器
  'slaveConfig' => [
    'username' => 'slave',
    'password' => '',
    'attributes' => [
      // use a smaller connection timeout
      PDO::ATTR_TIMEOUT => 10,
    ],
  ],

  // 配置从服务器组
  'slaves' => [
    ['dsn' => 'dsn for slave server 1'],
    ['dsn' => 'dsn for slave server 2'],
    ['dsn' => 'dsn for slave server 3'],
    ['dsn' => 'dsn for slave server 4'],
  ],
]

上述配置制定了2个主服务器和4个从服务器.Connection组件也支持主服务器的负载均衡和故障转移，与从服务器不同的是，如果所有主服务器都不可用，则会抛出异常.

注意:当你使用[[yii\db\Connection::masters|masters]]来配置一个或多个主服务器时，Connection中关于数据库连接的其他属性（例如：dsn, username, password）都会被忽略.

事务默认使用主服务器的连接，并且在事务执行中的所有操作都会使用主服务器的连接，例如:

// 在主服务器连接上开始事务
$transaction = $db->beginTransaction();

try {
  // 所有的查询都在主服务器上执行
  $rows = $db->createCommand('SELECT * FROM user LIMIT 10')->queryAll();
  $db->createCommand("UPDATE user SET username='demo' WHERE id=1")->execute();

  $transaction->commit();
} catch(\Exception $e) {
  $transaction->rollBack();
  throw $e;
}

如果你想在从服务器上执行事务操作则必须要明确地指定，比如:

$transaction = $db->slave->beginTransaction();

有时你想强制使用主服务器来执行读查询，你可以调用seMaster()方法.

$rows = $db->useMaster(function ($db) {
  return $db->createCommand('SELECT * FROM user LIMIT 10')->queryAll();
});

你也可以设置$db->enableSlaves 为false来使所有查询都在主服务器上执行.

操作数据库模式

获得模式信息

你可以通过 [[yii\db\Schema]]实例来获取Schema信息:

$schema = $connection->getSchema();

该实例包括一系列方法来检索数据库多方面的信息：

$tables = $schema->getTableNames();

更多信息请参考[[yii\db\Schema]]

修改模式

除了基础的 SQL 查询，[[yii\db\Command]]还包括一系列方法来修改数据库模式：

• 创建/重命名/删除/清空表

• 增加/重命名/删除/修改字段

• 增加/删除主键

• 增加/删除外键

• 创建/删除索引
  

使用示例:

// 创建表
$connection->createCommand()->createTable('post', [
  'id' => 'pk',
  'title' => 'string',
  'text' => 'text',
]);

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持PHP中文网。

更多yii2 数据库读写分离配置示例相关文章请关注PHP中文网！