HOWTO · React

有形狀的 React Proptype 陣列

了解如何使用帶有 shape 的 React PropTypes 陣列,強化應用程式中的資料驗證。本教學說明 PropTypes 的好處,提供程式碼範例,並引導你實作 PropTypes.shape() 以便更好地偵測錯誤。立即了解如何及早發現錯誤並提升程式碼品質。

本頁內容

PropTypes.arrayOf(PropTypes.shape(...)) 用來描述一個陣列,其中每個項目都是具有指定欄位的物件。prop-types 套件會在開發期間檢查元件的這項契約;如果傳入的 props 不符合預期,也可能顯示警告。

PropTypes 會驗證什麼

PropTypes 用來宣告元件預期收到的型別與物件結構。它有助於記錄元件介面,也能在開發期間指出不符合預期的資料。這些檢查會在主控台產生警告,但不會阻止元件渲染,也不是用來驗證正式環境中的資料。

使用 PropTypes 驗證物件陣列

在 React 專案中安裝 prop-types 套件。在元件模組中,使用 import PropTypes from 'prop-types' 匯入套件,並宣告 items: PropTypes.arrayOf(PropTypes.shape({ name: PropTypes.string.isRequired, value: PropTypes.number.isRequired })).isRequired。這會將物件形狀驗證套用至每個陣列項目。下方的小型 JavaScript 範例展示相同資料如何傳入清單渲染器;範例本身可以獨立執行,而 PropTypes 宣告則應放在 React 元件模組中。

const items = [
  { name: 'Ada', value: 7 },
  { name: 'Lin', value: 9 },
];

function renderItems(items) {
  return `<ul>${items.map((item) => `<li>${item.name}: ${item.value}</li>`).join('')}</ul>`;
}

console.log(renderItems(items));
<ul><li>Ada: 7</li><li>Lin: 9</li></ul>

在 React 元件中,使用相同的陣列作為 items prop,並以 items.map(...) 渲染每個項目;每個渲染出的元素都應有穩定的 key。範例資料符合宣告的欄位,因此會呈現預期的清單內容。

設定必填欄位並了解警告

在宣告中,items 上的 .isRequired 表示必須提供這個 prop。name 和 value 上的相同修飾詞,則表示每個物件都預期包含這些欄位,且型別必須符合宣告。若某個欄位可以省略,就移除該欄位上的 .isRequired;其他已宣告的欄位仍會接受檢查。若物件中的 value 是字串 '7' 而不是數字,便不符合物件形狀,因此 React 的開發檢查會在主控台顯示警告。警告不會將字串轉成數字、不會拒收 prop,也不會阻止渲染。如果應用程式仰賴外部資料或正式環境資料,請另外驗證這些資料。

常見問題

PropTypes 會驗證陣列中的每個項目嗎?

會。PropTypes.arrayOf 會對每個項目套用驗證器。搭配 PropTypes.shape 使用時,便會檢查每個物件中指定的欄位。

PropTypes.shape 本身會驗證陣列嗎?

不會。PropTypes.shape 描述的是單一物件的欄位。若要驗證物件陣列,請使用 PropTypes.arrayOf(PropTypes.shape(...))。

React 一定要使用 PropTypes 嗎?

不需要。PropTypes 是可選的執行階段檢查,可用來記錄 props 的預期內容,並在開發期間回報警告。它不能取代靜態型別,也不能取代應用程式資料邊界上的驗證。