¿Cómo serializar o convertir objetos Swift a JSON?

81

Esta clase de abajo 

class User: NSManagedObject {
  @NSManaged var id: Int
  @NSManaged var name: String
}

Necesita ser convertido a 

{
    "id" : 98,
    "name" : "Jon Doe"
}

Intenté pasar manualmente el objeto a una función que establece las variables en un diccionario y devuelve el diccionario. Pero me gustaría una mejor manera de lograr esto.

json  swift 
— Penkey Suresh
fuente
1
Lo mejor que puede hacer es ejecutarlo y guardarlo en matrices y dictados, luego convertirlo.
— Schemetrical
— Uttam Sinha
@Schemetrical, ¿podrías señalarme un ejemplo? No sé cómo atravesar un objeto.
— Penkey Suresh
Bueno, debe revisar el objeto en sí, tomar todos los valores y agregarlo a un dict manualmente, y repetir.
— Schemetrical
@Schemetrical De hecho lo intenté. Pero para objetos grandes, el tiempo de compilación aumenta drásticamente.
— Penkey Suresh

Respuestas:

126

En Swift 4, puedes heredar del Codabletipo.

struct Dog: Codable {
    var name: String
    var owner: String
}

// Encode
let dog = Dog(name: "Rex", owner: "Etgar")

let jsonEncoder = JSONEncoder()
let jsonData = try jsonEncoder.encode(dog)
let json = String(data: jsonData, encoding: String.Encoding.utf16)

// Decode
let jsonDecoder = JSONDecoder()
let secondDog = try jsonDecoder.decode(Dog.self, from: jsonData)
— Etgar
fuente
21
El tipo de codificación debe ser .utf8 en lugar de .utf16
— Chan Jing Hong
2
@ChanJingHong, depende de lo que intentes codificar
— Etgar
Para este ejemplo específico, ¿funciona .utf16? Lo intenté pero no funciona.
— Chan Jing Hong
@ChanJingHong Strange, lo probé hace 3 meses y funcionó. Creo que debería haber puesto el tipo de codificación también como argumento en el método de decodificación. Lo comprobaré.
— Etgar
2
La pregunta era específicamente sobre la codificación class(lo que necesito) no struct.
— góndo
37

Junto con Swift 4 (Foundation) ahora es compatible de forma nativa en ambos sentidos, una cadena JSON a un objeto, un objeto a una cadena JSON. Consulte la documentación de Apple aquí JSONDecoder () y aquí JSONEncoder ()

Cadena JSON a objeto

let jsonData = jsonString.data(using: .utf8)!
let decoder = JSONDecoder()
let myStruct = try! decoder.decode(myStruct.self, from: jsonData)

Objeto rápido a JSONString

let encoder = JSONEncoder()
encoder.outputFormatting = .prettyPrinted
let data = try! encoder.encode(myStruct)
print(String(data: data, encoding: .utf8)!)

Puede encontrar todos los detalles y ejemplos aquí Guía definitiva para el análisis de JSON con Swift 4

— mohacs
fuente
25

ACTUALIZACIÓN: el Codable protocolo introducido en Swift 4 debería ser suficiente para la mayoría de los JSONcasos de análisis. La siguiente respuesta es para personas que están atrapadas en versiones anteriores de Swift y por razones heredadas

EVReflection :

  • Esto funciona como principio de reflexión. Esto toma menos código y también es compatible NSDictionary, NSCoding, Printable, HashableyEquatable

Ejemplo:

    class User: EVObject { # extend EVObject method for the class
       var id: Int = 0
       var name: String = ""
       var friends: [User]? = []
    }

    # use like below
    let json:String = "{\"id\": 24, \"name\": \"Bob Jefferson\", \"friends\": [{\"id\": 29, \"name\": \"Jen Jackson\"}]}"
    let user = User(json: json)

ObjectMapper :

  • Otra forma es utilizando ObjectMapper. Esto le da más control pero también requiere mucho más código.

Ejemplo:

    class User: Mappable { # extend Mappable method for the class
       var id: Int?
       var name: String?

       required init?(_ map: Map) {

       }

       func mapping(map: Map) { # write mapping code
          name    <- map["name"]
          id      <- map["id"]
       }

    }

    # use like below
    let json:String = "{\"id\": 24, \"name\": \"Bob Jefferson\", \"friends\": [{\"id\": 29, \"name\": \"Jen Jackson\"}]}"
    let user = Mapper<User>().map(json)
— Penkey Suresh
fuente
¿Es compatible también con imágenes de mapas?
— Charlie
1
@Charlie lo siento, no estoy seguro de si eso es posible.
— Penkey Suresh
1
@ Suresh: es posible escribiendo una transformación personalizada como se muestra en los ejemplos. Convertí la imagen a String y luego agregué en el objeto Json. Ayuda mucho especialmente trabajar con watch os
— Charlie
1
Hola, ¿sabe cómo inicializar una clase Mappable y establecer propiedades manualmente y luego convertir el objeto a jsonString?
— VAAA
¿Cuál es el impacto del protocolo codificable de swift 4 / ios 11? . ¿Podemos convertir NSManagedObject a JSON en swift 4 usando esto?
— user1828845
13

Trabajé un poco en una solución más pequeña que no requiere herencia. Pero no se ha probado mucho. Es un cajero automático bastante feo.

https://github.com/peheje/JsonSerializerSwift

Puede pasarlo a un patio de recreo para probarlo. Por ejemplo, la siguiente estructura de clases:

//Test nonsense data
class Nutrient {
    var name = "VitaminD"
    var amountUg = 4.2

    var intArray = [1, 5, 9]
    var stringArray = ["nutrients", "are", "important"]
}

class Fruit {
    var name: String = "Apple"
    var color: String? = nil
    var weight: Double = 2.1
    var diameter: Float = 4.3
    var radius: Double? = nil
    var isDelicious: Bool = true
    var isRound: Bool? = nil
    var nullString: String? = nil
    var date = NSDate()

    var optionalIntArray: Array<Int?> = [1, 5, 3, 4, nil, 6]
    var doubleArray: Array<Double?> = [nil, 2.2, 3.3, 4.4]
    var stringArray: Array<String> = ["one", "two", "three", "four"]
    var optionalArray: Array<Int> = [2, 4, 1]

    var nutrient = Nutrient()
}

var fruit = Fruit()
var json = JSONSerializer.toJson(fruit)

print(json)

huellas dactilares

{"name": "Apple", "color": null, "weight": 2.1, "diameter": 4.3, "radius": null, "isDelicious": true, "isRound": null, "nullString": null, "date": "2015-06-19 22:39:20 +0000", "optionalIntArray": [1, 5, 3, 4, null, 6], "doubleArray": [null, 2.2, 3.3, 4.4], "stringArray": ["one", "two", "three", "four"], "optionalArray": [2, 4, 1], "nutrient": {"name": "VitaminD", "amountUg": 4.2, "intArray": [1, 5, 9], "stringArray": ["nutrients", "are", "important"]}}
— Peheje
fuente
¿Puede proporcionarnos su versión rápida 2.3?
— H Raval
8

Esta no es una solución perfecta / automática, pero creo que esta es la forma idiomática y nativa de hacerlo. De esta forma no necesita bibliotecas ni nada por el estilo.

Cree un protocolo como:

/// A generic protocol for creating objects which can be converted to JSON
protocol JSONSerializable {
    private var dict: [String: Any] { get }
}

extension JSONSerializable {
    /// Converts a JSONSerializable conforming class to a JSON object.
    func json() rethrows -> Data {
        try JSONSerialization.data(withJSONObject: self.dict, options: nil)
    }
}

Luego impleméntelo en su clase como:

class User: JSONSerializable {
    var id: Int
    var name: String

    var dict { return ["id": self.id, "name": self.name]  }
}

Ahora:

let user = User(...)
let json = user.json()

Nota: si lo desea jsoncomo una cadena, es muy simple convertir a una cadena:String(data: json, encoding .utf8)

— Cabra
fuente
6

Algunas de las respuestas anteriores están completamente bien, pero agregué una extensión aquí, solo para que sea mucho más legible y utilizable.

extension Encodable {
    var convertToString: String? {
        let jsonEncoder = JSONEncoder()
        jsonEncoder.outputFormatting = .prettyPrinted
        do {
            let jsonData = try jsonEncoder.encode(self)
            return String(data: jsonData, encoding: .utf8)
        } catch {
            return nil
        }
    }
}

struct User: Codable {
     var id: Int
     var name: String
}

let user = User(id: 1, name: "name")
print(user.convertToString!)

// Esto se imprimirá como el siguiente:

{
  "id" : 1,
  "name" : "name"
}
— dheeru
fuente
2

No estoy seguro de si existe lib / framework, pero si desea hacerlo automáticamente y desea evitar el trabajo manual :-) quédese con MirrorType...

class U {

  var id: Int
  var name: String

  init(id: Int, name: String) {
    self.id = id
    self.name = name
  }

}

extension U {

  func JSONDictionary() -> Dictionary<String, Any> {
    var dict = Dictionary<String, Any>()

    let mirror = reflect(self)

    var i: Int
    for i = 0 ; i < mirror.count ; i++ {
      let (childName, childMirror) = mirror[i]

      // Just an example how to check type
      if childMirror.valueType is String.Type {
        dict[childName] = childMirror.value
      } else if childMirror.valueType is Int.Type {
        // Convert to NSNumber for example
        dict[childName] = childMirror.value
      }
    }

    return dict
  }

}

Tómelo como un ejemplo aproximado, carece de soporte de conversión adecuado, carece de recursividad, ... Es solo una MirrorTypedemostración ...

PD: Aquí está hecho U, pero lo mejorará NSManagedObjecty luego podrá convertir todas las NSManagedObjectsubclases. No es necesario implementar esto en todas las subclases / objetos gestionados.

— zrzka
fuente
Hola, estoy probando este método, pero cada vez obtengo 0 como recuento. ¿Podría ser más específico sobre lo que debo hacer? Creo que @NSManaged está causando problemas. ¿Cómo puedo mejorar NSManagedObject?
— Penkey Suresh
No lo intenté @NSManaged. Tal vez sea la causa de tu problema. En este caso, lo escribiría en Objective-C y luego lo usaría desde Swift.
— zrzka
0

2020 | SWIFT 5.1:

(también funciona con SWIFT 4)

¡Solución lista para trabajar!

Uso:

var msgTemplates = [msgTemlate]()

// load from file
msgTemplates = try! Serializer.load(from: url)!

// save to file
Serializer.save(data: msgTemplates, to: url)

El siguiente código resuelve 3 cosas:

  • 1 cadena para guardar archivo
  • 1 cadena para cargar archivo
  • capacidad de obtener / imprimir JSON de algún elemento codificable con element.toJsonString
    import Foundation

    public class Serializer{
        static func save<T>(data: T, to url: URL) where T : Encodable{
            guard let json = data.toJsonString else { return }

            do {
                try json.write(to: url, atomically: true, encoding: String.Encoding.utf8)
            }
            catch { /* error handling here */ }
        }

        static func load<T>(from url: URL) throws -> T? where T : Decodable {
            let decoder = JSONDecoder()
            decoder.dateDecodingStrategy = .iso8601 // for human-read date format

            guard let dataStr = try? String(contentsOf: url, encoding: String.Encoding.utf8 ),
                  let data = dataStr.data(using: String.Encoding.utf8 ),
                  let result = try? decoder.decode( T.self , from: data)
            else { return nil }

            return result
        }
    }

    extension Encodable {
        var toJsonString: String? {
            let encoder = JSONEncoder()
            encoder.outputFormatting = .prettyPrinted  // nice formatted for reading by human
            encoder.dateEncodingStrategy = .iso8601    // for human-read date format

            do {
                let jsonData = try encoder.encode(self)
                return String(data: jsonData, encoding: .utf8)
            } catch {
                return nil
            }
        }
    }

PS: y los datos ofc deben ser codificables:

struct msgTemlate: Codable { 
     //some params
}

PS2: en caso de que msgTemlate tenga enumeraciones, también deben ser codificables

— Andrés
fuente
0 
struct User:Codable{
 var id:String?
 var name:String?
 init(_ id:String,_ name:String){
   self.id  = id
   self.name = name
 }
}

Ahora solo haz tu objeto así

dejar usuario = Usuario ("1", "pawan")

do{
      let userJson =  try JSONEncoder().encode(parentMessage) 
            
    }catch{
         fatalError("Unable To Convert in Json")      
    }

Luego reconvertir de json a Object

let jsonDecoder = JSONDecoder()
do{
   let convertedUser = try jsonDecoder.decode(User.self, from: userJson.data(using: .utf8)!)
 }catch{
   
 }
— Pawan kumar sharma
fuente
Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.