在我们的日常开发中，将复杂的数据结构存储在数据库的 jsON 字段中是常见的做法。然而，在 yii2 项目中，如果直接将一个 php 数组存入 json 字段，你需要手动调用 json_encode；取出时，又得手动 json_decode。这种重复且机械的操作，不仅让代码变得冗长，还可能因为忘记转换而引发类型错误。更糟糕的是，你无法直接通过数组下标 ($model->params['key']) 来访问或修改这些 JSON 数据，每次操作都需要先解码、修改、再编码，大大降低了开发效率和代码的可读性。
我曾在一个项目中负责管理用户的配置信息，这些信息以 JSON 格式存储在数据库的一个字段中。每次修改某个配置项，我都需要经历：从数据库取出字符串 -> json_decode 成数组 -> 修改数组中的值 -> json_encode 回字符串 -> 存入数据库。这套流程不仅繁琐，而且一旦配置项增多，代码就变得难以维护。我迫切需要一种更优雅、更“PHP原生”的方式来处理这些 JSON 字段。
救星登场：paulzi/yii2-json-behavior
就在我被这些重复劳动折磨得焦头烂额时，我发现了 paulzi/yii2-json-behavior 这个 Composer 包。它提供了一个行为（Behavior），可以自动处理 ActiveRecord 模型中指定 JSON 属性的编解码，并允许你像操作普通 PHP 数组一样访问这些字段。这简直就是为解决我的问题量身定制的！
重要提示： 尽管从 Yii 2.0.14 版本开始，Yii 已经内置了对数据库 JSON 类型的支持，使得在某些数据库（如 mysql 5.7+ 或 postgresql）中处理 JSON 字段变得更加原生。但对于运行在旧版本 Yii、不支持原生 JSON 类型的数据库，或者需要更灵活的 JSON 字段处理逻辑的场景，paulzi/yii2-json-behavior 依然是一个极其有用的工具。
如何安装与使用
首先，通过 Composer 轻松安装这个包：
<code class="bash">composer require paulzi/yii2-json-behavior</code>
接下来，在你的 ActiveRecord 模型中配置 JsonBehavior：
<pre class="brush:php;toolbar:false;">use paulzijsonBehaviorJsonBehavior; use yiidbActiveRecord; class Item extends ActiveRecord { public function behaviors() { return [ [ 'class' => JsonBehavior::class, 'attributes' => ['params'], // 指定你的 JSON 字段名 ], ]; } // ... 其他模型代码 }
配置完成后，你就可以像操作普通 PHP 数组一样访问 params 字段了：
<pre class="brush:php;toolbar:false;">$item = Item::findOne(1); $item->params['one'] = 'two'; $item->params['two'] = []; $item->params['two']['key'] = true; $item->save(); // 自动将 $item->params 编码为 JSON 字符串存入数据库 $item = Item::findOne(1); echo $item->params['two']['key']; // 输出：true
你甚至可以直接设置 JSON 字符串或数组：
Easily find JSON paths within JSON objects using our intuitive Json Path Finder
30 
<pre class="brush:php;toolbar:false;">$item = new Item(); $item->params->set('[2, 4, 42]'); echo $item->params[2]; // 输出：42 $item = new Item(); $item->params->set(['test' => ['one' => 1]]); echo $item->params['test']['one']; // 输出：1
需要将字段内容转换回 JSON 字符串或 PHP 数组？也很简单：
<pre class="brush:php;toolbar:false;">$item = new Item(); $item->params['test'] = ['one' => false, 'two' => [1, 2, 3]]; var_dump((string)$item->params); // 输出：string(29) "{"test":{"one":false,"two":[1,2,3]}}" var_dump($item->params->toArray()); // 输出：array(1) { ["test"]=> array(2) { ["one"]=> bool(false) ["two"]=> array(3) { [0]=> int(1) [1]=> int(2) [2]=> int(3) } } }
JSON 字段的校验
这个包还提供了一个 JsonValidator，可以确保你的 JSON 字段始终是有效的 JSON 格式：
<pre class="brush:php;toolbar:false;">use paulzijsonBehaviorJsonValidator; class Item extends ActiveRecord { public function rules() { return [ [['params'], JsonValidator::class], ]; } // ... } $item = new Item(); $item->attributes = ['params' => '{ test: }']; // 这是一个无效的 JSON 字符串 var_dump($item->save()); // 输出：false var_dump($item->errors); // 输出：['params' => ['Value is not valid JSON or scalar']]
你还可以设置 merge = true，这样在更新时，传入的新数据会与旧数据进行 array_merge，而不是完全覆盖：
<code class="php">[['params'], JsonValidator::class, 'merge' => true],</code>
深入应用：处理 isAttributeChanged() 和 getDirtyAttributes()
Yii2 默认的 isAttributeChanged() 和 getDirtyAttributes() 方法可能无法正确识别 JsonBehavior 包装的字段变化。为了解决这个问题，你需要重写这两个方法：
<pre class="brush:php;toolbar:false;">use paulzijsonBehaviorJsonField; // 注意这里引入了 JsonField class Item extends yiidbActiveRecord { // ... behaviors 和 rules /** * @inheritdoc */ public function isAttributeChanged($name, $identical = true) { if ($this->$name instanceof JsonField) { // 将当前 JSON 字段转换为字符串与旧值比较 return (string)$this->$name !== $this->getOldAttribute($name); } else { return parent::isAttributeChanged($name, $identical); } } /** * @inheritdoc */ public function getDirtyAttributes($names = null) { $result = []; $data = parent::getDirtyAttributes($names); foreach ($data as $name => $value) { if ($value instanceof JsonField) { // 如果是 JsonField 类型，则进行字符串比较判断是否“脏” if ((string)$value !== $this->getOldAttribute($name)) { $result[$name] = $value; } } else { $result[$name] = $value; } } return $result; } }
通过这些重写，你的模型就能正确地跟踪 JSON 字段的变化，这对于审计日志、缓存失效等功能至关重要。
总结与应用效果
paulzi/yii2-json-behavior 极大地提升了在 Yii2 中处理 JSON 字段的开发体验。它的核心优势在于：
- 自动化编解码：无需手动
json_encode和json_decode，减少了大量重复代码。 - 直观的数组访问：可以直接通过
$model->params['key']的方式操作 JSON 字段，就像操作 PHP 数组一样自然。 - 内置校验：
JsonValidator确保了数据存储的有效性。 - 提高可读性和维护性：代码更简洁，业务逻辑更清晰。
通过引入这个行为，我的项目代码量显著减少，错误率也降低了。现在，处理用户配置就像处理普通模型属性一样简单，极大地提升了开发效率。如果你还在为 Yii2 中 JSON 字段的繁琐操作而头疼，不妨试试 paulzi/yii2-json-behavior，它会给你带来惊喜！