path: root/files/zh-cn/mozilla/add-ons/webextensions/match_patterns/index.html

---
title: 匹配模式
slug: Mozilla/Add-ons/WebExtensions/Match_patterns
tags:
  - Match_patterns
  - URIs
  - urls
translation_of: Mozilla/Add-ons/WebExtensions/Match_patterns
---
<div>{{AddonSidebar}}</div>

<p>匹配模式是一种指定网址组的方法：: 一个匹配模式匹配特定的一组URL。 它们由WebExtensions 在几个地方使用，最明显的是指定要将<a href="/zh-CN/docs/Mozilla/Add-ons/WebExtensions/Content_scripts">内容脚本</a>加载到哪些文档中，并指定要向其中添加 <a href="/zh-CN/docs/Mozilla/Add-ons/WebExtensions/API/webRequest">webRequest </a>侦听器的URL。</p>

<p>使用匹配模板的API通常接收一个匹配模板的列表，当URL匹配任何模式时会恰当的运行. 看个例子 在manifest.json中的 <code><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/content_scripts">content_scripts</a></code> 关键字。</p>

<h2 id="匹配模式结构">匹配模式结构</h2>

<p>所有的匹配模式用一个字符串来定义，而且都是<a href="/en-US/Add-ons/WebExtensions/Match_patterns#%3Call_urls%3E">"&lt;all_urls&gt;"</a> 模板的一部份， 匹配模板包含三个部分: <em>scheme</em>, <em>host</em>, 和 <em>path</em>.  scheme  host 用 "://" 分隔。</p>

<pre>&lt;scheme&gt;://&lt;host&gt;&lt;path&gt;</pre>

<h3 id="方案">方案</h3>

<p> <em>scheme</em>  可能以下两种格式之一:</p>

<table class="fullwidth-table standard-table">
 <thead>
  <tr>
   <th scope="col" style="width: 50%;">Form</th>
   <th scope="col">Matches</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td>"*"</td>
   <td>Only "http" and "https".</td>
  </tr>
  <tr>
   <td>One of "http", "https", "file", "ftp", "app".</td>
   <td>Only the given scheme.</td>
  </tr>
 </tbody>
</table>

<h3 id="主机">主机</h3>

<p> <em>host </em>组件可以采取三种形式之一：:</p>

<table class="fullwidth-table standard-table">
 <thead>
  <tr>
   <th scope="col" style="width: 50%;">Form</th>
   <th scope="col">Matches</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td>"*"</td>
   <td>Any host.</td>
  </tr>
  <tr>
   <td>"*." followed by part of the hostname.</td>
   <td>The given host and any of its subdomains.</td>
  </tr>
  <tr>
   <td>A complete hostname, without wildcards.</td>
   <td>Only the given host.</td>
  </tr>
 </tbody>
</table>

<p>只有当 <em>scheme</em> 是 "file" 是 <em>host</em> 可选的</p>

<p>值得注意的是通配符可能只会在开头显示。</p>

<h3 id="路径">路径</h3>

<p><em>path </em>组件必须以“/”开头。</p>

<p>之后，它可能随后包含“*”通配符和网址路径中允许的任何字符的任意组合。 与 <em>host </em>不同， <em>path </em>组件可能在中间或末尾包含“*”通配符，并且“*”通配符可以多次出现。</p>

<h3 id="&lt;all_urls>">&lt;all_urls&gt;</h3>

<p>特殊值“&lt;all_urls&gt;”匹配任何受支持方案下的所有URL：即, "http", "https", "file", "ftp", "app"。</p>

<h2 id="范例">范例</h2>

<table class="fullwidth-table standard-table">
 <thead>
  <tr>
   <th scope="col" style="width: 33%;">Pattern</th>
   <th scope="col" style="width: 33%;">Example matches</th>
   <th scope="col" style="width: 33%;">Example non-matches</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td>
    <p><code>&lt;all_urls&gt;</code></p>

    <p>Match all URLs.</p>
   </td>
   <td>
    <p><code>http://example.org/</code></p>

    <p><code>ftp://files.somewhere.org/</code></p>

    <p><code>https://a.org/some/path/</code></p>
   </td>
   <td>
    <p><code>resource://a/b/c/</code><br>
     (unsupported scheme)</p>
   </td>
  </tr>
  <tr>
   <td>
    <p><code>*://*.mozilla.org/*</code></p>

    <p>Match all HTTP and HTTPS URLs that are hosted at "mozilla.org" or one of its subdomains.</p>
   </td>
   <td>
    <p><code>http://mozilla.org/</code></p>

    <p><code>https://mozilla.org/</code></p>

    <p><code>http://a.mozilla.org/</code></p>

    <p><code>http://a.b.mozilla.org/</code></p>

    <p><code>https://b.mozilla.org/path/</code></p>
   </td>
   <td>
    <p><code>ftp://mozilla.org/</code><br>
     (unmatched scheme)</p>

    <p><code>http://mozilla.com/</code><br>
     (unmatched host)</p>

    <p><code>http://firefox.org/</code><br>
     (unmatched host)</p>
   </td>
  </tr>
  <tr>
   <td>
    <p><code>*://mozilla.org/</code></p>

    <p>Match all HTTP and HTTPS URLs that are hosted at exactly "mozilla.org/".</p>
   </td>
   <td>
    <p><code>http://mozilla.org/</code></p>

    <p><code>https://mozilla.org/</code></p>
   </td>
   <td>
    <p><code>ftp://mozilla.org/</code><br>
     (unmatched scheme)</p>

    <p><code>http://a.mozilla.org/</code><br>
     (unmatched host)</p>

    <p><code>http://mozilla.org/a</code><br>
     (unmatched path)</p>
   </td>
  </tr>
  <tr>
   <td>
    <p><code>ftp://mozilla.org/</code></p>

    <p>Match only "ftp://mozilla.org/".</p>
   </td>
   <td><code>ftp://mozilla.org</code></td>
   <td>
    <p><code>http://mozilla.org/</code><br>
     (unmatched scheme)</p>

    <p><code>ftp://sub.mozilla.org/</code><br>
     (unmatched host)</p>

    <p><code>ftp://mozilla.org/path</code><br>
     (unmatched path)</p>
   </td>
  </tr>
  <tr>
   <td>
    <p><code>https://*/path</code></p>

    <p>Match HTTPS URLs on any host, whose path is "path".</p>
   </td>
   <td>
    <p><code>https://mozilla.org/path</code></p>

    <p><code>https://a.mozilla.org/path</code></p>

    <p><code>https://something.com/path</code></p>
   </td>
   <td>
    <p><code>http://mozilla.org/path</code><br>
     (unmatched scheme)</p>

    <p><code>https://mozilla.org/path/</code><br>
     (unmatched path)</p>

    <p><code>https://mozilla.org/a</code><br>
     (unmatched path)</p>

    <p><code>https://mozilla.org/</code><br>
     (unmatched path)</p>
   </td>
  </tr>
  <tr>
   <td>
    <p><code>https://*/path/</code></p>

    <p>Match HTTPS URLs on any host, whose path is "path/".</p>
   </td>
   <td>
    <p><code>https://mozilla.org/path/</code></p>

    <p><code>https://a.mozilla.org/path/</code></p>

    <p><code>https://something.com/path</code>/</p>
   </td>
   <td>
    <p><code>http://mozilla.org/path/</code><br>
     (unmatched scheme)</p>

    <p><code>https://mozilla.org/path</code><br>
     (unmatched path)</p>

    <p><code>https://mozilla.org/a</code><br>
     (unmatched path)</p>

    <p><code>https://mozilla.org/</code><br>
     (unmatched path)</p>
   </td>
  </tr>
  <tr>
   <td>
    <p><code>https://mozilla.org/*</code></p>

    <p>Match HTTPS URLs only at "mozilla.org", with any path.</p>
   </td>
   <td>
    <p><code>https://mozilla.org/</code></p>

    <p><code>https://mozilla.org/path</code></p>

    <p><code>https://mozilla.org/another</code></p>

    <p><code>https://mozilla.org/path/to/doc</code></p>
   </td>
   <td>
    <p><code>http://mozilla.org/path</code><br>
     (unmatched scheme)</p>

    <p><code>https://mozilla.com/path</code><br>
     (unmatched host)</p>
   </td>
  </tr>
  <tr>
   <td>
    <p><code>https://mozilla.org/a/b/c/</code></p>

    <p>Match only this URL.</p>
   </td>
   <td><code>https://mozilla.org/a/b/c/</code></td>
   <td>Anything else.</td>
  </tr>
  <tr>
   <td>
    <p><code>https://mozilla.org/*/b/*/</code></p>

    <p>Match HTTPS URLs hosted on "mozilla.org", whose path contains a component "b" somewhere in the middle.</p>
   </td>
   <td>
    <p><code>https://mozilla.org/a/b/c/</code></p>

    <p><code>https://mozilla.org/d/b/f/</code></p>

    <p><code>https://mozilla.org/a/b/c/d/</code></p>
   </td>
   <td>
    <p><code>https://mozilla.org/b/*/</code><br>
     (unmatched path)</p>

    <p><code>https://mozilla.org/a/b/</code><br>
     (unmatched path)</p>
   </td>
  </tr>
  <tr>
   <td>
    <p><code>file:///blah/*</code></p>

    <p>Match any FILE URL whose path begins with "blah".</p>
   </td>
   <td>
    <p><code>file:///blah/</code></p>

    <p><code>file:///blah/bleh</code></p>
   </td>
   <td><code>file:///bleh/</code><br>
    (unmatched path)</td>
  </tr>
 </tbody>
</table>

<h3 id="无效匹配模式">无效匹配模式</h3>

<table class="fullwidth-table standard-table">
 <thead>
  <tr>
   <th scope="col">Invalid pattern</th>
   <th scope="col">Reason</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td><code>resource://path/</code></td>
   <td>Unsupported scheme.</td>
  </tr>
  <tr>
   <td><code>https://mozilla.org</code></td>
   <td>No path.</td>
  </tr>
  <tr>
   <td><code>https://mozilla.*.org/</code></td>
   <td>"*" in host must be at the start.</td>
  </tr>
  <tr>
   <td><code>https://*zilla.org/</code></td>
   <td>"*" in host must by the only character or be followed by ".".</td>
  </tr>
  <tr>
   <td><code>http*://mozilla.org/</code></td>
   <td>"*" in scheme must be the only character.</td>
  </tr>
  <tr>
   <td><code>file://*</code></td>
   <td>Empty path: this should be "<code>file:///*</code>".</td>
  </tr>
 </tbody>
</table>

<h2 id="测试匹配模式">测试匹配模式</h2>

<p>当制作扩展时你通常不会跟直接使用匹配模板: 通常你讲一个匹配模式传递给API，然后API构造一个匹配模式并且使用他来测试url。不过如果你正在尝试哪一种匹配模式可以被使用，或者调试一个匹配问题，那么直接创建和测试匹配模板的能力将变得有用，这个模块将解释如何做到这点。</p>

<p>首先，打开开发者工具设置，并且检查 "Enable browser chrome and add-on debugging toolboxes" 被打开:</p>

<p>{{EmbedYouTube("JDEe2fyFpHE")}}</p>

<p>然后打开 "Browser Console":</p>

<p>{{EmbedYouTube("mfuBMje6dA4")}}</p>

<p>它给了你一个命令行以使你可以执行一些特权javascript代码。</p>

<div class="warning">
<p>因为运行在浏览器控制台的代码拥有系统特权，在任何时候都请你小心理解你的代码做了什么</p>
</div>

<p>现在粘贴以下代码到命令行然后按下 <kbd>enter</kbd>:</p>

<pre class="brush: js">Cu.import("resource://gre/modules/MatchPattern.jsm");
Cu.import("resource://gre/modules/BrowserUtils.jsm");</pre>

<p>这做了两件事:</p>

<ul>
 <li>导入 "MatchPattern.jsm": 这是实现了匹配模板的系统模块，特别的，这个模块包含了 <code>MatchPattern</code> 对象. <code>MatchPattern</code> 对象定义了一个 <code>matches()</code> 方法, 他需要一个URL然后返回 <code>true</code> 或者 <code>false</code>.</li>
 <li>导入 "BrowserUtils.jsm": 包含了一个方法 <code>makeURI()</code>, 他转换一个字符串为一个 <code><a href="/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIURI">nsIURI</a></code> 对象. <code>nsIURI</code> 是 <code>matches()</code> 方法需要接受的一个参数。</li>
</ul>

<p>现在你可以构造MatchPattern对象，构造URIs，并检查URIs 是否匹配：</p>

<pre class="brush: js">var match = new MatchPattern("*://mozilla.org/");

var uri = BrowserUtils.makeURI("https://mozilla.org/");
match.matches(uri); //        &lt; true

uri = BrowserUtils.makeURI("https://mozilla.org/path");
match.matches(uri); //        &lt; false</pre>

<p> </p>