iOS 端使用工作空間整合說明文件
iOS 端使用工作空間整合說明文件
本指南介紹了如何在 iOS 應用程式中整合 GPTBots 工作空間的詳細說明,包括權限申請、原生與 H5 互動以及其他相關設定。
GPTBots 同時提供了工作空間的 DEMO 專案,可以幫助您快速開始。iOS 端 DEMO 專案:ios-webview-bridge
基本設定要求
- iOS 13.0 或更高版本
- Xcode 12.0 或更高版本
- Swift 5.0 或更高版本
加入必要的框架
專案需要以下框架:
- WebKit
- AVFoundation(用於麥克風存取)
- Photos(用於相簿存取)
- MobileCoreServices(用於檔案選擇)
在 iOS 14 及以上版本,還可以使用:
#if canImport(UniformTypeIdentifiers)
import UniformTypeIdentifiers
#endif
#if canImport(UniformTypeIdentifiers)
import UniformTypeIdentifiers
#endif
此代碼塊在浮窗中顯示
設定 Info.plist
在 Info.plist 中加入以下設定:
<!-- 允许HTTP请求 -->
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
<key>NSExceptionDomains</key>
<dict>
<key>gptbots-auto.qa.jpushoa.com</key>
<dict>
<key>NSExceptionAllowsInsecureHTTPLoads</key>
<true/>
<key>NSExceptionMinimumTLSVersion</key>
<string>TLSv1.0</string>
<key>NSIncludesSubdomains</key>
<true/>
</dict>
</dict>
</dict>
<!-- 允许HTTP请求 -->
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
<key>NSExceptionDomains</key>
<dict>
<key>gptbots-auto.qa.jpushoa.com</key>
<dict>
<key>NSExceptionAllowsInsecureHTTPLoads</key>
<true/>
<key>NSExceptionMinimumTLSVersion</key>
<string>TLSv1.0</string>
<key>NSIncludesSubdomains</key>
<true/>
</dict>
</dict>
</dict>
此代碼塊在浮窗中顯示
權限設定
應用程式需要以下權限:
相機權限
<key>NSCameraUsageDescription</key>
<string>This app needs to use the camera to support photo capture features in web pages</string>
<key>NSCameraUsageDescription</key>
<string>This app needs to use the camera to support photo capture features in web pages</string>
此代碼塊在浮窗中顯示
麥克風權限
<key>NSMicrophoneUsageDescription</key>
<string>This app needs to use the microphone to support audio recording features in web pages</string>
<key>NSMicrophoneUsageDescription</key>
<string>This app needs to use the microphone to support audio recording features in web pages</string>
此代碼塊在浮窗中顯示
相簿權限
<key>NSPhotoLibraryUsageDescription</key>
<string>This app needs to access your photo library to select images and video files</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>This app needs to access your photo library to select images and video files</string>
此代碼塊在浮窗中顯示
文件存取權限
<key>NSDocumentUsageDescription</key>
<string>This app needs to access documents to support file upload features in web pages</string>
<key>NSDocumentUsageDescription</key>
<string>This app needs to access documents to support file upload features in web pages</string>
此代碼塊在浮窗中顯示
原生與 WebView 互動
建立 WebView 控制器
建立一個專門用於顯示 WebView 的控制器:
class WebViewController: UIViewController {
private var webView: WKWebView!
private var webViewBridge: WebViewBridge!
var urlString: String = ""
override func viewDidLoad() {
super.viewDidLoad()
setupWebView()
setupWebViewBridge()
loadURL()
}
private func setupWebView() {
let configuration = WKWebViewConfiguration()
configuration.allowsInlineMediaPlayback = true
configuration.mediaTypesRequiringUserActionForPlayback = []
configuration.applicationNameForUserAgent = "WebViewApp/1.0"
webView = WKWebView(frame: view.bounds, configuration: configuration)
webView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
webView.navigationDelegate = self
webView.uiDelegate = self
view.addSubview(webView)
}
private func loadURL() {
guard !urlString.isEmpty, let url = URL(string: urlString) else {
return
}
let request = URLRequest(url: url)
webView.load(request)
}
}
class WebViewController: UIViewController {
private var webView: WKWebView!
private var webViewBridge: WebViewBridge!
var urlString: String = ""
override func viewDidLoad() {
super.viewDidLoad()
setupWebView()
setupWebViewBridge()
loadURL()
}
private func setupWebView() {
let configuration = WKWebViewConfiguration()
configuration.allowsInlineMediaPlayback = true
configuration.mediaTypesRequiringUserActionForPlayback = []
configuration.applicationNameForUserAgent = "WebViewApp/1.0"
webView = WKWebView(frame: view.bounds, configuration: configuration)
webView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
webView.navigationDelegate = self
webView.uiDelegate = self
view.addSubview(webView)
}
private func loadURL() {
guard !urlString.isEmpty, let url = URL(string: urlString) else {
return
}
let request = URLRequest(url: url)
webView.load(request)
}
}
此代碼塊在浮窗中顯示
實作 JavaScript 橋接
建立一個橋接類別,用於原生程式碼與 JavaScript 之間的通訊:
class WebViewBridge: NSObject {
static let EVENT_CLICK = "click"
static let EVENT_MESSAGE = "message"
private weak var webView: WKWebView?
weak var delegate: WebViewBridgeDelegate?
init(webView: WKWebView, viewController: UIViewController) {
self.webView = webView
super.init()
}
func registerJSInterface() {
webView?.configuration.userContentController.add(self, name: "agentWebBridge")
}
func callH5(eventType: String, data: [String: Any]) {
let message: [String: Any] = [
"eventType": eventType,
"data": data
]
if let jsonData = try? JSONSerialization.data(withJSONObject: message),
let jsonString = String(data: jsonData, encoding: .utf8) {
let escapedJson = jsonString
.replacingOccurrences(of: "\\", with: "\\\\")
.replacingOccurrences(of: "'", with: "\\'")
.replacingOccurrences(of: "\"", with: "\\\"")
let jsCode = "window.onCallH5Message('\(escapedJson)')"
webView?.evaluateJavaScript(jsCode)
}
}
}
class WebViewBridge: NSObject {
static let EVENT_CLICK = "click"
static let EVENT_MESSAGE = "message"
private weak var webView: WKWebView?
weak var delegate: WebViewBridgeDelegate?
init(webView: WKWebView, viewController: UIViewController) {
self.webView = webView
super.init()
}
func registerJSInterface() {
webView?.configuration.userContentController.add(self, name: "agentWebBridge")
}
func callH5(eventType: String, data: [String: Any]) {
let message: [String: Any] = [
"eventType": eventType,
"data": data
]
if let jsonData = try? JSONSerialization.data(withJSONObject: message),
let jsonString = String(data: jsonData, encoding: .utf8) {
let escapedJson = jsonString
.replacingOccurrences(of: "\\", with: "\\\\")
.replacingOccurrences(of: "'", with: "\\'")
.replacingOccurrences(of: "\"", with: "\\\"")
let jsCode = "window.onCallH5Message('\(escapedJson)')"
webView?.evaluateJavaScript(jsCode)
}
}
}
此代碼塊在浮窗中顯示
實作 WebView 代理方法
實作必要的 WebView 代理方法,處理檔案選擇、權限請求等:
extension WebViewController: WKUIDelegate {
// 处理文件上传
@available(iOS 18.4, *)
func webView(_ webView: WKWebView, runOpenPanelWith parameters: WKOpenPanelParameters,
initiatedByFrame frame: WKFrameInfo, completionHandler: @escaping ([URL]?) -> Void) {
let alert = UIAlertController(title: "Select File", message: nil, preferredStyle: .actionSheet)
alert.addAction(UIAlertAction(title: "Select from Photos", style: .default) { _ in
self.presentImagePicker(completionHandler: completionHandler)
})
alert.addAction(UIAlertAction(title: "Select from Files", style: .default) { _ in
self.presentDocumentPicker(completionHandler: completionHandler)
})
alert.addAction(UIAlertAction(title: "Cancel", style: .cancel) { _ in
completionHandler(nil)
})
present(alert, animated: true)
}
// 处理媒体权限请求
@available(iOS 15.0, *)
func webView(_ webView: WKWebView, requestMediaCapturePermissionFor origin: WKSecurityOrigin,
initiatedByFrame frame: WKFrameInfo, type: WKMediaCaptureType,
decisionHandler: @escaping (WKPermissionDecision) -> Void) {
switch type {
case .microphone:
// 检查麦克风权限
switch AVAudioSession.sharedInstance().recordPermission {
case .granted:
decisionHandler(.grant)
case .denied:
decisionHandler(.deny)
case .undetermined:
AVAudioSession.sharedInstance().requestRecordPermission { granted in
DispatchQueue.main.async {
if granted {
decisionHandler(.grant)
} else {
decisionHandler(.deny)
}
}
}
@unknown default:
decisionHandler(.deny)
}
case .camera, .cameraAndMicrophone:
decisionHandler(.grant)
@unknown default:
decisionHandler(.deny)
}
}
}
extension WebViewController: WKUIDelegate {
// 处理文件上传
@available(iOS 18.4, *)
func webView(_ webView: WKWebView, runOpenPanelWith parameters: WKOpenPanelParameters,
initiatedByFrame frame: WKFrameInfo, completionHandler: @escaping ([URL]?) -> Void) {
let alert = UIAlertController(title: "Select File", message: nil, preferredStyle: .actionSheet)
alert.addAction(UIAlertAction(title: "Select from Photos", style: .default) { _ in
self.presentImagePicker(completionHandler: completionHandler)
})
alert.addAction(UIAlertAction(title: "Select from Files", style: .default) { _ in
self.presentDocumentPicker(completionHandler: completionHandler)
})
alert.addAction(UIAlertAction(title: "Cancel", style: .cancel) { _ in
completionHandler(nil)
})
present(alert, animated: true)
}
// 处理媒体权限请求
@available(iOS 15.0, *)
func webView(_ webView: WKWebView, requestMediaCapturePermissionFor origin: WKSecurityOrigin,
initiatedByFrame frame: WKFrameInfo, type: WKMediaCaptureType,
decisionHandler: @escaping (WKPermissionDecision) -> Void) {
switch type {
case .microphone:
// 检查麦克风权限
switch AVAudioSession.sharedInstance().recordPermission {
case .granted:
decisionHandler(.grant)
case .denied:
decisionHandler(.deny)
case .undetermined:
AVAudioSession.sharedInstance().requestRecordPermission { granted in
DispatchQueue.main.async {
if granted {
decisionHandler(.grant)
} else {
decisionHandler(.deny)
}
}
}
@unknown default:
decisionHandler(.deny)
}
case .camera, .cameraAndMicrophone:
decisionHandler(.grant)
@unknown default:
decisionHandler(.deny)
}
}
}
此代碼塊在浮窗中顯示
實作檔案選擇功能
extension WebViewController {
private func presentImagePicker(completionHandler: @escaping ([URL]?) -> Void) {
let picker = UIImagePickerController()
picker.delegate = self
picker.sourceType = .photoLibrary
picker.mediaTypes = ["public.image", "public.movie"]
fileUploadCallback = { url in
if let url = url {
completionHandler([url])
} else {
completionHandler(nil)
}
}
present(picker, animated: true)
}
private func presentDocumentPicker(completionHandler: @escaping ([URL]?) -> Void) {
let picker: UIDocumentPickerViewController
if #available(iOS 14.0, *) {
picker = UIDocumentPickerViewController(forOpeningContentTypes: [.data, .text, .image, .movie, .audio])
} else {
picker = UIDocumentPickerViewController(documentTypes: [
"public.data",
"public.text",
"public.image",
"public.movie",
"public.audio"
], in: .import)
}
picker.delegate = self
picker.allowsMultipleSelection = false
fileUploadCallback = { url in
if let url = url {
completionHandler([url])
} else {
completionHandler(nil)
}
}
present(picker, animated: true)
}
}
extension WebViewController {
private func presentImagePicker(completionHandler: @escaping ([URL]?) -> Void) {
let picker = UIImagePickerController()
picker.delegate = self
picker.sourceType = .photoLibrary
picker.mediaTypes = ["public.image", "public.movie"]
fileUploadCallback = { url in
if let url = url {
completionHandler([url])
} else {
completionHandler(nil)
}
}
present(picker, animated: true)
}
private func presentDocumentPicker(completionHandler: @escaping ([URL]?) -> Void) {
let picker: UIDocumentPickerViewController
if #available(iOS 14.0, *) {
picker = UIDocumentPickerViewController(forOpeningContentTypes: [.data, .text, .image, .movie, .audio])
} else {
picker = UIDocumentPickerViewController(documentTypes: [
"public.data",
"public.text",
"public.image",
"public.movie",
"public.audio"
], in: .import)
}
picker.delegate = self
picker.allowsMultipleSelection = false
fileUploadCallback = { url in
if let url = url {
completionHandler([url])
} else {
completionHandler(nil)
}
}
present(picker, animated: true)
}
}
此代碼塊在浮窗中顯示
處理 WebView 訊息
extension WebViewBridge: WKScriptMessageHandler {
func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
guard message.name == "agentWebBridge",
let messageBody = message.body as? String else {
return
}
do {
guard let data = messageBody.data(using: .utf8),
let jsonObject = try JSONSerialization.jsonObject(with: data, options: []) as? [String: Any],
let eventType = jsonObject["eventType"] as? String else {
return
}
let eventData = jsonObject["data"] as? [String: Any] ?? [:]
// 根据事件类型分发处理
DispatchQueue.main.async { [weak self] in
guard let self = self else { return }
switch eventType {
case WebViewBridge.EVENT_CLICK:
self.delegate?.onClickEvent(data: eventData)
case WebViewBridge.EVENT_MESSAGE:
self.delegate?.onMessageEvent(data: eventData)
default:
self.delegate?.onUnhandledEvent(eventType: eventType, data: eventData)
}
}
} catch {
print("Error parsing H5 message: \(error.localizedDescription)")
}
}
}
extension WebViewBridge: WKScriptMessageHandler {
func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
guard message.name == "agentWebBridge",
let messageBody = message.body as? String else {
return
}
do {
guard let data = messageBody.data(using: .utf8),
let jsonObject = try JSONSerialization.jsonObject(with: data, options: []) as? [String: Any],
let eventType = jsonObject["eventType"] as? String else {
return
}
let eventData = jsonObject["data"] as? [String: Any] ?? [:]
// 根据事件类型分发处理
DispatchQueue.main.async { [weak self] in
guard let self = self else { return }
switch eventType {
case WebViewBridge.EVENT_CLICK:
self.delegate?.onClickEvent(data: eventData)
case WebViewBridge.EVENT_MESSAGE:
self.delegate?.onMessageEvent(data: eventData)
default:
self.delegate?.onUnhandledEvent(eventType: eventType, data: eventData)
}
}
} catch {
print("Error parsing H5 message: \(error.localizedDescription)")
}
}
}
此代碼塊在浮窗中顯示
常見問題
1. WebView 無法載入頁面
- 檢查網路連線
- 確認 Info.plist 中的 NSAppTransportSecurity 設定正確
- 驗證 URL 格式是否正確
2. 權限請求被拒絕
- 確保在 Info.plist 中加入了所有必要的權限描述
- 引導使用者在裝置設定中手動開啟權限
3. JavaScript 互動失敗
- 確保 WebViewBridge 正確註冊了 JavaScript 介面
- 檢查 JavaScript 訊息格式是否符合預期
- 使用 Safari 開發者工具偵錯 WebView 中的 JavaScript 錯誤
4. 檔案上傳問題
- 對於 iOS 14 以下版本,確保使用正確的文件類型識別碼
- 確保應用程式有足夠的權限存取相簿和檔案系統
- 處理檔案 URL 的生命週期,確保 URL 在使用時仍然有效
