LaravelEloquentORM对象关系映射(一)

Eloquent ORM&＃xff08;对象关系映射&＃xff09;
ORM&＃xff0c;即 Object-Relational Mapping&＃xff08;对象关系映射&＃xff09;&＃xff0c;它的作用是在关系型数据库和业务实体对象之间作一个映射&＃xff0c;这样&＃xff0c;我们在操作具体的 业务对象时&＃xff0c;就不需要再去和复杂的SQL语句打交道&＃xff0c;只需简单的操作对象的属性和方法即可。

ORM 两种最常见的实现方式是 ActiveRecord 和 DataMapper&＃xff0c;ActiveRecord 尤其流行&＃xff0c;在很多框架中都能看到它的身影。两者的区别主要在于 ActiveRecord 中模型与数据表一一对应&＃xff0c;而 DataMapper 中模型与数据表是完全分离的。

Laravel 中的 Eloquent ORM 使用的也是 ActiveRecord 实现方式&＃xff0c;每一个 Eloquent 模型类对应着数据库中的一张表&＃xff0c;我们通过调用模型类的相应方法实现对数据库的增删改查。

2、定义模型
2.1 创建模型

我们使用Artisan命令make:model生成模型类&＃xff0c;模型类默认位于app目录下&＃xff0c;我们也可以在创建时指定生成目录&＃xff1a;

php artisan make:model Models/Post

这样就会在app目录下生成一个Models目录&＃xff0c;并且在Models目录下生成一个Post模型类。Laravel 中所有模型类继承自Illuminate\Database\Eloquent\Model类。
2.2 指定表名

如果不手动指定&＃xff0c;默认Post对应的数据表为posts&＃xff0c;以此类推。也可以通过设置$table属性自定义表名&＃xff1a;

public $table &＃61; &＃39;posts&＃39;;

2.3 指定主键

Eloquent默认数据表主键为id&＃xff0c;当然也可以通过设置$primaryKey属性来自定义主键&＃xff1a;

public $primaryKey &＃61; &＃39;id&＃39;;

2.4 时间戳设置

默认情况下&＃xff0c;Eloquent模型类会自动管理时间戳列create_at和update_at&＃xff08;如果定义迁移时设置了这两列的话&＃xff09;&＃xff0c;如果要取消自动管理&＃xff0c;可以设置$timestamps属性为false&＃xff1a;

public $timestamps &＃61; false;

还有&＃xff0c;如果你想要设置时间戳的格式&＃xff0c;可以使用$dateFormat属性&＃xff0c;该属性决定了日期时间以何种格式存入数据库&＃xff0c;以及以何种格式显示&＃xff1a;

//设置日期时间格式为Unix时间戳
protected $dateFormat &＃61; &＃39;U&＃39;;

3、查询数据
3.1 获取多个模型

我们可以使用Eloquent模型上的all方法获取所有模型实例
$posts &＃61; Post::all();
需要了解的是每一个Eloquent模型本身都是一个查询构建器&＃xff0c;所有我们可以调用所有查询构建器上的方法&＃xff0c;只不过第一个方法调用都要使用静态方法调用&＃xff1a;

$posts &＃61; Post::where(&＃39;id&＃39;,&＃39;<&＃39;,3)->orderBy(&＃39;id&＃39;,&＃39;desc&＃39;)->take(1)->get();
dd($posts);
3.2 获取单个模型

可以使用查询构建器方法获取单个模型实例&＃xff1a;

$post &＃61; Post::where(&＃39;id&＃39;,1)->first();
dd($post);

当然也可以通过Eloquent模型类提供的快捷方法find&＃xff1a;

$post &＃61; Post::find(1);

3.3 聚合函数查询

如果要对查询结果进行计数、统计、最大值/最小值、平均数等聚合运算&＃xff0c;可以使用查询构建器上的对应方法&＃xff0c;我们我们查询文章总数&＃xff1a;

$count &＃61; Post::where(&＃39;id&＃39;,&＃39;>&＃39;,0)->count();
echo $count;

输出结果为3&＃xff0c;又或者我们想要获取文章最大阅读数&＃xff1a;

$views &＃61; Post::where(&＃39;id&＃39;,&＃39;>&＃39;,0)->max(&＃39;views&＃39;);
echo $views;

调用Eloquent模型类的save方法即可创建模型并插入数据到数据库&＃xff1a;

1.2 使用create方法插入数据

除此之外还可以使用create方法插入数据&＃xff0c;由于该方法中用到了批量赋值&＃xff08;Mass Assignment&＃xff09;&＃xff0c;所以我们需要在模型类中设置$fillable属性或者$guarded属性&＃xff0c;以表明哪些属性可以通过该方法设置&＃xff0c;哪些不可以。

开始之前&＃xff0c;我们先解释下什么是批量赋值&＃xff0c;以及为什么要使用批量赋值。

批量赋值的英文名称是Mass Assignment&＃xff0c;所谓的批量赋值是指当我们将一个数组发送到模型类用于创建新的模型实例的时候&＃xff08;通常是表单请求数据&＃xff09;&＃xff0c;我们可以简单通过如下方式实现&＃xff1a;

$post &＃61; Post::create(Input::all());

而不是像使用save方法那样一个一个的设置属性值&＃xff0c;如果模型属性很多的话&＃xff0c;使用save简直是噩梦有木有。

但事物总是相对的&＃xff0c;使用批量赋值是很方便&＃xff0c;但同时也带来了安全隐患&＃xff0c;很多时候模型类的某些属性值不是我们所期望通过批量赋值修改的&＃xff0c;比如用户模型有个user_type属性&＃xff0c;如果用户通过请求数据将其类型修改为管理员类型&＃xff0c;这显然是不允许的&＃xff0c;正是基于这一考虑&＃xff0c;Eloquent模型类为我们提供了$fillable属性和$guarded属性&＃xff0c;我们可以将其分别看作“白名单”和“黑名单”&＃xff0c;定义在$fillable中的属性可以通过批量赋值进行赋值&＃xff0c;而定义在$guarded中的属性在批量赋值时会被过滤掉。

那么如果我们确实想要修改定义在$guarded中的属性怎么办&＃xff1f;答案是使用save方法。

此外需要注意的是$fillable和$guarded方法同时只能定义一个&＃xff0c;原因嘛很简单&＃xff0c;非黑即白&＃xff0c;定义了一个另外一个也就确定了。

可见批量赋值不仅为我们创建模型提供了便利&＃xff0c;还避免了安全隐患&＃xff0c;提高了系统的安全性。

下面我们来演示一下批量赋值的使用。首先在Post模型中定义$guarded属性如下&＃xff1a;

protected $guarded &＃61; [&＃39;views&＃39;,&＃39;user_id&＃39;,&＃39;updated_at&＃39;,&＃39;created_at&＃39;];
然后在控制器中实现创建模型实例的逻辑&＃xff1a;

$input &＃61; [
    &＃39;title&＃39;&＃61;>&＃39;test 5&＃39;,
    &＃39;content&＃39;&＃61;>&＃39;test content&＃39;,
    &＃39;cat_id&＃39;&＃61;>1,
    &＃39;views&＃39;&＃61;>100,
    &＃39;user_id&＃39;&＃61;>2
];
$post &＃61; Post::create($input);
dd($post);

2、更新模型
2.1 使用save方法更新模型

save方法还可以用于更新模型&＃xff0c;要更新模型数据&＃xff0c;先要获取该模型实例&＃xff0c;然后修改模型属性&＃xff0c;再调用save方法保存即可&＃xff1a;

$post &＃61; Post::find(1);
$post->title &＃61; &＃39;test 1 title&＃39;;
if($post->save()){
    echo &＃39;更新文章成功&＃xff01;&＃39;;
}else{
    echo &＃39;更新文章失败&＃xff01;&＃39;;
}

2.2 使用update方法更新数据

和create相对应的&＃xff0c;Eloquent模型类还支持使用update方法更新数据&＃xff0c;同样要用到批量赋值&＃xff1a;

$input &＃61; [
    &＃39;title&＃39;&＃61;>&＃39;test 6 title&＃39;,
    &＃39;content&＃39;&＃61;>&＃39;test content 6&＃39;,
    &＃39;cat_id&＃39;&＃61;>1,
    &＃39;views&＃39;&＃61;>200,
    &＃39;user_id&＃39;&＃61;>1
];
$post &＃61; Post::find(6);
if($post->update($input)){
    echo &＃39;更新文章成功&＃xff01;&＃39;;
    dd($post);
}else{
    echo &＃39;更新文章失败&＃xff01;&＃39;;
}

1、删除模型
1.1 使用delete删除模型

删除模型很简单&＃xff0c;先获取要删除的模型实例&＃xff0c;然后调用delete方法即可&＃xff1a;

$post &＃61; Post::find(5);
if($post->delete()){
    echo &＃39;删除文章成功&＃xff01;&＃39;;
}else{
    echo &＃39;删除文章失败&＃xff01;&＃39;;
}

该方法返回true或false。
1.2 使用destroy删除模型

当然如果已知要删除的模型id的话&＃xff0c;可以用更简单的方法destroy直接删除&＃xff1a;

$deleted &＃61; Post::destroy(5);

你也可以一次传入多个模型id删除多个模型&＃xff1a;

$deleted &＃61; Post::destroy([1,2,3,4,5]);

调用destroy方法返回被删除的记录数。

1.3 使用查询构建器删除模型

既然前面提到Eloquent模型本身就是查询构建器&＃xff0c;也可以使用查询构建器风格删除模型&＃xff0c;比如我们要删除所有浏览数为0的文章&＃xff0c;可以使用如下方式&＃xff1a;

$deleted &＃61; Models\Post::where(&＃39;views&＃39;, 0)->delete();

返回结果为被删除的文章数。
1、查询作用域

Eloquent还支持将一些常用的查询封装到模型方法中&＃xff0c;方便调用&＃xff0c;我们将其称之为“查询作用域”&＃xff0c;实现查询作用域很简单&＃xff0c;只需要在模型方法前加上scope前缀即可&＃xff0c;比如我们经常需要获取浏览数最高的文章&＃xff0c;就可以使用该机制实现——在Post中定义一个scopePopular方法&＃xff1a;

public function scopePopular($query)
{
    return $query->where(&＃39;views&＃39;,&＃39;>&＃61;&＃39;,100);
}

对应的&＃xff0c;我们在控制器中定义测试代码如下&＃xff1a;

$posts &＃61; Post::popular()->orderBy(&＃39;views&＃39;,&＃39;desc&＃39;)->get();
foreach ($posts as $post) {
    echo &＃39;<&＃39;.$post->title.&＃39;> &＃39;.$post->views.&＃39;views
&＃39;;
}
2、模型事件

Eloquent也支持模型事件——当模型被创建、更新或删除的时候触发相应事件&＃xff0c;Eloquent目前支持八种事件类型&＃xff1a;creating、created、updating、updated、saving、saved、deleting、deleted。

deleting和deleted很好理解&＃xff0c;在删除模型时触发&＃xff0c;deleting在删除操作前执行&＃xff0c;deleted在删除完成后执行。

当创建模型时&＃xff0c;依次执行saving、creating、created和saved&＃xff0c;同理在更新模型时依次执行saving、updating、updated和saved。无论是使用批量赋值&＃xff08;create/update&＃xff09;还是直接调用save方法&＃xff0c;都会触发对应事件&＃xff08;前提是注册了相应的模型事件&＃xff09;。

你可以在任何你喜欢的地方注册模型事件&＃xff0c;这里我们选择在服务提供者AppServiceProvider的boot方法中注册&＃xff1a;

Post::saving(function($post){
    echo &＃39;saving event is fired
&＃39;;
});

Post::creating(function($post){
    echo &＃39;creating event is fired
&＃39;;
});

Post::created(function($post){
    echo &＃39;created event is fired
&＃39;;
});

Post::saved(function($post){
    echo &＃39;saved event is fired
&＃39;;
});