ModelHelper

对laravel Eloquent OMR 的一层带缓存的封装

版本	时间	说明
V1.0	2016-11-30	1.增加了分页自动缓存 2.增加了hasOne,hasMany自动缓存（非with） 3. 修改了，model event 无法执行的bug 4. 修改了with预加载无法执行的bug
V1.1	2017-4-26	修改Model生成时的模板，支持idehelper，实现phpstrom的代码自动补全
V1.2	2017-5-23	对缓存的值做了优化，由缓存对象改为缓存数组，可以提升约30%的效率，减少70%的redis内网带宽开销。
V1.2.2	2017-6-6	增加缓存版本控制，平滑升级，不用清理缓存。
V1.2.7	2017-7-19	在读缓存的时候，增加对象复用，避免一组数据，对象多次创建
V1.2.8	2017-9-19	修正一个bug：setcaches方法生成的缓存未增加版本控制
V1.2.10	2017-11-10	修正一个bug：delCleanCache 方法,主动增加fillable中设置的所有字段，保证设置过的缓存全部自动清理
V1.2.13	2017-11-13	修复一个bug: 自动化缓存，如果遇到空值，依旧写入缓存bug修正
V1.2.14	2018-3-28	formatWhere增加null，notnull支持；增加whereUpdate方法，以支持乐观锁；laravel5.5 兼容验证
V1.2.15	2018-5-25	修正PHP7.2下，where为空时，whereformat报错的bug
V1.2.14	2018-7-25	having 条件下 bug 修正
V1.2.17	2018-11-7	修改一个在极大数组循环里使用model方法时，内存泄露的bug
V1.2.18	2018-11-13	修正v1.2.7中，不兼容php7.2的bug
V1.2.19	2018-12-10	不兼容php7.2的bug继续修正
V1.2.22	2021-03-16	修正不能触发模型无法触发事件的bug

注意

不能使用Eloquent ORM 中的软删除方法（use SoftDeletes）。这个设计与原子化缓存的**设计有冲突
技术交流，请加qq群:370087262

封装的目的

在laravel的使用过程中，发现很多对model层缓存的透明化封装，而这些封装主要是对所有的sql语句进行了缓存，如果有数据的更新或者删除，则对数据进行了全部删除，做的好一些的，就是对表级数据，进行了删除。在实际使用过程中，特别是web类，面向用户的操作，更多的只是简单的select操作，如果我们将这些简单的select单条查询存入缓存，讲连表操作改成 select一张表中的数据list，然后foreach 该list，循环取另一张表的info类型，我们可以避免80%以上的连表操作。但是，这种做法，对缓存控制要求就很高了，对于缓存脏数据的清理，我们希望更精准，谁脏了，就干掉谁，而不是批量处理的做法，封装了此扩展。
自动缓存包含精准缓存的缓存删除操作。

什么是原子化缓存? 对应于原子化操作的定义，对一条不可在细分数据的缓存就是原子化缓存，通俗点说，就是对表的行数据的缓存

主要功能

自动原子化缓存（行数据缓存）
自动分页缓存
hasOne/hasMany 时，外键自动缓存
常用方法封装

用法

1.安装

composer require hbclare/model-helper:dev-master

修改comfig/app.php, 将'Eloquent' => 'Illuminate\Database\Eloquent\Model', 改为 'Eloquent' => 'Hbclare\ModelHelper\Model',

在porviders里面，增加 'Hbclare\ModelHelper\ModelHelperServiceProvider',

2.phpstrom的idehelper生成

1.查看是否存在app/ide-helper.php文件，不存在则执行

php7 artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config

打开文件config\ide-helper.php

'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
#修改为
'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder', 'Hbclare\ModelHelper\HelperQueryBuilder'),

执行命令，生成_ide_helper.php文件

php7 artisan ide-helper:generate

3.artisan方法，生成程序

假设我们有一个user表

字段	说明
id	主键id
passport	登陆账号
password	登陆密码
nickname	昵称
...	...

php artisan make:eachmodel Models/User

会在/app/Models 下生成User的model类

php artisan make:repository Repository/UserRepository

会在/app/Repository 下生成UserRepository类同时会在 /app/RepositoryInterface 目录下，生成UserRepositoryInterface类

4.在model中，缓存的使用

<?php
#Game.php
namespace App\Models\Desktop;
use Hbclare\ModelHelper\Model;

class Game extends Model
{
    //设置表名
    protected $table = 'game';

    //设置修改字段
    protected $fillable = [
        'game_category',
        'game_name',
        'game_license_key',
        'reviewed_status',
        'active_begin_data',
        'active_end_data',
    ];

    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);
        //开启自动原子缓存,设置缓存10小时
        $this->startAutoEachCache(600);
        //开启自动分页缓存，实验方法，暂时默认设置5分钟
        $this->startAutoPageCache(5)；
        //改后，需要处理的缓存
        $this->setAfterUpdateFlushKey(
            ['gameinfo_by_name_{game_name}']
        );
        //删后，需要处理的缓存
        $this->setAfterDeleteFlushKey(['gameinfo_by_name_{game_name}']);
        //新增后，需要处理的缓存
        $this->setAfterInsertFlushKey(['getGameList*']);
        //增删改，都需要处理的缓存
        $this->setFlushKeys(['gameinfo_by_name_{game_name}']);
    }
    
    public function hasManyImage()
    {
        return $this->hasMany('App\Models\CMGameImg', 'game_id');
    }

	public function getGameInfo($id){
		return $this->findOne($id);
	}

	public function changeGame($id, $game_name){
		$return $this->saveInfo(['id'=>$id, 'game_name'=>$game_name]);
	}
...
}

<?php
#GameImg.php
namespace App\Models;

use Hbclare\ModelHelper\Model;

class GameImg extends Model {
    //设置表名
    protected $table = 'game_img';

    //设置修改字段
    protected $fillable = [
        'game_id',
        'game_name',
        'game_img_url',
    ];
    //设置外键
    protected $foreignKeyArr = [
        'game_id',
    ];
    //关闭自动更新时间戳
    #public $timestamps = false;

    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);
        $this->startAutoEachCache(120);#设置120分钟缓存
    }

    public function belongsToGame()
    {
        return $this->belongsTo(CMGame::class, 'game_id', 'id');
    }
}

执行 $game->getGameInfo 就会自动生成autoCache_tableName_primaryName_{id} 的缓存

执行 $game->changeGame 就会删除autoCache_tableName_primaryName_{id}这个缓存

执行 $game->getGameInfo(1)->hasManyImage,会自动生成，'autoForeignCache_'.table_name.''.foreignKey_name.''.{foreignKeyValue};

执行 $gameImg update,delete操作，都会删除相关缓存

缓存优先级 setCacheKeys > autoForeignCache > autoCache

5.可以对较复杂的Model层操作，快速的进行缓存，同时对于该缓存key的设计，可以自动的进行缓存更新操作

A. key通配处理：

如 gameinfo_by_name_{game_name},括号中的game_name,对应的就是表中的字段名字，如果条件中有 game_name=lol 这样的条件，就会将key变成 gameinfo_by_name_lol,并触发缓存动作（写缓存，或者更新缓存）
一个key里面可以包含多个{},如: user_info_type_{type}id{id}
使用的时候要注意，如果通配符字段未完全匹配（必须是配置game_name='lol'，且所有调配符字段必须匹配上），则该条缓存key不触发任何条件
在reids的驱动下，可以支持*,?等通配符的支持
注意，*,?和{},不能组合使用
不带通配符时，100%匹配，eg：gameinfoList

B. 通配符触发情况

$model->setCacheKeys($key);

仅支持传入支付串，如: gameinfo_by_name_{game_name}
在紧接着的一个$model->get()中，触发缓存是否缓存，匹配则缓存，不匹配，则抛弃。不带通配符的时候，100%匹配。
setCacheKeys 缓存优先级，高于auto缓存
匹配条件从where中获取
匹配条件再从columns中获取
where 和 colums 分别匹配，不混合匹配
注意，该方法不能处理分页缓存，如果需要分页缓存，可以直接在在model中，开启自动分页缓存配置$this->startAutoPageCache(5);

$model->setAfterUpdateFlushKey([]);

传值支持字符串或者数组，eg: ['gameinfo_by_name_{game_name}'] or 'gameinfo_by_name_{game_name}'
每次，在执行完update操作，都会尝试匹配，如果匹配成功，则触发删除该缓存操作
匹配条件从where中获取
匹配条件再从columns中获取
where 和 colums 分别匹配，不混合匹配

$model->setAfterDeleteFlushKey([]);

传值支持字符串或者数组，eg: ['gameinfo_by_name_{game_name}'] or 'gameinfo_by_name_{game_name}'
每次，在执行delete后操作（注意，这里实际执行步骤，在delete真正执行之前），都会尝试匹配，如果匹配成功，则触发删除该缓存操作
匹配条件从where中获取

$model->setAfterInsertFlushKey([]);

传值支持字符串或者数组，eg: ['gameinfoList'] or 'gameinfoList'
每次，在执行Inserter后操作，都会尝试匹配，如果匹配成功，则触发删除该缓存操作。不带通配符的时候，100%匹配。
匹配条件从columns中获取

$model->setFlushKeys([$flushData]);

传值支持字符串或者数组，eg: ['gameinfoList'] or 'gameinfoList'
相当于分给 setAfterUpdateFlushKey，setAfterDeleteFlushKey，setAfterInsertFlushKey写入了[$flushData]值

6. 提供常用sql封装方法，方便代码书写

A. getOne()：通过主键查找数据，如果开启原子化缓存会自动处理缓存（测试通过）

$model->getOne($id);

B. getOne：通过条件查找数据（测试通过）

param array $where eg:['id'=>1,'fild'=>2]

param array $orderBy eg：['id'=>'desc']

$model->findOne(['username'=>'testname'], ['age'=>'desc']);

C. getListUpgraded：得到列表数据，建议使用

param array $where 查询条件 eg: ['name'=>'test']

param array $predicate 断言条件 eg：

[
   'groupBy'=>['name'], #groupBy 的 value,支持字符串 'name' ，或者数组 [ 'name', 'sex' ]
   'haveing'=>['name'], #必须是数组[$column, $operator = null, $value = null, $boolean = 'and'
   'orderBy'=>['name'], # orderBy 的 value为数组 ['id'=>'desc']
   'skip'=>0,  #起始值，从0开始
   'take'=>20, #获得的条数
]

param string/array fields 查询字段，字符串或者数组

$where = [
    'client_type'   => $clientType,
    'real_time'     => ['between', [$startDay, $endDay]]
];
if( !empty($provCode) && 'all' != $provCode){
    $where['prov_code'] = $provCode;
}
if( !empty($cityCode) ){
    $where['city_code'] = $cityCode;
}

$fields = [
    DB::raw('DATE_FORMAT(real_time, \'%Y-%m-%d\') as show_date') ,
    DB::raw('count(id) as kdump_num'),
    DB::raw('count(DISTINCT gid) as kdump_gid_num')
];
$predicate = [
    'groupBy' => 'show_date',
    'orderBy' => ['id'=>asc]
];
return $this->KDumpModels->getListUpgraded($where, $predicate, $fields);

D. getList: 得到列表数据，不建议使用

向下兼容方法，不建议时间，具体使用方法，请看源码

E. getPaginateListUpgraded:获得分页数据高级方法，建议使用

param array $where 查询条件 eg: ['name'=>'test']

param int $pageNum 每页展示条数

param array $predicate 断言条件，同 getListUpgraded

param string/array fields 查询字段，字符串或者数组

F. getPaginateList:获得分页数据,不建议使用

G. saveInfo:保存/修改方法（测试通过）

param array saveInfo 需要保存或者修改的值，自动判断主键，自动清理缓存

H. delCleanCache: 条件删除，同时删除自动生成的缓存

执行流程是，先查找出id，再按照id删除

I. del:根据条件删除数据

直接删除

7.特别注意

在getOne的时候使用with预加载功能，会将预加载的值也缓存起来，可能产生脏数据。使用的时候需要注意一下。
在使用setCacheKeys的时候，也会缓存预加载问题
在with过程中，setCacheKeys 方法会失效，因为with过程中，产生了新的Builder对象,原来对象中的配置消失了，这里可以使用Cache方法来做三级缓存

8. 代码Demo

复杂sql写法

select * from `csp_netbar` where 
`netbar_name` like %123% 
or `netbar_address` like %123% 
or `license_key` like %123% 
and 
(`city_id` = 207 
and `borough_id` = 2126 
and `ip` = 33333 
and `contact_number` = 123123 
and `soft_name` = 6)

$where = [];
$where['city_id'] = 207;
$where['borough_id'] = 2126;
$where['ip'] = 33333;
$where['contact_number'] = 123123;
$where['soft_name'] = $condition['soft_name'];
$where['netbar_name'] = ['or', ['like', '%123%']];
$where['netbar_address'] = ['or', ['like', '%123%']];
$where['license_key'] = ['or', ['like', '%123%']];
$mode->getList($where);

select * from `csp_netbar` where 
(`city_id` = 207 
and `borough_id` = 2126) 
or (`ip` = 33333 
and `soft_name` = 6)

$where[] = [
    'raw', 
    "(`city_id` = 207 
and `borough_id` = 2126) 
or (`ip` = 33333 
and `soft_name` = 6)"
];
$mode->getList($where);

laravelSTHelper/ModelHelper

ModelHelper

注意

封装的目的

主要功能

用法

1.安装

2.phpstrom的idehelper生成

3.artisan方法，生成程序

4.在model中，缓存的使用

5.可以对较复杂的Model层操作，快速的进行缓存，同时对于该缓存key的设计，可以自动的进行缓存更新操作

A. key通配处理：

B. 通配符触发情况

6. 提供常用sql封装方法，方便代码书写

A. getOne()：通过主键查找数据，如果开启原子化缓存会自动处理缓存（测试通过）

B. getOne：通过条件查找数据（测试通过）

C. getListUpgraded：得到列表数据，建议使用

D. getList: 得到列表数据，不建议使用

E. getPaginateListUpgraded:获得分页数据高级方法，建议使用

F. getPaginateList:获得分页数据,不建议使用

G. saveInfo:保存/修改方法（测试通过）

H. delCleanCache: 条件删除，同时删除自动生成的缓存

I. del:根据条件删除数据

7.特别注意

8. 代码Demo