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;

请参考[[yii\db\connection]]获取可配置的属性列表。 如果你想通过odbc连接数据库，则需要配置[[yii\db\connection::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;

如果不想定义数据库连接为全局应用组件，可以在代码中直接初始化使用：

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

小提示：如果在创建了连接后需要执行额外的 sql 查询，可以添加以下代码到应用配置文件：

return [
  // ...
  'components' => [
    // ...
    'db' => [
      'class' => 'yii\db\connection',
      // ...
      'on afteropen' => function($event) {
        $event->sender->createcommand("set time_zone = 'utc'")->execute();
      }
    ],
  ],
  // ...
];

sql 基础查询

一旦有了连接实例就可以通过[[yii\db\command]]执行 sql 查询。

select 查询

查询返回多行：

$command = $connection->createcommand('select * from post');
$posts = $command->queryall();

返回单行：

$command = $connection->createcommand('select * from post where id=1');
$post = $command->queryone();

查询多行单值：

$command = $connection->createcommand('select title from post');
$titles = $command->querycolumn();

查询标量值/计算值：

$command = $connection->createcommand('select count(*) from post');
$postcount = $command->queryscalar();

update, insert, delete 更新、插入和删除等

如果执行 sql 不返回任何数据可使用命令中的 execute 方法：

$command = $connection->createcommand('update post set status=1 where id=1');
$command->execute();

你可以使用insert,update,delete 方法，这些方法会根据参数生成合适的sql并执行.

// 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();

引用的表名和列名

大多数时间都使用以下语法来安全地引用表名和列名：

$sql = "select count([[$column]]) from {{table}}";
$rowcount = $connection->createcommand($sql)->queryscalar();

以上代码[[$column]] 会转变为引用恰当的列名，而{{table}} 就转变为引用恰当的表名。 表名有个特殊的变量 {{%y}} ，如果设置了表前缀使用该变体可以自动在表名前添加前缀：

$sql = "select count([[$column]]) from {{%$table}}";
$rowcount = $connection->createcommand($sql)->queryscalar();

如果在配置文件如下设置了表前缀，以上代码将在 tbl_table 这个表查询结果：

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

手工引用表名和列名的另一个选择是使用[[yii\db\connection::quotetablename()]] 和 [[yii\db\connection::quotecolumnname()]]：

$column = $connection->quotecolumnname($column);
$table = $connection->quotetablename($table);
$sql = "select count($column) from $table";
$rowcount = $connection->createcommand($sql)->queryscalar();

预处理语句

为安全传递查询参数可以使用预处理语句,首先应当使用:placeholder占位，再将变量绑定到对应占位符：

$command = $connection->createcommand('select * from post where id=:id');
$command->bindvalue(':id', $_get['id']);
$post = $command->query();

另一种用法是准备一次预处理语句而执行多次查询：

$command = $connection->createcommand('delete from post where id=:id');
$command->bindparam(':id', $id);

$id = 1;
$command->execute();

$id = 2;
$command->execute();

提示，在执行前绑定变量，然后在每个执行中改变变量的值（一般用在循环中）比较高效.

事务

当你需要顺序执行多个相关的的query时，你可以把他们封装到一个事务中去保护数据一致性.yii提供了一个简单的接口来实现事务操作. 如下执行 sql 事务查询语句：

$transaction = $connection->begintransaction();
try {
  $connection->createcommand($sql1)->execute();
   $connection->createcommand($sql2)->execute();
  // ... 执行其他 sql 语句 ...
  $transaction->commit();
} catch(exception $e) {
  $transaction->rollback();
}

我们通过[[yii\db\connection::begintransaction()|begintransaction()]]开始一个事务，通过try catch 捕获异常.当执行成功，通过[[yii\db\transaction::commit()|commit()]]提交事务并结束，当发生异常失败通过[[yii\db\transaction::rollback()|rollback()]]进行事务回滚.

如需要也可以嵌套多个事务：

// 外部事务
$transaction1 = $connection->begintransaction();
try {
  $connection->createcommand($sql1)->execute();

  // 内部事务
  $transaction2 = $connection->begintransaction();
  try {
    $connection->createcommand($sql2)->execute();
    $transaction2->commit();
  } catch (exception $e) {
    $transaction2->rollback();
  }

  $transaction1->commit();
} catch (exception $e) {
  $transaction1->rollback();
}

注意你使用的数据库必须支持savepoints才能正确地执行，以上代码在所有关系数据中都可以执行，但是只有支持savepoints才能保证安全性。

yii 也支持为事务设置隔离级别isolation levels，当执行事务时会使用数据库默认的隔离级别，你也可以为事物指定隔离级别. yii 提供了以下常量作为常用的隔离级别

[[\yii\db\transaction::read_uncommitted]] - 允许读取改变了的还未提交的数据,可能导致脏读、不可重复读和幻读

[[\yii\db\transaction::read_committed]] - 允许并发事务提交之后读取，可以避免脏读，可能导致重复读和幻读。

[[\yii\db\transaction::repeatable_read]] - 对相同字段的多次读取结果一致，可导致幻读。

[[\yii\db\transaction::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',
]);

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