目录

Web组件如何正确设置User-Agent

问题现象

通过Web组件加载H5页面,设置自定义User-Agent后出现以下问题:

  1. 通过以下代码设置User-Agent后,点击页面功能无反应。
    import { webview } from '@kit.ArkWeb';
    
    @Entry
    @Component
    struct WebComponent {
      controller: webview.WebviewController = new webview.WebviewController();
      customUserAgent: string = ' DemoApp';
    
      build() {
        Column() {
          Web({ src: 'www.example.com', controller: this.controller })
            .fileAccess(false)
            .geolocationAccess(false)
            .onLoadIntercept(() => {
              let userAgent = this.controller.getUserAgent() + this.customUserAgent;
              this.controller.setCustomUserAgent(userAgent);
              return false;
            })
        };
      }
    }
  2. 通过defaultFontSize无法设置网页的默认字体大小,去掉自定义User-Agent正常。设置User-Agent的代码如下:
    this.controller.setCustomUserAgent('xxx_xxx_xxx_harmony')

背景知识

问题定位

  1. 检查自定义UA的设置时机。推荐当WebController成功绑定到Web组件后在onControllerAttached事件中设置,否则可能会出现加载的页面与实际设置User-Agent不匹配的异常现象。
  2. 检查自定义UA设置的格式是否正确。HarmonyOS默认User-Agent结构如下:
    Mozilla/5.0 ({DeviceType}; {OSName} {OSVersion}) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/{ChromeCompatibleVersion}.0.0.0 Safari/537.36  ArkWeb/{ArkWeb VersionCode} {DeviceCompat} {扩展区}

分析结论

  1. 自定义UA设置的时机不对,导致页面功能异常。
  2. 自定义UA设置的格式不正确。

修改建议

  1. 当WebController成功绑定到Web组件后,在onControllerAttached事件中通过setCustomUserAgent接口设置自定义UA。
    import { webview } from '@kit.ArkWeb';
    import { BusinessError } from '@kit.BasicServicesKit';
    
    @Entry
    @Component
    struct WebComponent {
      controller: webview.WebviewController = new webview.WebviewController();
      customUserAgent: string = ' DemoApp';
    
      build() {
        Column() {
          Web({ src: 'www.example.com', controller: this.controller })
            .fileAccess(false)
            .geolocationAccess(false)
            .onControllerAttached(() => {
              console.info('onControllerAttached');
              try {
                let userAgent = this.controller.getUserAgent() + this.customUserAgent;
                this.controller.setCustomUserAgent(userAgent);
              } catch (error) {
                console.error(`ErrorCode: ${(error as BusinessError).code},  Message: ${(error as BusinessError).message}`);
              }
            });
        };
      }
    }
    
  2. 按照规范格式设置UA。例如:
    Mozilla/5.0 (Phone; OpenHarmony 6.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.0.0 Safari/537.36  ArkWeb/6.0.0.120 Mobile

总结

如果页面出现加载白屏、内容布局异常、点击链接无反应,都可排查是否需要设置User-Agent或User-Agent设置是否正确。