PHP中數(shù)組規(guī)范和自定義集合

這差不多是一個關(guān)于數(shù)組設(shè)計(jì)的風(fēng)格指南，但是把它添加到對象設(shè)計(jì)風(fēng)格指南感覺不太對，因?yàn)椴皇撬械拿嫦驅(qū)ο笳Z言都有動態(tài)數(shù)組。本文中的示例是用 PHP 編寫的，因?yàn)?PHP 很像 Java(可能比較熟悉)，但是使用的是動態(tài)數(shù)組而不是內(nèi)置的集合類和接口。

使用數(shù)組作為列表

所有元素都應(yīng)該具有相同的類型

當(dāng)使用一個數(shù)組作為一個列表(一個具有特定順序的值的集合)時(shí)，每個值應(yīng)該是 z 類型:

$goodList = [     'a',     'b' ];  $badList = [     'a',     1 ];

一個被普遍接受的注釋列表類型的風(fēng)格是:@var array<TypeOfElement>。 確保不添加索引的類型(它總是int)。

應(yīng)該忽略每個元素的索引

PHP 將自動為列表中的每個元素(0、1、2等)創(chuàng)建新索引。然而，你不應(yīng)該依賴這些索引，也不應(yīng)該直接使用它們。客戶端應(yīng)該依賴的列表的唯一屬性是可迭代的和可計(jì)數(shù)的。

因此，可以隨意使用foreach和count()，但不要使用for循環(huán)遍歷列表中的元素:

// 好的循環(huán): foreach ($list as $element) { }  // 不好的循環(huán) (公開每個元素的索引): foreach ($list as $index => $element) { }  // 也是不好的循環(huán) (不應(yīng)該使用每個元素的索引): for ($i = 0; $i < count($list); $i++) { }

(在 PHP 中，for循環(huán)甚至可能不起作用，因?yàn)榱斜碇锌赡苋鄙偎饕宜饕赡鼙攘斜碇械脑財(cái)?shù)量還要多。)

使用過濾器而不是刪除元素

你可能希望通過索引從列表中刪除元素(unset())，但是，你應(yīng)該使用array_filter()來創(chuàng)建一個新列表(沒有不需要的元素)，而不是刪除元素。

同樣，你不應(yīng)該依賴于元素的索引，因此，在使用array_filter()時(shí)，不應(yīng)該使用flag 參數(shù)去根據(jù)索引過濾元素，甚至根據(jù)元素和索引過濾元素。

// 好的過濾: array_filter(     $list,      function (string $element): bool {          return strlen($element) > 2;      } );  // 不好的過濾器(也使用索引來過濾元素) array_filter(     $list,      function (int $index): bool {          return $index > 3;     },     ARRAY_FILTER_USE_KEY );  // 不好的過濾器(同時(shí)使用索引和元素來過濾元素) array_filter(     $list,      function (string $element, int $index): bool {          return $index > 3 || $element === 'Include';     },     ARRAY_FILTER_USE_BOTH );

使用數(shù)組作為映射

當(dāng)鍵是相關(guān)的，而不是索引(0,1,2，等等)。你可以隨意使用數(shù)組作為映射(可以通過其唯一的鍵從其中檢索值)。

所有的鍵應(yīng)該是相同的類型

使用數(shù)組作為映射的第一個規(guī)則是，數(shù)組中的所有鍵都應(yīng)該具有相同的類型(最常見的是string類型的鍵)。

$goodMap = [     'foo' => 'bar',     'bar' => 'baz' ];  // 不好(使用不同類型的鍵) $badMap = [     'foo' => 'bar',     1 => 'baz' ];

所有的值都應(yīng)該是相同的類型

映射中的值也是如此:它們應(yīng)該具有相同的類型。

$goodMap = [     'foo' => 'bar',     'bar' => 'baz' ];  // 不好(使用不同類型的值) $badMap = [     'foo' => 'bar',     'bar' => 1 ];

一種普遍接受的映射類型注釋樣式是: @var array<TypeOfKey, TypeOfValue>。

映射應(yīng)該保持私有

列表可以安全地在對象之間傳遞，因?yàn)樗鼈兙哂泻唵蔚奶卣鳌Ｈ魏慰蛻舳硕伎梢允褂盟鼇硌h(huán)其元素，或計(jì)數(shù)其元素，即使列表是空的。映射則更難處理，因?yàn)榭蛻舳丝赡芤蕾囉跊]有對應(yīng)值的鍵。這意味著在一般情況下，它們應(yīng)該對管理它們的對象保持私有。不允許客戶端直接訪問內(nèi)部映射，而是提供 getter (可能還有 setter )來檢索值。如果請求的鍵不存在值，則拋出異常。但是，如果您可以保持映射及其值完全私有，那么就這樣做。

// 公開一個列表是可以的  /**  * @return array<User>  */ public function allUsers(): array {     // ... }  // 公開地圖可能很麻煩  /**  * @return array<string, User>  */ public function usersById(): array {      // ... }  // 相反，提供一種方法來根據(jù)其鍵檢索值  /**  * @throws UserNotFound  */  public function userById(string $id): User {      // ... }

對具有多個值類型的映射使用對象

當(dāng)你想要在一個映射中存儲不同類型的值時(shí)，請使用一個對象。定義一個類，并向其添加公共的類型化屬性，或添加構(gòu)造函數(shù)和 getter。像這樣的對象的例子是配置對象，或者命令對象:

final class SillyRegisterUserCommand {     public string $username;     public string $plainTextPassword;     public bool $wantsToReceiveSpam;     public int $answerToIAmNotARobotQuestion; }

這些規(guī)則的例外

有時(shí)，庫或框架需要以更動態(tài)的方式使用數(shù)組。在這些情況下，不可能(也不希望)遵循前面的規(guī)則。例如數(shù)組數(shù)據(jù)，它將被存儲在一個數(shù)據(jù)庫表中,或者Symfony 表單配置。

自定義集合類

自定義集合類是一種非常酷的方法，最后可以和Iterator、ArrayAccess和其朋友一起使用，但是我發(fā)現(xiàn)大多數(shù)生成的代碼令人很困惑。第一次查看代碼的人必須在 PHP 手冊中查找詳細(xì)信息，即使他們是有經(jīng)驗(yàn)的開發(fā)人員。另外，你需要編寫