3分钟短文:Laravel模型读数据的那个“障眼法”

引言

通过前几篇文章视图和路由的介绍,我们通过模型对象操作数据库表。laravel模型的精巧设计使得我们操作数据层逻辑更加得心应手。

img

本文我们来说说模型在读写数据中所使用的技巧。

日期时间格式化

先从最常用的地方着手,比如在迁移文件内使用的 timestamps方法,就是在表内生成 created_atupdated_at两个 datetime 类型的字段,用于标记该记录的创建时间和更新时间。

laravel框架继承了广泛使用稳定可靠的 Carbon 类库用于操作日期时间。为了测试方便,我们不需要写额外的代码,直接使用 tinker 命令行交互工具,在命令行输入:

tinker

进入交互界面,然后我们使用模型查询一条 events 表的数据,并访问其属性:

namespace App;
$event = Event::find(1);
$event->created_at

打印 created_at 属性输入内容如下:

=> Illuminate\Support\Carbon {#819
    +"date": "2020-10-02 04:01:38.000000",
    +"timezone_type": 3,
    +"timezone": "Asia/Shanghai (+08:00)",
}

输出的是一个 Carbon 对象。也可以调用格式化方式返回需要的格式,比如返回时间字符串:

$event->created_at->toDateString()
// "2020-10-02"    

或者自定义格式:

$event->created_at->format('Y-m-d H:i')
// "2020-10-02 04:01"    

在模型内使用该格式化方式很容易,添加如下属性定义:

protected $dates = ['created_at','updated_at','started_at'];

那么这三个字段都会使用 Carbon 进行格式化,在访问模型对象属性时,就会返回该Carbon对象。

访问器

其实上一节所说的日期时间的格式化,正是laravel模型访问器的功能。专门用于在模型层面,修改模型属性的展示方式。定义一个访问器非常简单,就是在模型内添加规范格式的方法函数。比如想要使用

$model->human_size

而数据库没有这个字段,模型也没有这个属性,那么使用访问器好了,添加如下定义:

public funciton getHumanSizeAttribute(){}

方法内添加要处理的逻辑,并返回相应的值即可。使用 ->human_size 属性访问,就相当于访问了该方法。

下面是一个相对复杂的方法,根据不同情况返回字段name的值:

img

如果在忽略列表,就使用纯小写字母,如果不是忽略列表的元素,首字母大写。最后组装为空格间隔的字符串返回。

在程序内使用 ->name 访问的时候,就会调用该方法。我们仍然使用 tinker 进行临时测试:

namespace App;
$e = new Event;
$e->name = "let's learn a Little Laravel together";
$e->Save();

这里完成了模型的创建和属性赋值,并写入数据库。save方法会返回一个 Events 模型对象,直接访问其方法:

$e->name
// 输出 "Let's Learn a Little Laravel Together"

正是我们定义的访问器的修改策略。

对于已存在的字段属性,创建一些常用的访问器方法能提高效率,比如知道用户的姓氏和名字,我们可以返回其全名,模型内创建如下方法:

class User extends Model {
public function getFullnameAttribute()
{
    return $this->first_name . " " . $this->last_name;
}
}

声明完成时候,在代码内使用:

$user = User::find(12);
echo $user->fullname;

虽然没有fullname属性,可是通过访问器我们获得了类似的能力。这是laravel提供的语法糖,很好使!

写在最后

本文通过日期时间字段的格式化方法,引申出laravel模型的访问器功能,并通过实例介绍了具体的用法。

访问器虽然好用,看上去像是模型的方法,实际上却是调用了访问器方法。书写起来很简洁,但是对于维护者要排查为数众多的访问器,并且没有IDE的自动跳转,这着实很考验开发者的功底!

Happy coding :-)

我是@程序员小助手,专注编程知识,圈子动态的IT领域原创作者

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,951评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,606评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,601评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,478评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,565评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,587评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,590评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,337评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,785评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,096评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,273评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,935评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,578评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,199评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,440评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,163评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,133评论 2 352