Swift JSONデコード失敗の原因と対処｜DecodingError徹底解説
生徒
「SwiftでJSONを読み込もうとしたらエラーになってしまいました。どうしてなんでしょうか？」
先生
「SwiftではJSONDecoderを使ってJSONをSwiftの構造体やクラスに変換しますが、そのときに形式が合わないとエラーになります。」
生徒
「エラーって具体的にはどんな種類があるんですか？」
先生
「良い質問です。SwiftにはDecodingErrorという仕組みがあり、どの部分で失敗したかを詳しく教えてくれます。それでは、具体的に見ていきましょう。」
1. SwiftのJSONデコードとは？
まず「JSON」とは、データをやりとりするためのフォーマットの一つで、JavaScript Object Notationの略です。人間が読めるテキスト形式で、アプリやサーバー間の通信でよく使われます。
Swiftでは、サーバーから受け取ったJSONをアプリ内で使えるようにstructやclassに変換します。この変換処理を「JSONデコード」と呼び、JSONDecoderクラスを利用します。
2. DecodingErrorとは？
SwiftのJSONデコードが失敗したときに発生する代表的なエラーがDecodingErrorです。このエラーは「なぜ変換できなかったのか」を教えてくれるので、原因を調べる手がかりになります。
DecodingErrorにはいくつかの種類があり、それぞれ異なる原因を示しています。初心者のうちは難しく感じるかもしれませんが、エラーメッセージを見ればヒントが隠されています。
3. DecodingErrorの種類と原因
代表的なDecodingErrorの種類を順番に見ていきましょう。
3-1. typeMismatch（型の不一致）
JSONの値の型と、Swiftのプロパティの型が一致しないときに発生します。
struct User: Codable {
let id: Int
let name: String
}
let json = """
{
"id": "abc",
"name": "Taro"
}
""".data(using: .utf8)!
do {
let user = try JSONDecoder().decode(User.self, from: json)
print(user)
} catch {
print(error)
}
typeMismatch(Swift.Int, ...)
この例では、本来数字であるべきidに文字列が入っているためエラーになっています。
3-2. keyNotFound（キーが見つからない）
JSONに必要なキーが存在しない場合に発生します。
struct User: Codable {
let id: Int
let name: String
}
let json = """
{
"id": 1
}
""".data(using: .utf8)!
do {
let user = try JSONDecoder().decode(User.self, from: json)
print(user)
} catch {
print(error)
}
keyNotFound(CodingKeys(stringValue: "name", intValue: nil), ...)
この場合、JSONにnameが無いためエラーになります。
3-3. valueNotFound（値が見つからない）
キーはあるけれど値がnullなどで欠落しているときに発生します。
3-4. dataCorrupted（データの破損）
JSONそのものが正しくない形式のときに発生します。例えば、カンマの位置が間違っていたり、文字列のクォーテーションが抜けていたりするケースです。
4. エラーを回避する方法
それでは、初心者がよくつまずくエラーの対処法を紹介します。
- Optional型を使う：値が無い可能性がある場合は
String?やInt?と定義しましょう。 - キーの対応を明示する：
CodingKeysを使ってJSONのキー名とSwiftのプロパティを対応付けることができます。 - デフォルト値を設定する：デコードに失敗しそうな場合は、初期値を用意して安全に扱いましょう。
5. 実際のエラーメッセージの読み方
Swiftのエラーメッセージには「どのプロパティで」「どんな理由で」失敗したかが書かれています。初心者の方は英語の文章に戸惑うかもしれませんが、焦らずに「型の不一致」「キーが見つからない」といった部分に注目しましょう。
たとえばkeyNotFoundと出ていたら「そのキーがJSONに無いんだな」と考え、JSONを確認して修正すると理解が早まります。
6. まとめて覚えるポイント
SwiftのJSONデコード失敗は多くの場合、型の不一致かキーの不足です。DecodingErrorを読み解けば原因がわかり、すぐに対処できます。初心者のうちはエラーを恐れずに、JSONとSwiftの型定義を一つずつ確認していきましょう。
