توسعه یک اپلیکیشن MacOS ساده — از صفر تا صد

آخرین به‌روزرسانی: ۱۸ خرداد ۱۳۹۸
زمان مطالعه: ۱۵ دقیقه

در این مقاله قصد داریم با روش توسعه یک اپلیکیشن MacOS ساده آشنا شویم. این اپلیکیشن یک ساعت در نوار وضعیت سیستم عامل خواهد بود که امکان تنظیم یادآور دارد و کاربر می‌تواند نوتیفیکیشن‌ها را در آن زمان‌بندی کند. در این فرایند با روش جلوگیری از باز شدن یک پنجره برای چندین بار، تنظیم نوتیفیکیشن و موارد دیگر آشنا خواهیم شد.

پیش‌نیازها برای توسعه اپلیکیشن MacOS

برای مطالعه این راهنما، برخی موارد نیاز هستند که در ادامه فهرست شده‌اند:

  • دانش مقدماتی از زبان برنامه‌نویسی سوئیفت.
  • یک سیستم مک که روی آن Xcode نصب شده است.
  • نسخه Xcode باید 10.2 یا بالاتر باشد. گرچه نسخه‌های قدیمی نیز مشکلی ندارند، اما بسته به نسخه سوئیفت، ممکن است برخی از متدهایی که در این مقاله ارائه شده‌اند نیاز به تغییر داشته باشند.

ایجاد یک پروژه جدید

قبل از هر چیز باید یک پروژه جدید Xcode ایجاد کنیم. به این منظور به آدرس File > New > Project… بروید یا کلیدهای ترکیبی CMD+Shift+N را بزنید.

اپلیکیشن MacOS

گزینه macOS را به عنوان پلتفرم انتخاب کنید و سپس گزینه اول یعنی Cococa App را بزنید.

اپلیکیشن MacOS

در این مرحله یک نام برای اپلیکیشن خود انتخاب کنید. ما در این راهنما «Advanced Clock» را انتخاب می‌کنیم و سپس مطمئن می‌شویم که گزینه Use Storyboards انتخاب شده باشد.

به طور معمول روی iOS از استوری‌بورد استفاده نمی‌کنیم، اما روی macOS این گزینه واقعاً مفید خواهد بود.

تنظیم پروژه

پیش از اقدام به کدنویسی باید برخی تنظیمات را روی پروژه خود اعمال کنیم. ابتدا باید مقدار پیش‌فرض WindowController و مقدار مرتبط ViewController را حذف کنیم، زیرا قصد نداریم در زمان شروع به کار برنامه پنجره‌ای باز شود. سپس باید چیزی مانند تصویر زیر و صرفاً یک Main Menu داشته باشیم.

نکته: Main Menu را حذف نکنید، چون این اقدام قابل بازگردانی نیست و اگر در ادامه بخواهید آن را خودتان بسازید، مسیری بسیار طولانی خواهد داشت.

اپلیکیشن MacOS

کدنویسی پروژه

اینک باید اپلیکیشن ساعت خودمان را کدنویسی کنیم. تقریباً همه کد این اپلیکیشن در کلاس AppDelegate قرار می‌گیرد.

فایل AppDelegate.swift

//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Cocoa

@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {



    func applicationDidFinishLaunching(_ aNotification: Notification) {
        // Insert code here to initialize your application
    }

    func applicationWillTerminate(_ aNotification: Notification) {
        // Insert code here to tear down your application
    }


}

می‌توان به راحتی متد applicationWillTerminate را حذف کرد، زیرا فعلاً نیازی به آن نداریم. سپس می‌توانیم NSStatusItem را بسازیم که آیتم ما در «نوار وضعیت» (Status Bar) خواهد بود و به بیان دقیق‌تر کانتینر دکمه ما خواهد بود. برای ایجاد آیتم نوار وضعیت کد زیر را بنویسید.

فایل AppDelegate-01.swift

//
//  AppDelegate.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Cocoa

@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {

    var statusBarItem: NSStatusItem = NSStatusBar.system.statusItem(withLength: NSStatusItem.variableLength)

    func applicationDidFinishLaunching(_ aNotification: Notification) {
        guard let statusButton = statusBarItem.button else { return }
        statusButton.title = "Advanced Clock"
    }

}

فعلاً یک متن placeholder به این کانتینر انتساب می‌دهیم و در ادامه نویت به زمان‌بندی یک تایمر می‌رسد که «عنوان» (title) را در هر ثانیه با مقدار زمان جاری به‌روزرسانی می‌کند.

به این منظور متغیر کلاس دیگری به نام timer و با نوع optional به صورت Timer? اعلان می‌کنیم. مقدار آن را به صوت پیش‌فرض nil تعیین می‌کنیم. سپس در applicationDidFinisLaunching و زیر انتساب title تایمر را به صورت زیر کدنویسی می‌کنیم.

فایل AppDelegate-02.swift

//
//  AppDelegate.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Cocoa

@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {
    var statusBarItem: NSStatusItem = NSStatusBar.system.statusItem(withLength: NSStatusItem.variableLength)
    var timer: Timer? = nil
    
    func applicationDidFinishLaunching(_ aNotification: Notification) {
        guard let statusButton = statusBarItem.button else { return }
        
        statusButton.title = Date.now.stringTimeWithSeconds
        
        timer = Timer.scheduledTimer(
            timeInterval: 1,
            target: self,
            selector: #selector(updateStatusText),
            userInfo: nil,
            repeats: true
        )
    }
    
    @objc
    func updateStatusText(_ sender: Timer) {
        guard let statusButton = statusBarItem.button else { return }
        statusButton.title = Date.now.stringTimeWithSeconds
        print(Date.now.stringTimeWithSeconds)
    }
}

همچنین یک تابع objective-c ایجاد می‌کنیم که هر بار رویداد تایمر اجرا شود (یعنی هر ثانیه یک بار) فراخوانی می‌شود. در ادامه برخی تابع‌های کاربردی را می‌بینید که موجب می‌شوند همه چیز خواناتر و تمیزتر شود. یکی از این تابع‌ها برای کلاس Date و دیگری برای Int است.

فایل Date+Extension.swift

//
//  Date+Extension.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Foundation


/*
 * -----------------------
 * MARK: - Calendar Stuff
 * ------------------------
 */
extension Date {
    private var calendar: Calendar {
        return Calendar.current
    }
    
    var weekDay: Int {
        return calendar.component(.weekday, from: self)
    }
    
    var weekOfMonth: Int {
        return calendar.component(.weekOfMonth, from: self)
    }
    
    var weekOfYear: Int {
        return calendar.component(.weekOfYear, from: self)
    }
    
    var year: Int {
        return calendar.component(.hour, from: self)
    }
    
    var month: Int {
        return calendar.component(.month, from: self)
    }
    
    var quarter: Int {
        return calendar.component(.quarter, from: self)
    }
    
    var day: Int {
        return calendar.component(.day, from: self)
    }
    
    var era: Int {
        return calendar.component(.era, from: self)
    }
    
    var hours: Int {
        return calendar.component(.hour, from: self)
    }
    
    var minutes: Int {
        return calendar.component(.minute, from: self)
    }
    
    var seconds: Int {
        return calendar.component(.second, from: self)
    }
    
    var nanoseconds: Int {
        return calendar.component(.nanosecond, from: self)
    }
}


/*
 * -----------------------
 * MARK: - Utility
 * ------------------------
 */
extension Date {
    static var now: Date {
        return self.init()
    }
    
    var stringTime: String {
        return getStringTime(showSeconds: false)
    }
    
    var stringTimeWithSeconds: String {
        return getStringTime(showSeconds: true)
    }
    
    var timestamp: TimeInterval {
        return timeIntervalSince1970
    }
    
    private func getStringTime(showSeconds: Bool = false) -> String {
        var time = "\(hours.safeString):\(minutes.safeString)"
        
        if showSeconds {
            time += ":\(seconds.safeString)"
        }
        
        return time
    }
}

فایل Int+Extension.swift

//
//  Int+Extension.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Foundation

extension Int {
    /// ---
    ///     var n: Int = 5
    ///     n = n.safeString
    ///     print(n)  // "05"
    /// ---
    var safeString: String {
        return self >= 10 ? "\(self)" : "0\(self)"
    }
}

اینک می‌توانید اپلیکیشن خود را اجرا کنید و اگر همه کارها را به درستی انجام دهید، اکنون باید ساعت را در نوار وضعیت داشته باشید. بدین ترتیب شما موفق شده‌اید نخستین اپلیکیشن macOS خود را بسازید. در ادامه آن را کمی جذاب‌تر می‌سازیم.

افزودن منو

اکنون زمان آن رسیده است که اپلیکیشن خود را کاربرپسندتر بکنیم. بنابراین برخی قابلیت‌ها و امکانات پیکربندی جدید به آن اضافه می‌کنیم.

ابتدا باید کدهایی بنویسیم که این ترجیح‌های کاربر را مدیریت کنند. به این منظور معمولاً یک struct نوشته می‌شود که مقادیر پیش‌فرض کاربر (UserDefaults) را برای برخی تنظیمات ساده مانند اعداد بولی، رشته‌ها، enum-ها و موارد دیگر ذخیره می‌کند.

فایل Preferences.swift

//
//  Preferences.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Foundation

fileprivate let defaults: UserDefaults = UserDefaults.standard

struct Preferences {
    static var useFlashDots: Bool {
        get {
            return defaults.bool(forKey: .useFlashDots)
        }
        
        set {
            defaults.set(newValue, forKey: .useFlashDots)
            defaults.synchronize()
        }
    }
    
    static var showDockIcon: Bool {
        get {
            return defaults.bool(forKey: .showDockIcon)
        }
        
        set {
            defaults.set(newValue, forKey: .showDockIcon)
            defaults.synchronize()
        }
    }
    
    static var showSeconds: Bool {
        get {
            return defaults.bool(forKey: .showSeconds)
        }
        
        set {
            defaults.set(newValue, forKey: .showSeconds)
            defaults.synchronize()
        }
    }
    
    static var firstRunGone: Bool {
        get {
            return defaults.bool(forKey: .firstRunGone)
        }
        
        set {
            defaults.set(newValue, forKey: .firstRunGone)
            defaults.synchronize()
        }
    }
    
    static func restore() {
        Preferences.showSeconds = true
        Preferences.useFlashDots = false
        Preferences.showDockIcon = false
    }
}

فایل UserDefaults.swift

//
//  Preferences.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Foundation

extension UserDefaults {
    enum Key: String {
        case useFlashDots = "useFlashDots"
        case showSeconds = "showSeconds"
        case showDockIcon = "showDockIcon"
        case firstRunGone = "firstRunGone"
    }
    
    func set<T>(_ value: T, forKey key: Key) {
        set(value, forKey: key.rawValue)
    }
    
    func bool(forKey key: Key) -> Bool {
        return bool(forKey: key.rawValue)
    }
    
    func string(forKey key: Key) -> String? {
        return string(forKey: key.rawValue)
    }
    
    func integer(forKey key: Key) -> Int? {
        return integer(forKey: key.rawValue)
    }
    
    func url(forKey key: Key) -> URL? {
        return url(forKey: key.rawValue)
    }
}

اکنون می‌توانیم به طراحی منو بپردازیم. یک متغیر منوی جدید را در AppDelegate اعلان می‌کنیم و با استفاده از ()NSMenu یک منوی جدید می‌سازیم. سپس آیتم‌هایی مانند فهرست زیر به آن اضافه می‌کنیم:

  • جداکننده‌های چشمک‌زن
  • نمایش/عدم نمایش ثانیه
  • نمایش/عدم نمایش آیکون نوار وضعیت
  • خروج از اپلیکیشن (کاملاً مفید است)

پیش از آن که به کدنویسی این امکانات بپردازیم، 2 اکستنشن دیگر را با شما به اشتراک می‌گذاریم که می‌توانند به افزایش خوانایی و کاربردپذیری کد کمک کنند.

فایل Bool+Extension.swift

//
//  Bool+Extension.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Foundation
import AppKit

extension Bool {
    var stateValue: NSControl.StateValue {
        return self.toStateValue()
    }
    
    private func toStateValue() -> NSControl.StateValue {
        return self ? .on : .off
    }
}

فایل NSMenu+Extension.swift

//
//  NSMenu+Extension.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Foundation
import AppKit

extension NSMenu {
    func addSeparator() -> Void {
        addItem(.separator())
    }
    
    func addItems(_ items: NSMenuItem...) {
        for item in items {
            addItem(item)
        }
    }
}

بدین ترتیب اکنون AppDelegate را کمی بازسازی می‌کنیم تا کدها خواناتر و منسجم‌تر شوند. در نتیجه این کلاس به همراه پیاده‌سازی منو به صورت زیر درمی‌آید.

فایل AppDelegateWithMenu-01.swift

//
//  AppDelegate.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Cocoa

@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {
    var statusBarItem: NSStatusItem = NSStatusBar.system.statusItem(withLength: NSStatusItem.variableLength)
    var timer: Timer? = nil
    
    func applicationWillFinishLaunching(_ notification: Notification) {
        if Preferences.firstRunGone == false {
            // This will be executed on first run
            Preferences.firstRunGone = true
            
            // Set preferences to their defaults
            Preferences.restore()
        }
    }
    
    func applicationDidFinishLaunching(_ aNotification: Notification) {
        guard let statusButton = statusBarItem.button else { return }
        
        statusButton.title = Preferences.showSeconds ? Date.now.stringTimeWithSeconds : Date.now.stringTime
        
        timer = Timer.scheduledTimer(
            timeInterval: 1,
            target: self,
            selector: #selector(updateStatusText),
            userInfo: nil,
            repeats: true
        )
        
        let statusMenu: NSMenu = NSMenu()
        
        statusMenu.addItem(withTitle: "Good \(Date.now.isMorning ? "Morning" : "Evening")", action: nil, keyEquivalent: "")
        statusMenu.addSeparator()
        
        let toggleFlashingSeparatorsItem: NSMenuItem = {
            let item = NSMenuItem(
                title: "Flashing separators",
                action: #selector(toggleFlashingSeparators),
                keyEquivalent: ""
            )
            
            item.tag = 1
            item.target = self
            item.state = Preferences.useFlashDots.stateValue
            
            return item
        }()
        
        let toggleDockIconItem: NSMenuItem = {
            let item = NSMenuItem(
                title: "Toggle Dock Icon",
                action: #selector(toggleDockIcon),
                keyEquivalent: ""
            )
            
            item.tag = 2
            item.target = self
            item.state = Preferences.showDockIcon.stateValue
            
            return item
        }()
        
        let toggleSecondsItem: NSMenuItem = {
            let item = NSMenuItem(
                title: "Show seconds",
                action: #selector(toggleSeconds),
                keyEquivalent: ""
            )
            
            item.tag = 3
            item.target = self
            item.state = Preferences.showSeconds.stateValue
            
            return item
        }()
        
        let quitApplicationItem: NSMenuItem = {
            let item = NSMenuItem(title: "Quit", action: #selector(terminate), keyEquivalent: "q")
            item.target = self
            
            return item
        }()
        
        statusMenu.addItems(
            toggleFlashingSeparatorsItem,
            toggleDockIconItem,
            
            .separator(),
            
            toggleSecondsItem,
            
            .separator(),
            
            quitApplicationItem
        )
        
        statusBarItem.menu = statusMenu
    }
}




/*
 * -----------------------
 * MARK: - Actions
 * ------------------------
 */
extension AppDelegate {
    @objc
    func updateStatusText(_ sender: Timer) {
        guard let statusButton = statusBarItem.button else { return }
        statusButton.title = Preferences.showSeconds ? Date.now.stringTimeWithSeconds : Date.now.stringTime
    }
    
    @objc
    func toggleFlashingSeparators(_ sender: NSMenuItem) {
        Preferences.useFlashDots = !Preferences.useFlashDots
        
        if let menu = statusBarItem.menu, let item = menu.item(withTag: 1) {
            item.state = Preferences.useFlashDots.stateValue
        }
    }
    
    
    @objc
    func toggleDockIcon(_ sender: NSMenuItem) {
        Preferences.showDockIcon = !Preferences.showDockIcon
        
        if let menu = statusBarItem.menu, let item = menu.item(withTag: 2) {
            item.state = Preferences.showDockIcon.stateValue
        }
    }
    
    @objc
    func toggleSeconds(_ sender: NSMenuItem) {
        Preferences.showSeconds = !Preferences.showSeconds
        
        if let menu = statusBarItem.menu, let item = menu.item(withTag: 3) {
            item.title = "Show seconds"
            item.state = Preferences.showSeconds.stateValue
        }
    }
    
    @objc
    func terminate(_ sender: NSMenuItem) {
        NSApp.terminate(sender)
    }
}

اپلیکیشن ما اینک به صورت زیر نمایش پیدا می‌کند:

اپلیکیشن MacOS

اما این اپلیکیشن همچنان از نبود برخی قابلیت‌ها رنج می‌برد.

آیتم‌های useFlashingDots و showDockIcon در حال حاضر بی‌استفاده هستند. به جای این تابع‌ها، تنظیمات showSeconds در تابع updateStatusText مدیریت می‌شود.

درون هر اکشن NSMenuItem باید خود آیتم را با ترجیح‌های جدید به‌روزرسانی کنیم، چون این‌ها کادرهای انتخابی هستند که موجب به‌روزرسانی حالت می‌شوند. stateValue در Bool+Extension.swift گزاره‌ای است که بسته به مقدار بولی true یا false یک مقدار on. یا off. بازگشت می‌دهد. بدین ترتیب دیگر نیازی به نوشتن Preferences.showDockIcon?.on: به جای Preferences.showDockIcon.stateValue نداریم.

ترجیح‌ها: آیکون dock

اکنون یک اپلیکیشن نوار وضعیت داریم، اما یک آیکون dock نیز داریم. بدین ترتیب به عنان یک اپلیکیشن نوار وضعیت انتظار نداریم که آیکون dock نمایان باشد. اگر به گوشه راست-بالای نمایشگر خود نگاه کنید، این آیکون را می‌بینید.

اپلیکیشن MacOS

تصور کنید اگر همه اپلیکیشن‌ها در نوار وضعیت بخواهند آیکونی در dock داشته باشند چه قدر به‌هم‌ریخته خواهد شد. ما می‌توانیم آیکون dock را با NSApplication.ActivationPolicy مدیریت کنیم. به این منظور یک helper کوچک می‌نویسیم که یک struct با 2 متد برای تنظیم/خواندن ActivationPolicy است.

فایل DockIcon.swift

//
//  DockIcon.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Foundation
import AppKit

struct DockIcon {
    static var standard = DockIcon()
    
    var isVisible: Bool {
        get {
            return NSApp.activationPolicy() == .regular
        }
        
        set {
            setVisibility(isVisible)
        }
    }
    
    @discardableResult
    func setVisibility(_ state: Bool) -> Bool {
        if state {
            NSApp.setActivationPolicy(.regular)
        } else {
            NSApp.setActivationPolicy(.accessory)
        }
        
        return isVisible
    }
}

اینک می‌توانیم متد toggleDockIcon را ویرایش کنیم تا این ترجیح را مدیریت کند. در ادامه پیاده‌سازی این متد کمکی را می‌بینید:

فایل DockIconImplementation.swift

// ... AppDelegate
@objc
func toggleDockIcon(_ sender: NSMenuItem) {
    Preferences.showDockIcon = !Preferences.showDockIcon

    DockIcon.standard.setVisibility(Preferences.showDockIcon)

    if let menu = statusBarItem.menu, let item = menu.item(withTag: 2) {
        item.state = Preferences.showDockIcon.stateValue
    }
}

چنان که می‌بینید در خط 7 helper مربوط به DockIcon را پیاده‌سازی کرده‌ایم. اکنون این متد را کپی کرده و در انتهای متد applicationWillFinishLaunching می‌چسبانیم.

فایل applicationWillFinishLaunching.swift

// ... AppDelegate
func applicationWillFinishLaunching(_ notification: Notification) {
    if Preferences.firstRunGone == false {
        // This will be executed on first run
        Preferences.firstRunGone = true

        // Set preferences to their defaults
        Preferences.restore()
    }


    DockIcon.standard.setVisibility(Preferences.showDockIcon)
}

اپلیکیشن MacOS

ترجیح‌ها: جداکننده چشمک‌زن

در این بخش اقدام به پیاده‌سازی یکی از ترجیح‌های کاربر یعنی جداکننده‌های چشمک‌زن می‌کنیم. بدین ترتیب می‌توانیم کارکردهای یک ساعت استاندارد را بسط بدهیم. در ادامه این قابلیت ساده را که حتی ساعت پیش‌فرض اپل هم آن را دارد پیاده‌سازی می‌کنیم.

این کار ساده‌تر از آن چیزی است که فکر می‌کنید. ما به یک متغیر نیاز داریم که وضعیت جداکننده‌ها را مدیریت کند. این متغیر می‌تواند به صورت بولی visible/hidden یا حتی 0/1 باشد. همچنین می‌توانیم از NSControl.StateValue استفاده کنیم. اگر مقدار این متغیر 0 باشد یک جایگزینی رشته به صورت “:” -> “ “ در title صورت می‌گیرد:

فایل updateStatusText-01.swift

//... AppDelegate
var separatorsStatus: NSControl.StateValue = .on

// or 
var separatorsStatus: Int = 1

// or 
var separatorsStatus: Bool = true


// Then check if the variable is truthy or not
/// Implementation with `NSControl.StatusValue`
@objc
func updateStatusText(_ sender: Timer) {
    guard let statusButton = statusBarItem.button else { return }
    var title: String = (Preferences.showSeconds ? Date.now.stringTimeWithSeconds : Date.now.stringTime)

    if Preferences.useFlashDots && separatorsStatus == .on {
        separatorsStatus = .off
        title = title.replacingOccurrences(of: ":", with: " ")
    } else {
        separatorsStatus = .on
    }

    statusButton.title = title
}

یک روش بهتر برای انجام این کار بررسی این واقعیت است که ثانیه‌ها زوج یا فرد هستند. هر زمان که عدد ثانیه زوج (یا فرد) باشد از این متغیر جدید به جای حالت پیش‌فرض استفاده می‌شود. همچنین این وضعیت در حالتی مناسب خواهد بود که بخواهید جداکننده هر ثانیه یک بار چشمک بزند.

فایل updateStatusText-02.swift

// ... AppDelegate
// Cleaner implementation
@objc
func updateStatusText(_ sender: Timer) {
    guard let statusButton = statusBarItem.button else { return }
    var title: String = (Preferences.showSeconds ? Date.now.stringTimeWithSeconds : Date.now.stringTime)

    if Preferences.useFlashDots && Date.now.seconds % 2 == 0 {
        title = title.replacingOccurrences(of: ":", with: " ")
    }

    statusButton.title = title
}

در ادامه ظاهر ساعت را در حالت استفاده از جداکننده‌های چشمک‌زن می‌بینید:

اپلیکیشن MacOS

افزودن یادآوری

اینک اپلیکیشن ما به ظاهر تکمیل شده است، اما ما یکی از قابلیت‌های اصلی اپلیکیشن خودمان را که تنظیم یادآوری بود فراموش کرده‌ایم. در واقع چرا باید یک نفر بخواهد از اپلیکیشن ما صرفاً برای مشاهده ساعت استفاده کند؟ بنابراین باید قابلیت یادآوری را نیز به آن اضافه کنیم. این کار کاملاً ساده است و در طی آن با روش ایجاد و نمایش پنجره‌ها نیز آشنا می‌شویم.

کار خود را با ایجاد یک نوع struct و نامگذاری آن به صورت Reminder آغاز می‌کنیم:

فایل Reminder.swift

//
//  Reminder.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Foundation

// We'll use this later
protocol ReminderDelegate {
    func onReminderFired(_ reminder: Reminder) -> Void
}


class Reminder {
    private typealias Notification = NSUserNotification
    
    var timer: Timer!
    var title: String!
    var descr: String?
    
    var tag: Int?
    var fireDate: Date
    var delegate: ReminderDelegate?
    
    
    init(_ title: String, description descr: String? = nil, fireOnDate date: Date, tag: Int? = nil) {
        self.title = title
        self.fireDate = date
        self.tag = tag
        self.descr = descr
        
        self.timer = Timer.scheduledTimer(
            withTimeInterval: date.timeIntervalSinceNow,
            repeats: false,
            block: { (t) in
                t.invalidate()
                
                let notification = Notification()
                
                notification.title = self.title
                notification.informativeText = self.descr
                notification.subtitle = "Hey! Your timer has fired"
                
                NSUserNotificationCenter.default.deliver(notification)
                
                // DELEGATION
                if let d = self.delegate {
                    d.onReminderFired(self)
                }
            }
        )
    }
}

سپس یک متغیر جدید از نوع [Reminder] می‌سازیم و یک آرایه خالی با مقدار پیش‌فرض اضافه می‌کنیم.

var reminders: [Reminder] = []

اکنون می‌توانیم منطق آن را نیز بنویسیم:

  • یک آیتم منو به منوی استارت اضافه کن
  • یک منوی فرعی برای همه یادآوری‌ها اضافه کن.
  • یکم آیتم منو اضافه کن که کلیک کردن آن موجب باز شدن پنجره‌ای برای زمان‌بندی یک یادآور جدید می‌شود.
  • مدیریت یادآوری و کنترل view را به AppDelegate اعطا کن.

ایجاد NSMenuItem و submenu

همان طور که تا به این جا در مورد عناصر دیگر انجام داده‌ایم ابتدا یک NSMenuItem می‌سازیم و این مورد شبیه به statusBarItem خواهد بود. بدین ترتیب یک مشخصه منو خواهد داشت که در آن همه یادآوری‌های درون متغیر reminders که قبلاً اعلان کرده‌ایم، نمایش پیدا می‌کنند.

فایل reminder-submenu.swift

let remindersItem: NSMenuItem = {
    let item = NSMenuItem(title: "Reminders", action: nil, keyEquivalent: "")
    item.tag = 5

    let menu = NSMenu()

    for reminder in self.reminders {
        menu.addItem(.init(title: reminder.title, action: nil, keyEquivalent: ""))
    }

    item.isEnabled = reminders.count > 0

    return item
}()

شیوه افزودن یادآور جدید

اکنون می‌خواهیم یک اینترفیس برای افزودن یادآوری بنویسیم. به این منظور Main.storyboard را باز کرده و یک view controller بسازید که عنوان آن NSTextField، توضیح آن NSTextView و تاریخ آن NSDatePicker باشد.

این کار از طریق کدنویسی و به صورت برنامه‌نویسی شده نیز ممکن است، اما آن مسیر طولانی است و به دلیل مقاصد آموزشی در این راهنما از سریع‌ترین روش برای طراحی یک پنجره ابتدایی با برخی کنترل‌ها استفاده می‌کنیم.

اپلیکیشن MacOS

اکنون نوبت به ایجاد فایل رسیده است. این فایل کنترلر نمای ما خواهد بود. اگر فایل ViewController را حذف نکرده باشید، باید همچنان در پروژه موجود باشد و می‌توانید به جای ایجاد فایل جدید آن را ویرایش کنید. ابتدا نام آن را به NewReminderVC تغییر دهید و نام کلاس درون آن را نیز به همین ترتیب عوض کنید. بدین ترتیب چیزی مانند زیر خواهید داشت:

فایل NewReminderVC-01.swift

//
//  NewRemainderVC.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Cocoa

protocol NewReminderVCDelegate {
    func onSubmit(_ sender: NSButton, reminder: Reminder) -> Void
}

class NewReminderVC: NSViewController {    
    override func viewDidLoad() {
        super.viewDidLoad()
    }
}

برای صرفه‌جویی در زمان یک Delegate Protocol به ابتدای فایل اضافه می‌کنیم که از آن برای مدیریت رویداد submit استفاده خواهیم کرد.

اکنون همه موارد تنظیم شده‌اند. بنابراین به استوری‌بورد بروید و کنترلر نما را که هم اینک ایجاد کرده‌ایم انتخاب کرده و کلاس جدید را به آن انتساب دهید:

اپلیکیشن MacOS

مطمئن شوید که یک Storyboard ID اضافه کرده‌اید. ما آن را کلاس view controller نامیده‌ایم. از این شناسه استوری‌بورد در ادامه برای شناسایی نمای خود در کد استفاده می‌کنیم.

اپلیکیشن MacOS

اکنون با انتخاب کردن view controller روی دکمه Assistant Editor در گوشه راست-بالای Xcخde کلیک می‌کنیم.

بدین ترتیب ویرایشگر به دو بخش تقسیم می‌شود:

اپلیکیشن MacOS

اطمینان حاصل کنید که فایل درستی را انتخاب کرده‌اید (در واقع فایل درست، فایل کنترلر نما است)، سپس آیتم‌های خود را (با فشردن کلید ctrl) در کلاس کشیده و رها کنید.

ما اینک باید 3 IBOutlets و 1 IBAction داشته باشیم. اکشن به دکمه متصل شده است و 3 outlets دیگر به ترتیب title ،description و date picker هستند.

بدین ترتیب در حال حاضر یک نما یا view داریم، اما چگونه می‌توانیم آن را نمایش دهیم؟ این کار آسان است، ابتدا یک فایل جدید به کمک این helper بسازید. بدین ترتیب تابعی با نام getVC به دست می‌آید که باید شناسه استوری‌بورد و کلاس کنترل نما را به آن ارسال کنید.

فایل WindowsManager.swift

//
//  WindowsManager.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Foundation
import AppKit

struct WindowsManager {
    static func getVC<T: NSViewController>(withIdentifier identifier: String, ofType: T.Type?, storyboard: String = "Main", bundle: Bundle? = nil) -> T? {
        let storyboard = NSStoryboard(name: storyboard, bundle: bundle)
        
        guard let vc: T = storyboard.instantiateController(withIdentifier: identifier) as? T else {
            let alert = NSAlert()
            alert.alertStyle = .critical
            alert.messageText = "Error initiating the viewcontroller"
            alert.runModal()
            
            return nil
        }
        
        return vc
    }
}

اکنون تابع مفقود در AppDelegate را اضافه می‌کنیم. نخستین کاری که باید انجام دهیم اعلان کردن یک ثابت جدید در ابتدای فایل است:

let REMINDERS_WINDOW_CONTROLLER: NSWindowController = NSWindowController(window: nil)

اکنون یک اکشن را کم داریم و بنابراین آن را اضافه می‌کنیم. اما قبل از آن باید متغیر reminders را ویرایش کرده و یک رویداد didSet به آن اضافه کنیم:

فایل AppDelegate@AddReminder.swift

var reminders: [Reminder] = [] {
    didSet {
        if let menu = statusBarItem.menu, let item = menu.item(withTag: 5) {
            item.submenu = self.getRemindersMenu()
            item.isEnabled = reminders.count > 0
        }
    }
}


/*
 * -----------------------
 * MARK: - Utilities
 * ------------------------
 */
extension AppDelegate {
    private func getRemindersMenu() -> NSMenu {
        let menu = NSMenu()
        
        for reminder in self.reminders {
            menu.addItem(.init(title: reminder.title, action: nil, keyEquivalent: ""))
        }
        
        return menu
    }
}

بدین ترتیب یک تابع کاربردی ساخته‌ایم که به سادگی منوی یادآوری‌ها را برای ما ایجاد می‌کند. اکنون باید آیتم‌های منو را بسازیم و همچنین اضافه کردن آن‌ها به منو را نیز نباید فراموش کنیم:

فایل addRemainderItem.swift

let addReminderItem: NSMenuItem = {
    let item = NSMenuItem(title: "New Reminder", action: #selector(addReminder), keyEquivalent: "")
    item.tag = 6
    item.target = self
    return item
}()

در حال حاضر addReminder همچنان اعلان نشده است و از این رو Xcode پیام خطایی را نمایش می‌دهد. ابتدا آن را اعلان می‌کنیم تا خطا رفع شود.

فایل addReminderFunction.swift

@objc
func addReminder(_ sender: NSMenuItem) {
    if let vc = WindowsManager.getVC(withIdentifier: "NewReminderVC", ofType: NewReminderVC.self) {
        vc.delegate = self
        let window: NSWindow = {
            let w = NSWindow(contentViewController: vc)
            
            w.styleMask.remove(.fullScreen)
            w.styleMask.remove(.resizable)
            w.styleMask.remove(.miniaturizable)
            
            w.level = .floating
            
            return w
        }()
        
        if REMINDERS_WINDOW_CONTROLLER.window == nil {
            REMINDERS_WINDOW_CONTROLLER.window = window
        }
        
        REMINDERS_WINDOW_CONTROLLER.showWindow(self)
    }
}

برای درک سطح floating به توضیح زیر توجه کنید:

«سطوح پنجره» (Window Levels) دارای یک لیست از مقادیر ممکن است. هر سطح در لیست، پنجره‌های خود را در جلوی گروه‌های قبلی گروه‌بندی می‌کند. برای نمونه پنجره‌های شناور (Floating) در جلوی همه پنجره‌های سطح نرمال ظاهر می‌شوند. هنگامی که یک پنجره وارد سطح جدیدی می‌شود، در جلوی همه همتایانش در آن سطح مرتب‌سازی خواهد شد.

نکته مهم دیگر این که باید delegate-ها را پیاده‌سازی کنیم و کارهایی را نیز درون NewReminderVC سامان دهیم.

فایل NewReminderVC-02.swift

//
//  NewReminderVC.swift
//  Advanced Clock
//
//  Created by Federico Vitale on 20/05/2019.
//  Copyright © 2019 Federico Vitale. All rights reserved.
//
import Cocoa


protocol NewReminderVCDelegate {
    func onSubmit(_ sender: NSButton, reminder: Reminder) -> Void
}

class NewReminderVC: NSViewController {
    var delegate: NewReminderVCDelegate!
    
    @IBOutlet weak var taskTitle: NSTextField!
    @IBOutlet weak var taskDate: NSDatePicker!
    @IBOutlet weak var taskDescr: NSTextView!

    @IBAction func onSubmit(_ sender: NSButton) {
        let reminder = Reminder(
            taskTitle.stringValue,
            description: taskDescr.string,
            fireOnDate: taskDate.dateValue,
            tag: nil
        )
        
        delegate.onSubmit(sender, reminder: reminder)
    }
    
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        taskTitle.stringValue = ""
        taskDescr.string = ""
        
        taskDate.calendar = Calendar.current
        taskDate.dateValue = Date.now
    }
}

در متد viewDidLoad مقادیر پیش‌فرض را تعیین می‌کنیم و سپس reminder خود را ایجاد می‌کنیم. در ادامه متد onSubmit مربوط به delegate را فراخوانی می‌کنیم.

Delegation

در نهایت باید delegation را از NewReminderVC تأیید کنیم، به این منظور یک افزونه از AppDelegate مانند زیر اضافه می‌کنیم:

فایل AppDelegateDelegation-02.swift

extension AppDelegate: NewReminderVCDelegate, ReminderDelegate {
    
    // On submit close the window and save the reminder
    func onSubmit(_ sender: NSButton, reminder: Reminder) {
        reminder.delegate = self
        if reminder.tag == nil {
            reminder.tag = reminders.count
        }
        
        REMINDERS_WINDOW_CONTROLLER.close()
        reminders.append(reminder)
    }
    
    // Once a reminder is fired, let's delete it
    func onReminderFired(_ reminder: Reminder) {
        reminders.removeAll(where: { $0.tag == reminder.tag })
    }
}

سخن پایانی

بدین ترتیب به پایان این مقاله راهنمای ساخت نخستین اپلیکیشن macOS می‌رسیم. شما می‌توانید کد کامل این پروژه را در این آدرس گیت‌هاب (+) ملاحظه کنید.

اکنون شما می‌توانید نخستین اپلیکیشن macOS خود را که نوشته‌اید اجرا کنید. این مقاله یک راهنمای مقدماتی برای توسعه اپلیکیشن‌های مک محسوب می‌شود و با تمرین بیشتر و استفاده از منابع دیگر می‌توانید مهارت‌های خود را در این زمینه بیش از پیش افزایش دهید.

اگر این مطلب برای شما مفید بوده است، آموزش‌های زیر نیز به شما پیشنهاد می‌شوند:

==

بر اساس رای ۰ نفر
آیا این مطلب برای شما مفید بود؟
شما قبلا رای داده‌اید!
اگر بازخوردی درباره این مطلب دارید یا پرسشی دارید که بدون پاسخ مانده است، آن را از طریق بخش نظرات مطرح کنید.
منابع:
swlh

نظر شما چیست؟

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *