Laravel学习笔记之Model Observer模型观察者

说明：本文主要学习下Laravel的Model Observer模型观察者，把一点点经验分享出来希望对别人能有帮助。同时，作者会将开发过程中的一些截图和代码黏上去，提高阅读效率。

备注：上一篇文章：Laravel学习笔记之Redis保存页面浏览量，作者在开发的时候有个逻辑有点在意：那篇文章再用Redis保存浏览量后，当浏览量达到设置的次数后刷到MySQL里，同时把Redis里该浏览量键抹掉，还有Post的内容键抹掉，以便下一次请求从MySQL里请求到新的数据并缓存。研究时，发现可以使用Model Observer来实现Model的事件变化来自动刷新flush下Redis，个人觉得有点像是定义了一个事件监听器监听模型事件一样。这篇文章就用下Model Observer重新组织下代码。可以大概看下上篇文章的基本逻辑。

开发环境：Laravel5.1+MAMP+PHP7+MySQL5.5

没有Model Observer逻辑

看下最主要的浏览量达到一定量后刷到MySQL里的逻辑：

 /**
     * 不同用户访问,更新缓存中浏览次数
     * @param $id
     * @param $ip
     */
    public function updateCacheViewCount($id, $ip)
    {
        $cacheKey        = 'post:view:'.$id;
        //这里以Redis哈希类型存储键,就和数组类似,$cacheKey就类似数组名,$ip为$key.HEXISTS指令判断$key是否存在$cacheKey中
        if(Redis::command('HEXISTS', [$cacheKey, $ip])){
            //哈希类型指令HINCRBY,就是给$cacheKey[$ip]加上一个值,这里一次访问就是1
            $incre_count = Redis::command('HINCRBY', [$cacheKey, $ip, 1]);
            //redis中这个存储浏览量的值达到30后,就往MySQL里刷下,这样就不需要每一次浏览,来一次query,效率不高
            if($incre_count == self::postViewLimit){
                $this->updateModelViewCount($id, $incre_count);
                //本篇post,redis中浏览量刷进MySQL后,把该篇post的浏览量键抹掉,等着下一次请求重新开始计数

                Redis::command('HDEL', [$cacheKey, $ip]);//浏览量这个删除key操作也可以在Model Observer里做,不过要把Redis改成Cache的方法,这里就不写了

                //同时,抹掉post内容的缓存键,这样就不用等10分钟后再更新view_count了,
                //如该篇post在100秒内就达到了30访问量,就在3分钟时更新下MySQL,并把缓存抹掉,下一次请求就从MySQL中请求到最新的view_count,
                //当然,100秒内view_count还是缓存的旧数据,极端情况300秒内都是旧数据,而缓存里已经有了29个新增访问量
                //实际上也可以这样做:在缓存post的时候,可以把view_count单独拿出来存入键值里如single_view_count,每一次都是给这个值加1,然后把这个值传入视图里
                //或者平衡设置下postViewLimit和ipExpireSec这两个参数,对于view_count这种实时性要求不高的可以这样做来着
                //加上laravel前缀,因为Cache::remember会自动在每一个key前加上laravel前缀,可以看cache.php中这个字段:'prefix' => 'laravel'
               
                //使用Model Observer后注销这句
//                Redis::command('DEL', ['laravel:post:cache:'.$id]);//利用Model Observer,这里就不用刷掉这个key,逻辑可在模型观察器里做
            }
        }else{
            //哈希类型指令HSET,和数组类似,就像$cacheKey[$ip] = 1;
            Redis::command('HSET', [$cacheKey, $ip, '1']);
        }
    }

这里在浏览量达到self::postViewLimit后把view_count刷到MySQL里并刷新下Redis，使用这个逻辑:

Redis::command('DEL', ['laravel:post:cache:'.$id]);

有Model Observer逻辑

可以注册一个模型观察者，在观察者类里做一些模型对应事件的逻辑，这里就是刷掉一些缓存键值。
在app/Observers/PostObserver.php(模型观察类放在哪里可以自定义)里：

<?php
/**
 * Created by PhpStorm.
 * User: liuxiang
 * Date: 16/6/19
 * Time: 17:11
 */
namespace App\Observers;

use App\Post;
use Cache;

class PostObserver
{
    public function saved()
    {
        //原来逻辑是:view_count达到30次后,把view_count刷进MySQL里,同时删掉缓存在Redis里的$post整个模型的内容.
        //这里观察saved事件,当把save_count值save()进MySQL后,就在这里刷下redis这个post的key.
        //在把内容缓存进Redis里,加上tag标签以便于识别和分别操作,个人觉得这是一个好习惯.
        Cache::tags([Post::table(), 'model'])->flush();
    }

    public function saving()
    {

    }

    public function deleted()
    {

    }
}

这里使用flush()方法只刷指定tag的缓存键，免得把别的key也刷了。这里打的标签其实是：['posts', 'model']，Post::table()定义返回Model关联的表名，看下Post这个Model:

class Post extends Model
{
    public function category()
    {
        return $this->belongsTo(Category::class);
    }

    public function comments()
    {
        return $this->hasMany(Comment::class);
    }

    public function tags()
    {
        return $this->belongsToMany(Tag::class)->withTimestamps();
    }

    /**
     * 在boot()方法里注册下模型观察类
     * boot()和observe()方法都是从Model类继承来的
     * 主要是observe()来注册模型观察类，可以用Post::observe(new PostObserve())
     * 并放在代码逻辑其他地方如路由都行，这里放在这个Post Model的boot()方法里自启动。
     */
    public static function boot()
    {
        parent::boot(); // TODO: Change the autogenerated stub
        static::observe(new PostObserver());
    }

    /**
     * 返回该Model关联的表
     * @return string
     */
    public static function table()
    {
        $model = new static;
        //调用Model类的public function getTable()
        return $model->getTable();
    }
}

还有别忘了在PostController里缓存Post Model的时候打上标签：

public function showPostCache(Request $request, $id)
    {
        //Redis缓存中没有该post,则从数据库中取值,并存入Redis中,该键值key='post:cache'.$id生命时间10分钟
        //在把内容缓存进Redis里,加上tag标签以便于识别和分别操作,个人觉得这是一个好习惯实际上.这里加个该post对应的表名标签,保持唯一性
        $post = Cache::tags([Post::table(), 'model'])->remember('post:cache:'.$id, self::modelCacheExpires, function () use ($id) {
            return Post::whereId($id)->first();
        });

        //获取客户端IP
        $ip   = $request->ip();
        //触发浏览量计数器事件
        event(new PostViewCount($post, $ip));

        return view('browse.post', compact('post'));
    }

现在测试下当view_count被刷进MySQL时，即saved()事件后，模型观察类有没有把['posts', 'model']这个标签的键给刷掉。这里设置下：

class PostEventListener
{
    /**
     * 同一post最大访问次数,再刷新数据库
     */
    const postViewLimit = 3;

    ...    
}    

不同IP刷下3次后缓存的Post Model有没有被刷掉。
第一个IP访问时Post Model已经被刷到Redis里了：

第三个IP访问时，Post Model已经被从Redis里刷掉了：

it is working!!!
这证明了view_count被save()进MySQL时，模型观察类逻辑起作用了。当然第四个IP访问后页面就会显示最新的浏览量了。

模型观察者这个功能能做很多事情，比如Model Update模型更新时发个通知。或者就像一篇文章的内容重新编辑保存后，把原来缓存内的该篇文章内容刷新下，这样下一个请求来的时候读的就是最新的文章内容了。作者以后会继续研究研究，发现挺好玩的东西到时候分享出来吧。

总结：本篇文章主要学了下Laravel的Model Observer模型观察者，发现这个功能也能使代码结构更清晰，觉得挺好的。最近一直在瞎研究，有遇到好玩的再分享出来吧。

欢迎关注Laravel-China。

RightCapital招聘Laravel DevOps