NSUserDefaults — คืออะไร API UserDefaults และการทำงานกับการตั้งค่า iOS

NSUserDefaults คืออะไร?

NSUserDefaults (UserDefaults ใน Swift) เป็นกลไกในตัวของ Apple สำหรับเก็บคู่คีย์-ค่าในรูปแบบ plist โดยมีให้ใช้งานบนทุกแพลตฟอร์มของ Apple: iOS, iPadOS, watchOS, tvOS และ macOS วัตถุประสงค์หลักคือการบันทึกค่ากำหนดของผู้ใช้ สถานะอินเทอร์เฟซ แฟลกการเปิดครั้งแรก ตัวเลือกที่เลือก และข้อมูลง่ายอื่น ๆ ที่คงอยู่ข้ามการรีสตาร์ทแอปพลิเคชัน

แต่ละแอปพลิเคชัน iOS มีแซนด์บ็อกซ์ที่แยกออกจากกัน และ NSUserDefaults จะถูกเก็บไว้ในไดเรกทอรี Library/Preferences ภายในแซนด์บ็อกซ์นี้ในไฟล์ที่ชื่อตาม Bundle Identifier ไฟล์ plist ประกอบด้วยคู่คีย์-ค่า โดยที่คีย์เป็นสตริงและค่าเป็นหนึ่งในชนิดที่รองรับ ขนาดไฟล์ไม่ถูกจำกัด แต่ Apple แนะนำให้เก็บเฉพาะการตั้งค่าใน UserDefaults ไม่ใช่ข้อมูลปริมาณมาก

ตั้งแต่ iOS 8 เป็นต้นมา NSUserDefaults เริ่มรองรับ App Groups — ที่เก็บข้อมูลร่วมกันระหว่างแอปพลิเคชันของนักพัฒนาคนเดียวกันและส่วนขยายของพวกเขา (วิดเจ็ต, แอปพลิเคชันคู่หู watchOS) โดยใช้ตัวเริ่มต้น init?(suiteName:) พร้อมกับตัวระบุ App Group ซึ่งช่วยให้วิดเจ็ต Today สามารถอ่านการตั้งค่าจากแอปพลิเคชันหลักได้โดยไม่ต้องทำซ้ำตรรกะการบันทึก

รูปแบบการจัดเก็บ: plist บนอุปกรณ์

ทางกายภาพ NSUserDefaults จะถูกเก็บไว้ในไฟล์ plist แบบไบนารีที่: {Sandbox}/Library/Preferences/com.example.myapp.plist ไฟล์ใช้รูปแบบ plist แบบไบนารี (NSPropertyListBinaryFormat_v1_0) เพื่อความกะทัดรัดและความเร็วในการอ่าน บน macOS ไฟล์อาจอยู่ในรูปแบบ XML เพื่อความเข้ากันได้ แตกต่างจาก SharedPreferences บน Android ไฟล์ plist ของ UserDefaults สามารถมีโครงสร้างซ้อนกันผ่าน Dictionary และ Array

ไฟล์ NSUserDefaults ไม่ได้ถูกเข้ารหัสตามค่าเริ่มต้น ข้อมูลถูกเก็บในรูปแบบข้อความธรรมดาและสามารถอ่านได้เมื่อมีการเข้าถึงอุปกรณ์ทางกายภาพหรือผ่านการสำรองข้อมูล สำหรับการเก็บข้อมูลที่ละเอียดอ่อน (รหัสผ่าน โทเคน คีย์เข้ารหัส) Apple แนะนำอย่างยิ่งให้ใช้ Keychain ซึ่งเข้ารหัสข้อมูลโดยอัตโนมัติในระดับระบบปฏิบัติการ

NSUserDefaults ทำงานอย่างไรใน iOS

NSUserDefaults ทำงานบนหลักการแคชในหน่วยความจำพร้อมการซิงค์ดิสก์เป็นระยะ เมื่อเข้าถึงอินสแตนซ์มาตรฐาน UserDefaults.standard ครั้งแรก ระบบจะโหลดไฟล์ plist เข้าสู่ RAM ในรูปแบบ Dictionary การอ่านทั้งหมดที่ตามมาจะดำเนินการจากหน่วยความจำ การเขียนก็เกิดขึ้นในหน่วยความจำก่อนเช่นกัน โดยการซิงค์ดิสก์จะเกิดขึ้นเป็นระยะในเธรดพื้นหลัง

การดำเนินการเขียนใช้เมธอด set(_:forKey:) ซึ่งรับค่าแบบตัวเลือกชนิด Any? ค่าสามารถเป็น nil — ใช้เพื่อลบคีย์ สำหรับการเขียนลงดิสก์ทันที เดิมทีใช้เมธอด synchronize() แต่ตั้งแต่ iOS 7 และ OS X 10.9 เป็นต้นมาไม่จำเป็นอีกต่อไป — ระบบจะซิงค์ข้อมูลโดยอัตโนมัติในช่วงเวลาปกติ Apple ประกาศอย่างเป็นทางการว่า synchronize() นั้นซ้ำซ้อนในเอกสารของบริษัท

รีจิสเตอร์ของ UserDefaults และโดเมน

NSUserDefaults ใช้ระบบรีจิสเตอร์ (โดเมน) เพื่อจัดระเบียบการค้นหาค่า เมื่อแอปพลิเคชันร้องขอค่าตามคีย์ UserDefaults จะตรวจสอบโดเมนตามลำดับในลำดับที่กำหนด: อันดับแรก NSArgumentDomain (อาร์กิวเมนต์บรรทัดคำสั่ง) จากนั้นโดเมนแอปพลิเคชัน จากนั้น NSGlobalDomain (การตั้งค่าระบบ) จากนั้นโดเมนเฉพาะภาษา และสุดท้าย NSRegistrationDomain (ค่าที่ลงทะเบียนผ่าน register(defaults:))

import Foundation

// อินสแตนซ์มาตรฐานของ UserDefaults
let defaults = UserDefaults.standard

// การเขียนค่า
defaults.set("อันนา เปโตรวา", forKey: "username")
defaults.set(28, forKey: "age")
defaults.set(true, forKey: "isLoggedIn")

// การลงทะเบียนค่าเริ่มต้น
defaults.register(defaults: [
    "theme": "system",
    "fontSize": 14
])

// การอ่านพร้อมส่งคืนค่าเริ่มต้น
let theme = defaults.string(forKey: "theme") ?? "system"
let fontSize = defaults.integer(forKey: "fontSize")

โดเมน NSRegistrationDomain เป็นโดเมนเชิงโปรแกรมที่มีอยู่ในหน่วยความจำเท่านั้นและไม่ถูกจัดเก็บลงดิสก์ ใช้สำหรับกำหนดค่าเริ่มต้นซึ่งจะมีผลจนกว่าแอปพลิเคชันจะเขียนค่าของตัวเองลงในโดเมนแอปพลิเคชัน ซึ่งช่วยให้สามารถสร้างจุดกำหนดค่าเดียวสำหรับการตั้งค่าเริ่มต้นที่สามารถเปลี่ยนแปลงได้จากส่วนกลางในระหว่างการพัฒนา

วิธีการหลักของ NSUserDefaults

NSUserDefaults มีชุดเมธอดแบบกำหนดชนิดสำหรับการอ่านและเขียนข้อมูล: string(forKey:), integer(forKey:), bool(forKey:), float(forKey:), double(forKey:), data(forKey:), array(forKey:), dictionary(forKey:) และ object(forKey:) เมธอดอ่านแต่ละเมธอดมีเมธอดเขียนที่สอดคล้องกัน set(_:forKey:) พร้อมการกำหนดชนิดของค่าที่เก็บโดยอัตโนมัติ รุ่น Swift ของ UserDefaults ใช้การกำหนดชนิดที่เข้มงวด ในขณะที่รุ่น Objective-C รับและส่งคืน id

synchronize และความเกี่ยวข้อง

เมธอด synchronize() ใน NSUserDefaults บังคับเขียนการเปลี่ยนแปลงทั้งหมดจากหน่วยความจำลงดิสก์ ในเวอร์ชันแรก ๆ ของ iOS เมธอดนี้ต้องถูกเรียกหลังจากทุกการเขียนเพื่อรับประกันความคงอยู่ของข้อมูล ตั้งแต่ iOS 7 เป็นต้นมา ระบบซิงค์ UserDefaults โดยอัตโนมัติในเธรดพื้นหลัง และ Apple ประกาศอย่างเป็นทางการว่า synchronize() นั้นซ้ำซ้อน การเรียกเมธอดนี้ไม่ทำให้เกิดข้อผิดพลาด แต่ไม่ได้ให้การรับประกันความคงอยู่เพิ่มเติม

สำหรับการติดตามการเปลี่ยนแปลง NSUserDefaults มีการแจ้งเตือน UserDefaults.didChangeNotification และเมธอดการสังเกต KVO addObserver(_:forKeyPath:options:context:) ใน SwiftUI มี Property Wrapper @AppStorage ซึ่งซิงค์ค่าใน UserDefaults กับการอัปเดตอินเทอร์เฟซผู้ใช้โดยอัตโนมัติ @AppStorage รองรับชนิดเดียวกันกับ UserDefaults และเป็นวิธีที่ต้องการสำหรับการทำงานกับการตั้งค่าในแอปพลิเคชัน SwiftUI

// การสังเกตการเปลี่ยนแปลงผ่าน KVO
class SettingsViewModel: NSObject {
    override func observeValue(
        forKeyPath keyPath: String?,
        of object: Any?,
        change: [NSKeyValueChangeKey: Any]?,
        context: UnsafeMutableRawPointer?
    ) {
        guard let keyPath else { return }
        print("คีย์เปลี่ยนแล้ว: \(keyPath)")
    }
}

// SwiftUI - AppStorage
struct SettingsView: View {
    @AppStorage("theme") private var theme: String = "system"

    var body: some View {
        Picker("ธีม", selection: $theme) {
            Text("ระบบ").tag("system")
            Text("สว่าง").tag("light")
            Text("มืด").tag("dark")
        }
    }
}

สำหรับการทำงานกับ App Groups (ที่เก็บข้อมูลร่วมกันระหว่างแอปพลิเคชันและส่วนขยายของมัน) ให้ใช้ตัวเริ่มต้น UserDefaults(suiteName:) พร้อมกับตัวระบุ App Group ตัวอย่างเช่น “group.com.example.myapp” ข้อมูลที่เขียนลงในอินสแตนซ์นี้สามารถเข้าถึงได้จากแอปพลิเคชันหลัก วิดเจ็ต แอปพลิเคชันคู่หู watchOS และส่วนขยายอื่น ๆ ที่เป็นของ App Group เดียวกัน แต่ละอินสแตนซ์ suite จะถูกเก็บในไฟล์ plist แยกต่างหาก

NSUserDefaults กับทางเลือกการจัดเก็บอื่น

แม้จะสะดวกและเรียบง่าย แต่ NSUserDefaults ไม่ใช่โซลูชันการจัดเก็บแบบสากลสำหรับข้อมูลทุกชนิดบน iOS ขึ้นอยู่กับปริมาณ ความสำคัญ และข้อกำหนดด้านความปลอดภัย Apple มีทางเลือกหลายอย่าง ซึ่งแต่ละอย่างถูกปรับให้เหมาะสมกับกรณีการใช้งานเฉพาะ

Keychain — ที่เก็บข้อมูลที่ปลอดภัย

Keychain คือที่เก็บข้อมูลที่ปลอดภัยของ Apple สำหรับข้อมูลที่เป็นความลับ แตกต่างจาก NSUserDefaults ข้อมูลทั้งหมดใน Keychain จะถูกเข้ารหัสในระดับระบบปฏิบัติการโดยใช้การเข้ารหัสฮาร์ดแวร์จาก Secure Enclave บนอุปกรณ์ที่รองรับ Keychain จะล็อกและปลดล็อกโดยอัตโนมัติพร้อมกับอุปกรณ์และรองรับการแบ่งปันการเข้าถึงระหว่างแอปพลิเคชันของนักพัฒนาคนเดียวกันผ่าน Keychain Access Groups

ข้อเสียหลักของ Keychain คือความซับซ้อนของ API เพียงแค่บันทึกสตริงธรรมดา คุณต้องสร้างคำสั่ง SecItemAdd โดยระบุแอตทริบิวต์: คลาส (kSecClassGenericPassword), บริการ (kSecAttrService), บัญชี (kSecAttrAccount) และข้อมูลจริง (kSecValueData) เพื่อให้การทำงานกับ Keychain ง่ายขึ้น มี wrapper ของบริษัทอื่นเช่น KeychainAccess และ SwiftKeychainWrapper ซึ่งให้อินเทอร์เฟซคีย์-ค่าที่สะดวกคล้ายกับ UserDefaults

ตัวอย่างการใช้ NSUserDefaults ใน Swift

ลองพิจารณาตัวอย่างที่ใช้งานได้จริง: การบันทึกและกู้คืนสถานะการแนะนำ (หน้าต้อนรับ) ในแอปพลิเคชัน iOS โดยใช้ NSUserDefaults เมื่อเปิดครั้งแรก ผู้ใช้จะเห็นหน้าจอแนะนำ หลังจากทำครบแล้ว แฟลกจะถูกบันทึกใน UserDefaults ในการเปิดครั้งถัดไป จะข้ามการแนะนำไป สำหรับ SwiftUI ใช้ @AppStorage; สำหรับ UIKit ใช้การเข้าถึง UserDefaults.standard โดยตรง

การบันทึกสถานะการแนะนำ

มาสร้าง OnboardingManager ที่ห่อหุ้มการทำงานกับ UserDefaults สำหรับเก็บสถานะการแนะนำ ผู้จัดการมีคุณสมบัติ isOnboardingCompleted สำหรับตรวจสอบสถานะและเมธอด markOnboardingCompleted สำหรับตั้งค่าแฟลก คีย์จัดเก็บถูกแยกเป็นค่าคงที่เพื่อป้องกันการพิมพ์ผิด สำหรับการทดสอบหน่วย ผู้จัดการใช้โปรโตคอล UserDefaultsProtocol ซึ่งช่วยให้สามารถแทนที่ที่เก็บจริงด้วย MockUserDefaults

class OnboardingManager {
    private let defaults: UserDefaults
    private let hasSeenKey = "has_seen_onboarding"

    init(defaults: UserDefaults = .standard) {
        self.defaults = defaults
    }

    var isOnboardingCompleted: Bool {
        defaults.bool(forKey: hasSeenKey)
    }

    func markOnboardingCompleted() {
        defaults.set(true, forKey: hasSeenKey)
    }

    func resetOnboarding() {
        defaults.removeObject(forKey: hasSeenKey)
    }
}

// การใช้งานในแอปพลิเคชัน
let onboardingManager = OnboardingManager()
if !onboardingManager.isOnboardingCompleted {
    showOnboarding()
} else {
    showMainScreen()
}

สำหรับการเก็บการตั้งค่าที่ซับซ้อนมากขึ้น เช่น ออบเจกต์ Profile ที่มีโครงสร้าง แนะนำให้ใช้โปรโตคอล Codable และ JSONEncoder/JSONDecoder ออบเจกต์ถูกทำให้เป็นอนุกรมเป็น Data ผ่าน JSONEncoder บันทึกผ่าน set(_:forKey:) และเมื่ออ่านจะถูกดีซีเรียลไลซ์จาก Data กลับเป็นออบเจกต์ผ่าน JSONDecoder วิธีการนี้ช่วยให้สามารถเก็บโครงสร้างที่ซับซ้อนใน UserDefaults โดยไม่สูญเสียความปลอดภัยของชนิด

struct UserProfile: Codable {
    let name: String
    let age: Int
    let preferences: [String: String]
}

extension UserDefaults {
    func save<T: Codable>(_ value: T, forKey key: String) {
        if let data = try? JSONEncoder().encode(value) {
            set(data, forKey: key)
        }
    }

    func load<T: Codable>(_ type: T.Type, forKey key: String) -> T? {
        guard let data = data(forKey: key) else { return nil }
        return try? JSONDecoder().decode(type, from: data)
    }
}

// การใช้งาน
let profile = UserProfile(name: "อันนา", age: 28, preferences: ["theme": "dark"])
UserDefaults.standard.save(profile, forKey: "user_profile")
let loaded = UserDefaults.standard.load(UserProfile.self, forKey: "user_profile")

สิ่งสำคัญที่ต้องจำคือ NSUserDefaults ไม่ได้ออกแบบมาสำหรับเก็บข้อมูลปริมาณมาก Apple แนะนำให้จำกัดข้อมูลที่เก็บไว้ไม่เกินสองสามสิบกิโลไบต์ สำหรับการเก็บออบเจกต์ขนาดใหญ่ (รูปภาพ เอกสาร โมเดลที่ทำให้เป็นอนุกรม) ให้ใช้ FileManager กับไดเรกทอรี Documents หรือ CoreData นอกจากนี้ UserDefaults ไม่รองรับการกำหนดเวอร์ชันสคีมาข้อมูล — เมื่อโครงสร้างโมเดล Codable เปลี่ยนแปลง ข้อมูลเก่าอาจดีซีเรียลไลซ์ไม่ได้ และสิ่งนี้ต้องได้รับการจัดการในโค้ดของแอปพลิเคชัน