专栏首页全干工程师的收藏夹【译】20个 Laravel Eloquent 小技巧(上)

【译】20个 Laravel Eloquent 小技巧(上)

腾讯实习的项目按照公司的主流技术选型是PHP 流派的,而我习惯了 JAVA 的体系面对这个最好的语言还是挺不适应的。特别是很多写法用法以及框架知识不在文档中,语法又及其灵活就产生和每次看别人的代码都有种woc 还能这么写的感觉。所以遵循语言的编程范式,总结理解一些小技巧也是很有必要的。下面是翻译自 Laravel-News 的一篇教程,总结了 Laravel 的对象关系映射框架(ORM)的几个小技巧。

Eloquent ORM 在其表面简单易用的机制背后,还有很多半隐藏的功能或者少有人知的方法来实现一些很有用的需求。 在本文中,我将向您展示一些技巧。

1. 增量和减少

如果你平时是这么做的:

$article = Article::find($article_id);
$article->read_count++;
$article->save();

那么你可以试试这样:

$article = Article::find($article_id);
$article->increment('read_count');

或者这样也是可以的:

Article::find($article_id)->increment('read_count');
Article::find($article_id)->increment('read_count', 10); // +10
Product::find($produce_id)->decrement('stock'); // -1

2. XorY 方法

Eloquent有很多方法是两个方法的组合,实现 “请做X,否则做Y”这样的需求。

例 1 findOrFail():

可以把这样的代码:

$user = User::find($id);
if (!$user) { abort (404); }

换成这样:

$user = User::findOrFail($id);

例 2 firstOrCreate():

不需要写这么长:

$user = User::where('email', $email)->first();
if (!$user) {
  User::create([
    'email' => $email
  ]);
}

这样就够了:

$user = User::firstOrCreate(['email' => $email]);

3. 模型的 boot() 方法

在Eloquent模型中有一个名为boot()的神奇地方,您可以在其中覆盖默认行为:

class User extends Model
{
    public static function boot()
    {
        parent::boot();
        static::updating(function($model)
        {
            // 记录一些日志
            // 覆盖或者重写一些属性 比如$model->something = transform($something);
        });
    }
}

可能最常见的例子之一是在创建模型对象时设置一些字段值。比方说你需要在创建对象时候生成UUID字段。

4. 带条件以及排序的关联关系模型

通常定义关系模型的方法是这样的

public function users() {
    return $this->hasMany('App\User');    
}

但你是否知道在定义关系模型的时候就已经可以增加 where 或者 orderBy 的条件了? 比如说你需要定义一个特定类型的用户的关联关系并且用邮箱信息来排序,那你可以这么做:

public function approvedUsers() {
    return $this->hasMany('App\User')->where('approved', 1)->orderBy('email');
}

5. 模型属性: 时间戳, 附加属性(appends) 等

Eloquent模型有一些“参数”,会以该类的属性形式出现。 最常用的可能是这些:

class User extends Model {
    protected $table = 'users';
    protected $fillable = ['email', 'password']; // 这些字段可以在模型的 create 方法中直接创建
    protected $dates = ['created_at', 'deleted_at']; // 这些字段将会转换成 Carbon类型的,可以方便的使用 Carbon 提供的时间方法
    protected $appends = ['field1', 'field2']; // 序列化时候附加的额外属性,通过模型中定义 getXXXAttribute 的方式来定义
}

可不仅仅有这些,还有:

protected $primaryKey = 'uuid'; // 模型的主键名称可以不是默认的 id
public $incrementing = false; // 甚至可以不必是自增的类型!
protected $perPage = 25; // 是的,你还定义模型集合分页参数(默认是 15)
const CREATED_AT = 'created_at';
const UPDATED_AT = 'updated_at'; // 默认的时间戳字段也是可以改变的
public $timestamps = false; // 或者完全不用他

甚至还有更多,我仅仅列出了最有意思的一部分,更多请查看默认抽象Model类的代码,并查看所有使用的trait 方法。

6. 查询多个实体对象

find()方法想必大家都知道的吧?

$user = User::find(1);

我很惊讶很少有人知道它可以接受多个ID作为数组:

$users = User::find([1,2,3]);

7. WhereX

有一种很优雅的方式可以把下面的代码:

$users = User::where('approved', 1)->get();

改成这样:

$users = User::whereApproved(1)->get(); 

是的,你也可以改成任何字段的名称,并将其作为后缀附加到“where”,它将神奇的产生预想的效果(通过魔术方法实现调用)。

此外,Eloquent中还有一些与日期/时间相关的预定义方法:

User::whereDate('created_at', date('Y-m-d'));
User::whereDay('created_at', date('d'));
User::whereMonth('created_at', date('m'));
User::whereYear('created_at', date('Y'));

8. 使用关系模型字段排序

一个更复杂的“技巧”。 如果你有帖子,但要通过最新帖子对它们进行排序? 顶部有最新更新主题的论坛中非常常见的要求,对吧?

首先,定义关于该主题的最新帖子的关系:

public function latestPost()
{
    return $this->hasOne(\App\Post::class)->latest();
}

接下来可以在我们的控制器中用这个神奇的方法来实现:

$users = Topic::with('latestPost')->get()->sortByDesc('latestPost.created_at');

9. Eloquent::when() – 不用再写 if -else 啦

大部分时候我们用 if-else 来实现按条件查询,类似这样的代码:

if (request('filter_by') == 'likes') {
    $query->where('likes', '>', request('likes_amount', 0));
}
if (request('filter_by') == 'date') {
    $query->orderBy('created_at', request('ordering_rule', 'desc'));
}

但是一个更好的方法是——使用 when()方法

$query = Author::query();
$query->when(request('filter_by') == 'likes', function ($q) {
    return $q->where('likes', '>', request('likes_amount', 0));
});
$query->when(request('filter_by') == 'date', function ($q) {
    return $q->orderBy('created_at', request('ordering_rule', 'desc'));
});

它看起来可能不会更短或更优雅,但最强大的是可以传递参数:

$query = User::query();
$query->when(request('role', false), function ($q, $role) { 
    return $q->where('role_id', $role);
});
$authors = $query->get();

10. BelongsTo 关联的默认模型对象

假设有个 Post(帖子) 对象属于 Author (作者)对象,在 Blade 模板中有下面的代码

{{ $post->author->name }}

但是如果作者被删除,或者由于某种原因没有设置呢? 那么就会导致报错,可能是“property of non-object(非对象属性)”。

当然你可以用下面的代码来必变这种错误:

{{ $post->author->name ?? '' }}

不过你可以再模型定义时候就解决这个问题:

public function author()
{
    return $this->belongsTo('App\Author')->withDefault();
}

在这个例子中,在这个帖子下没有关联作者的时候,author()关联关系将返回一个空的App\Author 模型。

更进一步,我们可以设置一些默认属性个这个模型。

public function author()
{
    return $this->belongsTo('App\Author')->withDefault([
        'name' => 'Guest Author'
    ]);
}

太长了,下一篇再续上🤔😘

http://blog.kbiao.me/2019/01/05/20-Laravel-Eloquent-Tips-and-Tricks/

原文链接:https://laravel-news.com/eloquent-tips-tricks

原文作者:Laravel-News

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 【译】20个 Laravel Eloquent 小技巧(下)

    (设定了一个在返回对象时候的附加属性 ‘full_name’参见 tips5 模型属性: 时间戳, 附加属性(appends) 等)

    彪彪
  • 20 个 Laravel Eloquent 必备的实用技巧

    Eloquent ORM 看起来是一个简单的机制,但是在底层,有很多半隐藏的函数和鲜为人知的方式来实现更多功能。在这篇文章中,我将演示几个小技巧。

    猿哥
  • HDFS ZKFC实现NameNode自动切换原理

    官方文档: https://issues.apache.org/jira/secure/attachment/12521279/zkfc-design.pd...

    程裕强
  • 可变数据类型不能作为python函数的参数

    当使用列表作为参数传入函数时,实际上是引用传递。也就是传入的是实际参数的地址,而place=b也就是指向相同的地址。比如以下的:

    绝命生
  • 【职业】财务人员做分析报表的11个方法

    财务报表分析的主要依据是财务报表的数据资料,但是以金额表示的各项会计资 料并不能说明除本身以外的更多的问题。因此必须根据需要并采用一定的方法,将这些会计资料加以...

    小莹莹
  • 使用jsTree树形控件【1】入门

    部署环境使用压缩版的jsTree.min.js,如果是开发环境可以使用jsTree.js

    用户2936342
  • iOS 仿微信相册选择照片imagePicker(Swift) 序号 预览缩略图

    ZYImagePickerAndBrower 是一个模仿微信相册多选照片的一个控件。注意了微信相册的一些细节,比如序号,最大选择之后照片变灰,浏览缩略图等等。

    ZY_FlyWay
  • ssh的时候我最常用的6个快捷键

    ctrl+U:删除行首至光标所在处的所有内容 ctrl+K:删除光标所在处至行尾的所有内容

    shawyang
  • Python学习笔记 异常处理

    Python和很多其他语言一样,支持异常处理。我们可以使用try-catch类似的形式捕获异常,处理异常,或者抛出异常。Python的异常命名惯例和Java语言...

    乐百川
  • 六、面向对象进阶

    生成器 1、什么是生成器 生成器是这样一个函数,它记住上一次返回时在函数体中的位置。对生成器函数的第二次(或第 n 次)调用跳转至该函数中间,而上次调用的所有局...

    酱紫安

扫码关注云+社区

领取腾讯云代金券