失敗を画面に出す
このレッスンで分かること
- コンソールに出しただけの失敗は、利用者から見れば起きていないのと同じです
- 受け止める場所を間違えると、失敗が成功のように見えてしまいます
コンソールに出した失敗は、利用者には見えない
前の 2 回で、失敗を受け止める書き方と、失敗の種類を自分で作る書き方をやりました。どちらも catch までは書けています。足りないのは、その先です。
JavaScript
try {
render(works);
} catch (error) {
console.log(error.message);
}これを書いた人は「エラー処理を書いた」と思っています。ですが利用者は開発者ツールを開きません。画面には何も出ず、押したボタンは反応せず、一覧は空のままです。利用者から見れば、失敗したのではなく壊れています。
出す文言は 3 つの問いに答えられていれば足ります。何が起きたのか、自分のせいなのか、次に何をすればよいのか。それ以上の詳細はコンソールに置きます。
受け止める場所を間違えると、失敗が成功に化ける
どこで受け止めるかは、間違えたときに何が起きるかを見ると決めやすくなります。まず、解析だけをする関数の中で受け止めて、空配列を返した場合です。
JavaScript
function parseWorks(text) {
try {
return JSON.parse(text);
} catch (error) {
return []; // 失敗が「0 件」に化ける
}
}呼ぶ側は 0 件を受け取り、画面に「まだ作品がありません」と出します。データが途中で切れているのに、利用者には正常な空の状態に見えます。見分けがつかず、気づくのが遅れます。
反対に、一番外側で 1 回だけ受け止めるとこうなります。
JavaScript
try {
drawHeader();
drawWorks();
drawContactForm();
} catch (error) {
showNotice("読み込みに失敗しました");
}作品の解析が失敗すると、その下のフォームの描画まで動きません。作品が出ないだけで済むはずが、問い合わせもできない画面になります。
受け止めるのは、失敗したときに画面をどうするか知っている場所です。解析する関数は、赤い枠を出すべきかどうかを知りません。同じ関数を別の画面から呼ぶかもしれないからです。だからそこでは受け止めず、その画面を組み立てている関数の側で受け止めます。
出した表示は、次の読み込みで消す
表示の出し入れは、style.display を JavaScript から書き換えるのではなく、class の付け外しで行います。見た目の指定が CSS と JavaScript に分かれると、あとから配色を変える人がどちらを直せばよいか分からなくなります。
CSS
.notice { display: none; }
.notice.is-shown { display: block; }JavaScript
panel.textContent = "作品を読み込めませんでした (" + error.name + ")";
panel.classList.add("is-shown");error.message をそのまま出すと、利用者に「Unexpected end of JSON input」と見せることになります。伝わらないうえ、環境によって文面が変わります。出すのは自分で決めた 1 文にして、問い合わせを受けたときの手がかりとして error.name だけを添えます。
そして忘れやすいのが、消すほうです。
| する場所 | すること |
|---|---|
| 読み込みの開始時 | 前の失敗の表示を消す |
| 成功したとき | 一覧を描き直す |
| 失敗したとき | 理由を出し、一覧を空にする |
消し忘れると、正しいデータを読み直して作品が並んでいるのに、上には失敗の文言が残ったままになります。消す処理を開始時の 1 か所にまとめておけば、これから読み込みの入口が増えても書き足す必要がありません。
補助関数を画面側から呼ぶ
演習の parseWorksText(text) は文字列を作品の配列へ変え、renderWorks(works) は配列を描きます。showError(message) と clearError() は通知の出し入れを担当します。補助関数の内部を書き直す必要はありません。
関数の戻り値は次の関数へそのまま渡せます。次は、チケットの文字列を解析して一覧へ渡す、別の画面の例です。
JavaScript
const tickets = parseTickets(ticketText);
renderTickets(tickets);
// 同じ順番のまま、次のようにも書ける
renderTickets(parseTickets(ticketText));内側の呼び出しが先に実行されます。そこで例外が出ると外側の描画は行われず、周囲の catch へ進みます。
よくある間違い
- 失敗を
alertで出す — 押すまで消えず、押したら跡が残りません。利用者は文言を読み返せず、画面のどこが失敗したのかも分かりません。失敗した場所の近くに、消えない形で出します - 隠すつもりで要素を消す —
panel.remove()で見えなくはなりますが、次に失敗したときに出す先が無くなります。隠すのと消すのは違います。付け外しするのは class だけにします
課題
- 書くのは
showWorks(kind)の中だけとし、開始時にclearError()で前の通知を消す tryの中でloadWorksText(kind)の文字列をparseWorksTextに渡し、その戻り値をrenderWorksへ渡すparseWorksTextは JSON の解析と配列検査を行い、失敗すると例外を投げる。受け止めるのはshowWorksのcatchにするcatchでshowErrorを呼ぶ。文言は「作品を読み込めませんでした」で始め、半角の括弧の中にerror.nameを添える- 用意済みの
showErrorは通知にis-errorを付け、一覧を空にしてis-emptyを付ける。clearErrorは文と両方のクラスを消し、renderWorksは一覧を描き直す - 通知の文の例は
作品を読み込めませんでした (SyntaxError)。括弧の前に半角スペースを 1 つ入れる
ヒント
まだ開いていません
付箋は 3 枚。下の段ほど答えに近づきます
ヒント 2
ヒント 3答えに近い