Archives and Serialization アーカイブとシリアライゼーション

Convert objects and values to and from property list, JSON, and other flat binary representations. オブジェクトと値をプロパティリスト、JSON、そして平坦なバイナリ表現へとおよびそれから変換します。

Overview 概要

Use these APIs to convert your app’s in-memory types to representations suitable for serialization over I/O and network interfaces or to long-term storage.

In Swift, the standard library defines the Encodable, Decodable, and Codable types, along with Encoder and Decoder APIs to perform encoding and decoding, as described in Encoding, Decoding, and Serialization. Foundation extends this with the EncodableWithConfiguration and DecodableWithConfiguration protocols, used for types that require additional static information to encode and decode, such as AttributedString.

In Objective-C, NSCoding defines a protocol for encoding and decoding objects. When adding serialization to your own types, you should also adopt NSSecureCoding. This protocol adds protection against security vulnerabilities introduced by instantiating arbitrary objects as part of the decoding process.

Many system frameworks use these types. When working with external systems, such as URL endpoints, use the JSON and XML APIs to serialize your app’s types to standard formats.

Topics 話題

Adopting Codability

Encoding and Decoding Custom Types あつらえの型のエンコーディングとデコーディング
Make your data types encodable and decodable for compatibility with external representations such as JSON. あなたのデータ型のエンコーディングとデコーディングを外部表現、例えばJSONなどとの互換性のために行います。
typealias Codable
A type that can convert itself into and out of an external representation. それ自身を外部表現へとそしてそれをもとに変換できる型。
protocol NSCoding
A protocol that enables an object to be encoded and decoded for archiving and distribution. あるオブジェクトにアーカイブと配布のためにエンコードおよびデコードされることを可能にするプロトコル。
protocol NSSecureCoding
A protocol that enables encoding and decoding in a manner that is robust against object substitution attacks. エンコーディングとデコーディングを、オブジェクト置き換え攻撃に対して堅牢なある流儀で可能にするプロトコル。

Serializing Arbitrary Payloads 恣意的なペイロードをシリアル化する

typealias CodableWithConfiguration
A type that can convert itself into and out of an external representation with the help of a configuration that handles encoding contained types.
struct CodableConfiguration
A property wrapper that makes a type codable, by supplying a configuration that provides additional information for serialization.
protocol DecodableWithConfiguration
A protocol for types that support decoding when supplied with an additional configuration type.
protocol DecodingConfigurationProviding
A protocol whose conformers provide a configuration instance to help decode types that don’t support encoding by themselves.
protocol EncodableWithConfiguration
A protocol for types that support encoding when supplied with an additional configuration type.
protocol EncodingConfigurationProviding
A protocol whose conformers provide a configuration instance to help encode types that don’t support encoding by themselves.

JSON

Using JSON with Custom Types JSONをあつらえの型で使う
Encode and decode JSON data, regardless of its structure, using Swift’s JSON support. JSONデータをエンコードおよびデコードします、それの構造に関係なく、SwiftのJSONサポートを使います。
class JSONEncoder
An object that encodes instances of a data type as JSON objects. あるデータ型のインスタンスをJSONオブジェクトとしてエンコードするオブジェクト。
class JSONDecoder
An object that decodes instances of a data type from JSON objects. あるデータ型のインスタンスをJSONオブジェクトからデコードするオブジェクト。
class JSONSerialization
An object that converts between JSON and the equivalent Foundation objects. JSONと同等のFoundationオブジェクト間で変換するオブジェクト。

Property Lists プロパティ・リスト

class PropertyListEncoder
An object that encodes instances of data types to a property list. いくつかのデータ型のインスタンスをプロパティ・リストにエンコードするオブジェクト。
class PropertyListDecoder
An object that decodes instances of data types from a property list. いくつかのデータ型のインスタンスをプロパティ・リストからデコードするオブジェクト。
class PropertyListSerialization
An object that converts between a property list and one of several serialized representations. あるプロパティリストといくつかのシリアライズされた表現のうちの１つの間で変換をするオブジェクト。

XML

XML Processing and Modeling XMLの処理とモデリング
Parse XML documents. XML文書の構文解析。

Keyed Archivers キー付きアーカイバ

class NSKeyedArchiver
An encoder that stores an object’s data to an archive referenced by keys. あるオブジェクトのもつデータをキーそれらによって参照されるアーカイブに格納するエンコーダ。
protocol NSKeyedArchiverDelegate
The optional methods implemented by the delegate of a keyed archiver. キー付きアーカイバの委任先によって実装される随意のメソッド。
class NSKeyedUnarchiver
A decoder that restores data from an archive referenced by keys. キーそれらによって参照をつけられるあるアーカイブからデータを復元するデコーダ。
protocol NSKeyedUnarchiverDelegate
The optional methods implemented by the delegate of a keyed unarchiver. キー付きアンアーカイバの委任先によって実装される随意のメソッド。
class NSCoder
An abstract class that serves as the basis for objects that enable archiving and distribution of other objects. 他のオブジェクトのアーカイブと配布を可能にするオブジェクトの基礎として奉仕する抽象クラス。
class NSSecureUnarchiveFromDataTransformer
A value transformer that converts data to and from classes that support secure coding. ある値トランスフォーマ、それはデータを保安コード化をサポートするクラスへとそしてそれから変換します。

Deprecated 非推奨

class NSArchiver
A coder that stores an object's data to an archive. オブジェクトの持つデータをアーカイブに格納するコーダ。
Deprecated 非推奨
class NSUnarchiver
A decoder that restores data from an archive. アーカイブからデータを復元するデコーダ。
Deprecated 非推奨

See Also 参照

Files and Data Persistence ファイルとデータ永続

File System ファイルシステム
Create, read, write, and examine files and folders in the file system. ファイルシステムにおいてファイルとフォルダの作成、読み込み、書き出し、そして調査をします。
Preferences 環境設定
Persistently store domain-scoped pieces of information for configuring your app. あなたのアプリを設定するために情報のドメインスコープ断片を永続的に格納します。
Spotlight
Search for files and other items on the local device, and index your app's content for searching. ローカルデバイス上のファイルや他の項目を検索します、そしてあなたのアプリのもつ内容を検索のために索引化します。
iCloud
Manage files and key-value data that automatically synchronize among a user's iCloud devices. ユーザ所有のiCloudデバイス間で自動的に同期するファイルやキー値データを管理します。
Optimizing Your App’s Data for iCloud Backup
Minimize the space and time that backups take to create by excluding purgeable and nonpurgeable data from backups.