Codable 类从 Swift 到 Json (@Published & @StateObject)

Question

我的最终目标是 print 这个对象（如下）在控制台中从我的应用程序中的数据与 @Published 和 @StateObjects 连接。

我想创建最终通过 api 发送的对象（api 部分超出范围）。一个名为 "household" 的对象有几个不同的数组：receiving_benefits、utility_providers、person_details、incomes、assets.

{
"household": {
    "region": "PA",
    "household_size": 1,
    "receiving_benefits": [
    ],
    "energy_crisis": false,
    "utility_providers": [
        "peco"
    ],
    "residence_type": "other",
    "property_tax_past_due": false,
    "home_needs_repairs": false,
    "filed_previous_year_tax_return": false,
    "heating_system_needs_repairs": false,
    "at_risk_of_homelessness": false,
    "received_maximum_benefit": {
        "cip": false
    },
    "person_details": [
        {
            "age": 18,
            "marital_status": "single",
            "minimum_employment_over_extended_period": false,
            "work_status": "recent_loss",
            "pregnant": false,
            "attending_school": false,
            "disabled": false
        }
    ],
    "incomes": [
        {
            "gross_monthly_amount": 700,
            "countable_group": "household",
            "year": "current"
        },
        {
            "gross_monthly_amount": 700,
            "countable_group": "household",
            "year": "previous"
        }
    ],
    "assets": [
        {
            "amount": 1000,
            "countable_group": "household"
        }
    ]
}
}

我在名为 Eligible 的文件中的 classes 如下，但我只会扩展我认为重要的那些：

class Incomes : ObservableObject, Codable {...}

class Assets : ObservableObject, Codable {...}

class Person_details : ObservableObject, Codable {...}

class Received_maximum_benefit : ObservableObject, Codable {...}

class Base : ObservableObject, Codable {
    @Published var household: Household?
    enum CodingKeys: String, CodingKey {
        case household = "household"
    }
    
    init() { }
    
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(household, forKey: .household)
    }

    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        household = try container.decode(Household.self, forKey: .household)
    }
}

class Household : ObservableObject, Codable {
    @Published var region: String = ""
    @Published var household_size: Int = 1
    @Published var receiving_benefits : [String]?
    @Published var energy_crisis : Bool = false
    @Published var utility_providers: [String] = [""]
    @Published var residence_type : String = ""
    @Published var property_tax_past_due : Bool = false
    @Published var home_needs_repairs : Bool = false
    @Published var filed_previous_year_tax_return : Bool = false
    @Published var heating_system_needs_repairs : Bool = false
    @Published var at_risk_of_homelessness: Bool = false
    @Published var received_maximum_benefit : Received_maximum_benefit?
    @Published var person_details : [Person_details]?
    @Published var Income : [Incomes]?
    @Published var assets : [Assets]?

    enum CodingKeys: String, CodingKey {

        case region = "region"
        case household_size = "household_size"
        case receiving_benefits = "receiving_benefits"
        case energy_crisis = "energy_crisis"
        case utility_providers = "utility_providers"
        case residence_type = "residence_type"
        case property_tax_past_due = "property_tax_past_due"
        case home_needs_repairs = "home_needs_repairs"
        case filed_previous_year_tax_return = "filed_previous_year_tax_return"
        case heating_system_needs_repairs = "heating_system_needs_repairs"
        case at_risk_of_homelessness = "at_risk_of_homelessness"
        case received_maximum_benefit = "received_maximum_benefit"
        case person_details = "person_details"
        case Income = "incomes"
        case assets = "assets"
    }
    
    init() { }
    
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(region, forKey: .region)
        try container.encode(household_size, forKey: .household_size)
        try container.encode(receiving_benefits, forKey: .receiving_benefits)
        try container.encode(energy_crisis, forKey: .energy_crisis)
        try container.encode(utility_providers, forKey: .utility_providers)
        try container.encode(residence_type, forKey: .residence_type)
        try container.encode(property_tax_past_due, forKey: .property_tax_past_due)
        try container.encode(home_needs_repairs, forKey: .home_needs_repairs)
        try container.encode(filed_previous_year_tax_return, forKey: .filed_previous_year_tax_return)
        try container.encode(heating_system_needs_repairs, forKey: .heating_system_needs_repairs)
        try container.encode(at_risk_of_homelessness, forKey: .at_risk_of_homelessness)
        try container.encode(received_maximum_benefit, forKey: .received_maximum_benefit)
        try container.encode(person_details, forKey: .person_details)
        try container.encode(Income, forKey: .Income)
        try container.encode(assets, forKey: .assets)
    }
    
    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        region = try container.decode(String.self, forKey: .region)
        household_size = try container.decode(Int.self, forKey: .household_size)
        receiving_benefits = try container.decode([String].self, forKey: .receiving_benefits)
        energy_crisis = try container.decode(Bool.self, forKey: .energy_crisis)
        utility_providers = try container.decode([String].self, forKey: .utility_providers)
        residence_type = try container.decode(String.self, forKey: .residence_type)
        property_tax_past_due = try container.decode(Bool.self, forKey: .property_tax_past_due)
        home_needs_repairs = try container.decode(Bool.self, forKey: .home_needs_repairs)
        filed_previous_year_tax_return = try container.decode(Bool.self, forKey: .filed_previous_year_tax_return)
        heating_system_needs_repairs = try container.decode(Bool.self, forKey: .heating_system_needs_repairs)
        at_risk_of_homelessness = try container.decode(Bool.self, forKey: .at_risk_of_homelessness)
        received_maximum_benefit = try container.decode(Received_maximum_benefit.self, forKey: .received_maximum_benefit)
        person_details = try container.decode([Person_details].self, forKey: .person_details)
        Income = try container.decode([Incomes].self, forKey: .Income)
        assets = try container.decode([Assets].self, forKey: .assets)
    }
}

下面是我的内容视图中连接到 classes 的 @StateObjects：

@StateObject var eligBase = Base()
@StateObject var user = Household()
@StateObject var personDetails = Person_details()
@StateObject var Income = Incomes()
@StateObject var Asset = Assets()
@StateObject var RMB = Received_maximum_benefit()

一旦我 select ContentView 中的一个按钮，我有以下内容以 json 漂亮的格式将数据打印到控制台：

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


        do {
            let data = try encoder.encode(user) 
            print(String(data: data, encoding: .utf8)!) 
        } catch {
            print("fail")
        }

你是否可以根据@StateObjects 看到，当我要求它编码 'user'，即 Household class，它没有打印出 Income， Assets 或 PersonDetails 数组等，并且仅打印出 Household class 中的其他 @Published 变量，如下所示：

{
  "filed_previous_year_tax_return" : true,
  "heating_system_needs_repairs" : false,
  "household_size" : 1,
  "assets" : null,
  "home_needs_repairs" : false,
  "person_details" : null,
  "utility_providers" : [
    "pgw"
  ],
  "energy_crisis" : false,
  "incomes" : null,
  "receiving_benefits" : null,
  "region" : "PA",
  "residence_type" : "rent",
  "received_maximum_benefit" : null,
  "at_risk_of_homelessness" : true,
  "property_tax_past_due" : false
}

我尝试打印出 Base class 但只打印出以下内容：

{
  "household" : null
}

基本上，不确定我做错了什么或如何在这个问题的顶部重新创建该有效负载，但是一旦我能够创建该有效负载，我就可以发送 API.

Answer 1

为了实现您的 endgame，我的建议是重组您的代码，这样您就不会将它们作为单独的 classes:

class Incomes : ObservableObject, Codable {...}
class Assets : ObservableObject, Codable {...}
class Person_details : ObservableObject, Codable {...}
class Received_maximum_benefit : ObservableObject, Codable {...}
class Household : ObservableObject, Codable {...}
.....

将这些声明为 struct，而不是 ObservableObject class。请参阅示例代码。

同样不要单独使用这些 StateObject:

@StateObject var user = Household()
@StateObject var personDetails = Person_details()
@StateObject var Income = Incomes()
@StateObject var Asset = Assets()
@StateObject var RMB = Received_maximum_benefit()

您在 class Base : ObservableObject, Codable {...} 中已经拥有了所需的一切。

保持 class Base 不变，连同 @StateObject var eligBase = Base() 并在整个代码中使用它们。最后在 json 编码中使用 Base (eligBase)。

示例代码：

struct Household: Codable {
    var region: String
    var householdSize: Int
    var receivingBenefits: [String] 
    var energyCrisis: Bool
    var utilityProviders: [String]
    var residenceType: String
    var propertyTaxPastDue, homeNeedsRepairs, filedPreviousYearTaxReturn, heatingSystemNeedsRepairs: Bool
    var atRiskOfHomelessness: Bool
    var receivedMaximumBenefit: ReceivedMaximumBenefit
    var personDetails: [PersonDetail]
    var incomes: [Income]
    var assets: [Asset]

    enum CodingKeys: String, CodingKey {
        case region
        case householdSize = "household_size"
        case receivingBenefits = "receiving_benefits"
        case energyCrisis = "energy_crisis"
        case utilityProviders = "utility_providers"
        case residenceType = "residence_type"
        case propertyTaxPastDue = "property_tax_past_due"
        case homeNeedsRepairs = "home_needs_repairs"
        case filedPreviousYearTaxReturn = "filed_previous_year_tax_return"
        case heatingSystemNeedsRepairs = "heating_system_needs_repairs"
        case atRiskOfHomelessness = "at_risk_of_homelessness"
        case receivedMaximumBenefit = "received_maximum_benefit"
        case personDetails = "person_details"
        case incomes, assets
    }
}

struct Asset: Codable {
    var amount: Int
    var countableGroup: String

    enum CodingKeys: String, CodingKey {
        case amount
        case countableGroup = "countable_group"
    }
}

struct Income: Codable {
    var grossMonthlyAmount: Int
    var countableGroup, year: String

    enum CodingKeys: String, CodingKey {
        case grossMonthlyAmount = "gross_monthly_amount"
        case countableGroup = "countable_group"
        case year
    }
}

struct PersonDetail: Codable {
    var age: Int
    var maritalStatus: String
    var minimumEmploymentOverExtendedPeriod: Bool
    var workStatus: String
    var pregnant, attendingSchool, disabled: Bool

    enum CodingKeys: String, CodingKey {
        case age
        case maritalStatus = "marital_status"
        case minimumEmploymentOverExtendedPeriod = "minimum_employment_over_extended_period"
        case workStatus = "work_status"
        case pregnant
        case attendingSchool = "attending_school"
        case disabled
    }
}

struct ReceivedMaximumBenefit: Codable {
    var cip: Bool
}

编辑

[1]，现在我们正在为 Household 及其组成部分使用结构，init() 以及编码和解码都已为我们完成。这里不需要复杂的代码，除非需要做一些专门的处理。

[2]，这里是一些测试代码，展示了如何读写你的 Base(eligBase) 模型。

struct ContentView: View {
    @StateObject var eligBase = Base()
    
    let json = """
{
"household": {
    "region": "PA",
    "household_size": 1,
    "receiving_benefits": [
    ],
    "energy_crisis": false,
    "utility_providers": [
        "peco"
    ],
    "residence_type": "other",
    "property_tax_past_due": false,
    "home_needs_repairs": false,
    "filed_previous_year_tax_return": false,
    "heating_system_needs_repairs": false,
    "at_risk_of_homelessness": false,
    "received_maximum_benefit": {
        "cip": false
    },
    "person_details": [
        {
            "age": 18,
            "marital_status": "single",
            "minimum_employment_over_extended_period": false,
            "work_status": "recent_loss",
            "pregnant": false,
            "attending_school": false,
            "disabled": false
        }
    ],
    "incomes": [
        {
            "gross_monthly_amount": 700,
            "countable_group": "household",
            "year": "current"
        },
        {
            "gross_monthly_amount": 700,
            "countable_group": "household",
            "year": "previous"
        }
    ],
    "assets": [
        {
            "amount": 1000,
            "countable_group": "household"
        }
    ]
}
}
"""
    
    var body: some View {
        Text("demo")
            .onAppear {
                print("---> reading Json \n")
                readJson()
                print("---> writing Json \n")
                writeJson()
            }
    }
    
    func readJson() {
        do {
            let elig = try JSONDecoder().decode(Base.self, from: json.data(using: .utf8)!)
            eligBase.household = elig.household
            print("\n----> eligBase.household: \(eligBase.household) \n")
        } catch {
            print("---> error: \(error)")
        }
    }
    
    func writeJson() {
        let encoder = JSONEncoder()
        encoder.outputFormatting = .prettyPrinted
        do {
            let data = try encoder.encode(eligBase)
            if let str = String(data: data, encoding: .utf8) {
                print("\n----> str: \(str) \n")
            }
        } catch {
            print("---> error: \(error)")
        }
    }
    
}

编辑

为了便于数据交互而对代码进行了轻微的改造，并展示了如何使用 TextField 来更改 grossMonthlyAmount。

将 Base 中的 household 更改为非可选，并将数组结构更新为 Identifiable 以便更轻松地与数据进行交互。也把数据的读取放在Base模型中。

struct ContentView: View {
    @StateObject var eligBase = Base()
    
    var body: some View {
        VStack(spacing: 44) {
            Text("Region " + eligBase.household.region)
            Text("Total income: \(eligBase.household.incomes.reduce(0){ [=14=] + .grossMonthlyAmount})")
            List {
                Section("Income") {
                    ForEach($eligBase.household.incomes) { $income in
                        TextField("", value: $income.grossMonthlyAmount, formatter: NumberFormatter())
                            .keyboardType(.numbersAndPunctuation)
                    }
                }
            }
        }
    }
    
}

class Base: ObservableObject, Codable {
    @Published var household: Household  // <-- here
    
    enum CodingKeys: String, CodingKey {
        case household = "household"
    }
    
    // -- here simulated initial reading of data from db or server --
    init() {
        self.household = Household(region: "", householdSize: 0, receivingBenefits: [], energyCrisis: false, utilityProviders: [], residenceType: "", propertyTaxPastDue: false, homeNeedsRepairs: false, filedPreviousYearTaxReturn: false, heatingSystemNeedsRepairs: false, atRiskOfHomelessness: false, receivedMaximumBenefit: ReceivedMaximumBenefit(cip: false), personDetails: [], incomes: [], assets: [])
        
        readHousehold()
    }
    
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(household, forKey: .household)
    }
    
    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        household = try container.decode(Household.self, forKey: .household)
    }
    
    // --- here ---
    func readHousehold() {
        let json = """
     {
     "household": {
         "region": "PA",
         "household_size": 1,
         "receiving_benefits": [
         ],
         "energy_crisis": false,
         "utility_providers": [
             "peco"
         ],
         "residence_type": "other",
         "property_tax_past_due": false,
         "home_needs_repairs": false,
         "filed_previous_year_tax_return": false,
         "heating_system_needs_repairs": false,
         "at_risk_of_homelessness": false,
         "received_maximum_benefit": {
             "cip": false
         },
         "person_details": [
             {
                 "age": 18,
                 "marital_status": "single",
                 "minimum_employment_over_extended_period": false,
                 "work_status": "recent_loss",
                 "pregnant": false,
                 "attending_school": false,
                 "disabled": false
             }
         ],
         "incomes": [
             {
                 "gross_monthly_amount": 700,
                 "countable_group": "household",
                 "year": "current"
             },
             {
                 "gross_monthly_amount": 700,
                 "countable_group": "household",
                 "year": "previous"
             }
         ],
         "assets": [
             {
                 "amount": 1000,
                 "countable_group": "household"
             }
         ]
     }
     }
     """
        do {
            let elig = try JSONDecoder().decode(Base.self, from: json.data(using: .utf8)!)
            household = elig.household
        } catch {
            print("---> error: \(error)")
        }
    }
    
    // --- here ---
    func writeHousehold() {
        let encoder = JSONEncoder()
        encoder.outputFormatting = .prettyPrinted
        do {
            let data = try encoder.encode(household)
            if let str = String(data: data, encoding: .utf8) {
                print("\n----> str: \(str) \n")
            }
        } catch {
            print("---> error: \(error)")
        }
    }
    
}

struct Asset: Codable, Identifiable {  // <-- here
    let id  = UUID()  // <-- here
    var amount: Int
    var countableGroup: String
    
    enum CodingKeys: String, CodingKey {
        case amount
        case countableGroup = "countable_group"
    }
}

struct Income: Codable, Identifiable {  // <-- here
    let id  = UUID()  // <-- here
    var grossMonthlyAmount: Int
    var countableGroup, year: String
    
    enum CodingKeys: String, CodingKey {
        case grossMonthlyAmount = "gross_monthly_amount"
        case countableGroup = "countable_group"
        case year
    }
}

struct PersonDetail: Codable, Identifiable {  // <-- here
    let id  = UUID()  // <-- here
    var age: Int
    var maritalStatus: String
    var minimumEmploymentOverExtendedPeriod: Bool
    var workStatus: String
    var pregnant, attendingSchool, disabled: Bool
    
    enum CodingKeys: String, CodingKey {
        case age
        case maritalStatus = "marital_status"
        case minimumEmploymentOverExtendedPeriod = "minimum_employment_over_extended_period"
        case workStatus = "work_status"
        case pregnant
        case attendingSchool = "attending_school"
        case disabled
    }
}

Codable 类从 Swift 到 Json (@Published & @StateObject)

Codable Classes from Swift to Json (@Published & @StateObject)

arrays

xcode

json

swift

swiftui

Codable 类 从 Swift 到 Json (@Published & @StateObject)

Codable Classes from Swift to Json (@Published & @StateObject)

arrays

xcode

json

swift

swiftui

Codable 类从 Swift 到 Json (@Published & @StateObject)