SwiftUI / Keyboard Kit: Be Careful On Retaining Self! weak self WITHIN weak self is required!
Zusammenfassung
Kurz
Der Autor führt den steigenden Speicherverbrauch seiner Keyboard-Kit-Tastatur auf eine gespeicherte Rückruffunktion zurück, die den View Controller über eine direkte Methodenreferenz festhielt. Eine eigene Rückruffunktion mit erneutem [weak self] habe den Verbrauch in seinem Fall stabilisiert; der Bericht belegt keine allgemeine Ursache für vergleichbare Probleme.
Mittel
Der Autor berichtet von einer Keyboard-Kit-Tastaturerweiterung, bei der das Einfügen von Text nach einiger Zeit ausfiel. Sein Speicherverbrauch stieg nach jedem Wechsel der Tastatur oder erneuten Öffnen der App um etwa 6 bis 7 MB, von anfänglich rund 30 MB bis zum Systemlimit von ungefähr 70 MB. Das Entfernen eigener Tasks und SwiftUI-Zustände sowie Änderungen an der Ansicht halfen nicht. Eine eigene Ansicht ohne KeyboardView blieb laut Autor hingegen bei etwa 10 MB stabil.
Die Ursache fand er in einem CustomActionHandler: Eine gespeicherte Rückruffunktion verwies direkt auf eine Methode des View Controllers. Obwohl die äußere setupKeyboardKit-Abschlussfunktion [weak self] nutzte, hielt diese Methodenreferenz den Controller nach seiner Analyse weiterhin fest. Er ersetzte sie durch eine eigene Rückruffunktion mit erneutem [weak self]. Danach blieb der Verbrauch mit KeyboardView laut Bericht bei etwa 20 MB.
Der Autor leitet daraus ab, dass verschachtelte oder weitergereichte Rückruffunktionen ihre eigene schwache Erfassung benötigen können. Die Diagnose und Messwerte beziehen sich auf seinen konkreten Fall; eine allgemeine Überprüfung anderer Konfigurationen beschreibt der Bericht nicht.
Ausführlich lesen
Der vollständige Bericht beschreibt die Fehlersuche des Autors Itsuki bei einer iOS-Tastaturerweiterung mit Keyboard Kit. Nach einiger Laufzeit ließ sich laut Autor kein Text mehr einfügen. Er vermutete, das System beende die Erweiterung wegen ihres Speicherverbrauchs. Beim Start habe die Tastatur ungefähr 30 MB belegt; nach jedem Wechsel zu einer anderen Tastatur und zurück beziehungsweise nach dem erneuten Öffnen der App seien jeweils etwa 6 bis 7 MB hinzugekommen. Der Verbrauch sei linear bis auf rund 70 MB gestiegen, woraufhin das System die Erweiterung beendet habe.
Der Autor entfernte zunächst eigene Tasks sowie Zustände und AppStorage-Eigenschaften aus seiner SwiftUI-Ansicht. Auch mit dem Beispielcode aus der Keyboard-Kit-Dokumentation sei das Problem geblieben. Er prüfte außerdem, ob das Erzeugen der SwiftUI-Ansicht oder eines UIHostingController dafür verantwortlich sei. Eine eigene Ansicht ohne die betreffende KeyboardView beziehungsweise das Erstellen der Ansicht in viewDidLoad habe nach seinen Beobachtungen dagegen keinen steigenden Speicherverbrauch verursacht; er nennt dafür einen stabilen Wert von etwa 10 MB. Deshalb vermutete er zunächst einen Fehler in Keyboard Kit oder bei der Weitergabe beobachtbarer Objekte.
Schließlich fand er den Auslöser in seinem eigenen CustomActionHandler. Obwohl die äußere setupKeyboardKit-Abschlussfunktion [weak self] verwendete, wies er der Handler-Eigenschaft onPressAction direkt die Methode handlePressAction zu. Nach seiner Analyse hielt diese Referenz den View Controller weiter am Leben. Er ersetzte die direkte Methodenreferenz durch eine eigene Abschlussfunktion, die [weak self] erfasst und die Methode über self? aufruft. Danach sei der Speicherverbrauch mit KeyboardView stabil bei ungefähr 20 MB geblieben.
Als praktische Folgerung empfiehlt der Autor, bei Abschlussfunktionen, die innerhalb einer bereits schwachen äußeren Abschlussfunktion erzeugt und weitergegeben werden, erneut [weak self] zu verwenden. Das gelte seiner Ansicht nach auch für an eigene Ansichten übergebene Eigenschaften oder Rückrufe, die auf self zugreifen. Die zentrale Aussage ist somit eine persönliche Diagnose zu einer konkreten Retain-Zeichenfolge: Eine schwache Erfassung in der äußeren Abschlussfunktion macht eine darin erzeugte und gespeicherte Abschlussfunktion nicht automatisch schwach.
Die berichteten Speicherwerte und die Ursache stammen aus der eigenen Fehlersuche des Autors. Der Text nennt keine systematische Prüfung weiterer Keyboard-Kit-Versionen, Geräte oder Konfigurationen und belegt daher nicht, dass jeder ähnliche Speicheranstieg auf denselben Fehler zurückgeht. Der Autor räumt außerdem ein, keine allgemeine Lösung für das Problem zu haben; er beschreibt die gefundene Ursache und Abhilfe für seinen konkreten Fall.
Gegengeprüft von Claude Haiku 5.5: kleine Mängel
Im Prompt stehen keine Fragen zur Einordnung ("keine"), daher bleibt die Einordnung leer. Die Zusammenfassung wurde gegen den Bericht geprüft; die unbeschriftete Schlusspassage nach der mittleren Fassung wurde als Teil davon gewertet. Alle genannten Zahlen (30 MB, 6 bis 7 MB je Wechsel, 70 MB Limit, 10 MB und 20 MB Messwerte) und die Ursache im CustomActionHandler stimmen mit dem Bericht überein.
Im Bericht, aber nicht in der Zusammenfassung
- Laut Autor blieb der Speicherverbrauch auch mit [weak self] bzw. [unowned self] im setupKeyboardView-Abschluss bestehen, was in der kurzen Fassung fehlt
- Die Dokumentationswarnung zu weak/unowned-Referenzen, auf die sich der Autor bezieht, fehlt in beiden Fassungen
Wie die Modelle den Bericht einordnen
Ansicht
Filter
Kein Modell sieht bei diesem Bericht einen Bezug zu einer der 44 Sammelfragen.