技术 · 思考 · 实践 · 成长

首页/ThinkPHP8/正文

ThinkPHP 8 ORM 完全指南:模型定义、类型转换、关联与模型事件

ThinkPHP87 次阅读

ORM 把数据表映射成模型类,用面向对象的方式操作数据库。官方手册《ORM》一章下设多个子类:模型定义、模型与数据表、模型查询、新增/更新/删除、获取器与修改器、类型转换、时间戳、模型事件、关联关系。本文逐一整理,结尾附综合小实例。参考:ThinkPHP 8 ORM。

一、模型定义与数据表对应

模型放在 app/model 目录,继承 thinkModel;类名按约定自动对应带前缀的数据表(User → tp_user),也可以显式指定:

<?php
namespace appmodel;

use thinkModel;

class User extends Model
{
    protected $name = 'user';        // 对应 tp_user(自动补前缀)
    // protected $table = 'tp_user';  // 或直接指定完整表名
}

二、模型查询

模型支持查询构造器的全部链式方法,返回的是模型对象/模型集合,而不只是数组:

use appmodelUser;

$list = User::where('status', 1)->order('id desc')->paginate(10);
$user = User::find(1);          // 单个模型对象

echo $user->name;               // 属性访问(会触发获取器)
$list->toArray();               // 集合转数组
$user->getData('name');        // 获取原始字段值(不走获取器)

三、新增、更新与删除

// 新增
$user = new User();
$user->name = 'think';
$user->save();
echo $user->id;                 // 自增主键回填

// 或者一把写入(字段过滤)
$user = User::create($data, true);   // true 表示过滤非表字段

// 更新
$user = User::find(1);
$user->name = 'tp8';
$user->save();

// 删除
$user->delete();

四、获取器与修改器

// 获取器:读取属性时自动格式化
protected function getStatusAttr($value)
{
    return $value ? '正常' : '禁用';
}

// 修改器:写入字段时自动处理
protected function setNameAttr($value)
{
    return strtolower($value);
}

命名规则:字段名转驼峰加 get/set 前缀再加 Attr。获取器让展示逻辑进模型,控制器保持干净。

五、类型转换

用 $type 声明字段类型,取值时自动转成 PHP 类型:

protected $type = [
    'status'      => 'boolean',
    'info'        => 'json',
    'create_time' => 'datetime',
];
类型转换结果
integer / float整数 / 浮点数
boolean布尔值
array / json数组(存取自动序列化)
timestamp / datetime时间戳 / 时间字符串

六、时间戳

protected $autoWriteTimestamp = true;    // 自动维护 create_time / update_time
  • 新增时自动写入 create_time,更新时自动写入 update_time
  • 设为 'datetime' 则存日期时间字符串;自定义字段名可用 $createTime、$updateTime 属性

七、模型事件

use appmodelUser;

User::event('before_insert', function ($user) {
    $user->ip = request()->ip();     // 新增前自动记录 IP
});
User::event('after_delete', function ($user) {
    // 删除后清理关联数据
});

常用事件:before/after 与 write、insert、update、delete 的组合;日志、缓存清理、关联维护都挂在事件里。

八、关联关系

1. 一对一 / 一对多 / 属于

class User extends Model
{
    public function profile()      // 一对一:用户资料
    {
        return $this->hasOne(Profile::class, 'user_id', 'id');
    }
    public function articles()     // 一对多:用户的文章
    {
        return $this->hasMany(Article::class, 'user_id', 'id');
    }
}

class Article extends Model
{
    public function user()         // 属于:文章作者
    {
        return $this->belongsTo(User::class, 'user_id', 'id');
    }
}

2. 多对多

public function tags()
{
    return $this->belongsToMany(Tag::class, 'article_tag', 'article_id', 'tag_id');
}

3. 关联预载入(防 N+1)

$list = User::with(['profile', 'articles'])->select();   // 一次性查出关联
foreach ($list as $user) {
    echo $user->articles->count();    // 不再发 SQL
}

九、综合小实例:文章模型

把本章知识点串起来写一个文章模型及用法:

<?php
namespace appmodel;

use thinkModel;

class Article extends Model
{
    protected $autoWriteTimestamp = true;              // 自动时间戳
    protected $type = ['create_time' => 'datetime'];  // 类型转换

    public function user()                            // 关联:作者
    {
        return $this->belongsTo(User::class, 'user_id');
    }

    // 获取器:阅读量友好显示
    protected function getViewAttr($value)
    {
        return $value > 10000 ? round($value / 10000, 1) . '万' : $value;
    }
}

// 控制器里使用:
$articles = Article::with('user')      // 预载入作者,防 N+1
    ->where('isshow', 1)
    ->order('id desc')
    ->paginate(10);

foreach ($articles as $art) {
    echo $art->title . ' | ' . $art->user->name . ' | ' . $art->view;
}

一个模型用上了时间戳、类型转换、关联、预载入和获取器 —— 正好覆盖本章全部子类。

十、总结

模型 = 表 + 行为:$name/$table 对应数据表;查询复用链式语法;save/create/delete 管增删改;get/set Attr 做格式化与清洗;$type 管类型转换;autoWriteTimestamp 管时间;事件挂横切逻辑;hasOne/hasMany/belongsTo/belongsToMany 管关联,with 预载入防 N+1。

努力的意义,不在于一定会让你取得多大的成就,只是让你在平凡的日子里,活得比原来的那个自己更好一点。

评论交流

0 条评论 · 支持多级回复
验证码
暂无评论,来说说你的想法吧

相关文章

继续阅读