diff --git a/docs/api/cookie-shared.md b/docs/api/cookie-shared.md new file mode 100644 index 0000000000000000000000000000000000000000..a00242878149f787a0ee2a178bda0eee4984d2bb --- /dev/null +++ b/docs/api/cookie-shared.md @@ -0,0 +1,34 @@ +## Cookie + +### Cookie概念 + +HTTP cookie,简称cookie,是浏览网站时由网络服务器创建并由网页浏览器存放在用户计算机或其他设备的小文本文件。 + +Cookie使Web服务器能在用户的设备存储状态信息(如添加到在线商店购物车中的商品)或跟踪用户的浏览活动(如点击特定按钮、登录或记录历史) + +#### 语法 + +``` +Cookie: name=value +Cookie: name=value; name2=value2; name3=value3 +``` + +#### Cookie共享 + +Cookie共享是指在应用中,请求同一域名地址,Http请求头会携带相同的Cookie。这是因为Cookie是由应用存储在用户设备上的,因此所有支持Cookie共享的API和组件都可以访问到这些Cookie。 + +uni-app x 中已实现Cookie共享的API和组件有 + +- [uni.request](https://doc.dcloud.net.cn/uni-app-x/api/request.html) :用于发起网络请求,会自动携带Cookie。 +- [uni.uploadFile](https://doc.dcloud.net.cn/uni-app-x/api/upload-file.html) :用于上传文件,会自动携带Cookie。 +- [uni.downloadFile](https://doc.dcloud.net.cn/uni-app-x/api/download-file.html) :用于下载文件,会自动携带Cookie。 +- [image组件](https://doc.dcloud.net.cn/uni-app-x/component/image.html) :显示网络图片时,会自动携带Cookie(iOS端未实现Cookie共享)。 +- [video组件](https://doc.dcloud.net.cn/uni-app-x/component/video.html) :用于播放网络视频,会自动携带Cookie(iOS端未实现Cookie共享)。 +- [web-view组件](https://doc.dcloud.net.cn/uni-app-x/component/web-view.html) :用于显示网页,会自动携带Cookie(iOS端未实现Cookie共享)。 + + +已实现Cookie共享的组件和API,开发者无须关心Cookie的存储、删除、过期等问题,客户端已自动处理。 + +#### Cookie共享使用场景 + +客户端请求接口,服务端下发Cookie,此时使用web-view组件,在web-view组件里访问同域名地址,也会携带客户端请求时设置的Cookie。 diff --git a/docs/api/request.md b/docs/api/request.md index a87251d090857536dff5f6474941d21801666dd7..16ce67230049d17788bf70754aa60e4d99d378f6 100644 --- a/docs/api/request.md +++ b/docs/api/request.md @@ -13,7 +13,7 @@ ## cookie管理 -- uni-app x 4.0+,app-android平台的 `uni.request`、`uni.uploadFile`、`uni.downloadFile`,之间支持共享cookie。 +- uni-app x 4.0+,app-android平台的 `uni.request`、`uni.uploadFile`、`uni.downloadFile`,之间支持共享cookie [Cookie共享介绍](cookie-shared.md)。 ## 注意事项