मैं स्विफ्ट 4 में एनम डिकोडेबल कैसे बनाऊं?


157
enum PostType: Decodable {

    init(from decoder: Decoder) throws {

        // What do i put here?
    }

    case Image
    enum CodingKeys: String, CodingKey {
        case image
    }
}

इसे पूरा करने के लिए मुझे क्या करना चाहिए? इसके अलावा, मैं कहता हूं कि मैंने इसे बदल दिया है case:

case image(value: Int)

मैं इसे डिकोडेबल के अनुरूप कैसे बनाऊं?

EDit यहाँ मेरा पूरा कोड है (जो काम नहीं करता है)

let jsonData = """
{
    "count": 4
}
""".data(using: .utf8)!

        do {
            let decoder = JSONDecoder()
            let response = try decoder.decode(PostType.self, from: jsonData)

            print(response)
        } catch {
            print(error)
        }
    }
}

enum PostType: Int, Codable {
    case count = 4
}

फाइनल एडिट इसके अलावा, यह इस तरह एक एनुम को कैसे हैंडल करेगा?

enum PostType: Decodable {
    case count(number: Int)
}

जवाबों:


262

यह बहुत आसान है, बस उपयोग Stringया Intकच्चे मान जो संक्षेप में असाइन किए गए हैं।

enum PostType: Int, Codable {
    case image, blob
}

imageको एन्कोड किया गया है 0और blobकरने के लिए1

या

enum PostType: String, Codable {
    case image, blob
}

imageको एन्कोड किया गया है "image"और blobकरने के लिए"blob"


यह इसका उपयोग करने का एक सरल उदाहरण है:

enum PostType : Int, Codable {
    case count = 4
}

struct Post : Codable {
    var type : PostType
}

let jsonString = "{\"type\": 4}"

let jsonData = Data(jsonString.utf8)

do {
    let decoded = try JSONDecoder().decode(Post.self, from: jsonData)
    print("decoded:", decoded.type)
} catch {
    print(error)
}

1
मैंने आपके द्वारा सुझाए गए कोड की कोशिश की, लेकिन यह काम नहीं करता है। मैं दिखाने के लिए JSON मैं डिकोड करने के लिए कोशिश कर रहा हूँ मेरी कोड संपादित किया है
थक्का तेज

8
एक एनम एन-डीकोड नहीं किया जा सकता है। यह एक संरचना में एम्बेडेड होना चाहिए। मैंने एक उदाहरण जोड़ा।
vadian

मैं इसे सही साबित करूंगा। लेकिन ऊपर के प्रश्न में एक अंतिम भाग था जिसका उत्तर नहीं दिया गया था। अगर मेरी दुश्मनी इस तरह दिखे तो क्या होगा? (ऊपर संपादित)
स्विफ्ट नब

यदि आप संबंधित प्रकार के साथ एनम का उपयोग कर रहे हैं, तो आपको कस्टम एन्कोडिंग और डिकोडिंग विधियों को लिखना होगा। कृपया एन्कोडिंग और डीकोडिंग कस्टम प्रकार
vadian

1
के बारे में "एक एनम को एन-डीकोड नहीं किया जा सकता है।", इसे हल किया जा रहा है iOS 13.3। मैं परीक्षण करता हूं iOS 13.3और iOS 12.4.3वे अलग तरह से व्यवहार करते हैं। के तहत iOS 13.3, एनम को एन-डीकोड किया जा सकता है।
अचलोइलू

111

संबंधित प्रकारों के साथ एनम कैसे बनाते हैं Codable

इस उत्तर @Howard lovatt के समान है, लेकिन एक बनाने से बचा जाता है PostTypeCodableFormstruct और इसके बजाय का उपयोग करता है KeyedEncodingContainerप्रकार एप्पल द्वारा प्रदान पर एक संपत्ति के रूप में Encoderऔर Decoderजो बॉयलरप्लेट कम कर देता है,।

enum PostType: Codable {
    case count(number: Int)
    case title(String)
}

extension PostType {

    private enum CodingKeys: String, CodingKey {
        case count
        case title
    }

    enum PostTypeCodingError: Error {
        case decoding(String)
    }

    init(from decoder: Decoder) throws {
        let values = try decoder.container(keyedBy: CodingKeys.self)
        if let value = try? values.decode(Int.self, forKey: .count) {
            self = .count(number: value)
            return
        }
        if let value = try? values.decode(String.self, forKey: .title) {
            self = .title(value)
            return
        }
        throw PostTypeCodingError.decoding("Whoops! \(dump(values))")
    }

    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        switch self {
        case .count(let number):
            try container.encode(number, forKey: .count)
        case .title(let value):
            try container.encode(value, forKey: .title)
        }
    }
}

यह कोड मेरे लिए Xcode 9b3 पर काम करता है।

import Foundation // Needed for JSONEncoder/JSONDecoder

let encoder = JSONEncoder()
encoder.outputFormatting = .prettyPrinted
let decoder = JSONDecoder()

let count = PostType.count(number: 42)
let countData = try encoder.encode(count)
let countJSON = String.init(data: countData, encoding: .utf8)!
print(countJSON)
//    {
//      "count" : 42
//    }

let decodedCount = try decoder.decode(PostType.self, from: countData)

let title = PostType.title("Hello, World!")
let titleData = try encoder.encode(title)
let titleJSON = String.init(data: titleData, encoding: .utf8)!
print(titleJSON)
//    {
//        "title": "Hello, World!"
//    }
let decodedTitle = try decoder.decode(PostType.self, from: titleData)

मुझे यह जवाब पसंद है! एक नोट के रूप में, इस उदाहरण भी गूँजती है एक पोस्ट objc.io पर बनाने के बारे में Eithercodable
बेन Leggiero

सबसे अच्छा उत्तर
पीटर सुवारा

38

.dataCorruptedयदि यह अज्ञात एनम मान का सामना करता है, तो स्विफ्ट एक त्रुटि फेंक देगा । यदि आपका डेटा किसी सर्वर से आ रहा है, तो यह आपको किसी भी समय एक अज्ञात एनम मान भेज सकता है (बग सर्वर साइड, एक एपीआई संस्करण में नया प्रकार जोड़ा गया है और आप चाहते हैं कि आपके ऐप के पिछले संस्करण मामले को इनायत से संभालें, आदि) आप बेहतर तरीके से तैयार होंगे, और अपने एनम को सुरक्षित रूप से डिकोड करने के लिए "रक्षात्मक शैली" कोड।

यह एक उदाहरण है कि इसे कैसे करना है, संबद्ध मूल्य के साथ या इसके बिना

    enum MediaType: Decodable {
       case audio
       case multipleChoice
       case other
       // case other(String) -> we could also parametrise the enum like that

       init(from decoder: Decoder) throws {
          let label = try decoder.singleValueContainer().decode(String.self)
          switch label {
             case "AUDIO": self = .audio
             case "MULTIPLE_CHOICES": self = .multipleChoice
             default: self = .other
             // default: self = .other(label)
          }
       }
    }

और इसे एक संलग्न संरचना में कैसे उपयोग करें:

    struct Question {
       [...]
       let type: MediaType

       enum CodingKeys: String, CodingKey {
          [...]
          case type = "type"
       }


   extension Question: Decodable {
      init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         [...]
         type = try container.decode(MediaType.self, forKey: .type)
      }
   }

1
धन्यवाद, आपका उत्तर समझने में बहुत आसान है।
डज़कॉन्ग

1
इस जवाब ने मेरी भी मदद की, धन्यवाद। स्ट्रिंग से अपनी दुश्मनी को बनाकर इसे बेहतर बनाया जा सकता है, फिर आपको तार पर स्विच करने की ज़रूरत नहीं है
Gobe

27

@ टोका के उत्तर पर विस्तार करने के लिए, आप भी एनम के लिए एक कच्चा प्रतिनिधित्व योग्य मूल्य जोड़ सकते हैं, और बिना एनाम का निर्माण करने के लिए डिफ़ॉल्ट वैकल्पिक निर्माता का उपयोग कर सकते हैं switch:

enum MediaType: String, Decodable {
  case audio = "AUDIO"
  case multipleChoice = "MULTIPLE_CHOICES"
  case other

  init(from decoder: Decoder) throws {
    let label = try decoder.singleValueContainer().decode(String.self)
    self = MediaType(rawValue: label) ?? .other
  }
}

यह एक कस्टम प्रोटोकॉल का उपयोग करके बढ़ाया जा सकता है जो कंस्ट्रक्टर को फिर से भरने की अनुमति देता है:

protocol EnumDecodable: RawRepresentable, Decodable {
  static var defaultDecoderValue: Self { get }
}

extension EnumDecodable where RawValue: Decodable {
  init(from decoder: Decoder) throws {
    let value = try decoder.singleValueContainer().decode(RawValue.self)
    self = Self(rawValue: value) ?? Self.defaultDecoderValue
  }
}

enum MediaType: String, EnumDecodable {
  static let defaultDecoderValue: MediaType = .other

  case audio = "AUDIO"
  case multipleChoices = "MULTIPLE_CHOICES"
  case other
}

यह एक त्रुटि को फेंकने के लिए भी आसानी से बढ़ाया जा सकता है यदि एक अमान्य एनम मान निर्दिष्ट किया गया था, बजाय एक मान पर डिफ़ॉल्ट करने के। इस परिवर्तन के साथ यहाँ उपलब्ध है: https://gist.github.com/stephanecopin/4283175fabf6f0cdaf87fef2a00c8128
कोड को स्विफ्ट 4.1 / Xcode 9.3 का उपयोग करके संकलित और परीक्षण किया गया था।


1
यह वह उत्तर है जिसकी मुझे तलाश थी।
नाथन हॉसल्टन

7

@ प्रॉक्सपरो की प्रतिक्रिया का एक प्रकार जो टसर है, जो डिकोडर को सूत्रबद्ध करना होगा:

public init(from decoder: Decoder) throws {
    let values = try decoder.container(keyedBy: CodingKeys.self)
    guard let key = values.allKeys.first else { throw err("No valid keys in: \(values)") }
    func dec<T: Decodable>() throws -> T { return try values.decode(T.self, forKey: key) }

    switch key {
    case .count: self = try .count(dec())
    case .title: self = try .title(dec())
    }
}

func encode(to encoder: Encoder) throws {
    var container = encoder.container(keyedBy: CodingKeys.self)
    switch self {
    case .count(let x): try container.encode(x, forKey: .count)
    case .title(let x): try container.encode(x, forKey: .title)
    }
}

यह संकलक को मामलों को पूरी तरह से सत्यापित करने की अनुमति देता है, और उस मामले के लिए त्रुटि संदेश को भी नहीं दबाता है जहां एन्कोडेड मान कुंजी के अपेक्षित मूल्य से मेल नहीं खाता है।


मैं मानता हूं कि यह बेहतर है।
प्रॉप्परो

6

वास्तव में ऊपर दिए गए उत्तर वास्तव में बहुत अच्छे हैं, लेकिन वे कुछ विवरणों को याद कर रहे हैं कि लगातार विकसित क्लाइंट / सर्वर प्रोजेक्ट में कितने लोगों की आवश्यकता है। हम एक ऐप विकसित करते हैं जबकि हमारा बैकेंड लगातार समय के साथ विकसित होता है, जिसका अर्थ है कि कुछ एनुम मामले उस विकास को बदल देंगे। इसलिए हमें एक एनुम डिकोडिंग रणनीति की आवश्यकता है जो अज्ञात मामलों में शामिल होने वाले एनम की सरणियों को डिकोड करने में सक्षम हो। अन्यथा उस ऑब्जेक्ट को डिकोड करना जिसमें सरणी होती है बस विफल हो जाती है।

मैंने जो किया वह काफी सरल है:

enum Direction: String, Decodable {
    case north, south, east, west
}

struct DirectionList {
   let directions: [Direction]
}

extension DirectionList: Decodable {

    public init(from decoder: Decoder) throws {

        var container = try decoder.unkeyedContainer()

        var directions: [Direction] = []

        while !container.isAtEnd {

            // Here we just decode the string from the JSON which always works as long as the array element is a string
            let rawValue = try container.decode(String.self)

            guard let direction = Direction(rawValue: rawValue) else {
                // Unknown enum value found - ignore, print error to console or log error to analytics service so you'll always know that there are apps out which cannot decode enum cases!
                continue
            }
            // Add all known enum cases to the list of directions
            directions.append(direction)
        }
        self.directions = directions
    }
}

बोनस: कार्यान्वयन छिपाएँ> इसे एक संग्रह बनाएं

कार्यान्वयन विस्तार को छिपाने के लिए हमेशा एक अच्छा विचार है। इसके लिए आपको बस थोड़ा सा और कोड चाहिए होगा। चाल अनुरूप है DirectionsListकरने के लिए Collectionऔर अपने आंतरिक बनाने listसरणी निजी:

struct DirectionList {

    typealias ArrayType = [Direction]

    private let directions: ArrayType
}

extension DirectionList: Collection {

    typealias Index = ArrayType.Index
    typealias Element = ArrayType.Element

    // The upper and lower bounds of the collection, used in iterations
    var startIndex: Index { return directions.startIndex }
    var endIndex: Index { return directions.endIndex }

    // Required subscript, based on a dictionary index
    subscript(index: Index) -> Element {
        get { return directions[index] }
    }

    // Method that returns the next index when iterating
    func index(after i: Index) -> Index {
        return directions.index(after: i)
    }
}

आप जॉन सुंडेल द्वारा इस ब्लॉग पोस्ट में कस्टम संग्रह के अनुरूप के बारे में अधिक पढ़ सकते हैं: https://medium.com/@johnsundell/creating-custom-collections-in-swift-a344e25d0bb0


5

आप जो चाहते हैं वह कर सकते हैं, लेकिन यह थोड़ा सा शामिल है :(

import Foundation

enum PostType: Codable {
    case count(number: Int)
    case comment(text: String)

    init(from decoder: Decoder) throws {
        self = try PostTypeCodableForm(from: decoder).enumForm()
    }

    func encode(to encoder: Encoder) throws {
        try PostTypeCodableForm(self).encode(to: encoder)
    }
}

struct PostTypeCodableForm: Codable {
    // All fields must be optional!
    var countNumber: Int?
    var commentText: String?

    init(_ enumForm: PostType) {
        switch enumForm {
        case .count(let number):
            countNumber = number
        case .comment(let text):
            commentText = text
        }
    }

    func enumForm() throws -> PostType {
        if let number = countNumber {
            guard commentText == nil else {
                throw DecodeError.moreThanOneEnumCase
            }
            return .count(number: number)
        }
        if let text = commentText {
            guard countNumber == nil else {
                throw DecodeError.moreThanOneEnumCase
            }
            return .comment(text: text)
        }
        throw DecodeError.noRecognizedContent
    }

    enum DecodeError: Error {
        case noRecognizedContent
        case moreThanOneEnumCase
    }
}

let test = PostType.count(number: 3)
let data = try JSONEncoder().encode(test)
let string = String(data: data, encoding: .utf8)!
print(string) // {"countNumber":3}
let result = try JSONDecoder().decode(PostType.self, from: data)
print(result) // count(3)

दिलचस्प हैक
रोमन Filippov
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.