5.thinkphp模型的定义方式

原创已于 2025-04-15 00:47:36 修改 · 1k 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#java #数据库 #开发语言

于 2025-04-12 14:34:14 首次发布

一．定义模型

1.定义一个和数据库表向匹配的模型； class User extends Model

2.模型会自动对应数据表，并且有一套自己的命名规则；

3.模型类需要去除表前缀(tp_)，采用驼峰式命名，并且首字母大写； tp_user(表名) =>User tp_user_type(表名) =>UserType

4.创建空模型后，我们可以在控制器调用，创建控制器DataModel.php；

5.可以直接使用模型的名称User::*调用查询方法，比如select()等；

6.如果没有代码提示，请和上一节一样，把5.1的注释复制过来；

------------------------------------------------------------------------------------------------------------------------------

<?php
namespace app\model;

use think\Model;

class User extends Model
{
}

模型会自动对应数据表，模型类的命名规则是除去表前缀的数据表名称，采用驼峰法命名，并且首字母大写，例如：

模型名	约定对应数据表（假设数据库的前缀定义是 `think_`）
User	think_user
UserType	think_user_type

如果你的规则和上面的系统约定不符合，那么需要设置Model类的数据表名称属性，以确保能够找到对应的数据表。

模型自动对应的数据表名称都是遵循小写+下划线规范，如果你的表名有大写的情况，必须通过设置模型的table属性。

如果你希望给模型类添加后缀，需要设置name属性或者table属性。

<?php
namespace app\model;

use think\Model;

class UserModel extends Model
{
    protected $name = 'user';
}

模型设置

默认主键为id，如果你没有使用id作为主键名，需要在模型中设置属性：

<?php
namespace app\model;

use think\Model;

class User extends Model
{
    protected $pk = 'uid';
}

如果你想指定数据表甚至数据库连接的话，可以使用：

<?php
namespace app\model;

use think\Model;

class User extends Model
{
    // 设置当前模型对应的完整数据表名称
    protected $table = 'think_user';
    
    // 设置当前模型的数据库连接
    protected $connection = 'db_config';
}

connection属性使用用配置参数名（需要在数据库配置文件中的connections参数中添加对应标识）。

模型初始化

模型支持初始化，只需要定义init方法，例如：

<?php
namespace app\model;

use think\Model;

class User extends Model
{
    // 模型初始化
    protected static function init()
    {
        //TODO:初始化内容
    }
}

模型字段

模型的数据字段和对应数据表的字段是对应的，默认会自动获取（包括字段类型），但自动获取会导致增加一次查询，因此你可以在模型中明确定义字段信息避免多一次查询的开销。

<?php
namespace app\model;

use think\Model;

class User extends Model
{
    // 设置字段信息
    protected $schema = [
        'id'          => 'int',
        'name'        => 'string',
        'status'      => 'int',
        'score'       => 'float',
        'create_time' => 'datetime',
        'update_time' => 'datetime',
    ];
}

字段类型的定义可以使用PHP类型或者数据库的字段类型都可以，字段类型定义的作用主要用于查询的参数自动绑定类型。

时间字段尽量采用实际的数据库类型定义，便于时间查询的字段自动识别。如果是json类型直接定义为json即可。

php think optimize:schema

运行后会自动生成数据表的字段信息缓存。使用命令行缓存的优势是Db类的查询仍然有效。

需要在数据库配置中设置fields_cache为true才能生成缓存

字段类型

schema属性一旦定义，就必须定义完整的数据表字段类型。
如果你只希望对某个字段定义需要自动转换的类型，可以使用type属性，例如：

<?php
namespace app\model;

use think\Model;

class User extends Model
{
    // 设置字段自动转换类型
    protected $type = [
        'score'       => 'float',
    ];
}

type属性定义的不一定是实际的字段，也有可能是你的字段别名。

废弃字段

如果因为历史遗留问题，你的数据表存在很多的废弃字段，你可以在模型里面定义这些不再使用的字段。

<?php
namespace app\model;

use think\Model;

class User extends Model
{
    // 设置废弃字段
    protected $disuse = [ 'status', 'type' ];
}

在查询和写入的时候会忽略定义的status和type废弃字段。

获取数据

在模型外部获取数据的方法如下

$user = User::find(1);
echo $user->create_time;  
echo $user->name;

由于模型类实现了ArrayAccess接口，所以可以当成数组使用。

$user = User::find(1);
echo $user['create_time'];  
echo $user['name'];

否则可能会出现意想不到的错误。

模型赋值

可以使用下面的代码给模型对象赋值

$user = new User();
$user->name = 'thinkphp';
$user->score = 100;

该方式赋值会自动执行模型的修改器，如果不希望执行修改器操作，可以使用

$data['name'] = 'thinkphp';
$data['score'] = 100;
$user = new User($data);

或者使用

$user = new User();
$data['name'] = 'thinkphp';
$data['score'] = 100;
$user->data($data);

data方法支持使用修改器

$user = new User();
$data['name'] = 'thinkphp';
$data['score'] = 100;
$user->data($data, true);

如果需要对数据进行过滤，可以使用

$user = new User();
$data['name'] = 'thinkphp';
$data['score'] = 100;
$user->data($data, true, ['name','score']);

表示只设置data数组的name和score数据。

注意:data方法会清空调用前设置的数据

以追加数据的方式赋值:

$user = new User();
$user->group_id = 1;
$data['name'] = 'thinkphp';
$data['score'] = 100;
$user->appendData($data);    // 如果调用 data ,则清空group_id字段数据

可以通过传入第二个参数 true 来使用修改器 ,比如:appendData($data,true)

严格区分字段大小写

默认情况下，你的模型数据名称和数据表字段应该保持严格一致，也就是说区分大小写。

$user = User::find(1);
echo $user->create_time;  // 正确
echo $user->createTime;  // 错误

严格区分字段大小写的情况下，如果你的数据表字段是大写，模型获取的时候也必须使用大写。

如果你希望在获取模型数据的时候不区分大小写（前提是数据表的字段命名必须规范，即小写+下划线），可以设置模型的strict属性。

<?php
namespace app\model;

use think\Model;

class User extends Model 
{
    // 模型数据不区分大小写
    protected $strict = false,
}

你现在可以使用

$user = User::find(1);
// 下面两种方式都有效
echo $user->createTime; 
echo $user->create_time;