## 模型定义
定义一个模型类很简单，下面是一个最简单的`User`模型：
~~~
<?php
namespace app\model;
use think\Model;
class User extends Model
{
}
~~~
>[info] 请确保你已经在数据库配置文件中配置了数据库连接信息，如不清楚请参考数据库一章
模型会自动对应数据表，模型类的命名规则是除去表前缀的数据表名称，采用驼峰法命名，并且首字母大写，例如：
| 模型名 | 约定对应数据表（假设数据库的前缀定义是 `think_`） |
|-----|-----|
| User | think_user |
| UserType | think_user_type |
如果你的规则和上面的系统约定不符合，那么需要设置模型类的数据表名称`table`属性，以确保能够找到对应的数据表。
>[danger] 模型自动对应的数据表名称都是遵循小写+下划线规范，如果你的表名有大写的情况，必须通过设置模型的`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';
}
~~~
>[danger] `connection`属性使用用配置参数名（需要在数据库配置文件中的`connections`参数中添加对应标识）。
常用的模型设置属性包括（以下属性都不是必须设置）：
属性|描述
---|---
name|模型名（相当于不带数据表前后缀的表名，默认为当前模型类名）
table|数据表名（默认自动获取）
suffix|数据表后缀（默认为空）
pk|主键名（默认为`id`）
connection|数据库连接（默认读取数据库配置）
field|模型允许写入的字段列表（数组）
schema|模型对应数据表字段及类型（数组）
type|模型需要自动转换的字段及类型（数组）
strict|是否严格区分字段大小写（默认为true）
disuse|数据表废弃字段（数组）
>[danger] 模型不支持对数据表的前缀单独设置，并且也不推荐使用数据表的前缀设计，应该用不同的库区分。当你的数据表没有前缀的时候，`name`和`table`属性的定义是没有区别的，定义任何一个即可。
## 字段定义
模型的数据字段和对应数据表的字段是对应的，默认会自动获取（包括字段类型），但自动获取会导致增加一次查询，因此你可以在模型中明确定义字段信息避免多一次查询的开销。
~~~
<?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类型或者数据库的字段类型都可以，字段类型定义的作用主要用于查询的参数自动绑定类型。
>[danger] 时间字段尽量采用实际的数据库类型定义，便于时间查询的字段自动识别。如果是`json`类型直接定义为`json`即可。
如果在ThinkPHP`6.0+`中使用的话，没有定义`schema`属性的话，可以在部署完成后运行如下指令。
~~~cmd
php think optimize:schema
~~~
运行后会自动生成数据表的字段信息缓存。使用命令行缓存的优势是Db类的查询仍然有效。
## 字段类型
`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 = $this->find(1);
echo $user->getAttr('create_time');
echo $user->getAttr('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);
```
## 字段大小写
默认情况下，你的模型数据名称和数据表字段应该保持严格一致，也就是说区分大小写。
~~~
$user = User::find(1);
echo $user->create_time; // 正确
echo $user->createTime; // 错误
~~~
>[danger] 严格区分字段大小写的情况下，如果你的数据表字段是大写，模型获取的时候也必须使用大写。
如果你希望在获取模型数据的时候不区分大小写（前提是数据表的字段命名必须规范，即小写+下划线），可以设置模型的`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;
~~~
前提是你实际的数据表字段必须符合规范，采用小写和下划线设计，例如这里必须是`create_time`。
## 模型数据转驼峰
`V2.0.34+`版本开始，可以设置`convertNameToCamel`属性使得模型数据返回驼峰方式命名（前提也是数据表的字段命名必须规范，即小写+下划线）。
~~~
<?php
namespace app\model;
use think\Model;
class User extends Model
{
// 数据转换为驼峰命名
protected $convertNameToCamel = true,
}
~~~
然后在模型输出的时候可以直接使用驼峰命名的方式获取。
~~~
$user = User::find(1);
$data = $user->toArray();
echo $data['createTime']; // 正确
echo $user['create_time']; // 错误
~~~
## 模型初始化
模型支持初始化，只需要定义`init`方法，例如：
~~~
<?php
namespace app\model;
use think\Model;
class User extends Model
{
// 模型初始化
protected static function init()
{
//TODO:初始化内容
}
}
~~~
>[danger] `init`必须是静态方法，并且只在第一次实例化的时候执行，并且只会执行一次
## 模型操作
> 在模型中除了可以调用数据库类的方法之外（换句话说，**数据库的所有查询构造器方法模型中都可以支持**），可以定义自己的方法，所以也可以把模型看成是数据库的增强版。
模型的操作方法无需和数据库查询一样调用必须首先调用`table`或者`name`方法，因为模型会按照规则自动匹配对应的数据表，例如：
~~~
Db::name('user')->where('id','>',10)->select();
~~~
改成模型操作的话就变成
~~~
User::where('id','>',10)->select();
~~~
虽然看起来是相同的查询条件，但一个最明显的区别是**查询结果的类型**不同。第一种方式的查询结果是一个普通的数据集对象，而第二种方式的查询结果是包含了模型数据集对象。
模型操作和数据库操作的另外一个显著区别是模型支持包括获取器、修改器、自动时间写入在内的一系列自动化操作和事件，简化了数据的存取操作，但随之而来的是性能有所下降（其实并没下降，而是自动帮你处理了一些原本需要手动处理的操作），后面会逐步领略到模型的这些特色功能。
## 动态切换后缀
数据表后缀属性，可以用于多语言或者数据分表的模型查询，省去为多个相同结构的表定义多个模型的麻烦。
默认的数据表后缀可以在模型类里面直接定义`suffix`属性。
~~~
<?php
namespace app\model;
use think\Model;
class Blog extends Model
{
// 定义默认的表后缀（默认查询中文数据）
protected $suffix = _cn';
}
~~~
>[danger] 你在模型里面定义的`name`和`table`属性无需包含后缀定义
模型提供了动态切换方法`suffix`和`setSuffix`，例如：
```
// suffix方法用于静态查询
$blog = Blog::suffix('_en')->find();
$blog->name = 'test';
$blog->save();
// setSuffix用于动态设置
$blog = new Blog($data);
$blog->setSuffix('_en')->save();
```
## 模型方法依赖注入
如果你需要对模型的方法支持依赖注入，可以把模型的方法改成闭包的方式，例如，你需要对获取器方法增加依赖注入
```
public function getTestFieldAttr($value,$data) {
return $this->invoke(function(Request $request) use($value,$data) {
return $data['name'] . $request->action();
};
}
```
不仅仅是获取器方法，在任何需要依赖注入的方法都可以改造为调用`invoke`方法的方式，`invoke`方法第二个参数用于传入需要调用的（数组）参数。
如果你需要直接调用某个已经定义的模型方法（假设已经使用了依赖注入），可以使用
```
protected function bar($name, Request $request) {
// ...
}
protected function invokeCall(){
return $this->invoke('bar',['think']);
}
```
- 简介
- 数据库配置
- 分布式数据库
- 查询构造器
- 查询数据
- 新增数据
- 更新数据
- 删除数据
- 链式操作
- Where
- Table
- Alias
- Field
- Strict
- Limit
- Page
- Order
- Group
- Having
- Join
- Union
- Distinct
- Lock
- Cache
- Comment
- FetchSql
- Force
- Partition
- Replace
- FailException
- Extra
- Duplicate
- Sequence
- Procedure
- View
- 聚合查询
- 分页查询
- 时间查询
- 高级查询
- 子查询
- 原生查询
- 事务操作
- 存储过程
- 查询事件
- JSON字段
- 模型
- 定义
- 新增
- 更新
- 删除
- 查询
- 查询范围
- 只读字段
- JSON字段
- 自动时间写入
- 获取器
- 修改器
- 搜索器
- 类型转换
- 模型输出
- 模型事件
- 虚拟模型
- 关联
- 一对一关联
- 一对多关联
- 远程一对多
- 远程一对一
- 多对多关联
- 多态一对多
- 多态一对一
- 关联预载入
- 关联统计
- 关联输出
- SQL监听
- 缓存机制
- 字段缓存
- 查询缓存
- 扩展
- 自定义查询类
- 自定义数据库驱动