1. 程式人生 > >IOS 自定義 URL Scheme 完全指南

IOS 自定義 URL Scheme 完全指南

iPhone / iOS SDK 最酷的特性之一就是應用將其自身”繫結”到一個自定義 URL scheme 上,該 scheme 用於從瀏覽器或其他應用中啟動本應用。 註冊自定義 URL Scheme 註冊自定義 URL Scheme 的第一步是建立 URL Scheme — 在 Xcode Project Navigator 中找到並點選工程 info.plist 檔案。當該檔案顯示在右邊視窗,在列表上點選滑鼠右鍵,選擇 Add Row: 向下滾動彈出的列表並選擇 URL types。 iOS Custom URL Scheme 點選左邊剪頭開啟列表,可以看到 Item 0,一個字典實體。展開 Item 0,可以看到 URL Identifier,一個字串物件。該字串是你自定義的 URL scheme 的名字。建議採用反轉域名的方法保證該名字的唯一性,比如 com.yourCompany.yourApp。
urlScheme2a 點選 Item 0 新增一行,從下拉列表中選擇 URL Schemes,敲擊鍵盤迴車鍵完成插入。  iOS Custom URL Scheme 注意: URL Schemes 是一個數組,允許應用定義多個 URL schemes。  iOS Custom URL Scheme 展開該資料並點選 Item 0。你將在這裡定義自定義 URL scheme 的名字。只需要名字,不要在後面追加 :// — 比如,如果你輸入 iOSDevApp,你的自定義 url 就是 iOSDevApp://  iOS Custom URL Scheme 此時,整個定義如下圖:  iOS Custom URL Scheme 雖然我贊同 Xcode 使用描述性的名字的目的,不過看到建立的實際的 key 也是非常有用的。這裡有一個方便的技巧,右鍵點選 plist 並選擇 Show Raw Keys/Values,就能看到以下效果: 
iOS Custom URL Scheme 還有另一種有用的輸出格式,XML,因為可以非常容易的看到字典和原始陣列及其包括的實體的結構。點選 plist 並選擇 Open As – Source Code:  iPhone Custom URL Scheme 從 Safari 中呼叫自定義 URL Scheme 定義了 URL scheme,我們可以執行一個快速測試來驗證應用是否如我們所期望的被呼叫。在這之前,我建立了一個準 UI 以辨別帶有自定義 URL 的應用。該應用只有一個 UILabel,帶有文字 “App With Custom URL”(下載原始碼)。  iOS App with Custom URL 使用模擬器呼叫應用的步驟: 1. 在 Xcode 中執行應用 2. 一旦應用被安裝,自定義 URL scheme 就會被註冊 3. 通過模擬器的硬體選單中選擇 Home 來關閉應用 4. 啟動 Safari 5. 在瀏覽器位址列輸入之前定義的 URL scheme(如下) 
Call Custom URL Scheme from Safari 此時 Safari 將會關閉,應用會被帶回到前臺。祝賀你剛剛使用自定義 URL scheme 呼叫了一個 iPhone 應用。 從另一個 iPhone 應用中呼叫自定義 URL Scheme 讓我們看看如何從另一個應用中呼叫自定義 URL scheme。我又建立了一個非常簡單的 iPhone 應用,它只有一個 UILabel 和一個 UIButton — 前者顯示了一段資訊,告訴你這個應用將要通過自定義 URL scheme 來呼叫另一個應用,按鈕則開始這個行為(下載原始碼)。  iPhone app that call Custom URL Scheme buttonPressed 方法中的程式碼處理 URL 呼叫: 
  1. - (void)buttonPressed:(UIButton *)button 
  2.   NSString *customURL = @"iOSDevTips://"
  3.   if ([[UIApplication sharedApplication] 
  4.     canOpenURL:[NSURL URLWithString:customURL]]) 
  5.   { 
  6.     [[UIApplication sharedApplication] openURL:[NSURL URLWithString:customURL]]; 
  7.   } 
  8.   else
  9.   { 
  10.     UIAlertView *alert = [[UIAlertView alloc] initWithTitle:@"URL error"
  11.                           message:[NSString stringWithFormat: 
  12.                             @"No custom URL defined for %@", customURL] 
  13.                           delegate:self cancelButtonTitle:@"Ok"
  14.                           otherButtonTitles:nil]; 
  15.     [alert show]; 
  16.   } 
第 5 行程式碼檢查自定義 URL 是否被定義,如果定義了,則使用 shared application 例項來開啟 URL (第 8 行)。openURL: 方法啟動應用並將 URL 傳入應用。在此過程中,當前的應用被退出。 通過自定義 URL Scheme 嚮應用傳遞引數 有時你需要通過自定義 URL 嚮應用中傳遞引數。讓我們看看該如何完成這個工作。 NSURL 作為從一個應用呼叫另一個的基礎,遵循 RFC 1808 (Relative Uniform Resource Locators) 標準。 因此你所熟悉的基於網頁內容的 URL 格式在這裡也適用。 在自定義了 URL scheme 的應用中,app delegate 必須實現以下方法: 
  1. - (BOOL)application:(UIApplication *)application 
  2.   openURL:(NSURL *)url 
  3.   sourceApplication:(NSString *)sourceApplication 
  4.   annotation:(id)annotation 
從一個應用傳遞引數到另一個的訣竅是通過 URL。例如,假設我們使用以下的 URL scheme,想傳遞一個名為 “token”的引數和一個標識註冊狀態的標誌,我們可以像這樣建立一個 URL: 
  1. NSString *customURL = @"iOSDevTips://?token=123abct&registered=1"
在 web 開發中,字串 ?token=123abct&registered=1 被稱作查詢詢串(query string)。 在被呼叫(設定了自定義 URL)的應用的 app delegate 中,獲取引數的程式碼如下: 
  1. - (BOOL)application:(UIApplication *)application openURL:(NSURL *)url 
  2.         sourceApplication:(NSString *)sourceApplication annotation:(id)annotation 
  3.   NSLog(@"Calling Application Bundle ID: %@", sourceApplication); 
  4.   NSLog(@"URL scheme:%@", [url scheme]); 
  5.   NSLog(@"URL query: %@", [url query]); 
  6.   return YES; 
以上程式碼在應用被呼叫時的輸出為: 
  1. Calling Application Bundle ID: com.3Sixty.CallCustomURL 
  2. URL scheme:iOSDevTips 
  3. URL query: token=123abct&registered=1 
注意 “Calling Application Bundle ID”,你可以用這個來確保只有你定義的應用可以與你的應用直接互動。 讓我們改變一下程式碼,來驗證發起呼叫的應用的 Bundle ID 是否合法: 
  1. - (BOOL)application:(UIApplication *)application openURL:(NSURL *)url 
  2.         sourceApplication:(NSString *)sourceApplication annotation:(id)annotation 
  3.   // Check the calling application Bundle ID
  4.   if ([sourceApplication isEqualToString:@"com.3Sixty.CallCustomURL"]) 
  5.   { 
  6.     NSLog(@"Calling Application Bundle ID: %@", sourceApplication); 
  7.     NSLog(@"URL scheme:%@", [url scheme]); 
  8.     NSLog(@"URL query: %@", [url query]); 
  9.     return YES; 
  10.   } 
  11.   else
  12.     return NO; 
有一點要特別注意,你不能阻止其他應用通過自定義 URL scheme 呼叫你的應用,然而你可以跳過後續的操作並返回 NO,就像上面的程式碼那樣。也就是說,如果你想阻止其它應用呼叫你的應用,建立一個與眾不同的 URL scheme。儘管這不能保證你的應用不會被呼叫,但至少大大降低了這種可能性。 自定義 URL Scheme 示例工程 我意識到按照本文的每一步做下來還是有一點複雜的。我做好了兩個非常基礎的 iOS 應用,一個自定義了 URL scheme,另一個則去呼叫它,並傳遞了一個比較短的引數列表(query string)。這些是體驗自定義 URL 的很好的入門點。 其它資源