## 介绍
`think-orm`是一个基于PHP`5.6+` 的`ORM`实现，主要特性包括：
- 基于ThinkPHP5.1的`ORM`封装
- 支持`Mysql`/`Pgsql`/`Sqlite`/`SqlServer`/`Oracle`/`Mongodb`
- 基于`PDO`实现
- 支持原生查询和查询构造器
- 支持事务
- 支持模型和关联（和ThinkPHP内置一致）
应该说功能特性和`ThinkPHP`内置的`ORM`几乎一致，适用于不使用`ThinkPHP`框架的开发者，对于习惯了ThinkPHP的ORM操作但不得已必须使用其它框架的用户来说是一个福音。
>[danger] 本文主要列出一些基本用法和区别所在，以及一些注意事项，更多的详细用法建议直接阅读ThinkPHP5.1的官方手册中关于[数据库](https://www.kancloud.cn/manual/thinkphp5_1/353997)和[模型](https://www.kancloud.cn/manual/thinkphp5_1/354040)章节。
## 安装
如果你已经有自己的基于composer的应用了，可以直接使用`composer`安装
```
composer require topthink/think-orm
```
如果暂时还没有，可以创建一个目录并添加`VHOST`进行测试，
```
mkdir orm
cd orm
composer require topthink/think-orm
```
然后在orm目录下面添加一个入口文件，写法类似下面这样。
```
<?php
namespace think;
require __DIR__.'/vendor/autoload.php';
// 下面添加后面提到的测试代码
```
目前最新版本为`V1.2.11`，功能和ThinkPHP`5.1`最新版本同步更新。
## 数据库配置
数据库配置使用`Db::setConfig()`方法设置。
```php
use think\Db;
// 数据库配置信息设置（全局有效）
Db::setConfig([
// 数据库类型
'type' => 'mysql',
// 服务器地址
'hostname' => '127.0.0.1',
// 数据库名
'database' => 'demo',
// 用户名
'username' => 'root',
// 密码
'password' => '',
// 端口
'hostport' => '',
]);
// 获取数据库配置信息
$dbConfig = Db::getConfig();
$database = Db::getConfig('database');
```
包目录下的`src/config.php`文件提供了完整的配置参数以及默认配置（该配置文件会自动加载）。
为了方便统一管理，你可以通过在单独文件中定义数据库配置后加载。
```
Db::setConfig(include '/config/database.php');
```
## 多数据库和分布式支持
数据库配置也支持配置多个数据库连接，然后通过`connect()`方法动态切换连接。
```
Db::setConfig([
'mysql' => [...],
'mongo' => [...],
]);
Db::connect('mysql')->name('user')->select();
```
当然，如果需要你仍然可以在`connect`方法中传入实际的数据库配置参数（数组）。
支持分布式数据库，包括读写分离，具体可以参考5.1手册的[分布式数据库](https://www.kancloud.cn/manual/thinkphp5_1/354039)
## CURD操作
数据库CURD操作的用法和ThinkPHP几乎一致。
~~~php
use think\Db;
// 进行CURD操作
Db::table('user')
->data(['name'=>'thinkphp','email'=>'thinkphp@qq.com'])
->insert();
Db::table('user')
->where('id','>',10)
->order('id','desc')
->limit(10)
->select();
Db::table('user')
->where('id',10)
->update(['name'=>'test']);
Db::table('user')
->where('id',10)
->delete();
~~~
`Db`类支持所有的`ThinkPHP`数据库链式操作，具体的可以参考5.1手册的[数据库部分](https://www.kancloud.cn/manual/thinkphp5_1/353999)。
`think-orm`的Db类增加的（静态）方法包括：
- `setConfig` 设置全局配置信息
- `getConfig` 获取数据库配置信息
- `setQuery` 设置数据库Query类名称
- `setCacheHandler` 设置缓存对象Handler（必须支持`get`、`set`及`rm`方法）
- `getSqlLog` 用于获取当前请求的SQL日志信息（包含连接信息）
## 模型
定义模型很简单，你只需要继承`think\Model`即可。
~~~php
<?php
namespace app\model;
use think\Model;
class User extends Model
{
}
~~~
模型可以单独定义数据库连接和对应的表名。
~~~php
<?php
namespace app\model;
use think\Model;
class User extends Model
{
// 设置当前模型对应的完整数据表名称
protected $table = 'think_user';
// 设置当前模型的数据库连接
protected $connection = 'db_config';
// 如果主键不是id则需要单独定义
protected $pk = 'uid';
}
~~~
模型操作：
~~~php
use app\model\User;
$user = User::get(1);
$user->name = 'thinkphp';
$user->save();
~~~
你可以和`ThinkPHP`一样使用包括获取器、修改器和搜索器在内的模型功能，具体参考5.1手册的[模型章节](https://www.kancloud.cn/manual/thinkphp5_1/354040)。
## Db类和模型用法对比
#### 创建Create
Db用法
```php
Db::table('user')
->insert([
'name' => 'thinkphp',
'email' => 'thinkphp@qq.com',
]);
```
模型用法
```php
$user = new User;
$user->name = 'thinkphp';
$user->email = 'thinkphp@qq.com';
$user->save();
```
批量设置
```php
$user = new User;
$user->save([
'name' => 'thinkphp',
'email' => 'thinkphp@qq.com',
]);
```
#### 读取Read
Db用法
```php
$user = Db::table('user')
->where('id', 1)
->find();
// 或者
$user = Db::table('user')
->find(1);
echo $user['id'];
echo $user['name'];
```
模型用法
```php
$user = User::get(1);
echo $user->id;
echo $user->name;
```
模型实现读取多个记录
```php
// 查询用户数据集
$users = User::where('id', '>', 1)
->limit(5)
->select();
// 遍历读取用户数据
foreach ($users as $user) {
echo $user->id;
echo $user->name;
}
```
#### 更新Update
Db用法
```php
Db::table('user')
->where('id', 1)
->update([
'name' => 'topthink',
'email' => 'topthink@qq.com',
]);
```
模型用法
```php
$user = User::get(1);
$user->name = 'topthink';
$user->email = 'topthink@qq.com';
$user->save();
```
或者使用
```php
$user = User::get(1);
$user->save([
'name' => 'topthink',
'email' => 'topthink@qq.com',
]);
```
静态调用
```php
User::update([
'name' => 'topthink',
'email' => 'topthink@qq.com',
], ['id' => 1]);
```
#### 删除Delete
Db用法
```php
Db::table('user')->delete(1);
```
模型用法
```php
$user = User::get(1);
$user->delete();
```
或者静态实现
```php
User::destroy(1);
```
`destroy`方法支持删除指定主键或者查询条件的数据
```php
// 根据主键删除多个数据
User::destroy([1, 2, 3]);
// 指定条件删除数据
User::destroy([
'status' => 0,
]);
// 使用闭包条件
User::destroy(function ($query) {
$query->where('id', '>', 0)
->where('status', 0);
});
```
更多模型用法可以参考5.1完全开发手册的[模型](https://www.kancloud.cn/manual/thinkphp5_1/354041)章节
## 查询缓存
由于`think-orm`包没有内置缓存类，所以如果你需要使用查询缓存功能，必须设置缓存对象。
```
// 你可以实例化自己的缓存类 假设为Cache
$cache = new Cache();
// 设置查询缓存对象
Db::setCacheHandler($cache);
```
现在你就可以使用数据库的查询缓存功能了。
## 功能扩展
如果你觉得内置的查询类功能不能满足需求，可以自己扩展一个`think\db\Query`类的子类（例如 `app\db\Query`），然后使用
```
// 设置查询对象类
Db::setQuery('app\db\Query');
```
## 获取SQL日志
你可以通过下面的方法获取当前请求的SQL日志
```
$sqlHistory = Db::getSqlLog();
```
- 值得升级到5.1的18个理由
- 5.1.7版本新特性
- JSON字段类型在ORM中的使用
- 文件下载响应对象
- 教你使用5.1的数组对象查询
- 模型三大利器之一：搜索器
- 在ThinkPHP中使用Yaconf
- 掌握命令行的表格输出
- 5.1.25查询参数绑定的改进
- ThinkPHP安全规范指引
- 巧用数据集的排序功能实现统计排序
- think-orm ——基于5.1的独立ORM库
- think-template——基于ThinkPHP的独立模板引擎
- ThinkPHP5.1.26版本发布——修正版本，包含安全更新
- ThinkPHP5.0和3.2再发安全更新
- 官宣：ThinkPHP发布首个LTS版本
- 你真的了解Db类和模型的正确使用姿势么？
- 如何更有效的记录和管理日志
- 模型三大利器之二：修改器
- ThinkPHP5.1.28版本发布——修正上一版本问题，改进关联查询
- 模型三大利器之三：获取器
- API版本控制的几种思路
- ThinkPHP5.2第一个Beta版本发布测试
- 让你少犯错的数据查询基本原则
- ThinkPHP发布5.1.29版本——常规更新
- 这15个好习惯让你更容易升级到5.2
- 如何有效提高ThinkPHP的应用性能
- 让你提高开发效率的查询技巧
- 模型关联查询不完全指南
- 5.2发布Beta2版本——统一和精简大量用法
- ThinkPHP发布5.1.30版本——支持微秒时间字段写入
- ThinkPHP的数据缓存使用
- ThinkPHP5.2安装及入口文件
- ThinkPHP荣获2018 年度最受欢迎中国开源开发框架第1名
- 5.1路由使用心得技巧
- ThinkPHP5.*版本发布安全更新
- ThinkPHP项目及代码规范指北
- 5.2版本的设计规范指导
- ThinkPHP5.1.32版本发布——圣诞快乐
- 利用Trait特性给模型增加乐观锁功能
- 5.2数据库和模型的变化（摘要）
- ThinkPHP模板引擎实现和常见问题
- ThinkPHP5.0.24版本发布——安全更新
- 不忘初心，方得始终——ThinkPHP十三周年报告
- ThinkPHP5+相关资源汇总
- 异步社区ThinkPHP周年庆专享优惠活动
- 5.2路由的调整和改进
- ThinkPHP发布5.1.33版本——包含安全更新
- ThinkPHP扩展开发指南
- ThinkPHP发布5.2Beta3版本
- ThinkPHP发布5.1.34版本——喜迎新年
- ThinkPHP发布5.2RC1版本
- ThinkPHP发布5.1.35版本——常规更新
- 5.2配置类的调整
- 5.2时间查询的改进和优化
- 5.2RC版本升级不完全指导（仅供学习参考）
- ThinkPHP5.2版本正式变更为6.0版本
- ThinkPHP百度云云虚拟主机专享免费活动
- 事件系统以及查询事件、模型事件的使用
- ThinkPHP6.0RC2版本发布——架构升级、精简核心
- ThinkPHP5.1.36LTS版本发布——常规更新
- 新版Session和Cookie设计变化
- ThinkPHP5.1.37版本发布——常规更新
- ThinkPHP6.0RC3版本发布——细节完善，体验优化
- 6.0中间件使用详解
- Composer各大厂商镜像地址
- ThinkPHP6.0发布计划公告
- 「ThinkPHP开发者周刊」招募志愿者
- ThinkPHP6.0日志变化
- ThinkPHP5.1.38版本发布——常规更新
- ThinkPHP6.0RC4版本发布——ORM独立，日志多通道支持
- ThinkORM2.0开发指南上线
- ThinkPHP6.0RC5版本发布——多应用模式独立，中间件机制调整
- ThinkPHP6.0版本发布——程序员节福利
- ThinkPHP5.1.39LTS版本发布——常规更新
- ThinkPHP6.0.1版本发布——圣诞快乐！
- 回顾2019，展望2020！
- ThinkPHPV6.0.2版本发布——2020新春快乐！
- 周年福利系列：Swoole合作优惠
- 亿速云成为ThinkPHPV6.0独家赞助发布商🎉
- 新冠疫情工具和限免资源专题（保持更新中）
- 周年福利系列：创宇信用认证合作优惠
- 周年福利系列：码云企业版限时10%优惠
- 周年福利系列：想天短说抵现优惠
- think-swoole直播：从零开始掌握swoole开发
- 周年福利系列：B2C开源电商ShopXO授权8折优惠
- 周年福利系列：LayuiAdmin 永久授权限时优惠
- ThinkPHP资源导航站上线——构建生态 服务未来
- ThinkPHP官方技术支持服务和应用服务市场上线公测
- ThinkPHP市场精选——推广基本要素
- ThinkPHP市场精选——客服聊天专题
- ThinkPHPV6.0.3版本发布——端午安康
- ThinkPHP开发者扶持计划
- 6.0.3版本关键更新及升级事项
- 「ThinkPHP开发者周刊」改版重启
- ThinkPHP市场精选——企业建站专题
- ThinkPHP 提供统一API接口服务
- ThinkPHP市场精选——直播电商专题
- ThinkAPI服务SDK发布
- 官方服务市场启用独立子域名
- ThinkPHP市场精选——刷脸支付专题
- ThinkAPI推出会员服务计划
- ThinkPHPV6.0.4版本发布——中秋国庆双节快乐
- ThinkPHPV5.1.40版本发布——常规更新
- 1024程序员节福利走一波
- ThinkPHP V6.0.5版本发布——兼容Composer2.0
- 知识图谱应用场景——源论技术沙龙
- ThinkPHP5.*版本改进Composer2.0的兼容
- 官方市场双十一精选推荐
- 技术人做产品有机会么（文末送课程）
- 本周秒杀——古德云售后获客营销系统
- ThinkAPI服务更新——支持接口分组和PHP版本依赖调整
- PHP8新特性盘点
- PHP8新特性系列：构造器属性提升使用及注意事项
- ThinkPHP2021新年寄语
- ThinkPHP V6.0.6&V5.1.41版本发布——兼容PHP8.0
- PHP如何更优雅地调用API接口
- ThinkPHP V6.0.7发布——修正版本
- ThinkAPI服务更新——IP白名单
- 最新版ThinkORM对于时间字段的调整
- ThinkAPI短信接口正式上线
- ThinkPHP V6.0.8版本发布——多环境变量配置支持
- 顶想云写作服务开启第一次公测
- ThinkSSL上线——官方SSL/TLS证书服务
- MDBootstrap国内用户福利——ThinkPHP官方市场首发
- ThinkPHP V6.0.9版本发布——常规更新
- ThinkORM功能盘点——虚拟模型
- 全面支持主流GIT版本库——云写作服务第二次公测
- 云写作服务私有化部署方案之：版本库私有化
- 看云双十一活动
- ThinkPHP V6.0.10LTS发布——兼容PHP8.1
- ThinkPHP V6.0.12发布——命令行兼容8.1
- 顶想云知识管理上线公测——构建企业文档中心和知识库
- 顶想云上线——助力生态数字化建设
- 618活动进行中——官方市场迎来一波更新
- 顶想云知识管理正式上线——看云文档启动迁移服务
- ThinkPHP V6.0.13发布——常规更新
- 顶想云网站助理服务上线——构建产品支持服务
- ThinkPHP发布6.1.0&6.0.14版本——安全更新
- ThinkPHP新版社区上线试运营
- ThinkAPI上架人脸核身接口——助力网站实名认证
- 辞旧迎新——旧版社区停止注册及发帖
- ThinkPHP6.1.2版本发布——兼容PHP8.2