ViewBuilder пользовательского представления SwiftUI не выполняет повторную визуализацию / обновление при обновлении подкласса ObservedObject

Question

Этого я исследовал несколько дней, просматривая документы Swift и SwiftUI, SO, форумы и т. Д. И, похоже, не нашел ответа.

Вот в чем проблема;

У меня есть настраиваемое представление SwiftUI, которое выполняет некоторое определение состояния в настраиваемом классе запросов API к удаленному ресурсу. В представлении обрабатываются состояния загрузки и состояния сбоя, а также содержимое его тела, передаваемое через ViewBuilder, поэтому, если состояние из API выполнено успешно и данные ресурса загружены, он будет отображать содержимое страницы.

Проблема в том, что содержимое ViewBuilder не перерисовывается при обновлении подкласса ObservedObject. Объект обновляется в ответ на пользовательский интерфейс (при нажатии кнопок и т. Д.), Но пользовательский интерфейс никогда не перерисовывает / не обновляет, чтобы отразить изменения в подклассе ObservedObject, например ForEach за массивом в подклассе ObservedObject не обновляется, когда содержимое массива изменится. Если я вынесу его из пользовательского представления, ForEach будет работать так, как задумано.

Я могу подтвердить, что код компилируется и запускается. Наблюдатели иdebugPrint()повсюду показывают, что ApiObject правильно обновляет состояние, и вид отражает ApiStateизменить абсолютно нормально. Это простоContentViewBuilder. Я предполагаю, что это связано с тем, что ViewBuilder будет вызываться только один раз.

РЕДАКТИРОВАТЬ: приведенный выше абзац должен был быть подсказкой,ApiStateобновляется правильно, но после обширного входа в приложение пользовательский интерфейс не прослушивал публикацию подкласса ObservedObject. Свойства менялись, и состояние тоже, но пользовательский интерфейс не реагировал на это. Кроме того, следующее предложение оказалось ложным, я снова протестировал в VStack, и компонент все еще не перерисовывался, то есть я искал не в том месте!

Если это так, то как VStackа другие подобные элементы обходят это стороной? Или это потому, что мойApiObjectViewперерисовывается при изменении состояния, что приводит к "сбросу" дочернего представления? Хотя в этом случае я бы ожидал, что он затем примет новые данные и все равно будет работать так, как ожидалось, его просто никогда не будет повторного рендеринга.

Проблемный код находится в CustomDataList.swift а также ApiObjectView.swiftниже. Я оставил комментарии, чтобы указать в правильном направлении.

Вот пример кода;

// ApiState.swift
// Stores the API state for where the request and data parse is currently at.
// This drives the ApiObjectView state UI.

import Foundation

enum ApiState: String
{
    case isIdle

    case isFetchingData
    case hasFailedToFetchData

    case isLoadingData
    case hasFailedToLoadData

    case hasUsableData
}

// ApiObject.swift
// A base class that the Controllers for the app extend from.
// These classes can make data requests to the remote resource API over the
// network to feed their internal data stores.

class ApiObject: ObservableObject
{
    @Published var apiState: ApiState = .isIdle

    let networkRequest: NetworkRequest = NetworkRequest(baseUrl: "https://api.example.com/api")

    public func apiGetJson<T: Codable>(to: String, decodeAs: T.Type, onDecode: @escaping (_ unwrappedJson: T) -> Void) -> Void
    {
        self.apiState = .isFetchingData

        self.networkRequest.send(
            to: to,
            onComplete: {
                self.apiState = .isLoadingData

                let json = self.networkRequest.decodeJsonFromResponse(decodeAs: decodeAs)

                guard let unwrappedJson = json else {
                    self.apiState = .hasFailedToLoadData
                    return
                }

                onDecode(unwrappedJson)

                self.apiState = .hasUsableData
            },
            onFail: {
                self.apiState = .hasFailedToFetchData
            }
        )
    }
}

// DataController.swift
// This is a genericised example of the production code.
// These controllers build, manage and serve their resource data.
// Subclassed from the ApiObject, inheriting ObservableObject

import Foundation
import Combine

class CustomDataController: ApiObject
{
    @Published public var customData: [CustomDataStruct] = []

    public func fetch() -> Void
    {
        self.apiGetJson(
            to: "custom-data-endpoint ",
            decodeAs: [CustomDataStruct].self,
            onDecode: { unwrappedJson in
                self.customData = unwrappedJson
            }
        )
    }
}

Это представление, у которого есть проблема с повторной отрисовкой ForEach на ObservedObject измените свойство связанного массива.

// CustomDataList.swift
// This is the SwiftUI View that drives the content to the user as a list
// that displays the CustomDataController.customData.
// The ForEach in this View 

import SwiftUI

struct CustomDataList: View
{
    @ObservedObject var customDataController: CustomDataController = CustomDataController()

    var body: some View
    {
        ApiObjectView(
            apiObject: self.customDataController,
            onQuit: {}
        ) {
            List
            {
                Section(header: Text("Custom Data").padding(.top, 40))
                {
                    ForEach(self.customDataController.customData, id: \.self, content: { customData in
                        // This is the example that doesn't re-render when the
                        // customDataController updates its data. I have
                        // verified via printing at watching properties
                        // that the object is updating and pushing the
                        // change.

                        // The ObservableObject updates the array, but this ForEach
                        // is not run again when the data is changed.

                        // In the production code, there are buttons in here that
                        // change the array data held within customDataController.customData.

                        // When tapped, they update the array and the ForEach, when placed
                        // in the body directly does reflect the change when
                        // customDataController.customData updates.
                        // However, when inside the ApiObjectView, as by this example,
                        // it does not.

                        Text(customData.textProperty)
                    })
                }
            }
            .listStyle(GroupedListStyle())
        }
        .navigationBarTitle(Text("Learn"))
        .onAppear() {
            self.customDataController.fetch()
        }
    }
}

struct CustomDataList_Previews: PreviewProvider
{
    static var previews: some View
    {
        CustomDataList()
    }
}

Это пользовательский просмотр, о котором идет речь, который не повторно отображает свой контент.

// ApiObjectView
// This is the containing View that is designed to assist in the UI rendering of ApiObjects
// by handling the state automatically and only showing the ViewBuilder contents when
// the state is such that the data is loaded and ready, in a non errornous, ready state.
// The ViewBuilder contents loads fine when the view is rendered or the state changes,
// but the Content is never re-rendered if it changes.
// The state renders fine and is reactive to the object, the apiObjectContent
// however, is not.

import SwiftUI

struct ApiObjectView<Content: View>: View {
    @ObservedObject var apiObject: ApiObject

    let onQuit: () -> Void

    let apiObjectContent: () -> Content

    @inlinable public init(apiObject: ApiObject, onQuit: @escaping () -> Void, @ViewBuilder content: @escaping () -> Content) {
        self.apiObject = apiObject
        self.onQuit = onQuit
        self.apiObjectContent = content
    }

    func determineViewBody() -> AnyView
    {
        switch (self.apiObject.apiState) {
            case .isIdle:
                return AnyView(
                    ActivityIndicator(
                        isAnimating: .constant(true),
                        style: .large
                    )
                )

            case .isFetchingData:
                return AnyView(
                    ActivityIndicator(
                        isAnimating: .constant(true),
                        style: .large
                    )
                )

            case .isLoadingData:
                return AnyView(
                    ActivityIndicator(
                        isAnimating: .constant(true),
                        style: .large
                    )
                )

            case .hasFailedToFetchData:
                return AnyView(
                    VStack
                    {
                        Text("Failed to load data!")
                            .padding(.bottom)

                        QuitButton(action: self.onQuit)
                    }
                )

            case .hasFailedToLoadData:
                return AnyView(
                    VStack
                    {
                        Text("Failed to load data!")
                            .padding(.bottom)

                        QuitButton(action: self.onQuit)
                    }
                )

            case .hasUsableData:
                return AnyView(
                    VStack
                    {
                        self.apiObjectContent()
                    }
                )
        }
    }

    var body: some View
    {
        self.determineViewBody()
    }
}

struct ApiObjectView_Previews: PreviewProvider {
    static var previews: some View {
        ApiObjectView(
            apiObject: ApiObject(),
            onQuit: {
                print("I quit.")
            }
        ) {
            EmptyView()
        }
    }
}

Теперь весь приведенный выше код работает абсолютно нормально, если ApiObjectView не используется, а содержимое помещается непосредственно в представление.

Но это ужасно для повторного использования кода и архитектуры, так красиво и аккуратно, но не работает.

Есть ли другой способ приблизиться к этому, например, через ViewModifier или View расширение?

Любая помощь по этому поводу будет очень признательна.

Как я уже сказал, я не могу найти никого с этой проблемой или какого-либо ресурса в Интернете, который мог бы указать мне правильное направление для решения этой проблемы или что могло бы ее вызвать, например, как описано в документации для ViewBuilder.

РЕДАКТИРОВАТЬ: Чтобы добавить что-то интересное, с тех пор я добавил таймер обратного отсчета в CustomDataList, который обновляет метку каждые 1 секунду. ЕСЛИ текст обновляется этим объектом таймера, представление повторно отображается, но ТОЛЬКО при обновлении текста на этикетке, отображающей время обратного отсчета.

Answer 1

Я понял это после того, как выдернул волосы в течение недели, это недокументированная проблема с подклассом ObservableObject, как видно в этом SO-ответе.

Это особенно раздражает, поскольку Xcode явно предлагает вам удалить класс, поскольку родительский класс предоставляет это наследование для ObservableObject, так что на мой взгляд все было хорошо.

Исправление заключается в том, что в подклассе класса вручную запускает общее изменение состояния self.objectWillChange.send() через willSet слушатель на @Published рассматриваемая переменная или любое другое.

В приведенных мной примерах базовый класс ApiObject в вопросе остаётся тот же.

Хотя CustomDataController необходимо изменить следующим образом:

// DataController.swift
// This is a genericised example of the production code.
// These controllers build, manage and serve their resource data.

import Foundation
import Combine

class CustomDataController: ApiObject
{
    @Published public var customData: [CustomDataStruct] = [] {
        willSet {
            // This is the generic state change fire that needs to be added.
            self.objectWillChange.send()
        }
    }

    public func fetch() -> Void
    {
        self.apiGetJson(
            to: "custom-data-endpoint ",
            decodeAs: [CustomDataStruct].self,
            onDecode: { unwrappedJson in
                self.customData = unwrappedJson
            }
        )
    }
}

Как только я добавил эту ручную публикацию, проблема решена.

Важное примечание из связанного ответа: не объявлять повторноobjectWillChangeв подклассе, так как это снова приведет к неправильному обновлению состояния. Например, объявление по умолчанию

let objectWillChange = PassthroughSubject<Void, Never>()

в подклассе снова прервет обновление состояния, это должно оставаться в родительском классе, который продолжается от ObservableObject напрямую, либо мое ручное, либо автоматическое определение по умолчанию (напечатанное или нет и оставленное как унаследованное объявление).

Хотя вы все равно можете определить столько пользовательских PassthroughSubject объявления, которые вам нужны, без проблем в подклассе, например

// DataController.swift
// This is a genericised example of the production code.
// These controllers build, manage and serve their resource data.

import Foundation
import Combine

class CustomDataController: ApiObject
{
    var customDataWillUpdate = PassthroughSubject<[CustomDataStruct], Never>()

    @Published public var customData: [CustomDataStruct] = [] {
        willSet {
            // Custom state change handler.
            self.customDataWillUpdate.send(newValue)

            // This is the generic state change fire that needs to be added.
            self.objectWillChange.send()
        }
    }

    public func fetch() -> Void
    {
        self.apiGetJson(
            to: "custom-data-endpoint ",
            decodeAs: [CustomDataStruct].self,
            onDecode: { unwrappedJson in
                self.customData = unwrappedJson
            }
        )
    }
}

Так долго как

• В self.objectWillChange.send() остается на @Published свойства, которые вам нужны в подклассе
• По умолчанию PassthroughSubject объявление не объявляется повторно в подклассе

Он будет работать и правильно распространять изменение состояния.