Web 分享 API 赋予浏览器原生分享能力

简介: 本文讲的是Web 分享 API 赋予浏览器原生分享能力,多年来,Web 一直向着与移动原生应用等价的方向发展,并且新增了许多以前没有的特性。 如今,浏览器支持了其中的大部分特性,从离线模式到用 Service Workers 增强体验以及 Geolocation 和 NFC。
本文讲的是Web 分享 API 赋予浏览器原生分享能力,

多年来,Web 一直向着与移动原生应用等价的方向发展,并且新增了许多以前没有的特性。 如今,浏览器支持了其中的大部分特性,从离线模式到用 Service Workers 增强体验以及 Geolocation 和 NFC。

但有一种已经在移动应用上广泛使用的重要功能仍然缺失,那就是分享页面、文章或一些特定数据的功能。

Web 分享 API 是填补这种缺失的第一步,它将把原生的分享能力带到 Web 端。

为什么需要新的 API

前几年,在移动 Web 应用上尝试实现了一些 API/协议 能够实现分享功能:

1)Web Intents 在 Chrome 15 引入并实现,但在 Chrome 24 中废弃

2)也有许多自定义 URL 的解决方法:

  1. Mozilla 曾提出了 Web Activities 方案,但是已经被淘汰,不再支持了。

所以现在的情况是,没有 API 能够支持 Web 上简单的内容分享功能。 但是用户需要一个快速分享的方式,能够方便地把 网址/文本/图片 等数据分享到他们喜欢的 app 和服务上。

现在的能提供的是:

  1. 针对特定服务的分享按钮(将导致众多服务和内容整合商仅提供分享按钮的 API)

  2. 许多浏览器和应用程序提供自己特定的分享按钮。

但仍然没有从 Web 应用程序分享内容的简便方法。

Web 分享 API

如今的 Web 分享 API 是基于 Promise 的非阻塞API 的最佳实践。

正如其他大多数分享 API 一样,你能够分享的数据包括 titleurl 和 text(三者至少一项为必填项)。 下面是允许分享图片数据或/和文件对象的方案。

如下所示:

function onShareClick(photo){
    // WEB SHARE API
    navigator.share({
        title: 'Checkout this funny photo',
        text: '',
        url: window.location.origin + '/' + photo.id 
    })
    .then(() => console.log('Successfully shared'))
    .catch((error) => console.log('Error sharing:', error));
}

image credits

如你所见,这个 API 相当简单,并且目前为止接收至少一个以下字段:

  • title (string): 被分享文档的标题(可能会被处理程序忽略)。
  • text(string):形成分享消息主体的文本。
  • url(string):被分享资源的 URL / URI 地址。

这个方法返回一个 Promise。

如果用户选择了目标应用程序,它会被 resolve,同时目标应用成功接收数据。

Promise 被 reject 的情况有如下几种:

  • 分享的是不可用数据(例如:传递错误字段)
  • 用户取消对话框,或者没有目标应用
  • 数据不能被传递到目标应用

分享的数据

网站上传递到 navigator.share 的所有字段通常都有许多预定义的值。

例如,流行的 Open Graph Markup。 如果你的网站在使用它,那么你想分享网页数据时能够容易地重用值。

我在下面的 demo 中使用了这个方法:

function getOpenGraphData(property){
    return document.querySelector(`meta[property="${property}"]`)
        .getAttribute('content');
}

const sharePage = () => {
        navigator.share({
            title: getOpenGraphData('og:title'),
            text: getOpenGraphData('og:description'),
            url: getOpenGraphData('og:url')
        }) //...
}

Demo

这里有一个视频示范如何使用它

(点击分享按钮  :arrow_right:  tweet  :arrow_right:  在 Twitter 上新增的 tweet):

绝大多数情况下,如果你想拥有从任何页面分享数据的能力,但是并不确定是 Open Graph 还是其他标签, 这里有一个通用方案:

navigator.share({
    title: document.title,
    url: document.querySelector('link[rel=canonical]') ?
        document.querySelector('link[rel=canonical]').href :
        window.location.href
})

link[rel=canonical] 代表可选但是更通用的 <link> 元素, 意思是使用这个元素内 href 标签指向的 URL。 如果网站的 URL 有例如 mobile 的前缀或者其他内容,则这个 URL 不应该被分享。

如果没有提供规范 link,那么分享的就是默认 URL。

最新建议,如果不可用的话(浏览器不支持,设备没有分享功能等),别忘了禁用或撤销分享功能。

if(!navigator.share){
  shareButton.hidden = true;
  return;
}
// SHARE CODE

要求

现在,Web 分享 API 在 Android 上稳定的 Chrome 版本中已经可用。

但首先,要求 HTTPS 环境,其次,在 Origin Trial 下可用。

简而言之,Origin Trial 使得开发者能够在固定一段时间内启用 API。 这将给予供应商和 API 作者/提供商 反馈。 你可以把它理解为你的网站可以在浏览器下启用分享的一个标志。 你可以在这里找到一些可用的尝试 here

要启用 Web 分享 API,你需要:

  1. 登录并获取试用 token
  2. 24 小时内,你将收到一封邮件,里面包含试用 Token 和如何在 Web 应用中使用的说明
  3. 在 header 中或者直接在网页的 HTML,全局任何你想使用这个 API 的地方加上下面这段代码
<metahttp-equiv="origin-trial"data-feature="Web Share"content="TOKEN_FROM_THE_EMAIL">

Web 分享试用在 Chrome 55 上引入了,将支持到 2017 年 4 月,在那之后也许会在浏览器中默认开启。

总结一下启用 Web 分享 API 的步骤:

  1. 网站在 HTTPS 环境下
  2. 把 origin trial 相关的 header/meta 加入到页面上
  3. 用户行为(点击,触摸)触发并调用 navigator.share()

总结

随着 Web 的发展,移动 Web 与原生应用之间的界限越来越模糊,Web 分享 API 就是革命的下一步,如今你就可以使用了。

未来的工作将围绕跨平台 API 的实现,图片数据的提供或者文件(二进制对象)的分享。

同时,不仅限于发送,关于 Web 应用的分享接收也有一个讨论。

在 Web 分享目标 API 中,我们也许能了解更多分享之后的事情。






原文发布时间为:2017年3月10日

本文来自云栖社区合作伙伴掘金,了解相关信息可以关注掘金网站。
目录
相关文章
|
2月前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
58 4
|
2月前
|
XML JSON API
ServiceStack:不仅仅是一个高性能Web API和微服务框架,更是一站式解决方案——深入解析其多协议支持及简便开发流程,带您体验前所未有的.NET开发效率革命
【10月更文挑战第9天】ServiceStack 是一个高性能的 Web API 和微服务框架,支持 JSON、XML、CSV 等多种数据格式。它简化了 .NET 应用的开发流程,提供了直观的 RESTful 服务构建方式。ServiceStack 支持高并发请求和复杂业务逻辑,安装简单,通过 NuGet 包管理器即可快速集成。示例代码展示了如何创建一个返回当前日期的简单服务,包括定义请求和响应 DTO、实现服务逻辑、配置路由和宿主。ServiceStack 还支持 WebSocket、SignalR 等实时通信协议,具备自动验证、自动过滤器等丰富功能,适合快速搭建高性能、可扩展的服务端应用。
160 3
|
11天前
|
Kubernetes 安全 Devops
有效抵御网络应用及API威胁,聊聊F5 BIG-IP Next Web应用防火墙
有效抵御网络应用及API威胁,聊聊F5 BIG-IP Next Web应用防火墙
36 10
有效抵御网络应用及API威胁,聊聊F5 BIG-IP Next Web应用防火墙
|
1月前
|
人工智能 前端开发 计算机视觉
Inpaint-Web:纯浏览器端实现的开源图像处理工具
在刷短视频时,常看到情侣在景区拍照被路人“抢镜”,男朋友用手机将路人“P”掉,既贴心又有趣。最近我发现了一个纯前端实现的开源项目——inpaint-web,可在浏览器端删除照片中的部分内容,非常酷。该项目基于 WebGPU 和 WASM 技术,支持图像修复与放大,已在 GitHub 上获得 5.1k Star。项目地址:[GitHub](https://github.com/lxfater/inpaint-web)。
60 3
 Inpaint-Web:纯浏览器端实现的开源图像处理工具
|
24天前
|
存储 缓存 前端开发
Web端IM聊天消息该不该用浏览器本地存储?一文即懂!
鉴于目前浏览器技术的进步(主要是HTML5的普及),在Web网页端IM聊天应用的技术选型阶段,很多开发者都会纠结到底该不该像原生移动端IM那样将聊天记录缓存在浏览器的本地,还是像传统Web端即时通讯那样继续存储在服务端?本文将为你简洁明了地讲清楚浏览器本地存储技术(Web Storage),然后你就知道到底该怎么选择了。
26 1
|
1月前
|
前端开发 API 开发者
Python Web开发者必看!AJAX、Fetch API实战技巧,让前后端交互如丝般顺滑!
在Web开发中,前后端的高效交互是提升用户体验的关键。本文通过一个基于Flask框架的博客系统实战案例,详细介绍了如何使用AJAX和Fetch API实现不刷新页面查看评论的功能。从后端路由设置到前端请求处理,全面展示了这两种技术的应用技巧,帮助Python Web开发者提升项目质量和开发效率。
52 1
|
1月前
|
JSON API 数据格式
如何使用Python和Flask构建一个简单的RESTful API。Flask是一个轻量级的Web框架
本文介绍了如何使用Python和Flask构建一个简单的RESTful API。Flask是一个轻量级的Web框架,适合小型项目和微服务。文章从环境准备、创建基本Flask应用、定义资源和路由、请求和响应处理、错误处理等方面进行了详细说明,并提供了示例代码。通过这些步骤,读者可以快速上手构建自己的RESTful API。
63 2
|
1月前
|
Web App开发 API Windows
取接口访问者信息[IP,浏览器,操作系统]免费API接口教程
此API用于获取访问者的IP地址、浏览器和操作系统信息,支持70多种浏览器和操作系统。通过POST或GET请求至`https://cn.apihz.cn/api/ip/getapi.php`,需提供用户ID和KEY。返回结果包括状态码、消息、IP、浏览器和操作系统信息。示例:{&quot;code&quot;:200,&quot;ip&quot;:&quot;175.154.88.178&quot;,&quot;browser&quot;:&quot;Chrome&quot;,&quot;os&quot;:&quot;Windows 10&quot;}。详情见官网文档。
|
2月前
|
监控 负载均衡 API
Web、RESTful API 在微服务中有哪些作用?
在微服务架构中,Web 和 RESTful API 扮演着至关重要的角色。它们帮助实现服务之间的通信、数据交换和系统的可扩展性。
54 2
|
2月前
|
人工智能 搜索推荐 API
用于企业AI搜索的Bocha Web Search API,给LLM提供联网搜索能力和长文本上下文
博查Web Search API是由博查提供的企业级互联网网页搜索API接口,允许开发者通过编程访问博查搜索引擎的搜索结果和相关信息,实现在应用程序或网站中集成搜索功能。该API支持近亿级网页内容搜索,适用于各类AI应用、RAG应用和AI Agent智能体的开发,解决数据安全、价格高昂和内容合规等问题。通过注册博查开发者账户、获取API KEY并调用API,开发者可以轻松集成搜索功能。
下一篇
DataWorks