第3章 ActiveRecord, 模型, 数据库

在本章中，我们将会讨论如下话题：

• 从数据库中获取数据
• 定义和使用多个数据库连接
• 自定义ActiveQuery类
• 使用AR event-like方法处理model fields
• 自动化时间戳
• 自动设置一个作者
• 自动设置一个slug
• 事务
• 复制和读写分离
• 实现单表继承

介绍

在本章中，你将学习如何高效使用数据库，什么时候应该使用models而什么时候不应该，如何使用多个数据库，如何自动预处理Active Record fields，如何使用事务，等等。

从数据库中获取数据

今天大多数应用都在使用数据库。不论是一个小网站，还是一个大型社交网站，至少其中一部分功能是由数据库驱动的。

Yii引入了三种方法来允许你使用数据库。他们是：

• Active Record
• Query Builder
• SQL via DAO

我们将使用这三种方法从film、film_actor、actor表中获取数据，并将他们展示在一个列表中。同时，我们将会比较它们的执行时间和内存占用情况，来决定这些方法的使用场景。

准备

1. 按照官方指南http://www.yiiframework.com/doc-2.0/guide-start-installation.html的描述，使用Composer包管理器创建一个新的应用。
2. 从http://dev.mysql.com/doc/index-other.html下载Sakila数据库。
3. 执行下载好的SQLs；首先是schema，然后是数据。
4. 在config/main.php中配置数据库连接，使用Sakila数据库。
5. 使用Gii为actor和film表创建模型。

如何做…

1. 创建app/controllers/DbController.php：

<?php
namespace app\controllers;
use app\models\Actor;
use Yii;
use yii\db\Query;
use yii\helpers\ArrayHelper;
use yii\helpers\Html;
use yii\web\Controller;
/**
 * Class DbController
 * @package app\controllers
 */
class DbController extends Controller
{
/**
 * Example of Active Record usage.
 *
 * @return string
 */
    public function actionAr()
    {
        $records = Actor::find()
            ->joinWith('films')
            ->orderBy('actor.first_name,
actor.last_name, film.title')
            ->all();
        return $this->renderRecords($records);
    }
    /**
     * Example of Query class usage.
     *
     * @return string
     */
    public function actionQuery()
    {
        $rows = (new Query())
            ->from('actor')
            ->innerJoin('film_actor',
                'actor.actor_id=film_actor.actor_id')
            ->leftJoin('film',
                'film.film_id=film_actor.film_id')
            ->orderBy('actor.first_name, actor.last_name,
actor.actor_id, film.title')
            ->all();
        return $this->renderRows($rows);
    }
    /**
     * Example of SQL execution usage.
     *
     * @return string
     */
    public function actionSql()
    {
        $sql = 'SELECT *
FROM actor a
JOIN film_actor fa ON fa.actor_id = a.actor_id
JOIN film f ON fa.film_id = f.film_id
ORDER BY a.first_name, a.last_name, a.actor_id,
f.title';
        $rows = Yii::$app->db->createCommand($sql)->queryAll();
        return $this->renderRows($rows);
    }
    /**
     * Render records for Active Record array.
     *
     * @param array $records
     *
     * @return string
     */
    protected function renderRecords(array $records = [])
    {
        if (!$records) {
            return $this->renderContent('Actor list is empty.');
        }
        $items = [];
        foreach ($records as $record) {
            $actorFilms = $record->films
                ?
                Html::ol(ArrayHelper::getColumn($record->films, 'title')): null;
            $actorName = $record->first_name.'
'.$record->last_name;
            $items[] = $actorName.$actorFilms;
        }
        return $this->renderContent(Html::ol($items, [
            'encode' => false,
        ]));
    }
    /**
     * Render rows for result of query.
     *
     * @param array $rows
     *
     * @return string
     */
    protected function renderRows(array $rows = [])
    {
        if (!$rows) {
            return $this->renderContent('Actor list is empty.');
        }
        $items = [];
        $films = [];
        $actorId = null;
        $actorName = null;
        $actorFilms = null;
        $lastActorId = $rows[0]['actor_id'];
        foreach ($rows as $row) {
            $actorId = $row['actor_id'];
            $films[] = $row['title'];
            if ($actorId != $lastActorId) {
                $actorName = $row['first_name'].'
'.$row['last_name'];
                $actorFilms = $films ? Html::ol($films) : null;
                $items[] = $actorName.$actorFilms;
                $films = [];
                $lastActorId = $actorId;
            }
        }
        if ($actorId == $lastActorId) {
            $actorFilms = $films ? Html::ol($films) : null;
            $items[] = $actorName.$actorFilms;
        }
        return $this->renderContent(Html::ol($items, [
            'encode' => false,
        ]));
    }
}

1. 这里，我们有三个actions分别对应于三种不同的方法。
2. 运行上面的db/ar、db/query、db/sql三个actions之后，你应该得到了一个展示200个演员和他们演过的1000个电影的树，截图如下：

1. 在页面底部，提供了关于内存使用和执行时间的信息。运行这段代码的绝对时间可能不同，但相对大小应该是一致的：

工作原理…

actionAr方法使用Active Record方法获取了模型的实例。我们使用Gii生成的Actor模型来获取所有的演员，并指定joinWith=>'films'来获取对应的电影，它使用一个简单的查询或者通过关系预先加载，这是由Gii从InnoDB表外键为我们创建的。然后迭代所有的演员和电影，打印出他们的名字。

actionQuery函数使用Query Builder。首先我们使用\yii\db\Query为当前数据库连接创建了一个查询。然后依次加入查询部分from、joinInner和leftJoin。这些方法自动escape值、表和field名称。\yii\db\Query的函数all()返回了原始数据库的行数组。每一行也是一个数组，索引是field名称。我们将结果传给了renderRows，它负责渲染。

actionSql是一样的，不同的是我们直接传递SQL，而不是一个接着一个。值得一提的是，我们应该使用Yii::app()->db->quoteValue手动escape参数值：

renderRows方法渲染了Query Builder。

renderRecords方法渲染了active records。

更多…

欲了解更多有关Yii操作数据库，参考如下资源：

• http://www.yiiframework.com/doc-2.0/guide-db-dao.html
• http://www.yiiframework.com/doc-2.0/guide-db-query-builder.html
• http://www.yiiframework.com/doc-2.0/guide-db-active-record.html

定义和使用多个数据库连接

对于新的单机web应用，多数据库连接并不常用。但是，当你为一个已经存在的系统附加一个应用是，你很可能需要另外一个数据库连接。

在本节中，你将会学习如何定义多个数据库连接并利用DAO、Query Builder和Active Record模型使用它们。

准备

1. 按照官方指南http://www.yiiframework.com/doc-2.0/guide-start-installation.html的描述，使用Composer包管理器创建一个新的应用。
2. 创建两个MySQL数据库，名字分别叫db1和db2。
3. 在db1中创建一个名叫post的表：

DROP TABLE IF EXISTS 'post';
CREATE TABLE IF NOT EXISTS 'post' (
  'id' INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
  'title' VARCHAR(255) NOT NULL,
  'text' TEXT NOT NULL,
  PRIMARY KEY ('id')
);

1. 在db2中创建一个名叫comment的表：

DROP TABLE IF EXISTS 'comment';
CREATE TABLE IF NOT EXISTS 'comment' (
  'id' INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
  'text' TEXT NOT NULL,
  'post_id' INT(10) UNSIGNED NOT NULL,
  PRIMARY KEY ('id')
);

如何做…

1. 首先配置数据库连接。打开config/main.php文件，按照官方指南中的描述，定义一个主连接：

'db' => [
    'connectionString' =>'mysql:host=localhost;dbname=db1',
    'username' => 'root',
    'password' => '',
    'charset' => 'utf8',
],

1. 复制它，重命名db组件为db2，并相应修改connectionString。同时，你需要按照如下方式添加class：

'db2' => [
    'class'=>'yii\db\Connection',
    'connectionString' => 'mysql:host=localhost;dbname=db2',
    'username' => 'root',
    'password' => '',
    'charset' => 'utf8',
],

1. 现在你有两个数据库连接，你可以按如下方式利用DAO和Query Builder使用它们：

$rows1 = Yii::$app->db->createCommand($sql)->queryAll();
$rows2 = Yii::$app->db2->createCommand($sql)->queryAll();

1. 现在，如何我们需要使用Active Record模型，首先我们需要使用Gii创建Post和Comment模型。你可以为每一个模型选择一个合适的连接。当你创建Comment模型时，将数据库连接ID设置为db2，如下截图所示：

1. 现在你可以按往常一样使用Comment模型，并创建controllers/DbController.php：

<?php
namespace app\controllers;
use app\models\Post;
use app\models\Comment;
use yii\helpers\ArrayHelper;
use yii\helpers\Html;
use yii\web\Controller;
/**
 * Class DbController.
 * @package app\controllers
 */
class DbController extends Controller
{
    public function actionIndex()
    {
        $post = new Post();
        $post->title = 'Post #'.rand(1, 1000);
        $post->text = 'text';
        $post->save();
        $posts = Post::find()->all();
        echo Html::tag('h1', 'Posts');
        echo Html::ul(ArrayHelper::getColumn($posts, 'title'));
        $comment = new Comment();
        $comment->post_id = $post->id;
        $comment->text = 'comment #'.rand(1, 1000);
        $comment->save();
        $comments = Comment::find()->all();
        echo Html::tag('h1', 'Comments');
        echo Html::ul(ArrayHelper::getColumn($comments,
            'text'));
    }
}

1. 运行db/index多次，然后你将会看到记录保存到了两个数据库中，如下截图所示：

工作原理…

在Yii中，你可以通过配置文件添加和配置你自己的组件。对于非标准的组件，例如db2，你必须指定组件类。类似地，你可以添加db3、db4或者其他组件，例如facebookApi。剩余的数组键值对分别赋值给了组件的公共属性。

更多…

依赖于使用的RDBMS，有一个额外的事情可以做，能让我们更方便的使用多个数据库。

跨数据库关系

如果你使用的是MySQL，你可以为你的模型创建跨数据库的关系。为了做到这一步，你应该为Comment模型的表名添加数据库名称：

class Comment extends \yii\db\ActiveRecord
{
//...
    public function tableName()
    {
        return 'db2.comment';
    }
//...
}

现在，如果在Post模型中你定义了一个评论关系，你可以按如下方式使用：

$posts = Post::find()->joinWith('comments')->all();

参考

欲了解更多信息，参考http://www.yiiframework.com/doc-2.0/guide-db-dao.html#creating-dbconnections

自定义ActiveQuery类

默认情况下，所有的Active Record查询是由\yii\db\ActiveQuery支持的。为了在一个Active Record中使用一个自定义的查询类，你可以重写\yii\db\ActiveRecord::find()方法，并返回一个你的自定义查询类的实例。

准备

1. 按照官方指南http://www.yiiframework.com/doc-2.0/guide-start-installation.html的描述，使用Composer包管理器创建一个新的应用。
2. 设置数据库连接，创建一个名为post的表：

DROP TABLE IF EXISTS ''post'';
CREATE TABLE IF NOT EXISTS ''post'' (
''id'' INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
''lang'' VARCHAR(5) NOT NULL DEFAULT ''en'',
''title'' VARCHAR(255) NOT NULL,
''text'' TEXT NOT NULL,
PRIMARY KEY (''id'')
);
INSERT INTO ''post''(''id'',''lang'',''title'',''text'')
VALUES (1,''en_us'',''Yii news'',''Text in English''),
(2,''de'',''Yii Nachrichten'',''Text in Deutsch'');

1. 使用Gii生成一个Post模型，并选中Generate ActiveQuery选项，这会生成PostQuery类。

如何做…

1. 为models/PostQuery.php添加如下方法：

<?php
namespace app\models;
/**
 * This is the ActiveQuery class for [[Post]].
 *
 * @see Post
 */
class PostQuery extends \yii\db\ActiveQuery
{
/**
 * @param $lang
 *
 * @return $this
 */
    public function lang($lang)
    {
        return $this->where([ 'lang' => $lang ]);
    }
}

1. 现在，我们可以使用我们的模型。创建controllers/DbController.php：

<?php
namespace app\controllers;
use app\models\Post;
use yii\helpers\Html;
use yii\web\Controller;
/**
 * Class DbController.
 * @package app\controllers
 */
class DbController extends Controller
{
    public function actionIndex()
    {
        // Get posts written in default application language
        $posts = Post::find()->all();
        echo Html::tag('h1', 'Default language');
        foreach ($posts as $post) {
            echo Html::tag('h2', $post->title);
            echo $post->text;
        }
        // Get posts written in German
        $posts = Post::find()->lang('de')->all();
        echo Html::tag('h1', 'German');
        foreach ($posts as $post) {
            echo Html::tag('h2', $post->title);
            echo $post->text;
        }
    }
}

1. 现在运行db/index你会得到类似如下截图所示的输出：

工作原理…

我们在Post模型中重写了find方法，并扩展了ActiveQuery类。lang方法返回指定语言值的ActiveQuery。为了支持链式调用，lang返回自身模型的实例。

参考

欲了解更多信息，参考如下地址：

• http://www.yiiframework.com/doc-2.0/guide-db-active-record.html#customizing-query-classes
• http://www.yiiframework.com/doc-2.0/guide-intro-upgrade-from-v1.html#active-record

使用AR event-like方法处理model fields

Yii中实现的Active Record非常强大，并有很多特性。其中一个特性就是event-like方法，你可以在将存入数据库之前或者从数据库中取出来时，利用它预处理模型字段，也可以删除和模型相关的数据等等。

在本节中，我们将会链接post文本中所有的URL，并列出所有存在的Active Record event-like方法。

准备

1. 按照官方指南http://www.yiiframework.com/doc-2.0/guide-start-installation.html的描述，使用Composer包管理器创建一个新的应用。
2. 设置数据库连接并创建一个名叫post的表：

DROP TABLE IF EXISTS 'post';
CREATE TABLE IF NOT EXISTS 'post' (
  'id' INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
  'title' VARCHAR(255) NOT NULL,
  'text' TEXT NOT NULL,
  PRIMARY KEY ('id')
);

1. 使用Gii生成Post模型。

如何做…

1. 添加如下方法到models/Post.php：

/**
* @param bool $insert
*
* @return bool
*/
public function beforeSave($insert)
{
    $this->text = preg_replace(
        '~((?:https?|ftps?)://.*?)(|$)~iu', 
        '<a href="\1">\1</a>\2', 
        $this->text
    );
    return parent::beforeSave($insert);
}

1. 现在尝试保存一个包含链接的帖子，创建controllers/TestController.php：

<?php
namespace app\controllers;
use app\models\Post;
use yii\helpers\Html;
use yii\helpers\VarDumper;
use yii\web\Controller;
/**
 * Class TestController.
 * @package app\controllers
 */
class TestController extends Controller
{
    public function actionIndex()
    {
        $post = new Post();
        $post->title = 'links test';
        $post->text = 'before http://www.yiiframework.com/
after';
        $post->save();
        return $this->renderContent(Html::tag('pre',
            VarDumper::dumpAsString(
                $post->attributes
            )));
    }
}

1. 现在，运行test/index。你会得到如下结果：

工作原理…

ActiveRecord类中实现的方法beforeSave是在保存之前执行的。使用一个正则表达式，我们将所有的URL替换成链接。为了防止保存，你可以返回false。

参考

• 欲了解更多信息，访问http://www.yiiframework.com/doc-2.0/guide-db-activerecord. html#active-record-life-cycles。
• 第一章基础中的使用事件小节
• 自动化时间戳小节
• 自动设置一个作者小节
• 自动设置一个slug小节

自动化时间戳

举个例子，我们有一个简单的博客应用。在任何一个博客中，有帖子、评论等等。我们希望在创建或者更新帖子时，生成时间戳。假设我们的帖子模型是BlogPost。

准备

1. 按照官方指南http://www.yiiframework.com/doc-2.0/guide-start-installation.html的描述，使用Composer包管理器创建一个新的应用。
2. 设置数据库连接并创建一个表名叫blog_post：

DROP TABLE IF EXISTS 'blog_post';
CREATE TABLE IF NOT EXISTS 'blog_post' (
  'id' INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
  'title' VARCHAR(255) NOT NULL,
  'text' TEXT NOT NULL,
  'created_date' INTEGER,
  'modified_date'INTEGER,
  PRIMARY KEY ('id')
);

1. 使用Gii为blog_post表创建一个模型。

如何做…

1. 将如下方法添加到models/BlogPost.php：

/**
 * @return array
 */
public function behaviors()
{
    return [
        'timestamp'=> [
            'class' => 'yii\behaviors\TimestampBehavior',
            'createdAtAttribute' => 'creation_date',
            'updatedAtAttribute' => 'modified_date'
        ]
    ];
}

1. 创建controllers/TestController.php：

<?php
namespace app\controllers;
use app\models\BlogPost;
use yii\helpers\Html;
use yii\helpers\VarDumper;
use yii\web\Controller;
/**
 * Class TestController.
 * @package app\controllers
 */
class TestController extends Controller
{
    public function actionIndex()
    {
        $blogPost = new BlogPost();
        $blogPost->title = 'Gotcha!';
        $blogPost->text = 'We need some laughter to ease the
tension of holiday shopping.';
        $blogPost->save();
        return $this->renderContent(Html::tag('pre',
            VarDumper::dumpAsString($blogPost->attributes)
        ));
    }
}

1. 现在运行test/index，你将会得到如下结果：

工作原理…

默认情况下，Timestamp behavior填充created_at（创建模型时的时间戳）和updated_at（更新模型时的时间戳）。这样命名这些字段是标准经验，但也可以根据实际需求进行修改。

更多…

例如我们的字段名称是creation_date和modified_date。

根据这些字段使用behavior来配置我们的模型。此外，我们应该添加我们的behavior的代码到我们的Post模型：

<?php
namespace app\models;
use Yii;
use yii\db\BaseActiveRecord;
class Post extends \yii\db\ActiveRecord
{
// ..
    public function behaviors()
    {
        return [
            [
                'class' => 'yii\behaviors\TimestampBehavior',
                'attributes' => [
                    BaseActiveRecord::EVENT_BEFORE_INSERT =>
                        'creation_date',
                    BaseActiveRecord::EVENT_BEFORE_UPDATE =>
                        'modified_date',
                ]
            ]
        ];
    }
// ..
}

在这个例子中，我们设定了creation_date和modified_date，在创建和更新时分别使用如下事件：EVENT_BEFORE_INSERT和EVENT_BEFORE_UPDATE。

其它…

在一些场景中，你可能希望保存时间戳。例如你希望给一个特定的控制器动作更新last_login字段。在这种情况下，你可以使用如下方式触发时间戳更新：

$model->touch('last_login');

注意touch()不能用于新模型，否则你得到InvalidCallException异常：

$model = new Post();
$model->touch('creation_date');

touch()方法在它内部调用模型保存，所以你不需要再次调用。

参考

欲了解更多信息，参考http://www.yiiframework.com/doc-2.0/guide-conceptbehaviors.html#using-timestampbehavior

自动设置一个作者

Blameable behavior允许你自动更新一个或多个作者的字段。它主要用于生成created_by和update_by字段的数据。和时间戳行为类似，你可以很容易为这个行为指定一些特殊的参数和必要的事件。

回顾上节中的例子。在我们的博客应用中也有帖子。例如，假设我们的博客模型叫做BlogPost。模型有author_id字段，它标明创建这个帖子的人，以及updater_id，它标明更新这个帖子的人。我们希望在创建或者更新模型事件时自动填写这些字段。现在你将学习如何做到这个。

准备

1. 按照官方指南http://www.yiiframework.com/doc-2.0/guide-start-installation.html的描述，使用Composer包管理器创建一个新的应用。
2. 设置数据库连接并创建一个名叫blog_post的表：

DROP TABLE IF EXISTS 'blog_post';
CREATE TABLE IF NOT EXISTS 'blog_post' (
  'id' INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
  'author_id' INT(10) UNSIGNED DEFAULT NULL,
  'updater_id' INT(10) UNSIGNED DEFAULT NULL,
  'title' VARCHAR(255) NOT NULL,
  'text' TEXT NOT NULL,
  PRIMARY KEY ('id')
);

1. 使用Gii为blog_post表生成BlogPost模型。

如何做…

1. 添加如下behaviors方法到models/BlogPost.php：

<?php
namespace app\models;
use Yii;
use yii\db\BaseActiveRecord;
/**
 * This is the model class for table "blog_post".
 *
 * @property integer $id
 * @property integer $author_id
 * @property integer $updater_id
 * @property string $title
 * @property string $text
 */
class BlogPost extends \yii\db\ActiveRecord
{
    /**
     * @return array
     */
    public function behaviors()
    {
        return [
            [
                'class' => 'yii\behaviors\BlameableBehavior',
                'attributes' => [
                    BaseActiveRecord::EVENT_BEFORE_INSERT =>
                        'author_id',
                    BaseActiveRecord::EVENT_BEFORE_UPDATE =>
                        'updater_id'
                ]
            ]
        ];
    }
}

1. 创建controllers/TestController.php：

<?php
namespace app\controllers;
use app\models\BlogPost;
use app\models\User;
use Yii;
use yii\helpers\Html;
use yii\helpers\VarDumper;
use yii\web\Controller;
/**
 * Class TestController.
 * @package app\controllers
 */
class TestController extends Controller
{
    public function actionIndex()
    {
        $users = new User();
        $identity = $users->findIdentity(100);
        Yii::$app->user->setIdentity($identity);
        $blogPost = new BlogPost();
        $blogPost->title = 'Very pretty title';
        $blogPost->text = 'Success is not final, failure is not fatal...';
        $blogPost->save();
        return $this->renderContent(Html::tag('pre',
            VarDumper::dumpAsString(
                $blogPost->attributes
            )));
    }
}

1. 运行test/index，你将会得到如下结果：

工作原理…

默认情况下，Blameable行为填充created_by和updated_by字段，但是我们根据需求改变。

我们也指定了模型事件和字段，所以在模型创建时，author_id将会填充。类似地，在模型更新时，我们将会填充updater_id。

Blameable所做的就是当创建或者更新模型事件发生时，将当前的用户ID值插入到created_by和updated_by字段。这是非常便利的一个方法。每次创建或者更新模型时，我们将自动填充必要的字段。

这对于一些项目非常有用，例如对于大型系统，当多个用户是管理员，你需要知道谁都做了些什么。你也可以为前端实现使用这个。例如，如果你有一个blog_comment表，你希望使用这个方法来记录评论的作者。此外，你可以在控制器中设置作者的字段，但这个行为帮助你避免写不必要的和额外的代码。这将非常有效并且简单。

更多…

有时我们希望使用一个id填充author_id和updater_id，而不是当前用户。在这种情况下，我们需要拆除这个行为：

$model->detachBehavior('blammable');

参考

欲了解更多信息，参考http://www.yiiframework.com/doc-2.0/yii-behaviorsblameablebehavior.html。

自动设置一个slug

在web中，slug是一个用于URL中的短文本，用来标识和描述一个资源。slug是URL的一部分，它使用可读的关键词标定一个网页。Sluggable行为是Yii2模型行为，它能为我们生成唯一的slugs。

在本节中，我们将会指导你修改Yii默认URL，修改成一个用户友好和搜索引擎友好的格式。Yii通过一个sluggable行为为这个提供内置支持。

准备

1. 按照官方指南http://www.yiiframework.com/doc-2.0/guide-start-installation.html的描述，使用Composer包管理器创建一个新的应用。
2. 设置数据库连接，并创建一个名为blog_post的表：

DROP TABLE IF EXISTS 'blog_post';
CREATE TABLE IF NOT EXISTS 'blog_post' (
  'id' INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
  'title' VARCHAR(255) NOT NULL,
  'slug' VARCHAR(255) NOT NULL,
  'text' TEXT NOT NULL,
  PRIMARY KEY ('id')
);

1. 使用Gii为帖子表创建一个模型。

如何做…

1. 为models/BlogPost.php添加如下behaviors方法：

<?php
namespace app\models;
use Yii;
use yii\db\BaseActiveRecord;
class BlogPost extends \yii\db\ActiveRecord
{
    // ..
    public function behaviors()
    {
        return [
            [
                'class' => 'yii\behaviors\SluggableBehavior',
                'attribute' => 'title',
                'slugAttribute' => 'slug',
                'immutable'=> false,
                'ensureUnique' => true
            ]
        ];
    }
    // ..
}

1. 创建controllers/TestController.php：

<?php
namespace app\controllers;
use app\models\BlogPost;
use Yii;
use yii\helpers\Html;
use yii\helpers\VarDumper;
use yii\web\Controller;
/**
 * Class TestController
 * @package app\controllers
 */
class TestController extends Controller
{
    public function actionIndex()
    {
        $blogPostA = new BlogPost();
        $blogPostA->title = 'Super Quote title 1';
        $blogPostA->text = 'The price of success is hard work, dedication to the job at hand';
        $blogPostA->save();
        $blogPostB = new BlogPost();
        $blogPostB->title = 'Super Quote title 2';
        $blogPostB->text = 'Happiness lies in the joy of achievement...';
        $blogPostB->save();
        return $this->renderContent(
            '<pre>' .
            VarDumper::dumpAsString(
                $blogPostA->attributes
            ).
            VarDumper::dumpAsString(
                $blogPostB->attributes
            ) .
            '</pre>'
        );
    }
}

1. 结果如下：

工作原理…

• Yii为SluggableBehavior提供了一些友好的增强功能。
• 例如，一旦一个搜索引擎记录了一个slug，你不要再修改页面的URL。
• 不可变的属性告诉Yii在首次创建后保持slug不变——尽管标题被修改了。
• 如果用户输入消息覆盖了内容，ensureUnique属性将会自动附加一个唯一的后缀到复件中。这保证了每一个消息都有一个唯一的URL，即时是消息是唯一的。
• 如果你创建了另一个帖子，和之前有相同的内容，你将会看到它的slug自动增加为hot-update-for-ios-devices-2。

注意

注意：如果你收到了一个关于这个不可变属性的错误，也许是因为你需要运行Composer来更新你的Yii到最新版本。

更多…

1. 使用Gii为模型app\models\Post生成CRUD和控制器app\controllers\BlogPostController。
2. 添加如下动作到app\controllers\BlogPostController：

/**
 * @param $slug
 *
 * @return string
 * @throws NotFoundHttpException
 */
public function actionSlug($slug)
{
    $model = BlogPost::findOne(['slug'=>$slug]);
    if ($model === null) {
        throw new NotFoundHttpException('The requested page does not exist.');
    }
    return $this->render('view', [
        'model' => $model,
    ]);
}

1. 如果你使用slug值sluggablebehavior-test运行blogpost/slug，你将会得到如下结果：

1. 建议使用一个Post模型的实例完成先前的slug小节。
2. 为了美化URL，在config/web.php中添加如下urlManager组件：

//..
'urlManager' => [
    'enablePrettyUrl' => true,
    'rules' => [
        'blog-post' => 'blog-post/index',
        'blog-post/index' => 'blog-post/index',
        'blog-post/create' => 'blog-post/create',
        'blog-post/view/<id:\d+>' => 'blog-post/view',
        'blog-post/update/<id:\d+>' => 'blog-post/update',
        'blog-post/delete/<id:\d+>' => 'blog-post/delete',
        'blog-post/<slug>' => 'blog-post/slug',
        'defaultRoute' => '/site/index',
    ],
]
//..

1. 注意blog-post/<slug>' => 'blog-post/slug规则。
2. 如果你使用你的slug URL访问网页，例如index.php/blog-post/super-quote-title-1/，你将会得到类似步骤3中的结果：

参考

欲了解更多信息，参考：

• http://www.yiiframework.com/doc-2.0/yii-behaviors-sluggablebehavior.html
• http://www.yiiframework.com/doc-2.0/guide-runtime-routing.html#url-rules

事务

在现代数据库中，事务可以做一些别的事情，例如保证在别人写数据的时候你没有访问数据的权限。但是，基本的思想是一样的——事务能保证无论发生什么事情，你使用的数据都是可感知的。他们保证不存在这样这样一种情况，钱从一个账户中拿走了，但没有进入另外一个账户中。

Yii2支持强大的带有保存点的事务机制。

一个经典的例子是，将钱从一个银行账户转移到另外一个银行账户中。为了做到这一点，首先你需要从源账户中取出钱，然后转移到目标账户中。这个操作必须全部成功。如果半道终止了，钱将会丢失。例如，我们有一个接收账户和一个发送账户。我们需要将钱从发送账户转移到接收账户中。假设我们有一个账户模型。

准备…

账户模型非常简单，只包含id和balance两个字段。

1. 按照官方指南http://www.yiiframework.com/doc-2.0/guide-start-installation.html的描述，使用Composer包管理器创建一个新的应用。
2. 创建一个migration，它会使用如下命令添加一个账户表：

./yii migrate/create create_account_table

1. 同时，使用如下代码更新刚刚创建的migration：

<?php
use yii\db\Schema;
use yii\db\Migration;
class m150620_062034_create_account_table extends Migration
{
    const TABLE_NAME = '{{%account}}';
    public function up()
    {
        $tableOptions = null;
        if ($this->db->driverName === 'mysql') {
            $tableOptions = 'CHARACTER SET utf8 COLLATE utf8_general_ci ENGINE=InnoDB';
        }
        $this->createTable(self::TABLE_NAME, [
            'id' => Schema::TYPE_PK,
            'balance' => ' NUMERIC(15,2) DEFAULT NULL',
        ], $tableOptions);
    }
    public function down()
    {
        $this->dropTable(self::TABLE_NAME);
    }
}

1. 然后使用如下命令安装migration：

./yii migrate up

1. 使用Gii为账户表创建模型。
2. 创建一个migration，他会添加一些测试Account模型到表中：

./yii migrate/create add_account_records

1. 同时，使用如下代码更新刚刚创建的migration：

<?php
use yii\db\Migration;
use app\models\Account;
class m150620_063252_add_account_records extends Migration
{
    public function up()
    {
        $accountFirst = new Account();
        $accountFirst->balance = 1110;
        $accountFirst->save();
        $accountSecond = new Account();
        $accountSecond->balance = 779;
        $accountSecond->save();
        $accountThird = new Account();
        $accountThird->balance = 568;
        $accountThird->save();
        return true;
    }
    public function down()
    {
        $this->truncateTable('{{%account}}');
        return false;
    }
}

如何做…

1. 添加如下规则到models/Account.php中的rules方法：

public function rules()
{
    return [
        //..
        [['balance'], 'number', 'min' => 0],
        //..
    ];
}

1. 假设balance只能是正的，不能是负值。
2. 给TestController创建success和error动作：

<?php
namespace app\controllers;
use app\models\Account;
use Yii;
use yii\db\Exception;
use yii\helpers\Html;
use yii\helpers\VarDumper;
use yii\web\Controller;
class TestController extends Controller
{
    public function actionSuccess()
    {
        $transaction = Yii::$app->db->beginTransaction();
        try {
            $recipient = Account::findOne(1);
            $sender = Account::findOne(2);
            $transferAmount = 177;
            $recipient->balance += $transferAmount;
            $sender->balance -= $transferAmount;
            if ($sender->save() && $recipient->save()) {
                $transaction->commit();
                return $this->renderContent(
                    Html::tag('h1', 'Money transfer was successfully')
                );
            } else {
                $transaction->rollBack();
                throw new Exception('Money transfer failed:' .
                    VarDumper::dumpAsString($sender->getErrors()) .
                    VarDumper::dumpAsString($recipient->getErrors())
                );
            }
        } catch ( Exception $e ) {
            $transaction->rollBack();
            throw $e;
        }
    }
    public function actionError()
    {
        $transaction = Yii::$app->db->beginTransaction();
        try {
            $recipient = Account::findOne(1);
            $sender = Account::findOne(3);
            $transferAmount = 1000;
            $recipient->balance += $transferAmount;
            $sender->balance -= $transferAmount;
            if ($sender->save() && $recipient->save()) {
                $transaction->commit();
                return $this->renderContent(
                    Html::tag('h1', 'Money transfer was successfully')
                );
            } else {
                $transaction->rollBack();
                throw new Exception('Money transfer failed: ' .
                    VarDumper::dumpAsString($sender->getErrors()) .
                    VarDumper::dumpAsString($recipient->getErrors())
                );
            }
        } catch ( Exception $e ) {
            $transaction->rollBack();
            throw $e;
        }
    }
}

1. 运行test/success你会得到如下输出：

1. 在这中情况下，如果发生了一些错误，事务机制不会更新接收者账户和发送者账户。
2. 运行test/error你将会得到如下输出：

如果你记得，我们给Account模型添加了一条规则，所以我们的账户只能是正的。在这种情况下，事务将会回滚，它阻止了从发送者账户中取出钱，但没有钱到接收者账户中的情况。

参考

欲了解更多信息，参考：

• http://www.yiiframework.com/doc-2.0/guide-db-dao.html#performing-transactions
• http://www.yiiframework.com/doc-2.0/guide-db-dao.html#nesting-transactions

复制和读写分离

在本节中，我们将学习如何复制和读写分离。我们将会看到slave和master服务器如何帮助我们做到这些。

准备

1. 按照官方指南http://www.yiiframework.com/doc-2.0/guide-start-installation.html的描述，使用Composer包管理器创建一个新的应用。
2. 设置数据库连接并创建一个名叫post的表：

DROP TABLE IF EXISTS 'blog_post';
CREATE TABLE IF NOT EXISTS 'blog_post' (
  'id' INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
  'title' VARCHAR(255) NOT NULL,
  'text' TEXT NOT NULL,
  'created_at' INTEGER,
  'modified_at'INTEGER,
  PRIMARY KEY ('id')
);

1. 为表blog_post创建BlogPost模型。
2. 按照文章https://www.digitalocean.com/community/tutorials/how-to-set-up-master-slave-replication-inmysql/中的描述，在你的数据库服务器之间，配置主从复制。
3. 在config/main.php中配置db组件，下面是个例子：

'components' => [
    // ..
    'db' => [
        'class' => 'yii\db\Connection',
        'dsn' => 'mysql:host=4.4.4.4;dbname=masterdb',
        'username' => 'master',
        'password' => 'pass',
        'charset' => 'utf8',
        'slaveConfig' => [
            'username' => 'slave',
            'password' => 'pass',
        ],
        // list of slave configurations
        'slaves' => [
            ['dsn' => 'mysql:host=5.5.5.5;dbname=slavedb']
        ]
    ],
    //..
]

如何做…

1. 创建TestController.php：

<?php
namespace app\controllers;
use app\models\BlogPost;
use Yii;
use yii\helpers\Html;
use yii\helpers\VarDumper;
use yii\web\Controller;
/**
 * Class TestController
 * @package app\controllers
 */
class TestController extends Controller
{
    public function actionIndex(){
        $masterModel = new BlogPost();
        $masterModel->title = 'Awesome';
        $masterModel->text = 'Something is going on..';
        $masterModel->save();
        $postId = $masterModel->id;
        $replModel = BlogPost::findOne($postId);
        return $this->renderContent(
            Html::tag('h2', 'Master') .
            Html::tag('pre', VarDumper::dumpAsString(
                $masterModel
                    ? $masterModel->attributes
                    : null
            )) .
            Html::tag('h2', 'Slave') .
            Html::tag('pre', VarDumper::dumpAsString(
                $replModel
                    ? $replModel->attributes
                    : null
            ))
        );
    }
}

1. 运行test/index，你将会得到如下输出：

工作原理…

slave服务器用于数据读取，master服务器用于数据写入。ActiveRecord模型保存到master服务器中，数据复制到slave服务器中，然后$replModel在它上边找到。

更多…

\yii\db\Connection组件支持负载均衡和slaves之间的失效转移。当首都执行一个读查询时，\yii\db\Connection组件将会随机挑选一个slave并进行连接。如果这个slave死掉了，它将会尝试另外一个。如果所有的slaves都不可用，它将会连接到master。通过配置一个服务器状态缓存，死掉的服务器将会被记住，它将会在一段时间内不会被使用。

参考

欲了解更多信息，参考如下链接：

• http://www.yiiframework.com/doc-2.0/guide-db-dao.html#replication-and-read-write-splitting
• http://dev.mysql.com/doc/refman/5.6/en/replication.html
• http://docs.mongodb.org/manual/tutorial/deploy-replica-set/
• http://docs.mongodb.org/manual/tutorial/deploy-replica-set-for-testing/

实现单表继承

关系数据库不支持继承。如果我们需要在数据库中存储继承，我们需要通过代码来支持它。这个代码应该是高效的，从而它应该生成尽量少的JOINs。一个常见的解决方法是Matrin Fowler提出的，叫做单表继承。

当我们使用这个模式时，我们在一张表中存储所有的类树数据，并使用这个类型字段来决定模型的每一行。

作为一个例子，我们希望实现如下单表继承：

Car |- SportCar |- FamilyCar

准备

1. 按照官方指南http://www.yiiframework.com/doc-2.0/guide-start-installation.html的描述，使用Composer包管理器创建一个新的应用。
2. 创建并设置一个数据库，添加如下表格：

DROP TABLE IF EXISTS 'car';
CREATE TABLE 'car' (
  'id' int(10) UNSIGNED NOT NULL AUTO_INCREMENT,
  'name' varchar(255) NOT NULL,
  'type' varchar(100) NOT NULL,
  PRIMARY KEY ('id')
);
INSERT INTO 'car' ('name', 'type')
  VALUES ('Ford Focus', 'family'),
  ('Opel Astra', 'family'),
  ('Kia Ceed', 'family'),
  ('Porsche Boxster', 'sport'),
  ('Ferrari 550', 'sport');

1. 使用Gii为car表创建一个Car模型，并未Car模型生成ActiveQuery。

如何做…

1. 添加如下方法和属性到models/CarQuery.php：

/**
 * @var
 */
public $type;
/**
 * @param \yii\db\QueryBuilder $builder
 *
 * @return \yii\db\Query
 */
public function prepare($builder)
{
    if ($this->type !== null) {
        $this->andWhere(['type' => $this->type]);
    }
    return parent::prepare($builder);
}

1. 创建models/SportCar.php：

<?php
namespace app\models;
use Yii;
/**
 * Class SportCar
 * @package app\models
 */
class SportCar extends Car
{
    const TYPE = 'sport';
    /**
     * @return CarQuery
     */
    public static function find()
    {
        return new CarQuery(get_called_class(), ['where' =>
            ['type' => self::TYPE]]);
    }
    /**
     * @param bool $insert
     *
     * @return bool
     */
    public function beforeSave($insert)
    {
        $this->type = self::TYPE;
        return parent::beforeSave($insert);
    }
}

1. 创建models/FamilyCar.php：

<?php
namespace app\models;
use Yii;
/**
 * Class FamilyCar
 * @package app\models
 */
class FamilyCar extends Car
{
    const TYPE = 'family';
    /**
     * @return CarQuery
     */
    public static function find()
    {
        return new CarQuery(get_called_class(), ['where' =>
            ['type' => self::TYPE]]);
    }
    /**
     * @param bool $insert
     *
     * @return bool
     */
    public function beforeSave($insert)
    {
        $this->type = self::TYPE;
        return parent::beforeSave($insert);
    }
}

1. 添加如下方法到models/Car.php：

/**
 * @param array $row
 *
 * @return Car|FamilyCar|SportCar
 */
public static function instantiate($row)
{
    switch ($row['type']) {
        case SportCar::TYPE:
            return new SportCar();
        case FamilyCar::TYPE:
            return new FamilyCar();
        default:
            return new self;
    }
}

1. 添加TestController：

<?php
namespace app\controllers;
use app\models\Car;
use app\models\FamilyCar;
use Yii;
use yii\helpers\Html;
use yii\web\Controller;
/**
 * Class TestController
 * @package app\controllers
 */
class TestController extends Controller
{
    public function actionIndex()
    {
        echo Html::tag('h1', 'All cars');
        $cars = Car::find()->all();
        foreach ($cars as $car) {
            // Each car can be of class Car, SportCar or FamilyCar
            echo get_class($car).' '.$car->name."<br />";
        }
        echo Html::tag('h1', 'Family cars');
        $familyCars = FamilyCar::find()->all();
        foreach($familyCars as $car)
        {
            // Each car should be FamilyCar
            echo get_class($car).' '.$car->name."<br />";
        }
    }
}

1. 运行test/index，你将会得到如下输出：

工作原理…

基础模型Car是一个典型的Yii AR模型，除了他有两个额外的方法。tableName方法明确声明了模型使用的表名。单对于Car模型，这没有意义，单对于子模型，它将会返回相同的car表，这就是我们想要的——整个类树用一个表。instantiate方法被用于AR内部，当我们调用方法例如Car::find()->all()，用于创建一个模型的实例。我们使用一个switch来创建不同的类。

SportCar和FamilyCar模型只是设置了缺省的AR作用域，所以当我们使用SportCar::model()->方法查询模型时，我们只会得到SportCar模型。

参考

参考如下地址，了解更多关于单表继承模式，和Yii Active Record实现：

• http://martinfowler.com/eaaCatalog/singleTableInheritance.html
• https://blog.liip.ch/archive/2012/03/27/table-inheritance-with-doctrine.html
• http://www.yiiframework.com/doc/api/CActiveRecord/