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/cache/match | |
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/cache/match')
-rw-r--r-- | files/zh-cn/web/api/cache/match/index.html | 173 |
1 files changed, 173 insertions, 0 deletions
diff --git a/files/zh-cn/web/api/cache/match/index.html b/files/zh-cn/web/api/cache/match/index.html new file mode 100644 index 0000000000..6670556654 --- /dev/null +++ b/files/zh-cn/web/api/cache/match/index.html @@ -0,0 +1,173 @@ +--- +title: Cache.match() +slug: Web/API/Cache/match +tags: + - Cache.match() + - ServiceWorker + - match + - 实验性的 +translation_of: Web/API/Cache/match +--- +<p>{{APIRef("Service Workers API")}}{{SeeCompatTable}}</p> + +<p>{{domxref("Cache")}} 接口的 <strong><code>match()</code></strong> 方法, 返回一个 {{jsxref("Promise")}} 解析为(resolve to)与 {{domxref("Cache")}} 对象中的第一个匹配请求相关联的{{domxref("Response")}} 。如果没有找到匹配,{{jsxref("Promise")}} 解析为 {{jsxref("undefined")}}。</p> + +<h2 id="语法">语法</h2> + +<pre class="brush: js notranslate">cache.match(request,{options}).then(function(response) { + //操作response +}); +</pre> + +<h3 id="返回值">返回值</h3> + +<p>一个 {{jsxref("Promise")}} 对象,该对象解析为第一个匹配请求的 {{domxref("Response")}} 对象,如果没有匹配到,则解析到 {{jsxref("undefined")}} 。</p> + +<div class="note"> +<p><strong>Note</strong>: <code>Cache.match()</code> 基本上和 {{domxref("Cache.matchAll()")}} 一样, 只不过 <code>Cache.match()</code> 只解析为 <code>response[0]</code> (第一个匹配的响应(response)对象) 而不是 <code>response[]</code> (所有响应对象组成的数组)。</p> +</div> + +<h3 id="参数">参数</h3> + +<dl> + <dt>request</dt> + <dd>在{{domxref("Cache")}}对象中查找的{{domxref("Request")}}对象对应的response。这个{{domxref("Request")}}可以是 object 或者是一个URL.</dd> + <dt>options {{optional_inline}}</dt> + <dd>一个为 <code>match</code> 操作设置选项的对象。有效的选项如下: + <ul> + <li><code>ignoreSearch</code>: 一个 {{domxref("Boolean")}} 值用来设置是否忽略url中的query部分。例如, 如果该参数设置为 <code>true</code> ,那么 <code>http://foo.com/?value=bar中的</code> <code>?value=bar</code> 部分就会在匹配中被忽略. 该选项默认为 <code>false</code>。</li> + <li><code>ignoreMethod</code>: 一个 {{domxref("Boolean")}} 值,如果设置为 <code>true</code>在匹配时就不会验证 {{domxref("Request")}} 对象的<code>http</code> 方法 (通常只允许是 <code>GET</code> 或 <code>HEAD</code> 。) 该参数默认值为 <code>false</code>。</li> + <li><code>ignoreVary</code>: 一个 {{domxref("Boolean")}} 值,该值如果为 <code>true</code> 则匹配时不进行 <code>VARY</code> 部分的匹配。例如,如果一个URL匹配,此时无论{{domxref("Response")}}对象是否包含<code>VARY</code>头部,都会认为是成功匹配。该参数默认为 <code>false</code>。</li> + <li><code>cacheName</code>: 一个 {{domxref("DOMString")}} ,代表一个具体的要被搜索的缓存。注意该选项被 <code>Cache.match()</code>方法忽略。</li> + </ul> + </dd> +</dl> + +<h2 id="例子" style="line-height: 30px; font-size: 2.14285714285714rem;">例子</h2> + +<p>这个是个来自 <a href="https://github.com/GoogleChrome/samples/blob/gh-pages/service-worker/custom-offline-page/service-worker.js">custom offline page</a> 的例子 (<a href="https://googlechrome.github.io/samples/service-worker/custom-offline-page/index.html">live demo</a>)。</p> + +<p>下面的例子在请求失败时提供特定的数据。 <code>catch()</code> 在 <code>fetch()</code> 的调用抛出异常时触发。在 <code>catch()</code> 语句中, <code>match()</code>用来返回正确的响应。</p> + +<p>在这个例子中,我们决定只缓存通过GET取得的HTML文档. <span style="line-height: 19.0909080505371px;">如果 <code>if()</code> 条件是 false,那么这个fetch处理器就不会处理这个请求。如果还有其他的fetch处理器被注册,它们将有机会调用 <code>event.respondWith()</code> 如果没有fetch处理器调用 <code>event.respondWith()</code> ,该请求就会像没有 service worker 介入一样由浏览器处理。如果 </span><code style="font-style: normal; line-height: 19.0909080505371px;">fetch()</code><span style="line-height: 19.0909080505371px;"> 返回了有效的HTTP响应,相应码是4xx或5xx,那么</span><code style="font-style: normal; line-height: 19.0909080505371px;">catch()</code><span style="line-height: 19.0909080505371px;"> 就<strong>不会</strong>被调用。</span></p> + +<pre class="brush: js notranslate">self.addEventListener('fetch', function(event) { + // 我们只想在用GET方法请求HTML文档时调用 event.respondWith()。 + if (event.request.method === 'GET' && + event.request.headers.get('accept').indexOf('text/html') !== -1) { + console.log('Handling fetch event for', event.request.url); + event.respondWith( + fetch(event.request).catch(function(e) { + console.error('Fetch failed; returning offline page instead.', e); + return caches.open(OFFLINE_CACHE).then(function(cache) { + return cache.match(OFFLINE_URL); + }); + }) + ); + } +});</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', '#cache', 'Cache')}}</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)}} [1]</td> + <td>{{CompatGeckoDesktop(39)}}<sup>[2]</sup></td> + <td>{{CompatNo}}</td> + <td>{{CompatOpera(24)}}</td> + <td>{{CompatNo}}</td> + </tr> + <tr> + <td>All options supported</td> + <td>{{CompatChrome(54.0)}}</td> + <td></td> + <td></td> + <td>{{CompatOpera(41)}}</td> + <td></td> + </tr> + </tbody> +</table> +</div> + +<div id="compat-mobile"> +<table class="compat-table"> + <tbody> + <tr> + <th>Feature</th> + <th>Android</th> + <th>Android Webview</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>{{CompatNo}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatGeckoMobile(39)}}</td> + <td>{{CompatUnknown}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatVersionUnknown}}</td> + <td>{{CompatNo}}</td> + <td>{{CompatChrome(40.0)}} [1]</td> + </tr> + <tr> + <td>All options supported</td> + <td>{{CompatNo}}</td> + <td>{{CompatNo}}</td> + <td></td> + <td></td> + <td></td> + <td>{{CompatOperaMobile(41)}}</td> + <td></td> + <td>{{CompatChrome(54.0)}}</td> + </tr> + </tbody> +</table> +</div> + +<ul> + <li>[1] The options parameter only supports <code>ignoreSearch</code>, and <code>cacheName</code>. </li> + <li>[2] 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 & 52 Extended Support Releases</a> (ESR.)</li> +</ul> + +<h2 id="参阅">参阅</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>{{domxref("Cache")}}</li> + <li>{{domxref("WorkerGlobalScope.caches")}}</li> +</ul> |