SwiftUI - утечка памяти в NavigationView - PullRequest
Новая
       71

SwiftUI - утечка памяти в NavigationView

5 голосов
/ 19 апреля 2020

Я пытаюсь добавить кнопку закрытия к модально представленной панели навигации View. Однако после отклонения мой метод просмотра моделей deinit никогда не вызывается. Я обнаружил, что проблема в том, что он захватывает self в navigationBarItem . Я не могу просто передать действие weak self в navigationBarItem , потому что View - это структура, а не класс. Это действительная проблема или просто недостаток знаний? 

struct ModalView: View {

    @Environment(\.presentationMode) private var presentation: Binding<PresentationMode>
    @ObservedObject var viewModel: ViewModel

    var body: some View {

        NavigationView {
            Text("Modal is presented")
            .navigationBarItems(leading:
                Button(action: {
                    // works after commenting this line
                    self.presentation.wrappedValue.dismiss()
                }) {
                    Text("close")
                }

            )
        }
    }
}

Ответы [ 3 ]

2 голосов
/ 23 апреля 2020

Вам не нужно разделять кнопку закрытия в своем собственном представлении. Вы можете устранить эту утечку памяти, добавив список захвата к закрытию NavigationView: это нарушит ссылочный цикл, который сохраняет ваши viewModel.

. Вы можете скопировать / вставить этот пример кода в игровая площадка, чтобы увидеть, что это решает проблему (Xcode 11.4.1, iOS детская площадка). 

import SwiftUI
import PlaygroundSupport

struct ModalView: View {
    @Environment(\.presentationMode) private var presentation
    @ObservedObject var viewModel: ViewModel

    var body: some View {
        // Capturing only the `presentation` property to avoid retaining `self`, since `self` would also retain `viewModel`.
        // Without this capture list (`->` means `retains`):
        // self -> body -> NavigationView -> Button -> action -> self
        // this is a retain cycle, and since `self` also retains `viewModel`, it's never deallocated.
        NavigationView { [presentation] in
            Text("Modal is presented")
                .navigationBarItems(leading: Button(
                    action: {
                        // Using `presentation` without `self`
                        presentation.wrappedValue.dismiss()
                },
                    label: { Text("close") }))
        }
    }
}

class ViewModel: ObservableObject { // << tested view model
    init() {
        print(">> inited")
    }

    deinit {
        print("[x] destroyed")
    }
}

struct TestNavigationMemoryLeak: View {
    @State private var showModal = false
    var body: some View {
        Button("Show") { self.showModal.toggle() }
            .sheet(isPresented: $showModal) { ModalView(viewModel: ViewModel()) }
    }
}

PlaygroundPage.current.needsIndefiniteExecution = true
PlaygroundPage.current.setLiveView(TestNavigationMemoryLeak())
1 голос
/ 19 апреля 2020

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

Протестировано с Xcode 11.4 / iOS 13.4 - ViewModel уничтожено как ожидалось.

Здесь завершено код тестового модуля: 

struct CloseBarItem: View { // separated bar item with passed binding
    @Binding var presentation: PresentationMode
    var body: some View {
        Button(action: {
            self.presentation.dismiss()
        }) {
            Text("close")
        }
    }
}

struct ModalView: View {
    @Environment(\.presentationMode) private var presentation
    @ObservedObject var viewModel: ViewModel

    var body: some View {

        NavigationView {
            Text("Modal is presented")
            .navigationBarItems(leading: 
                CloseBarItem(presentation: presentation)) // << decompose
        }
    }
}

class ViewModel: ObservableObject {    // << tested view model
    init() {
        print(">> inited")
    }

    deinit {
        print("[x] destroyed")
    }
}

struct TestNavigationMemoryLeak: View {
    @State private var showModal = false
    var body: some View {
        Button("Show") { self.showModal.toggle() }
            .sheet(isPresented: $showModal) { ModalView(viewModel: ViewModel()) }
    }
}

struct TestNavigationMemoryLeak_Previews: PreviewProvider {
    static var previews: some View {
        TestNavigationMemoryLeak()
    }
}
0 голосов
/ 26 апреля 2020

Мое решение 

.navigationBarItems(
    trailing: self.filterButton
)

..........................................

var filterButton: some View {
    Button(action: {[weak viewModel] in
        viewModel?.showFilter()
    },label: {
        Image("search-filter-icon").renderingMode(.original)
    })
}
...