From ec7aadd52e719ccf7f27529ebc30e245e88cb438 Mon Sep 17 00:00:00 2001
From: yanyilin <yanyilin@dcloud.io>
Date: Tue, 14 Mar 2023 13:00:44 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0App=E7=AB=AFUser=20Agent?=
 =?UTF-8?q?=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/tutorial/_sidebar.md      |  1 +
 docs/tutorial/app-useragent.md | 57 ++++++++++++++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 docs/tutorial/app-useragent.md

diff --git a/docs/tutorial/_sidebar.md b/docs/tutorial/_sidebar.md
index ccb3f91d1..e2bf6d25a 100644
--- a/docs/tutorial/_sidebar.md
+++ b/docs/tutorial/_sidebar.md
@@ -47,6 +47,7 @@
   * [Native.js](/tutorial/native-js.md)
   * [renderjs](/tutorial/renderjs.md)
   * [原生插件](https://nativesupport.dcloud.net.cn/NativePlugin/README)
+  * [App的User Agent](/tutorial/app-useragent.md)
   * [App使用高斯模糊](/tutorial/app-blureffect.md)
   * App 打包配置
     * [基础配置](/tutorial/app-base.md)
diff --git a/docs/tutorial/app-useragent.md b/docs/tutorial/app-useragent.md
new file mode 100644
index 000000000..6ca834265
--- /dev/null
+++ b/docs/tutorial/app-useragent.md
@@ -0,0 +1,57 @@
+用户代理（User Agent，简称 UA），是http/https网络请求头中的一个特殊字符串，使服务器能够识别客户端使用的操作系统及版本、浏览器渲染引擎、内核版本等信息。uni-app中的vue页面使用系统Webview渲染，为了保持一致，App端所有http/https网络请求头使用统一的User Agent。  
+API包括[uni.request](https://uniapp.dcloud.net.cn/api/request/request.html#request)、[uni.uploadFile](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)、[uni.downloadFile](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)等  
+组件包括[image](https://uniapp.dcloud.net.cn/component/image.html)、[web-view](https://uniapp.dcloud.net.cn/component/web-view.html)等。
+
+### 默认User Agent  
+默认情况使用系统Webview的User Agent，并添加Html5Plus/1.0、uni-app两字段  
+- Android平台，在荣耀Play4T手机上默认值为：  
+```
+Mozilla/5.0 (Linux; Android 10; AKA-AL10 Build/HONORAKA-AL10; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/88.0.4324.93 Mobile Safari/537.36 uni-app Html5Plus/1.0 (Immersed/34.5)
+```
+- iOS平台，在iPhone 12手机上默认值为：  
+```
+Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148 Html5Plus/1.0 (Immersed/20) uni-app
+```
+
+
+### 自定义User Agent  
+如需自定义User Agent，在项目的 manifest.json 中 "app-plus" -> "useragent" 进行配置，支持以下属性：
+- value  
+字符串类型，表示要添加的自定义User Agent值  
+- concatenate  
+boolean类型， true表示在默认User Agent基础上添加额外字段，false表示替换默认User Agent  
+
+注意：
+- 如需单独定义Android平台的User Agent，可设置"useragent_android"，在Android平台存在"useragent_android"时会覆盖"useragent"配置  
+- 如需单独定义iOS平台的User Agent，可设置"useragent_ios"，在iOS平台存在"useragent_ios"时会覆盖"useragent"配置  
+- 配置自定义User Agent后需提交云端打包才能生效  
+
+#### 在默认User Agent中添加额外字段  
+如需在默认User Agent中添加myua字段，可配置如下：  
+```json
+{
+	"app-plus": {
+		"useragent": {
+			"value": "myua",
+			"concatenate": true
+		}
+	}
+}
+```
+
+#### 替换默认User Agent  
+如需完全自定义User Agent为"CustomUA"，可配置如下：  
+```json
+{
+	"app-plus": {
+		"useragent": {
+			"value": "CustomUA",
+			"concatenate": false
+		}
+	}
+}
+```
+
+`注意：此时默认UA信息中的操作系统及版本、浏览器渲染引擎、内核版本等信息将丢失，实际项目中不建议使用替换默认User Agent。`
+
+
-- 
GitLab