بتل کد Battle Codeدارد باز می‌شود…

جلسه‌ی 33: داده از بیرون Data from Outside

داده‌ای که از بیرونِ برنامه می‌آید قولی به تو نداده است. می‌بینی JSON.parse بی‌صدا any می‌دهد، با unknown این سوراخ را می‌بندی، و یک «نگهبان نوع» می‌نویسی که داده را قبل از استفاده بررسی می‌کند.

در این جلسه یاد می‌گیری

درس

بعضی داده‌ها را تو ننوشته‌ای: متنی که کاربر در یک کادر می‌نویسد، چیزی که قبلاً ذخیره شده، جوابی که از یک سرور می‌آید. این‌ها معمولاً یک متن JSON هستند و با JSON.parse به شیء تبدیل می‌شوند. این‌جا کسی score را غلط نوشته: scor. اجرا کن. هیچ خط قرمزی نیست و برنامه می‌نویسد Score: undefined! چرا تایپ‌اسکریپت ساکت ماند؟ چون نمی‌تواند داخل متن را ببیند، پس جواب JSON.parse را any می‌گذارد: همان کلیدِ خاموشِ جلسه‌ی ۴.

<style>
body { font-family: sans-serif; text-align: center; padding: 16px; }
button, input, select { font-size: 16px; min-height: 40px; margin: 4px; }
#out { direction: ltr; text-align: left; font: 16px monospace; margin: 12px 0; padding: 12px; min-height: 28px; border-radius: 12px; background: #0f172a; color: #e2e8f0; white-space: pre-wrap; overflow-wrap: anywhere; }
#out .line { min-height: 22px; }
</style>

<pre id="out"></pre>

<script type="text/typescript">
const text = '{"name": "Sara", "scor": 12}';
const data = JSON.parse(text);
show(data.name);
show("Score: " + data.score);
</script>

سوراخ را با یک کلمه می‌بندیم: const data: unknown = JSON.parse(text);. اسم unknown را در جلسه‌ی ۴ شنیدی. یعنی «نمی‌دانم این چیست». فرقش با any این است: با any همه کار آزاد است، با unknown هیچ کاری آزاد نیست تا وقتی بررسی کنی. اجرا کن: حالا data.name خط قرمز است. تایپ‌اسکریپت دوباره بیدار شد.

<style>
body { font-family: sans-serif; text-align: center; padding: 16px; }
button, input, select { font-size: 16px; min-height: 40px; margin: 4px; }
#out { direction: ltr; text-align: left; font: 16px monospace; margin: 12px 0; padding: 12px; min-height: 28px; border-radius: 12px; background: #0f172a; color: #e2e8f0; white-space: pre-wrap; overflow-wrap: anywhere; }
#out .line { min-height: 22px; }
</style>

<pre id="out"></pre>

<script type="text/typescript">
const text = '{"name": "Sara", "scor": 12}';
const data: unknown = JSON.parse(text);
show(data.name);
</script>

بررسی کردن را بلدی: typeof، همان که در جلسه‌ی ۱۶ برای یونیون‌ها استفاده کردی. این‌جا متن JSON فقط یک عدد است. بعد از if (typeof data === "number")، تایپ‌اسکریپت می‌داند data عدد است و جمع آزاد می‌شود. بیرون از if هنوز unknown است.

<style>
body { font-family: sans-serif; text-align: center; padding: 16px; }
button, input, select { font-size: 16px; min-height: 40px; margin: 4px; }
#out { direction: ltr; text-align: left; font: 16px monospace; margin: 12px 0; padding: 12px; min-height: 28px; border-radius: 12px; background: #0f172a; color: #e2e8f0; white-space: pre-wrap; overflow-wrap: anywhere; }
#out .line { min-height: 22px; }
</style>

<pre id="out"></pre>

<script type="text/typescript">
const data: unknown = JSON.parse("42");

if (typeof data === "number") {
  show(data + 1);
} else {
  show("Not a number");
}
</script>

برای شیء سه سؤال می‌پرسیم. ۱. شیء است؟ typeof data === "object". ۲. null نیست؟ (یک چیز عجیبِ قدیمی: typeof null هم "object" است.) ۳. فیلد name را دارد؟ "name" in data. بعد از این سه، می‌شود data.name را خواند، ولی نوعِ خودش هنوز unknown است. پس یک typeof دیگر: متن است؟ حالا toUpperCase آزاد است.

<style>
body { font-family: sans-serif; text-align: center; padding: 16px; }
button, input, select { font-size: 16px; min-height: 40px; margin: 4px; }
#out { direction: ltr; text-align: left; font: 16px monospace; margin: 12px 0; padding: 12px; min-height: 28px; border-radius: 12px; background: #0f172a; color: #e2e8f0; white-space: pre-wrap; overflow-wrap: anywhere; }
#out .line { min-height: 22px; }
</style>

<pre id="out"></pre>

<script type="text/typescript">
const text = '{"name": "Sara", "score": 12}';
const data: unknown = JSON.parse(text);

if (typeof data === "object" && data !== null && "name" in data) {
  if (typeof data.name === "string") {
    show(data.name.toUpperCase());
  }
} else {
  show("Bad data");
}
</script>

این همه سؤال را هر بار نمی‌نویسیم. آن‌ها را در یک تابع می‌گذاریم: یک نگهبان نوع (type guard). نوع خروجی‌اش خاص است: value is Player. یعنی «اگر true برگرداندم، value یک Player است». بعد از if (isPlayer(data))، تایپ‌اسکریپت data را Player می‌داند و data.score بدون خط قرمز خوانده می‌شود.

<style>
body { font-family: sans-serif; text-align: center; padding: 16px; }
button, input, select { font-size: 16px; min-height: 40px; margin: 4px; }
#out { direction: ltr; text-align: left; font: 16px monospace; margin: 12px 0; padding: 12px; min-height: 28px; border-radius: 12px; background: #0f172a; color: #e2e8f0; white-space: pre-wrap; overflow-wrap: anywhere; }
#out .line { min-height: 22px; }
</style>

<pre id="out"></pre>

<script type="text/typescript">
interface Player {
  name: string;
  score: number;
}

function isPlayer(value: unknown): value is Player {
  if (typeof value !== "object" || value === null) {
    return false;
  }
  if (!("name" in value) || !("score" in value)) {
    return false;
  }
  return typeof value.name === "string" && typeof value.score === "number";
}

const data: unknown = JSON.parse('{"name": "Sara", "score": 12}');

if (isPlayer(data)) {
  show(data.name + " has " + data.score);
} else {
  show("Bad data");
}
</script>

مهم: نگهبان نوع قولِ توست. تایپ‌اسکریپت داخلش را بررسی نمی‌کند. این نگهبان تنبل همیشه true می‌گوید. اجرا کن: خط قرمزی نیست، ولی برنامه می‌نویسد Ali has undefined. اشتباهِ بی‌صدا برگشت! نگهبانِ خوب هر فیلد را بررسی می‌کند: هست؟ نوعش درست است؟

<style>
body { font-family: sans-serif; text-align: center; padding: 16px; }
button, input, select { font-size: 16px; min-height: 40px; margin: 4px; }
#out { direction: ltr; text-align: left; font: 16px monospace; margin: 12px 0; padding: 12px; min-height: 28px; border-radius: 12px; background: #0f172a; color: #e2e8f0; white-space: pre-wrap; overflow-wrap: anywhere; }
#out .line { min-height: 22px; }
</style>

<pre id="out"></pre>

<script type="text/typescript">
interface Player {
  name: string;
  score: number;
}

function isPlayer(value: unknown): value is Player {
  return true;
}

const data: unknown = JSON.parse('{"name": "Ali"}');

if (isPlayer(data)) {
  show(data.name + " has " + data.score);
}
</script>

اگر داده یک لیست باشد چه؟ Array.isArray(data) می‌پرسد «آرایه است؟». بعد می‌توانی نگهبان را به filter بدهی: data.filter(isPlayer) فقط بازیکن‌های درست را نگه می‌دارد و نوع نتیجه Player[] است. در این لیست یک بازیکنِ بدون امتیاز و یک عدد هم هست. هر دو کنار گذاشته می‌شوند.

<style>
body { font-family: sans-serif; text-align: center; padding: 16px; }
button, input, select { font-size: 16px; min-height: 40px; margin: 4px; }
#out { direction: ltr; text-align: left; font: 16px monospace; margin: 12px 0; padding: 12px; min-height: 28px; border-radius: 12px; background: #0f172a; color: #e2e8f0; white-space: pre-wrap; overflow-wrap: anywhere; }
#out .line { min-height: 22px; }
</style>

<pre id="out"></pre>

<script type="text/typescript">
interface Player {
  name: string;
  score: number;
}

function isPlayer(value: unknown): value is Player {
  if (typeof value !== "object" || value === null) {
    return false;
  }
  if (!("name" in value) || !("score" in value)) {
    return false;
  }
  return typeof value.name === "string" && typeof value.score === "number";
}

const text = '[{"name": "Sara", "score": 12}, {"name": "Ali"}, 7]';
const data: unknown = JSON.parse(text);

if (Array.isArray(data)) {
  const players: Player[] = data.filter(isPlayer);
  show("Players: " + players.length);
} else {
  show("Not a list");
}
</script>

حالا با یک کادر واقعی. کاربر هر چیزی می‌تواند بنویسد، حتی متنی که اصلاً JSON نیست. آن‌وقت JSON.parse برنامه را متوقف می‌کند. برای همین آن را داخل try می‌گذاریم و در catch می‌نویسیم Not JSON (از دوره‌ی جاوااسکریپت یادت هست). متن کادر را عوض کن و دکمه را بزن: یک بار score را پاک کن، یک بار یک آکولاد را.

<style>
body { font-family: sans-serif; text-align: center; padding: 16px; }
button, input, select { font-size: 16px; min-height: 40px; margin: 4px; }
#json { width: 100%; max-width: 340px; box-sizing: border-box; direction: ltr; }
</style>

<input id="json" type="text" value='{"name": "Sara", "score": 12}'>
<button id="go" onclick="press()">Read</button>
<p id="msg"></p>

<script type="text/typescript">
interface Player {
  name: string;
  score: number;
}

function isPlayer(value: unknown): value is Player {
  if (typeof value !== "object" || value === null) {
    return false;
  }
  if (!("name" in value) || !("score" in value)) {
    return false;
  }
  return typeof value.name === "string" && typeof value.score === "number";
}

function press(): void {
  const box = document.querySelector<HTMLInputElement>("#json");
  const msg = document.getElementById("msg");
  if (!box || !msg) {
    return;
  }
  let data: unknown;
  try {
    data = JSON.parse(box.value);
  } catch {
    msg.textContent = "Not JSON";
    return;
  }
  if (isPlayer(data)) {
    msg.textContent = "Welcome, " + data.name;
  } else {
    msg.textContent = "Bad data";
  }
}
</script>

مثال‌های این جلسه

چالش‌ها

  1. Close the Hole (آسان)
  2. Fix the Red Line (آسان)
  3. The Honest Guard (متوسط)
  4. The Pet Card (متوسط)
  5. Find the Bug (سخت)
  6. The Team Total (سخت)

بیشتر بخوان

← جلسه‌ی 32: رویدادها با نوع جلسه‌ی 34: بعداً، با نوع →