iOS 動態更換Icon

動態切換 App 的 icon 這個需求，在上一家公司作一款定製 App 時遇到過一次，此次領導說可能須要作，就又作了一次。雖然不是什麼很難的知識點，這裏也就記錄一下本身作的過程吧。

• info.plist 文件編輯
• 更換 Icon
• 靜默切換

info.plist 文件

爲了動態更換 icon，咱們須要先配置一下咱們項目的 info.plist 文件：

1. 加入 Icon files(iOS5)，其中會默認有兩個 item：
   1. Newsstand Icon
   2. Primary Icon
2. 咱們須要加入咱們須要的鍵——CFBundleAlternateIcons，類型爲 Dictionary。
3. 下面再添加一些字典。這裏字典的鍵是你但願更換 Icon 的名稱，在下方的 CFBundleIconFiles 數組中，寫入須要更換的 Icon 的名稱。

Primary Icon： 能夠設置 App 的主 Icon，通常都不理會。通常主 Icon 在 Assets.xcassets 中設置。

Newsstand Icon： 這個設置通常用於在 Newsstand 中顯示使用。咱們也不須要理會。

這裏咱們就將 info.plist 編輯完成了，下面咱們將對應的圖片加入到項目中，這裏的圖片須要直接加到項目中，不能放在 Assets.xcassets 中。

更換 Icon

在 iOS 10.3，蘋果開放了這個 API，可讓咱們動態更換咱們的 App Icon。

// If false, alternate icons are not supported for the current process.
@available(iOS 10.3, *)
open var supportsAlternateIcons: Bool { get }
    
// Pass `nil` to use the primary application icon. The completion handler will be invoked asynchronously on an arbitrary background queue; be sure to dispatch back to the main queue before doing any further UI work.
@available(iOS 10.3, *)
open func setAlternateIconName(_ alternateIconName: String?, completionHandler: ((Error?) -> Void)? = nil)
    
// If `nil`, the primary application icon is being used.
@available(iOS 10.3, *)
open var alternateIconName: String? { get }

複製代碼

切換到咱們須要的 Icon

@IBAction func changeOneClick(_ sender: Any) {
    if UIApplication.shared.supportsAlternateIcons {
        UIApplication.shared.setAlternateIconName("lambot") { (error) in
            if error != nil {
                print("更換icon錯誤")
            }
        }
    }
}
複製代碼

這裏的 iconName 直接傳入項目中的 icon 名稱。這裏須要注意的是，項目中的名字、info.plist 中存入的名稱以及這裏傳入的名稱須要一致。

重置爲原始的 Icon

@IBAction func resetClick(_ sender: Any) {
    if UIApplication.shared.supportsAlternateIcons {
        UIApplication.shared.setAlternateIconName(nil) { (error) in
            if error != nil {
                print("更換icon錯誤")
            }
        }
    }
}
複製代碼

若是須要恢復爲原始的 icon，只須要在傳入 iconName 的地方傳入 nil 便可。

如今，已經完成了切換 Icon 的功能了。可是每次切換時，都會有一個彈框，下面咱們就想辦法去掉這個彈框。

靜默切換

咱們能夠利用 Runtime 的方法來替換掉彈出提示框的方法。

之前 Method Swizzling 的時候須要在 load 或者 initialize 方法，可是在 Swift 中不能使用了。那就只能本身定義一個了。

extension UIViewController {
    public class func initializeMethod() {
        if self != UIViewController.self {
            return
        }
		// Method Swizzling
        DispatchQueue.once(token: "ChangeIcon") {
            let orignal = class_getInstanceMethod(self, #selector(UIViewController.present(_:animated:completion:)))
            let swizzling = class_getInstanceMethod(self, #selector(UIViewController.jt_present(_:animated:completion:)))

            if let old = orignal, let new = swizzling {
                method_exchangeImplementations(old, new)
            }
        }
    }

    @objc private func jt_present(_ viewControllerToPresent: UIViewController, animated flag: Bool, completion: (() -> Void)? = nil) {
        // 在這裏判斷是不是更換icon時的彈出框
        if viewControllerToPresent is UIAlertController {

            let alertTitle = (viewControllerToPresent as! UIAlertController).title
            let alertMessage = (viewControllerToPresent as! UIAlertController).message

            // 更換icon時的彈出框，這兩個string都爲nil。
            if alertTitle == nil && alertMessage == nil {
                return
            }
        }
		
		// 由於方法已經交換，這個地方的調用就至關於調用原先系統的 present
        self.jt_present(viewControllerToPresent, animated: flag, completion: completion)
    }
}
複製代碼

定義完 UIViewController 的擴展方法後，記得在 AppDelegate 中調用一下。

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

    UIViewController.initializeMethod()

    return true
}
複製代碼

由於，Swift 中 GCD 以前的 once 函數沒有了，這裏本身簡單定義了一個。

extension DispatchQueue {
    private static var _onceTracker = [String]()
    public class func once(token: String, block: () -> ()) {
        objc_sync_enter(self)
        defer {
            objc_sync_exit(self)
        }
        if _onceTracker.contains(token) {
            return
        }
        _onceTracker.append(token)
        block()
    }
}
複製代碼

defer block 裏的代碼會在函數 return 以前執行，不管函數是從哪一個分支 return 的，仍是有 throw，仍是天然而然走到最後一行。

如今，咱們再更換 Icon 的時候，就不會出現彈出框了。

總結

簡單的知識點，時間長了不用也有可能忘記。但願本身能堅持學習，堅持記錄，不斷成長。

參考連接：

Information Property List Key Reference