模型三大利器之三：獲取器 · ThinkPHP官方博客

### 2018 年 11 月 2 日發布模型三大利器我們已經了解了[修改器](https://blog.thinkphp.cn/817548)和[搜索器](https://blog.thinkphp.cn/783775)，如果還不是特別理解的可以參考之前的博客。今天來總結下獲取器的用法，其實獲取器是最容易理解的，但卻又是最容易困惑和出問題的。 ## 定義獲取器獲取器的作用是對模型對象的（原始）數據做出自動處理。一個獲取器對應模型的一個特殊方法（該方法必須為`public`類型），方法命名規范為： >[info]### get**FieldName**Attr `FieldName`為數據表字段的駝峰轉換或者你數據表不存在的字段（注意理解后面這句話），下面是一個典型的獲取器定義： ``` <?php namespace app\index\model; use think\Model; class User extends Model { public function getUserTypeAttr($value, $data) { $type = [0 => '普通', 1 => 'VIP', 2 => '黃金', 3 => '白金', 4 => '鉆石']; return $type[$value]; } } ``` 你需要給每一個需要輸出轉換處理的數據字段定義一個對應的獲取器，但獲取器的字段名不一定要和數據表的字段名一致，例如我希望給`user_type`字段定義一個名為`getTypeAttr`的獲取器也是允許的，但要注意這個時候傳入獲取器的第一個參數肯定是沒有值（因為沒有對應的數據表字段數據），只能通過第二個參數獲取你需要的數據。 ``` <?php namespace app\index\model; use think\Model; class User extends Model { public function getTypeAttr($value, $data) { $type = [0 => '普通', 1 => 'VIP', 2 => '黃金', 3 => '白金', 4 => '鉆石']; return $type[$data['user_type']]; } } ``` 當然更為嚴謹的情況下，你還需要判斷下是否存在`$data['user_type']`，這個暫且略過。 >[danger] 注意第二個參數的`data`數據，可能本身已經經過了獲取器的處理（如果你定義了相關的獲取器的話）。為什么要定義一個和數據報字段不一致的獲取器呢？最明顯的好處可以區分不同的字段獲取原始數據和處理過的數據。事實上，有很多理由可以讓你定義一些數據表不存在的字段獲取器，這恰恰是獲取器的魅力所在。看的出來獲取器定義本身沒什么難度，關鍵在于方法里面的獲取邏輯，這是實際應用中最需要關注的。 ## 調用獲取器定義獲取器之后會在下列情況自動觸發： * 模型的數據對象取值操作（例如`$model->field_name`）； * 模型的序列化輸出操作（例如`$model->toArray()`或`toJson()`）； * 顯式調用`getAttr`方法（例如`$model->getAttr('field_name')`）；前面兩種其實最終都是調用最后一種來實現的，最關鍵的是要理解第一種。模型對象取值的時候一般都是通過下面的方式： ``` $user = User::get(1); echo $user->name; echo $user->user_type; ``` 當我們使用上面的方式進行模型對象數據獲取或者在模板輸出的時候事實上都會按照下面的順序來檢測和獲取數據。 * 第`1`步——如果查詢結果包含該字段數據，取回原始數據，否則并進入第2步； * 第`2`步——檢查是否定義該字段的獲取器（包括動態獲取器），如果有，則調用獲取器返回結果，沒有則進入第3步； * 第`3`步——檢查是否定義了字段的類型轉換，有則進行轉換處理并返回結果，沒有則進入第4步； * 第`4`步——如果是系統的時間字段，則自動進行時間格式化處理并返回結果，否則進入第5步； * 第`5`步——如果第1步檢查的時候不包含該字段數據，則檢查是否存在關聯屬性定義，有則通過關聯關系獲取數據并返回結果，否則拋出屬性未定義的異常。 >[info] 上面的這五個步驟的詳細代碼，如果你有興趣的可以直接參考`think\model\concern\Attribute`的`getAttr`方法代碼。簡單來說，當你獲取`$user->user_type`的時候都會去檢查是否定義了相關的獲取器，而不管`user_type`字段是否是一個真實的數據表字段。但很多情況下，你不會一個個去獲取模型數據，而是把整個模型數據返回給客戶端或者模板。 ``` public function index() { $user = User::get(1); return json($user); } ``` 在這種情況下，其實就是在響應輸出的時候進行了模型的`toJson`處理。 >[danger] 有一點至關重要，如果你的獲取器定義了非數據表的字段，是不會自動輸出的，必須通過`append`方法追加額外屬性（并且支持追加關聯模型屬性）。如果我們定義了一個`type`屬性的獲取器（假設這并不是一個真實的數據表字段），那么需要使用下?的方式才能正常輸出（否則你可能只有`user_type`數據）： ``` public function index() { $user = User::get(1); return json($user->append(['type'])); } ``` 如果你是使用`toArray`的話，處理方式相同。如果是數據集查詢的話，一樣可以使用`append`方法統一追加額外字段。 ``` public function index() { $users = User::all(); return json($users->append(['type'])); } ``` >[info] 除了`append`方法之外，我們還支持用`hidden`方法臨時隱藏一些數據。 ## 獲取原始數據有些情況下，除了要獲取處理過的數據外，還需要獲取原始數據以便應對不同的需求。如果?你的獲取器都是用的區分于實際數據表字段的額外屬性字段，那么這個問題本身已經解決了。所以我們主要討論的是當你的獲取器屬性和數據表字段一致的情況下，該如何獲取原始數據。一個最簡單的辦法是使用`getData`方法： ``` $user = User::get(1); // 獲取user_type獲取器數據 echo $user->user_type; // 獲取原始的user_type數據 echo $user->getData('user_type'); // 獲取全部原始數據 dump($user->getData()); ``` ## 動態獲取器前面我們提到過動態獲取器的概念，動態獲取器就是不需要在模型類里面定義獲取器方法，而是在查詢的時候使用閉包來定義一個字段的獲取器對數據進行統一的處理。 ``` User::withAttr('name', function($value, $data) { return strtolower($value); })->select(); ``` 如果你需要定義多個動態獲取器，多次調用`withAttr`方法就行。動態獲取器的意義除了可以不用在模型里面定義獲取器方法之外，還可以起到覆蓋已經定義的獲取器的作用，并且動態獲取器可以支持`Db`類操作，彌補了`Db`操作不能使用獲取器的缺憾，具體就看自己的需求來選擇了。 ``` Db::name('user')->withAttr('name', function($value, $data) { return strtolower($value); })->select(); ``` ## 總結無論是獲取器，還是之前提?的修改器、搜索器，其作用無非是把你的模型工作細化和拆分，這樣代碼和邏輯也會更清晰，可維護性也大大增強，至于性能，從來不是模型首先考慮的。