根據后端返回的json數據快速生成ts類型的實現代碼

更新時間：2023年10月08日 09:56:27 作者：Moment

在前端開發(fā)中,我們通常需要處理來自后端或其他數據源的 JSON 數據,這些數據可能非常復雜,包含不同類型的屬性,甚至嵌套對象和數組,為了更好地使用這些數據,我們希望將其轉換為TypeScript類型定義,以獲得類型檢查和代碼智能提示的好處

起因

假設我們有一個包含混合類型的 JSON 數據文件 input.json：

{
  "name": "moment",
  "age": 30,
  "hobbies": ["籃球", 7, true],
  "address": {
    "street": "二仙橋",
    "city": "陜西西安"
  }
}

我們想要將這個 JSON 數據轉換為 TypeScript 類型定義，以便在 TypeScript 代碼中使用它，但由于數據中包含了混合類型的數組和嵌套對象，這并不是一個簡單的任務。

實現思路

為了將混合類型的 JSON 數據轉換為 TypeScript 類型定義，我們需要執(zhí)行以下步驟：

創(chuàng)建一個函數 generateTsCode，該函數將接受 JSON 數據和類型名稱作為參數。
在函數內部，初始化一個 TypeScript 類型定義字符串，例如 interface MyType {.
定義一個用于處理屬性值的函數 processValue，該函數將檢查屬性值的類型，并生成相應的 TypeScript 類型定義。
遍歷 JSON 數據的屬性，對每個屬性調用 processValue 函數，生成相應的屬性聲明。
如果屬性是數組，我們使用聯合類型來表示不同元素的類型；如果是對象，我們遞歸調用 processValue 函數以處理嵌套對象；否則，我們直接生成屬性的類型聲明。
最后，在 TypeScript 類型定義字符串的末尾，添加 } 來結束類型定義。
返回生成的 TypeScript 類型定義字符串。
在主程序中，讀取包含混合類型的 JSON 數據的文件，將其解析為 JavaScript 對象。
定義要生成的 TypeScript 類型的名稱。
調用 generateTsCode 函數來生成 TypeScript 類型定義。
將生成的 TypeScript 類型定義寫入文件，以供在 TypeScript 代碼中使用。

代碼示例

以下是完整的代碼示例：

const fs = require("fs");
// 定義一個函數，用于生成 TypeScript 類型定義
function generateTsCode(obj, typeName) {
  // 初始化 TypeScript 類型定義字符串
  let tsCode = `interface ${typeName} {\n`;
  // 定義一個處理屬性值的函數
  function processValue(value, key, indent) {
    if (Array.isArray(value)) {
      // 如果屬性是數組，定義聯合類型數組
      tsCode += `${indent}${key}: (`;
      for (const item of value) {
        const type =
          typeof item === "number"
            ? "number"
            : typeof item === "string"
            ? "string"
            : typeof item === "boolean"
            ? "boolean"
            : "any";
        tsCode += `${type} | `;
      }
      tsCode = tsCode.slice(0, -2); // 移除最后的 " | "
      tsCode += `)[];\n`;
    } else if (typeof value === "object" && !Array.isArray(value)) {
      // 如果屬性是嵌套對象，遞歸處理
      tsCode += `${indent}${key}: {\n`;
      processObject(value, `${indent}    `);
      tsCode += `${indent}};\n`;
    } else {
      // 否則，直接生成屬性
      const type =
        typeof value === "number"
          ? "number"
          : typeof value === "string"
          ? "string"
          : typeof value === "boolean"
          ? "boolean"
          : "any";
      tsCode += `${indent}${key}: ${type};\n`;
    }
  }
  // 定義一個處理對象的函數
  function processObject(obj, indent) {
    for (const key in obj) {
      const value = obj[key];
      processValue(value, key, indent);
    }
  }
  // 調用處理對象的函數，從根對象開始生成類型定義
  processObject(obj, "  ");
  // 完成 TypeScript 類型定義字符串
  tsCode += `}\n`;
  return tsCode;
}
// 讀取包含混合類型數組的 JSON 數據的文件
const jsonCode = fs.readFileSync("input.json", "utf-8");
// 將 JSON 代碼解析為 JavaScript 對象
const jsonObj = JSON.parse(jsonCode);
// 定義 TypeScript 類型的名稱
const typeName = "MyType";
// 調用生成 TypeScript 類型定義的函數
const tsTypeCode = generateTsCode(jsonObj, typeName);
// 將生成的 TypeScript 類型代碼寫入文件
fs.writeFileSync("output.ts", tsTypeCode, "utf-8");
// 輸出轉換完成的信息
console.log("JSON 轉換為 TypeScript 類型完成！");