iOS问题记录 - iOS 17通过NSUserDefaults设置UserAgent无效

文章目录

前言
开发环境
问题描述
问题分析
解决方案
最后

前言

最近维护一个老项目时遇到的问题。说起这老项目我就有点头疼，一个快十年前的项目，这么说你可能不觉得有什么，但是你想想Swift也才发布不到十年（2014年6月发布，现2023年12月）。

开发环境

Xcode: 15.1
iOS: 17.2

问题描述

项目运行在iOS 17.2设备时，应用内网页无法成功获取设置后的UserAgent。

项目中设置UserAgent的关键源码：

[self.webView evaluateJavaScript:@"navigator.userAgent" completionHandler:^(id result, NSError *error) {
    NSString *userAgent = [NSString stringWithFormat:@"%@", result];
    NSString *newUserAgent = [userAgent stringByAppendingString:@" App/1.0.0"];
    [[NSUserDefaults standardUserDefaults] registerDefaults:@{@"UserAgent": newUserAgent}];
}];

问题分析

从项目源码看，设置UserAgent是通过NSUserDefaults实现的。大致操作如下：

首先应用启动后创建一个WKWebView实例对象，无需加载任何网页
然后通过navigator.userAgent获取当前的UserAgent并修改
接着调用registerDefaults方法将修改后的UserAgent注册到NSUserDefaults，成为应用的默认设置
最后销毁该WKWebView实例对象

经过以上操作，后续创建WKWebView实例对象时都能从NSUserDefaults中获取到修改后的UserAgent用于初始化，从而实现全局设置。需要注意一点，registerDefaults方法设置默认值的操作不会进行持久化存储，所以应用每次启动都需要设置一遍。

虽然理了一遍设置逻辑感觉没什么问题，但是这个方法有点老了，现在一般通过customUserAgent属性设置，难道这个方法过时了？

为了排除其他可能存在的干扰，新建一个iOS项目用于测试，源码如下：

import UIKit
import WebKit

class ViewController: UIViewController, WKNavigationDelegate {
    
    private let htmlString = """
    <html>
        <head>
            <meta name="viewport" content="width=device-width">
            <style>
                button {
                    font-size: 24px;
                }
            </style>
            <script>
                function getUserAgent() {
                    var userAgent = navigator.userAgent;
                    var paragraph = document.createElement('p');
                    paragraph.textContent = 'UserAgent: ' + userAgent;
                    document.body.appendChild(paragraph);
                }
            </script>
        </head>
        <body style="text-align: center;">
            <button οnclick="getUserAgent()">获取 UserAgent</button>
        </body>
    </html>
    """
    
    private var webView: WKWebView!
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        // 在WKWebView初始化前设置UserAgent
        UserDefaults.standard.register(defaults: ["UserAgent": "App/1.0.0"])
        
        // 创建WKWebView
        let webViewConfiguration = WKWebViewConfiguration()
        webView = WKWebView(frame: view.bounds, configuration: webViewConfiguration)
        webView.navigationDelegate = self
        view.addSubview(webView)
        
        // 加载HTML
        webView.loadHTMLString(htmlString, baseURL: nil)
    }
}

iOS 17.2测试结果：

screenshot1

iOS 16.4测试结果：

screenshot2

实测iOS 17.0和iOS 17.2测试结果一样，现在可以确定从iOS 17开始，通过NSUserDefaults设置UserAgent都无法生效。初步判断，这个设置方法在iOS 17及以上过时了，个人猜测可能是WKWebView初始化时不再从NSUserDefaults获取默认值导致的（今天天太冷了，实在扛不住，后面有机会再翻翻相关源码尝试验证猜测）。

既然这个方法失效了，那在iOS 17上通过customUserAgent属性设置能正常生效吗？

对前面的测试源码做简单修改，页面加载完成后自动获取一次未修改的UserAgent，然后再修改UserAgent并通过customUserAgent属性设置，接着手动点击按钮获取一次UserAgent，最后对比两次获取结果判断是否设置成功。

import UIKit
import WebKit

class ViewController: UIViewController, WKNavigationDelegate {
    
    private let htmlString = """
    <html>
        <head>
            <meta name="viewport" content="width=device-width">
            <style>
                button {
                    font-size: 24px;
                }
            </style>
            <script>
                function getUserAgent() {
                    var userAgent = navigator.userAgent;
                    var paragraph = document.createElement('p');
                    paragraph.textContent = 'UserAgent: ' + userAgent;
                    document.body.appendChild(paragraph);
                }
                /* 页面加载完成后获取一次UserAgent */
                window.onload = function() {
                    getUserAgent();
                };
            </script>
        </head>
        <body style="text-align: center;">
            <button οnclick="getUserAgent()">获取 UserAgent</button>
        </body>
    </html>
    """
    
    private var webView: WKWebView!
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        // 创建WKWebView
        let webViewConfiguration = WKWebViewConfiguration()
        webView = WKWebView(frame: view.bounds, configuration: webViewConfiguration)
        webView.navigationDelegate = self
        view.addSubview(webView)
        
        // 加载HTML
        webView.loadHTMLString(htmlString, baseURL: nil)
    }
    
    func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) {
        // 获取当前的UserAgent
        webView.evaluateJavaScript("navigator.userAgent") { (result, error) in
            guard let userAgent = result as? String else {
                return
            }
            let newUserAgent = userAgent + " App/1.0.0"
            // 设置UserAgent
            webView.customUserAgent = newUserAgent
        }
    }
}