Swift + CoreData + Немного напильника

Кому дорого время

Синтетический пример

С чем будем ковыряться

• название (строка — обязательное)
• внутренний номер (число — обязательное)
• номер телефона (строка — опциональная, никаких проверок корректности номера делать не будем)

• Имя (строка — обязательно)
• Фамилия (строка — обязательно)
• Пол (число — обязательно)
• Возраст (число — опционально)

Менеджер управления данными

• Вырезаем всю работу с CoreData из AppDelegate
• Создаем класс CSDataManager
• В нем создаем свойства для работы с моделью, контекстом и непосредственным хранилищем данных
• Создаем метод для работы в виде синглетона

import UIKit
import CoreData

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
                            
    var window: UIWindow?

    func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: NSDictionary?) -> Bool {
        // Override point for customization after application launch.
        return true
    }
}

import UIKit
import Foundation
import CoreData

let kCSErrorDomain = "ru.novilab-mobile.cstest"
let kCSErrorLocalStorageCode = -1000

@objc(CSDataManager)
class CSDataManager:NSObject {
    //Managed Model
    var _managedModel: NSManagedObjectModel?
    var managedModel: NSManagedObjectModel{
        if !_managedModel{
            _managedModel = NSManagedObjectModel.mergedModelFromBundles(nil)
        }
        return _managedModel!
    }
    
    //Store coordinator
    var _storeCoordinator: NSPersistentStoreCoordinator?
    var storeCoordinator: NSPersistentStoreCoordinator{
        if !_storeCoordinator{
            let _storeURL = self.applicationDocumentsDirectory.URLByAppendingPathComponent("CSDataStorage.sqlite")
            _storeCoordinator = NSPersistentStoreCoordinator(managedObjectModel: self.managedModel)
            
            func addStore() -> NSError?{
                var result: NSError? = nil
                if _storeCoordinator!.addPersistentStoreWithType(NSSQLiteStoreType, configuration: nil, URL: _storeURL, options: nil, error: &result) == nil{
                    println("Create persistent store error occurred: \(result?.userInfo)")
                }
                return result
            }
            
            var error = addStore()
            if  error != nil{
                println("Store scheme error. Will remove store and try again. TODO: add scheme migration.")
                NSFileManager.defaultManager().removeItemAtURL(_storeURL, error: nil)
                error = addStore()
                
                if error{
                    println("Unresolved critical error with persistent store: \(error?.userInfo)")
                    abort()
                }
            }
        }
        return _storeCoordinator!
    }

    //Managed Context
    var _managedContext: NSManagedObjectContext? = nil
    var managedContext: NSManagedObjectContext {
        if !_managedContext {
            let coordinator = self.storeCoordinator
            if coordinator != nil {
                _managedContext = NSManagedObjectContext()
                _managedContext!.persistentStoreCoordinator = coordinator
            }
        }
        return _managedContext!
    }
    
    //Init
    init() {
        super.init()
        NSNotificationCenter.defaultCenter().addObserver(self, selector: "appDidEnterBackground", name: UIApplicationDidEnterBackgroundNotification, object: nil)
    }
    
    @objc(appDidEnterBackground)
    func appDidEnterBackground(){
        var (result:Bool, error:NSError?) = self.saveContext()
        if error != nil{
            println("Application did not save data with reason: \(error?.userInfo)")
        }
    }

    // Returns the URL to the application's Documents directory.
    var applicationDocumentsDirectory: NSURL {
        let urls = NSFileManager.defaultManager().URLsForDirectory(.DocumentDirectory, inDomains: .UserDomainMask)
        return urls[urls.endIndex-1] as NSURL
    }

    //Save context
    func saveContext() -> (Bool, NSError?){
        println("Will save")
        var error: NSError? = nil
        var result: Bool = false
        let context = self.managedContext
        if context != nil{
            if context.hasChanges && !context.save(&error){
                println("Save context error occurred: \(error?.userInfo)")
            }else{
                result = true
            }
        }else{
            let errorCode = kCSErrorLocalStorageCode
            let userInfo = [NSLocalizedDescriptionKey : "Managed context is nil"]
            error = NSError.errorWithDomain(kCSErrorDomain, code: errorCode, userInfo: userInfo)
        }
        return (result, error)
    }
    
    //Singleton Instance
    class func sharedInstance() -> CSDataManager{
        struct wrapper{
            static var shared_instance: CSDataManager? = nil
            static var token: dispatch_once_t = 0
        }
        
        dispatch_once(&wrapper.token, {wrapper.shared_instance = CSDataManager()})
        return wrapper.shared_instance!
    }
}

• работа с глобальными константами
• работа со свойствами класса
• статические методы класса (старые добрые class object methods)
• хранимые процедуры (допилил напильником свойство storeCoordinator, так как постоянно менял в будущем модель данных и это обеспечивало автоматическое затирание файла БД по необходимости)
• работа с Tuples на примере модифицированного метода сохранения контекста
• работа с NSNotificationCenter

Косяк №2

Работа со свойствами — очень мне не нравится. Пример основан на том, что предлагает сам Xcode по умолчанию — соответственно я делаю вывод, что это лучшее из существующих решений. Конкретно не нравится — необходимость напрямую объявлять внутреннюю переменную для хранения (раньше это работало под капотом). При этом сами переменные не смотря на ведущее подчеркивание впереди остаются видимыми извне — и у нас по факту получается, что в инспекторе файла видны по два свойства для каждой из наших задач. Итого суммарно мне не нравится:

• Необходимость явно дублировать свойства для решения подобных задач
• Невозможность создания просто внутренних переменных
• Невозможность создания внутренних свойств — раньше решалось будем определения property внутри файла реализации, а не заготовочного файла

@objc(CSDataManager)
class CSDataManager:NSObject {
...
@objc(appDidEnterBackground)
func appDidEnterBackground(){
...

Создаем модель данных

Собственно проблема

• Вариант A. Используем нормальную кодогенерацию, получаем на выходе привычные рабочие файлы Objective-C и через Bridging файл используем их в нашем Swift-коде основном. Как использовать Objective-C классы кастомные в Swift можно прочитать здесь — Swift and Objective-C in the Same Project
• Вариант B. Пытаемся сделать наоборот — будем писать Swift класс, который сможет вести себя как Objective-C класс и при этом будет валютно работать с CoreData. Для этого берем в правую руку напильник, а в левую крайне краткий гайд от Apple — Writing Swift Classes with Objective-C Behavior

Следуем инструкции

import Foundation
import CoreData
import UIKit

class CSDepartment : NSManagedObject{
    @NSManaged var title: NSString
    @NSManaged var internalID: NSNumber
    @NSManaged var phone: NSString?
}

func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: NSDictionary?) -> Bool {
    //Get manager
    let manager = CSDataManager.sharedInstance()
    
    //Create new department
    let newDepartment : AnyObject! = NSEntityDescription.insertNewObjectForEntityForName("CSDepartment", inManagedObjectContext: manager.managedContext)
    
    //Save context
    manager.saveContext()
    
    //Get and print all departments
    let request = NSFetchRequest(entityName: "CSDepartment")
    let departments = manager.managedContext.executeFetchRequest(request, error: nil)
    println("Departments: \(departments)")
    
    return true
}

• В первую очередь мы получаем ошибку сохранения данных в CoreData по причине того, что ряд полей у нас выставлены как обязательные (title и internalID), а мы их не указали. Здесь типовое решение выставить некоторые значения по умолчанию в файлике модели или использовать метод awakeFromInsert. Первое решение рабочее, но не спортивное, второе нерабочее в таком виде — метод просто не вызывается, что навело меня в уныние.
• Второй важный момент, в логах мы видим что-то примерно такое Departments:
  

  [<NSManagedObject: 0xb264030> (entity: CSDepartment; id: 0xb264090 <x-coredata:///CSDepartment/t3403D9E7-F910-4E2D-989E-95D9C984C1762> ; data: {employees =     (); internalID = nil;phone = nil;title = nil;})] 
  

  
  Из этого лога следует важный вывод — наша переменная инстанцировалась как экземпляр NSManagedObject, а не как CSDepartment. В результате чего указать значения полей мы также не можем — так как жесткое приведение типов в духе
  

  let newDepartment : CSDepartment = NSEntityDescription.insertNewObjectForEntityForName("CSDepartment", inManagedObjectContext: manager.managedContext) as CSDepartment
  

  
  не сработает, приложение просто вылетает.

Пускаем в ход напильник

Шаг 1. Совместимость с Objective-C.

Шаг 2. Шлифуем файл модели.

Шаг 3. Косметический.

import Foundation
import CoreData
import UIKit

@objc(CSDepartment)
class CSDepartment : NSManagedObject{
    @NSManaged var title: NSString
    @NSManaged var internalID: NSNumber
    @NSManaged var phone: NSString?
    
    override func awakeFromInsert() {
        self.title = "New department"
        self.internalID = 0
    }
    
    func description() -> NSString{
        return "Department: className=\(self.dynamicType.description()), title=\(self.title), id=[\(self.internalID)] and phone=\(self.phone)"
    }
}

Работаем с отношениями

import Foundation
import CoreData

let st_fNames = ["John", "David", "Michael", "Bob"]
let st_lNames = ["Lim", "Jobs", "Kyler"]

@objc(CSEmployee)
class CSEmployee:NSManagedObject{
    @NSManaged var firstName: NSString
    @NSManaged var lastName: NSString
    @NSManaged var age: NSNumber?
    @NSManaged var department: CSDepartment
    
    override func awakeFromInsert() {
        super.awakeFromInsert()
        self.firstName = st_fNames[Int(arc4random_uniform(UInt32(st_fNames.count)))]
        self.lastName = st_lNames[Int(arc4random_uniform(UInt32(st_lNames.count)))]
    }
    
    func description() -> NSString{
        return "Employee: name= \(self.firstName) \(self.lastName), age=\(self.age) years" 
    }
}

• Добавляем свойство для хранения сотрудников с классом NSSet
• Добавляем самописные методы для добавления и удаления сотрудников — делалось на основе сниппетов XCode для версии на Objective-C

import Foundation
import CoreData

@objc(CSDepartment)
class CSDepartment : NSManagedObject{
    @NSManaged var title: NSString
    @NSManaged var internalID: NSNumber
    @NSManaged var phone: NSString?
    @NSManaged var employees: NSSet
    
    override func awakeFromInsert() {
        self.title = "New department"
        self.internalID = 0
    }
    
    func description() -> NSString{
        let employeesDescription = self.employees.allObjects.map({employee in employee.description()})
        return "Department: title=\(self.title), id=[\(self.internalID)], phone=\(self.phone) and employees = \(employeesDescription)"
    }

    //Working with Employees
    func addEmployeesObject(employee: CSEmployee?){
        let set:NSSet = NSSet(object: employee)
        self.addEmployees(set)
    }
    
    func removeEmployeesObject(employee: CSEmployee?){
        let set:NSSet = NSSet(object: employee)
        self.removeEmployees(set)
    }
    
    func addEmployees(employees: NSSet?){
        self.willChangeValueForKey("employees", withSetMutation: NSKeyValueSetMutationKind.UnionSetMutation, usingObjects: employees)
        self.primitiveValueForKey("employees").unionSet(employees)
        self.didChangeValueForKey("employees", withSetMutation: NSKeyValueSetMutationKind.UnionSetMutation, usingObjects: employees)
    }
    
    func removeEmployees(employees: NSSet?){
        self.willChangeValueForKey("employess", withSetMutation: NSKeyValueSetMutationKind.MinusSetMutation, usingObjects: employees)
        self.primitiveValueForKey("employees").minusSet(employees)
        self.didChangeValueForKey("employees", withSetMutation: NSKeyValueSetMutationKind.MinusSetMutation, usingObjects: employees)
    }
}

Итоговый код проверки работы и оставшиеся проблемы

• В класс CSDataManager внесены два метода для получения полного списка департаментов и сотрудников
• Изменен код примера — посмотрели фичи добавления, удаления объектов и каскадного удаления

import UIKit
import CoreData

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
                            
    var window: UIWindow?

    func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: NSDictionary?) -> Bool {
        //Get manager
        let manager = CSDataManager.sharedInstance()
        
        //Testing insert new objects
        let newDepartment : CSDepartment = NSEntityDescription.insertNewObjectForEntityForName("CSDepartment", inManagedObjectContext: manager.managedContext) as CSDepartment
        let newEmployee: CSEmployee = NSEntityDescription.insertNewObjectForEntityForName("CSEmployee", inManagedObjectContext: manager.managedContext) as CSEmployee
        let newEmployee2: CSEmployee = NSEntityDescription.insertNewObjectForEntityForName("CSEmployee", inManagedObjectContext: manager.managedContext) as CSEmployee
        newEmployee.department = newDepartment
        newDepartment.addEmployeesObject(newEmployee2)
        manager.saveContext()
        
        //Get and print all departments
        println("Have add oen department and two employees")
        println("Departments: \(manager.departments())")
        println("Employees: \(manager.employees())")
        
        //Testing remove child object
        newDepartment.removeEmployeesObject(newEmployee2)
        manager.saveContext()
        println("Have delete one employee")
        println("Departments: \(manager.departments())")
        
        //Testing cascade remove
        manager.managedContext.deleteObject(newDepartment)
        manager.saveContext()
        println("\nHave delete department")
        println("Departments: \(manager.departments())")
        println("Employees: \(manager.employees())")
        
        //Uncomment to remove all records
//        let departments = manager.departments()
//        for i in 0..departments.count{
//            let dep = departments[i] as CSDepartment
//            manager.managedContext.deleteObject(dep)
//        }
//        let employees = manager.employees()
//        for i in 0..employees.count{
//            let emp = employees[i] as CSEmployee
//            manager.managedContext.deleteObject(emp)
//        }
//        manager.saveContext()
//        println("\nHave delete all data")
//        println("Departments: \(manager.departments())")
//        println("Employees: \(manager.employees())")
        
        return true
    }
}

Заключение