diff options
author | Peter Bengtsson <mail@peterbe.com> | 2020-12-08 14:40:17 -0500 |
---|---|---|
committer | Peter Bengtsson <mail@peterbe.com> | 2020-12-08 14:40:17 -0500 |
commit | 33058f2b292b3a581333bdfb21b8f671898c5060 (patch) | |
tree | 51c3e392513ec574331b2d3f85c394445ea803c6 /files/zh-cn/web/api/serviceworkercontainer | |
parent | 8b66d724f7caf0157093fb09cfec8fbd0c6ad50a (diff) | |
download | translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.tar.gz translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.tar.bz2 translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.zip |
initial commit
Diffstat (limited to 'files/zh-cn/web/api/serviceworkercontainer')
3 files changed, 350 insertions, 0 deletions
diff --git a/files/zh-cn/web/api/serviceworkercontainer/controller/index.html b/files/zh-cn/web/api/serviceworkercontainer/controller/index.html new file mode 100644 index 0000000000..349ba57586 --- /dev/null +++ b/files/zh-cn/web/api/serviceworkercontainer/controller/index.html @@ -0,0 +1,57 @@ +--- +title: ServiceWorkerContainer.controller +slug: Web/API/ServiceWorkerContainer/controller +translation_of: Web/API/ServiceWorkerContainer/controller +--- +<div>{{SeeCompatTable}}{{APIRef("Service Workers API")}}</div> + +<p><span class="seoSummary">当状态为<code>activated</code> 时, {{domxref("ServiceWorkerContainer")}} 接口的只读属性 <strong><code>controller</code></strong> 返回一个 {{domxref("ServiceWorker")}} 对象(与 {{domxref("ServiceWorkerRegistration.active")}} 返回的对象是同一个)。当页面强制刷新 (<em>Shift</em> + refresh) 或不存在active worder时,该属性返回 <code>null</code> 。</span></p> + +<h2 id="语法">语法</h2> + +<pre class="syntaxbox">var myController = navigator.serviceWorker.controller; +</pre> + +<h3 id="值">值</h3> + +<p>一个{{domxref("ServiceWorker")}}对象.</p> + +<h2 id="示例">示例</h2> + +<pre class="brush: js">if ('serviceWorker' in navigator) { + // Do a one-off check to see if a service worker's in control. + if (navigator.serviceWorker.controller) { + console.log('This page is currently controlled by:', + navigator.serviceWorker.controller); + } else { + console.log('This page is not currently controlled ' + + 'by a service worker.'); + } +} else { + console.log('Service workers are not supported.'); +}</pre> + +<h2 id="规范">规范</h2> + +<table class="standard-table"> + <tbody> + <tr> + <th scope="col">规范</th> + <th scope="col">状态</th> + <th scope="col">附注</th> + </tr> + <tr> + <td>{{SpecName('Service Workers', '#navigator-service-worker-controller', 'ServiceWorkerRegistration.controller')}}</td> + <td>{{Spec2('Service Workers')}}</td> + <td>Initial definition</td> + </tr> + </tbody> +</table> + +<h2 id="浏览器兼容性">浏览器兼容性</h2> + +<div> +<div class="hidden">此页面上的兼容性表从结构化数据生成。如果您想做出贡献,请查看 <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> 并发送拉取请求.</div> + +<p>{{Compat("api.ServiceWorkerContainer.controller")}}</p> +</div> diff --git a/files/zh-cn/web/api/serviceworkercontainer/index.html b/files/zh-cn/web/api/serviceworkercontainer/index.html new file mode 100644 index 0000000000..094ee798e2 --- /dev/null +++ b/files/zh-cn/web/api/serviceworkercontainer/index.html @@ -0,0 +1,161 @@ +--- +title: ServiceWorkerContainer +slug: Web/API/ServiceWorkerContainer +tags: + - API + - Draft + - Interface + - NeedsTranslation + - Offline + - Reference + - Service Workers + - ServiceWorkerContainer + - TopicStub + - Workers +translation_of: Web/API/ServiceWorkerContainer +--- +<p>{{SeeCompatTable}}{{APIRef("Service Workers API")}} </p> + +<p><code>ServiceWorkerContainer</code>接口为 service worker提供一个容器般的功能,包括对service worker的注册,卸载 ,更新和访问service worker的状态,以及他们的注册者</p> + +<p>主要是{{domxref("ServiceWorkerContainer.register", "ServiceWorkerContainer.register(scriptURL, scope[, base])")}}提供一个注册service worker的方法,{{domxref("ServiceWorkerContainer.controller")}}将获取当前控制页面网络的service worker</p> + +<h2 id="属性">?属性</h2> + +<dl> + <dt>{{domxref("ServiceWorkerContainer.controller")}} {{readonlyinline}}</dt> + <dd>当?{{domxref("ServiceWorker")}}对象的state是active的时候,返回一个 {{domxref("ServiceWorker")}} ?对象 和{{domxref("ServiceWorkerRegistration.active")}})返回相同的对象。 如果当前的state都不是active或者强制刷新浏览器则返回null。</dd> +</dl> + +<dl> + <dt>{{domxref("ServiceWorkerContainer.ready")}} {{readonlyinline}}</dt> + <dd>定义了一个serviceWorker是否准备好为一个页面服务,将返回一个 {{jsxref("Promise")}},并且这个 {{jsxref("Promise")}}永远不会 reject,这个 {{jsxref("Promise")}}会在{{domxref("ServiceWorkerRegistration")}} 获取到一个active的{{domxref("ServiceWorker")}}的时候被解决。</dd> + <dd> </dd> +</dl> + +<h3 id="事件">?事件</h3> + +<dl> + <dt>{{domxref("ServiceWorkerContainer.oncontrollerchange")}}</dt> + <dd>在{{domxref("ServiceWorkerRegistration")}}获取到一个新的active的{{domxref("ServiceWorker")}}对象的时候被触发</dd> + <dt>{{domxref("ServiceWorkerContainer.onerror")}}</dt> + <dd>当service workers中出现错误的时候被触发</dd> + <dt>{{domxref("ServiceWorkerContainer.onmessage")}}</dt> + <dd>当{{domxref("ServiceWorkerContainer")}} 对象接受到一个message消息的时候被触发,message由{{domxref("MessagePort.postMessage()")}}发出</dd> +</dl> + +<h2 id="方法">?方法</h2> + +<dl> + <dt>{{domxref("ServiceWorkerContainer.register", "ServiceWorkerContainer.register()")}} </dt> + <dd>创建或者更新一个{{domxref("ServiceWorkerRegistration")}} 用给定的<code>scriptURL</code></dd> + <dt>{{domxref("ServiceWorkerContainer.getRegistration()")}}</dt> + <dd>根据当前网页的URL与当前service worker的scope Url的匹配,返回一个 {{domxref("ServiceWorkerRegistration")}}对象,如果不能返回一个 {{domxref("ServiceWorkerRegistration")}},则返回一个{{jsxref("Promise")}}。</dd> + <dt>{{domxref("ServiceWorkerContainer.getRegistrations()")}}</dt> + <dd>返回所有的{{domxref("ServiceWorkerRegistration")}}对象,如果不能返回一个 {{domxref("ServiceWorkerRegistration")}},则返回一个{{jsxref("Promise")}}。</dd> +</dl> + +<h2 id="举例">?举例</h2> + +<p>?代码是<a href="https://github.com/GoogleChrome/samples/blob/gh-pages/service-worker/fallback-response/index.html#L126">service worker fallback-response sample</a> (see <a href="http://googlechrome.github.io/samples/service-worker/fallback-response/">fallback-response live</a>)的其中一段. ?首先检查浏览器是否支持serviceWorker. 代码创建了一个serviceWorker,并且打印出来当前页面的serviceWorker的?是否接管了页面的网络状态. 如果没有需要刷新页面再次查看. 代码也处理了注册失败的情况</p> + +<pre>if ('serviceWorker' in navigator) { + navigator.serviceWorker.register('service-worker.js', {scope: './'}).then(function() { + if (navigator.serviceWorker.controller) { + document.querySelector('#status').textContent = 'The service worker is currently handling network operations.'; + showRequestButtons(); + } else { + document.querySelector('#status').textContent = 'Please reload this page to allow the service worker to handle network operations.'; + } + }).catch(function(error) { + document.querySelector('#status').textContent = error; + }); +} else { + var aElement = document.createElement('a'); + aElement.href = 'http://www.chromium.org/blink/serviceworker/service-worker-faq'; + aElement.textContent = 'unavailable'; + document.querySelector('#status').appendChild(aElement); +}</pre> + +<h2 id="Specifications">Specifications</h2> + +<table> + <tbody> + <tr> + <th scope="col">Specification</th> + <th scope="col">Status</th> + <th scope="col">Comment</th> + </tr> + <tr> + <td>{{SpecName('Service Workers', '#service-worker-container', 'ServiceWorkerContainer')}}</td> + <td>{{Spec2('Service Workers')}}</td> + <td>Initial definition.</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility">Browser compatibility</h2> + +<p>{{CompatibilityTable}}</p> + +<table> + <tbody> + <tr> + <th>Feature</th> + <th>Chrome</th> + <th>Firefox (Gecko)</th> + <th>Internet Explorer</th> + <th>Opera</th> + <th>Safari (WebKit)</th> + </tr> + <tr> + <td>Basic support</td> + <td>{{CompatChrome(40.0)}}</td> + <td>{{ CompatGeckoDesktop("44.0") }}<sup>[1]</sup></td> + <td>{{CompatNo}}</td> + <td>24</td> + <td>{{CompatNo}}</td> + </tr> + </tbody> +</table> + +<table> + <tbody> + <tr> + <th>Feature</th> + <th>Android</th> + <th>Firefox Mobile (Gecko)</th> + <th>Firefox OS</th> + <th>IE Mobile</th> + <th>Opera Mobile</th> + <th>Safari Mobile</th> + <th>Chrome for Android</th> + </tr> + <tr> + <td>Basic support</td> + <td>{{CompatUnknown}}</td> + <td>{{ CompatGeckoMobile("44.0") }}</td> + <td>{{ CompatVersionUnknown }}</td> + <td>{{CompatNo}}</td> + <td>{{CompatUnknown}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatUnknown}}</td> + </tr> + </tbody> +</table> + +<p>[1] Service workers (and <a href="/en-US/docs/Web/API/Push_API">Push</a>) have been disabled in the <a href="https://www.mozilla.org/en-US/firefox/organizations/">Firefox 45 and 52 Extended Support Releases</a> (ESR.)</p> + +<h2 id="See_also">See also</h2> + +<ul> + <li><a href="https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorker_API/Using_Service_Workers">Using Service Workers</a></li> + <li><a href="https://github.com/mdn/sw-test">Service workers basic code example</a></li> + <li><a href="https://jakearchibald.github.io/isserviceworkerready/">Is ServiceWorker ready?</a></li> + <li>{{jsxref("Promise")}}</li> + <li><a href="https://developer.mozilla.org/en-US/docs/Web/Guide/Performance/Using_web_workers">Using web workers</a></li> +</ul> + +<ul> + <li> </li> +</ul> diff --git a/files/zh-cn/web/api/serviceworkercontainer/register/index.html b/files/zh-cn/web/api/serviceworkercontainer/register/index.html new file mode 100644 index 0000000000..67b4d1a9ef --- /dev/null +++ b/files/zh-cn/web/api/serviceworkercontainer/register/index.html @@ -0,0 +1,132 @@ +--- +title: ServiceWorkerContainer.register() +slug: Web/API/ServiceWorkerContainer/register +tags: + - ServiceWorkerContainer.register() +translation_of: Web/API/ServiceWorkerContainer/register +--- +<p>{{SeeCompatTable}}{{APIRef("Service Workers API")}}</p> + +<p>{{domxref("ServiceWorkerContainer")}} 接口的 <strong><code>register()<font face="Open Sans, Arial, sans-serif"> </font></code></strong>方法创建或更新一个给定scriptURL的<code><a href="https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration" title="The ServiceWorkerRegistion interface of the ServiceWorker API represents the service worker registration. You register a service worker to control one or more pages that share the same origin.">ServiceWorkerRegistration</a> </code>。</p> + +<p>如果成功,一个服务工作者注册将提供的脚本URL与一个范围进行关联,后者用于导航匹配。如果该方法无法返回一个 <code>ServiceWorkerRegistration</code>,则返回一个 <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" title="The Promise object is used for deferred and asynchronous computations. A Promise is in one of the three states:"><code>Promise</code></a>。</p> + +<p>您可以从受控页无条件调用此方法, 即, 您不需要首先检查是否有一个有效的注册。</p> + +<h2 id="语法">语法</h2> + +<pre class="brush: js">ServiceWorkerContainer.register(scriptURL, options) + .then( + function(ServiceWorkerRegistration) { + // do something + } +);</pre> + +<h3 id="参数">参数</h3> + +<dl> + <dt><code>scriptURL</code></dt> + <dd>service worker脚本的URL.</dd> + <dt><code>options</code> <code>{{optional_inline}}</code></dt> + <dd>注册时提供选项的配置对象。 目前可用的选项包括: + <ul> + <li><code>scope</code>: 一个 {{domxref("USVString")}},表示定义service worker注册范围的URL ;service worker可以控制的URL范围。通常是相对URL。默认值是基于当前的location,并以此来解析传入的路径.</li> + </ul> + </dd> +</dl> + +<h3 id="返回">返回</h3> + +<p>返回一个 {{domxref("Promise")}} 对象, 值是 {{domxref("ServiceWorkerRegistration")}} .</p> + +<h2 id="示例">示例</h2> + +<pre class="brush: js">if ('serviceWorker' in navigator) { + navigator.serviceWorker.register('service-worker.js', {scope: './'}) + .then(function(registration) { + document.querySelector('#status').textContent = 'succeeded'; + }).catch(function(error) { + document.querySelector('#status').textContent = error; + }); +} else { + // The current browser doesn't support service workers. + let aElement = document.createElement('a'); + aElement.href = ` + http://www.chromium.org/blink/serviceworker/service-worker-faq + `; + aElement.textContent = 'unavailable'; + document.querySelector('#status').appendChild(aElement); +}</pre> + +<h2 id="规范">规范</h2> + +<table class="standard-table"> + <tbody> + <tr> + <th scope="col">Specification</th> + <th scope="col">Status</th> + <th scope="col">Comment</th> + </tr> + <tr> + <td>{{SpecName('Service Workers', '#service-worker-container', 'ServiceWorkerContainer')}}</td> + <td>{{Spec2('Service Workers')}}</td> + <td>Initial definition.</td> + </tr> + </tbody> +</table> + +<h2 id="浏览器兼容性">浏览器兼容性</h2> + +<div>{{CompatibilityTable}}</div> + +<div id="compat-desktop"> +<table class="compat-table"> + <tbody> + <tr> + <th>Feature</th> + <th>Chrome</th> + <th>Firefox (Gecko)</th> + <th>Internet Explorer</th> + <th>Opera</th> + <th>Safari (WebKit)</th> + </tr> + <tr> + <td>Basic support</td> + <td>{{CompatChrome(40.0)}}</td> + <td>{{ CompatGeckoDesktop("44.0") }}<sup>[1]</sup></td> + <td>{{CompatNo}}</td> + <td>24</td> + <td>{{CompatNo}}</td> + </tr> + </tbody> +</table> +</div> + +<div id="compat-mobile"> +<table class="compat-table"> + <tbody> + <tr> + <th>Feature</th> + <th>Android</th> + <th>Firefox Mobile (Gecko)</th> + <th>Firefox OS</th> + <th>IE Mobile</th> + <th>Opera Mobile</th> + <th>Safari Mobile</th> + <th>Chrome for Android</th> + </tr> + <tr> + <td>Basic support</td> + <td>{{CompatUnknown}}</td> + <td>{{ CompatGeckoMobile("44.0") }}</td> + <td>{{ CompatVersionUnknown }}</td> + <td>{{CompatNo}}</td> + <td>{{CompatUnknown}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatChrome(40.0)}}</td> + </tr> + </tbody> +</table> +</div> + +<p>[1] Service workers (and <a href="/en-US/docs/Web/API/Push_API">Push</a>) have been disabled in the <a href="https://www.mozilla.org/en-US/firefox/organizations/">Firefox 45 Extended Support Release</a> (ESR.)</p> |