ThinkPHP：JSON欄位類型的使用（ORM）

ThinkPHP5.1版本正式發表已經有一段時間了，我會陸續跟大家介紹其中的新特性。今天要跟大家介紹的是一個可能很多使用者還不了解的一個特性：JSON欄位資料支援。

不過先註意一點，本篇內容中所描述的JSON欄位資料的支援是從V5.1.4 版本引進的。由於包含安全性更新的原因，建議確保使用5.1.9 版本。

本篇中對JSON欄位的定義包含JSON類型或儲存的資料為JSON格式的字元類型，所以理論上除了使用JSON欄位條件查詢外，對資料庫類型和版本沒有要求。

Db類操作JSON

#如果你沒有使用模型類，Db類提供了一個json方法可以指定你的數據表JSON格式字段。例如你的user表有一個info欄位是JSON類型的，你可以用下面的方式來操作資料。

資料寫入

$user['name'] = 'thinkphp';
$user['info'] = [
'email'    => 'thinkphp@qq.com',
'nickname' => '流年',
];
Db::name('user')
->json(['info'])
->insert($user);

json方法的參數是數組，範例中指定了info字段，其實可以指定多個JSON類型字段。

資料查詢

查詢整個JSON資料使用。

$user = Db::name('user')
->json(['info'])
->find(1);
dump($user);

傳回的查詢結果資料中，會自動包含一個陣列類型的info數據，也就是說JSON格式資料已經自動json_decode處理。

該方式查詢對info欄位並非嚴格要求使用JSON類型

如果需要根據JSON資料的值進行查詢，可以使用下面的方法

$user = Db::name('user')
->json(['info'])
    ->where('info->nickname','ThinkPHP')
->find();
dump($user);

要求info欄位必須是JSON類型，MySQL需要5.7 版本才能支援

#當然，也可以支援多層

$user = Db::name('user')
->json(['info'])
    ->where('info->profile->nickname','ThinkPHP')
->find();
dump($user);

由於JSON欄位的屬性類型並不會自動獲取，所以，如果是整數資料查詢的話，需要手動參數綁定，例如：

$user = Db::name('user')
->json(['info'])
    ->where('info->user_id', ':user_id')
    ->bind(['user_id' => [10, \PDO::PARAM_INT]])
->find();
dump($user);

資料更新

##完整JSON資料更新

$data['info'] = [
'email'    => 'kancloud@qq.com',
'nickname' => 'kancloud',
];
Db::name('user')
->json(['info'])
    ->where('id',1)
->update($data);

該方式查詢對info欄位並非嚴格要求使用JSON類型

#如果只是更新JSON資料中的某個值，則可以使用下面的方法：

$data['info->nickname'] = 'ThinkPHP';
Db::name('user')
->json(['info'])
    ->where('id',1)
->update($data);

同樣要求info欄位必須是JSON類型

模型操作JSON資料

如果你使用的是模型操作資料庫的話，那麼JSON資料操作就更簡單了。

我們只要為User模型類別增加一個json屬性定義即可。

<?php
namespace app\index\model;
use think\Model;
class User extends Model
{
// 设置json类型字段
protected $json = [&#39;info&#39;];
}

json屬性同樣支援定義多個欄位名稱，定義後，可以進行如下JSON資料操作。

寫入資料

使用陣列方式寫入JSON資料：

$user = new User;
$user->name = 'thinkphp';
$user->info = [
'email'    => 'thinkphp@qq.com',
    'nickname '=> '流年',
];
$user->save();

使用物件方式寫入JSON資料

$user = new User;
$user->name = 'thinkphp';
$info = new StdClass();
$info->email = 'thinkphp@qq.com';
$info->nickname = '流年';
$user->info = $info;
$user->save();

#查詢資料

和Db類別查詢出來的結果類型不同，模型的JSON欄位會自動轉換成物件方式。

$user = User::get(1);
echo $user->name; // thinkphp
echo $user->info->email; // thinkphp@qq.com
echo $user->info->nickname; // 流年

同樣也可以支援查詢JSON欄位資料

$user = User::where('info->nickname','流年')->find();
echo $user->name; // thinkphp
echo $user->info->email; // thinkphp@qq.com
echo $user->info->nickname; // 流年

和Db類別查詢一樣，如果你需要查詢的JSON屬性是整數類型的話，需要進行手動參數綁定。

$user = User::where('info->user_id',':user_id')
->bind(['user_id' => [10 ,\PDO::PARAM_INT]])
->find();
echo $user->name; // thinkphp
echo $user->info->email; // thinkphp@qq.com
echo $user->info->nickname; // 流年

如果你使用的是V5.1.11 版本的話，可以在模型類別裡面定義JSON欄位的屬性類型，就會自動進行對應類型的參數綁定查詢。

<?php
namespace app\index\model;
use think\Model;
class User extends Model
{
// 设置json类型字段
protected $json = [&#39;info&#39;];
    
    // 设置JSON字段的类型
    protected $jsonType = [
    &#39;user_id&#39;=>&#39;int&#39;
    ];
}

沒有定義類型的屬性預設為字串類型，因此字串類型的屬性可以無需定義。

更新資料

更新JSON資料也是採用物件的方式

$user = User::get(1);
$user->name = 'kancloud';
$user->info->email = 'kancloud@qq.com';
$user->info->nickname = 'kancloud';
$user->save();

如果你需要對JSON類型欄位做更複雜的操作，還可以透過exp表達式方式完成。這個就等大家去發現更多的JSON用法了。

PHP中文網，有大量免費的

ThinkPHP入門教學，歡迎大家學習！

本文轉自：https://blog.thinkphp.cn/784281

以上是ThinkPHP：JSON欄位類型的使用（ORM）的詳細內容。更多資訊請關注PHP中文網其他相關文章！