| <!doctype html> |
| <html lang="zh" dir="ltr"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta name="generator" content="Docusaurus v2.0.0-beta.4"> |
| <link rel="alternate" type="application/rss+xml" href="/zh/blog/rss.xml" title="Apache ShenYu Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/zh/blog/atom.xml" title="Apache ShenYu Blog Atom Feed"> |
| <link rel="search" type="application/opensearchdescription+xml" title="Apache ShenYu" href="/zh/opensearch.xml"> |
| <link rel="alternate" type="application/rss+xml" href="/zh/news/rss.xml" title="Apache ShenYu Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/zh/news/atom.xml" title="Apache ShenYu Blog Atom Feed"><title data-react-helmet="true">选择器和规则管理 | Apache ShenYu</title><meta data-react-helmet="true" property="og:url" content="https://shenyu.apache.org//zh/docs/next/user-guide/admin-usage/selector-and-rule"><meta data-react-helmet="true" name="docsearch:language" content="zh"><meta data-react-helmet="true" name="docsearch:version" content="current"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="选择器和规则管理 | Apache ShenYu"><meta data-react-helmet="true" name="description" content="选择器和规则管理"><meta data-react-helmet="true" property="og:description" content="选择器和规则管理"><meta data-react-helmet="true" name="keywords" content="选择器,规则"><link data-react-helmet="true" rel="shortcut icon" href="/zh/img/favicon.svg"><link data-react-helmet="true" rel="canonical" href="https://shenyu.apache.org//zh/docs/next/user-guide/admin-usage/selector-and-rule"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//docs/next/user-guide/admin-usage/selector-and-rule" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//zh/docs/next/user-guide/admin-usage/selector-and-rule" hreflang="zh"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//docs/next/user-guide/admin-usage/selector-and-rule" hreflang="x-default"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/zh/assets/css/styles.b6f9a199.css"> |
| <link rel="preload" href="/zh/assets/js/runtime~main.5fb8cba9.js" as="script"> |
| <link rel="preload" href="/zh/assets/js/main.7e01774b.js" as="script"> |
| </head> |
| <body> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> |
| <div><a href="#" class="skipToContent_OuoZ">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/zh/"><img src="/zh/img/logo.svg" alt="Apache ShenYu Logo" class="themedImage_TMUO themedImage--light_4Vu1 navbar__logo"><img src="/zh/img/logo-light.svg" alt="Apache ShenYu Logo" class="themedImage_TMUO themedImage--dark_uzRr navbar__logo"></a></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/zh/download">下载</a><a class="navbar__item navbar__link" href="/zh/document">文档</a><a class="navbar__item navbar__link" href="/zh/community/contributor-guide">社区</a><a class="navbar__item navbar__link" href="/zh/team">团队</a><a class="navbar__item navbar__link" href="/zh/event">事件</a><a class="navbar__item navbar__link" href="/zh/news">新闻</a><a class="navbar__item navbar__link" href="/zh/blog">博客</a><a class="navbar__item navbar__link" href="/zh/users">用户</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__item navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://www.apache.org/foundation/policies/privacy.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div><a href="https://github.com/apache/shenyu" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" class="navbar__item navbar__link"><span><svg t="1631348384596" class="icon" viewBox="0 0 1024 1024" version="1.1" style="vertical-align:text-bottom;margin-right:5px" p-id="557" width="20" height="20"><path d="M547.797333 638.208l-104.405333-103.168 1.237333-1.28a720.170667 720.170667 0 0 0 152.490667-268.373333h120.448V183.082667h-287.744V100.906667H347.605333v82.218666H59.818667V265.386667h459.178666a648.234667 648.234667 0 0 1-130.304 219.946666 643.242667 643.242667 0 0 1-94.976-137.728H211.541333a722.048 722.048 0 0 0 122.453334 187.434667l-209.194667 206.378667 58.368 58.368 205.525333-205.525334 127.872 127.829334 31.232-83.84m231.424-208.426667h-82.218666l-184.96 493.312h82.218666l46.037334-123.306667h195.242666l46.464 123.306667h82.218667l-185.002667-493.312m-107.690666 287.744l66.56-178.005333 66.602666 178.005333z" fill="currentColor" p-id="558"></path></svg><span>简体中文</span></span></a><ul class="dropdown__menu"><li><a href="/docs/next/user-guide/admin-usage/selector-and-rule" target="_self" rel="noopener noreferrer" class="dropdown__link" style="text-transform:capitalize">English</a></li><li><a href="/zh/docs/next/user-guide/admin-usage/selector-and-rule" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" style="text-transform:capitalize">简体中文</a></li></ul></div><div class="react-toggle toggle_2i4l react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_iYfV">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_iYfV">🌞</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div><div class="searchBox_Bc3W"><button type="button" class="DocSearch DocSearch-Button" aria-label="搜索"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">搜索</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_lDyR"><button class="clean-btn backToTopButton_i9tI" type="button" title="Scroll to top"><svg viewBox="0 0 24 24" width="28"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z" fill="currentColor"></path></svg></button><aside class="docSidebarContainer_0YBq"><div class="sidebar_a3j0"><nav class="menu thin-scrollbar menu_cyFh menuWithAnnouncementBar_+O1J"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/zh/docs/next/index">Apache ShenYu 介绍</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">设计文档</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">运维部署</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">快速开始</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#">用户指南</a><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#" tabindex="0">Admin使用</a><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/zh/docs/next/user-guide/admin-usage/api-document">API文档管理</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/zh/docs/next/user-guide/admin-usage/data-permission">数据权限管理</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/zh/docs/next/user-guide/admin-usage/dictionary-management">字典管理</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/zh/docs/next/user-guide/admin-usage/plugin-handle-explanation">插件配置</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/zh/docs/next/user-guide/admin-usage/role-management">用户资源管理</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/zh/docs/next/user-guide/admin-usage/selector-and-rule">选择器和规则管理</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">属性配置</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Shenyu-Sdk Usage</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Discovery</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">快速接入</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Kubernetes Controller</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">API Document Aggregation</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">插件集合</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">开发者文档</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">基准测试</a></li></ul></nav></div></aside><main class="docMainContainer_r8cw"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_zHA2"><div class="alert alert--warning margin-bottom--md" role="alert"><div>This is unreleased documentation for Apache ShenYu <b>当前版本</b> version.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/zh/docs/user-guide/admin-usage/selector-and-rule">latest version</a></b> (2.6.1).</div></div><div class="docItemContainer_oiyr"><article><span class="badge badge--secondary">Version: 当前版本</span><div class="tocCollapsible_aw-L tocMobile_Tx6Y"><button type="button" class="clean-btn tocCollapsibleButton_zr6a">On this page</button></div><div class="markdown"><header><h1 class="h1Heading_dC7a">选择器和规则管理</h1></header><p>本文档将介绍<code>Apache ShenYu</code>后台管理系统中选择器和规则的使用，关于选择器和规则的概念及设计请参考 <a href="/zh/docs/next/design/flow-control">流量控制</a>。</p><p>请参考运维部署的内容，选择一种方式启动<code>shenyu-admin</code>。比如，通过 <a href="/zh/docs/next/deployment/deployment-local">本地部署</a> 启动<code>Apache ShenYu</code>后台管理系统。 启动成功后，可以直接访问 <code>http://localhost:9095</code> ，默认用户名和密码分别为: <code>admin</code> 和 <code>123456</code>。</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="选择器"></a>选择器<a class="hash-link" href="#选择器" title="Direct link to heading">#</a></h2><p>在插件列表中展示了当前的所有插件，可以给每个插件添加选择器和规则：</p><p><img src="/zh/assets/images/selector_example-83c08aae1fc1ced7477b97844480022c.png"></p><p>例如，给<code>divide</code>插件添加选择器：</p><p><img src="/zh/assets/images/selector_add-c4666ca1ce45ccaad4b5bf76c10af906.png"></p><ul><li><p>选择器详解：</p><ul><li>名称：给选择器取一个名字。</li><li>类型：自定义流量(<code>custom flow</code>) 或 全流量(<code>full flow</code>)。自定义流量就是请求会走下面的匹配方式与条件。全流量则不走。</li><li>匹配方式：<code>and</code>或者 <code>or</code> 是指下面多个条件是按照 并(<code>and</code>) 还是 或(<code>or</code>) 的方式来组合。</li><li>条件：<ul><li><code>uri</code>：根据 <code>uri</code> 的方式来筛选流量，<code>match</code> 的方式支持模糊匹配（<code>/**</code>）</li><li><code>header</code>：根据请求头里面的字段来筛选流量。</li><li><code>query</code>：根据 <code>uri</code> 的查询条件来进行筛选流量。</li><li><code>ip</code>：根据请求的真实 <code>ip</code> 来筛选流量。</li><li><code>host</code>：根据请求的真实 <code>host</code> 来筛选流量。</li><li><code>post</code>：根据请求上下文获取参数，不建议使用。</li><li><code>cookie</code>：根据请求的 <code>cookie</code> 来筛选流量。</li><li><code>req_method</code>：根据请求的方式来筛选流量。</li><li>条件匹配：<ul><li><code>match</code>：模糊匹配，建议和<code>uri</code>条件搭配，支持 <code>restful</code> 风格的匹配。（<code>/test/**</code>）</li><li><code>=</code>：前后值相等，才能匹配。</li><li><code>regEx</code>：正则匹配，表示前面一个值去匹配后面的正则表达式。</li><li><code>contains</code>：请求包含指定的值，才能匹配。</li><li><code>TimeBefore</code>：指定时间之前。</li><li><code>TimeAfter</code>：指定时间之后。</li><li><code>exclude</code>： 是 <code>match</code> 方式的反选。</li><li><code>startsWith</code>：请求前缀等于指定的值，才能匹配。在特定场景下，可替换 <code>match</code> （如用<code>/test/</code>来替换<code>/test/**</code>）以获得更好的性能。</li><li><code>endsWith</code>：请求后缀等于指定的值，才能匹配。</li><li><code>pathPattern</code>：是 <code>match</code> 的优化版，性能比<code>match</code>更好，但是不支持将<code>**</code>写在path中间（如<code>/api/**/xxx</code>）。</li></ul></li></ul></li><li>继续后续选择器：后续选择器还是否执行。</li><li>是否开启：打开才会生效。</li><li>打印日志：打开时，当匹配上的时候，会打印匹配日志。</li><li>执行顺序：当多个选择器的时候，执行顺序小的优先执行，值越小优先级越高。</li><li>处理：即<code>handle</code>字段，在 <a href="/zh/docs/next/user-guide/admin-usage/plugin-handle-explanation">插件处理管理</a> 中进行设置。作用是：当请求流量匹配上该选择器时，做什么样的处理操作。 在选择器中，<code>handle</code>字段往往用来表示用户手动维护的服务实例列表，每条服务实例信息包含以下字段：<ul><li><code>host</code>：host地址</li><li><code>ip:port</code>：ip+port地址</li><li><code>protocol</code>：协议</li><li><code>weight</code>：服务实例的权重</li><li><code>warmupTime</code>：服务预热时间</li><li><code>startupTime</code>：服务开启时间</li><li><code>status</code>：true: 服务节点可用，false: 服务节点不可用</li></ul></li></ul></li></ul><blockquote><p><strong>注意</strong>：对于引入了服务发现模块的插件（如Divide插件、Grpc插件和WebSocket插件），选择器页面上不展示处理（即<code>handle</code>字段），而是通过<code>服务发现</code>标签页下的local模式来手动维护服务下游实例列表，详见<a href="/zh/docs/next/user-guide/discovery/discovery-mode">服务发现模块</a> 。</p></blockquote><ul><li>上述图片中表示: 当请求的 <code>uri</code> 前缀是 <code>/http</code>，会转发到 <code>127.0.0.1:8080</code> 这个服务上。</li><li>选择器建议：可以通过设置 <code>uri</code> 条件， <code>startsWith</code> 前缀（<code>/contextPath/</code>）匹配，进行第一道流量筛选。</li><li>选择器(同规则)模糊匹配条件规则：<ul><li><code>?</code> 匹配1个字符</li><li><code>*</code> 匹配0个或多个字符</li><li><code>**</code> 匹配0个或多个目录</li></ul></li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="规则"></a>规则<a class="hash-link" href="#规则" title="Direct link to heading">#</a></h2><p><img src="/zh/assets/images/rule_handle-c4290b99e8bfc5253308641ea4bf803a.png"></p><ul><li><p>当流量经过选择器匹配成功之后，会进入规则来进行最终的流量匹配。</p></li><li><p>规则是对流量最终执行逻辑的确认。</p></li><li><p>规则详解：</p><ul><li>名称：给规则取一个名字。</li><li>匹配方式：<code>and</code> 或者 <code>or</code> 是指下面多个条件的组合方式。</li><li>条件：<ul><li><code>uri</code>：根据 <code>uri</code> 的方式来筛选流量，<code>match</code> 的方式支持模糊匹配（<code>/**</code>）</li><li><code>header</code>：根据请求头里面的字段来筛选流量。</li><li><code>query</code>：根据 <code>uri</code> 的查询条件来进行筛选流量。</li><li><code>ip</code>：根据请求的真实 <code>ip</code> 来筛选流量。</li><li><code>host</code>：根据请求的真实 <code>host</code> 来筛选流量。</li><li><code>post</code>：不建议使用。</li><li><code>cookie</code>：根据请求的 <code>cookie</code> 来筛选流量。</li><li><code>req_method</code>：根据请求的 <code>req_method</code> 来筛选流量。</li><li>条件匹配：<ul><li><code>match</code>：模糊匹配，建议和<code>uri</code>条件搭配，支持 <code>restful</code> 风格的匹配。（<code>/test/**</code>）</li><li><code>=</code>：前后值相等，才能匹配。</li><li><code>regEx</code>：正则匹配，表示前面一个值去匹配后面的正则表达式。</li><li><code>contains</code>：请求包含指定的值，才能匹配。</li><li><code>TimeBefore</code>：指定时间之前。</li><li><code>TimeAfter</code>：指定时间之后。</li><li><code>exclude</code>： 是 <code>match</code> 方式的反选。</li><li><code>startsWith</code>：请求前缀等于指定的值，才能匹配。在特定场景下，可替换 <code>match</code> （如用<code>/test/</code>来替换<code>/test/**</code>）以获得更好的性能。</li><li><code>endsWith</code>：请求后缀等于指定的值，才能匹配。</li><li><code>pathPattern</code>：是 <code>match</code> 的优化版，性能比<code>match</code>更好，但是不支持将<code>**</code>写在path中间（如<code>/api/**/xxx</code>）。</li></ul></li></ul></li><li>是否开启：打开才会生效。</li><li>打印日志：打开时，当匹配上的时候，才会打印匹配日志。</li><li>执行顺序：当多个规则的时候，执行顺序小的优先执行。</li><li>处理：即<code>handle</code>字段，在 <a href="/zh/docs/next/user-guide/admin-usage/plugin-handle-explanation">插件处理管理</a> 中进行设置。每个插件的规则处理不一样，具体请查看每个对应插件的处理。</li></ul></li><li><p>上图表示：当 <code>uri</code> 等于 <code>/http/order/save</code> 的时候能够匹配上该规则，就会执行该规则中，负载策略是 <code>random</code>，重试次数是 <code>3</code> 等处理操作。</p></li><li><p>规则建议：可以<code>uri</code> 条件， <code>match</code> 最真实的<code>uri路径</code>，进行流量的最终筛选 。</p></li></ul><p>联合选择器，我们来表述一下：当一个请求的 <code>uri</code> 为 <code>/http/order/save</code>，会通过 <code>random</code> 的方式，转发到 <code>127.0.0.1:8080</code> 机器上。</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="匹配方式"></a>匹配方式<a class="hash-link" href="#匹配方式" title="Direct link to heading">#</a></h2><p>匹配方式是指在选择器或规则匹配时，多个条件之间的匹配方式，当前支持 <code>and</code> 和 <code>or</code>。</p><ul><li><p><code>and</code></p><p><code>and</code>表示多个条件同时满足才能匹配上选择器或规则。</p><p>下图中的示例表示，请求必须同时满足条件 <code>uri = /http/order/findById</code> 和 条件 <code>id = 100</code> 才能匹配上该条规则。</p><p>比如一个真实的请求 <code>http://localhost:9195/http/order/findById?id=100</code> 能够同时满足上述两个条件，所以可以匹配上该条规则。</p></li></ul><p><img src="/zh/assets/images/match-strategy-and-zh-10f996e238caa8b956024540ac565809.png"></p><ul><li><p><code>or</code></p><p><code>or</code>表示多个条件中满足一个就能匹配上选择器或规则。</p><p>下图中的示例表示，请求满足条件 <code>uri = /http/order/findById</code> 或者 条件 <code>id = 100</code> 就能匹配上该条规则。</p><p>比如一个真实的请求 <code>http://localhost:9195/http/order/findById?id=99</code> 能够满足上述第一个条件 <code>uri = /http/order/findById</code>，所以也可以匹配上该条规则。</p></li></ul><p><img src="/zh/assets/images/match-strategy-or-zh-235cf203decaac3bff7f9d4231c505ac.png"></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="条件参数"></a>条件参数<a class="hash-link" href="#条件参数" title="Direct link to heading">#</a></h2><p>对选择器和规则中的条件参数设置再次进行解释。假如下面是一个 <code>HTTP</code> 请求的请求头：</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI shell"><pre tabindex="0" class="prism-code language-shell codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">GET http://localhost:9195/http/order/findById?id</span><span class="token operator" style="color:#393A34">=</span><span class="token number" style="color:#36acaa">100</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain">Accept: application/json</span></span><span class="token-line" style="color:#393A34"><span class="token plain">Cookie: </span><span class="token assign-left variable" style="color:#36acaa">shenyu</span><span class="token operator" style="color:#393A34">=</span><span class="token plain">shenyu_cookie</span></span><span class="token-line" style="color:#393A34"><span class="token plain">MyHeader: custom-header</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><p>在<code>ShenYu</code>中可以通过设置不同的条件参数从请求信息中获取真实数据。</p><ul><li>如果条件参数是<code>uri</code>，那么获取到的真实数据是 <code>/http/order/findById</code>；</li><li>如果条件参数是<code>header</code>，字段名称是<code>MyHeader</code>，那么获取到的真实数据是 <code>custom-header</code>；</li><li>如果条件参数是<code>query</code>，字段名称是<code>id</code>，那么获取到的真实数据是 <code>100</code>；</li><li>如果条件参数是<code>ip</code>，那么获取到的真实数据 <code>0:0:0:0:0:0:0:1</code>；</li><li>如果条件参数是<code>host</code>，那么获取到的真实数据是 <code>0:0:0:0:0:0:0:1</code>；</li><li>如果条件参数是<code>post</code>，字段名称是<code>contextPath</code>，那么获取到的真实数据是 <code>/http</code>；</li><li>如果条件参数是<code>cookie</code>，字段名称是<code>shenyu</code>，那么获取到的真实数据是 <code>shenyu_cookie</code>；</li><li>如果条件参数是<code>req_method</code>，那么获取到的真实数据是 <code>GET</code>。</li></ul><ul><li><p><code>uri</code> （推荐）</p><ul><li><p><code>uri</code> 匹配是根据你请求路径中的 <code>uri</code> 来进行匹配，在接入网关的时候，前端几乎不用做任何更改。</p></li><li><p>当使用 <code>match</code> 方式匹配时候，同 <code>springmvc</code> 模糊匹配原理相同。</p></li><li><p>在选择器中，推荐使用 <code>uri</code> 中的前缀来进行匹配，而在规则中，则使用具体路径来进行匹配。</p></li><li><p>使用该匹配方式的时候，填写匹配字段的值，图中的示例是<code>/http/**</code>。</p></li></ul><p><img src="/zh/assets/images/parameter-data-uri-zh-46a99708699beeb342340338a49913d0.png"></p></li><li><p><code>header</code></p><ul><li><p><code>header</code> 是根据你的 <code>http</code> 请求头中的字段值来匹配。</p></li><li><p>使用该匹配方式的时候，需要填写字段名称和字段值，图中的示例分别是<code>MyHeader</code>和<code>custom-header</code>。</p></li></ul><p><img src="/zh/assets/images/parameter-data-header-zh-9709829d7af21e665bf146498b8ee922.png"></p></li><li><p><code>query</code></p><ul><li><p>这个是根据你的 <code>uri</code> 中的查询参数来进行匹配，比如 <code>/test?id=1</code>，那么可以选择该匹配方式。</p></li><li><p>使用该匹配方式的时候，需要填写字段名称和字段值，图中的示例分别是<code>id</code>和<code>1</code>。</p></li></ul><p><img src="/zh/assets/images/parameter-data-query-zh-b2b21dd7a65306ca4ea81d938f574c23.png"></p></li><li><p><code>ip</code></p><ul><li><p>这个是根据 <code>http</code> 调用方的 <code>ip</code> 来进行匹配。</p></li><li><p>尤其是在 <code>waf</code> 插件里面，如果发现一个 <code>ip</code>地址有攻击，可以新增一条匹配条件，填上该 <code>ip</code>，拒绝该 <code>ip</code> 的访问。</p></li><li><p>如果在 <code>Apache ShenYu</code> 前面使用了 <code>nginx</code> 代理，为了获取正确的 <code>ip</code>，可以参考 <a href="/zh/docs/next/developer/custom-parsing-ip-and-host">自定义解析IP与Host</a> 。</p></li><li><p>使用该匹配方式的时候，填写匹配字段的值，图中的示例是<code>192.168.236.75</code>。</p></li></ul><p><img src="/zh/assets/images/parameter-data-ip-zh-e93a7c18af803ed70186359443bc1525.png"></p></li></ul><ul><li><p><code>host</code></p><ul><li><p>这个是根据 <code>http</code> 调用方的 <code>host</code> 来进行匹配。</p></li><li><p>尤其是在 <code>waf</code> 插件里面，如果发现一个 <code>host</code> 地址有攻击，可以新增一条匹配条件，填上该 <code>host</code>，拒绝该 <code>host</code> 的访问。</p></li><li><p>如果在 <code>Apache ShenYu</code> 前面使用了 <code>nginx</code> 代理，为了获取正确的 <code>host</code>，可以参考 <a href="/zh/docs/next/developer/custom-parsing-ip-and-host">自定义解析IP与Host</a> 。</p></li><li><p>使用该匹配方式的时候，填写匹配字段的值，图中的示例是<code>localhost</code>。</p></li></ul><p><img src="/zh/assets/images/parameter-data-host-zh-c7823938a86c552856746b0e08a1fe14.png"></p></li><li><p><code>post</code></p><ul><li><p>从请求上下文（<code>org.apache.shenyu.plugin.api.context.ShenyuContext</code>）中获取条件参数，需要通过反射获取字段的值，不推荐使用此方式。</p></li><li><p>使用该匹配方式的时候，需要填写字段名称和字段值，图中的示例分别是<code>contextPath</code>和<code>/http</code>。</p></li></ul><p><img src="/zh/assets/images/parameter-data-post-zh-acf747bb43aff131b9f0c6e2ad15c02c.png"></p></li></ul><ul><li><p><code>cookie</code></p><ul><li><p>这个是根据 <code>http</code> 调用方的请求头中<code>Cookie</code>作为条件参数进行匹配。</p></li><li><p>使用该匹配方式的时候，需要填写字段名称和字段值，图中的示例分别是<code>shenyu</code>和<code>shenyu_cookie</code>。</p></li></ul><p><img src="/zh/assets/images/parameter-data-cookie-zh-e2d0a15cbec98f24084d464c7cac0d19.png"></p></li><li><p><code>req_method</code></p><ul><li><p>这个是根据 <code>http</code> 调用方的请求形式来进行匹配，比如<code>GET</code>、<code>POST</code>等。</p></li><li><p>使用该匹配方式的时候，填写匹配字段的值，图中的示例是<code>GET</code>。</p></li></ul><p><img src="/zh/assets/images/parameter-data-req_method-zh-e3469e3a3e4e1fdc3a96343ec2cc0db1.png"></p></li></ul><p>如果想更深入理解条件参数的获取，请阅读相关源码，包名是<code>org.apache.shenyu.plugin.base.condition.data</code>：</p><table><thead><tr><th align="left">条件参数</th><th align="left">源码类</th></tr></thead><tbody><tr><td align="left"><code>uri</code></td><td align="left"><code>URIParameterData</code></td></tr><tr><td align="left"><code>header</code></td><td align="left"><code>HeaderParameterData</code></td></tr><tr><td align="left"><code>query</code></td><td align="left"><code>QueryParameterData</code></td></tr><tr><td align="left"><code>ip</code></td><td align="left"><code>IpParameterData</code></td></tr><tr><td align="left"><code>host</code></td><td align="left"><code>HostParameterData</code></td></tr><tr><td align="left"><code>post</code></td><td align="left"><code>PostParameterData</code></td></tr><tr><td align="left"><code>cookie</code></td><td align="left"><code>CookieParameterData</code></td></tr><tr><td align="left"><code>req_method</code></td><td align="left"><code>RequestMethodParameterData</code></td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="条件匹配策略"></a>条件匹配策略<a class="hash-link" href="#条件匹配策略" title="Direct link to heading">#</a></h2><p>通过条件参数能够获取到请求的真实数据。真实数据如何匹配上选择器或规则预设的条件数据，是通过条件匹配策略来实现。</p><ul><li><p><code>match</code></p><p><code>match</code> 的方式支持模糊匹配（<code>/**</code>）。假如你的选择器条件设置如下，那么请求 <code>/http/order/findById</code> 就可以匹配上。</p><p><img src="/zh/assets/images/predicate-judge-match-zh-f1d580331000bd4c2cbc1a7b6f203e5e.png"></p></li><li><p><code>=</code></p><p><code>=</code> 的方式表示请求的真实数据和预设的条件数据相等。假如你的选择器条件设置如下：请求<code>uri</code>等于<code>/http/order/findById</code>，那么请求 <code>/http/order/findById?id=1</code> 就可以匹配上。</p><p><img src="/zh/assets/images/predicate-judge-equals-zh-ec24b42555dc145ceac61dc425497175.png"></p></li><li><p><code>regex</code></p><p><code>regex</code> 的方式表示请求的真实数据能够满足预设条件的正则表达式才能匹配成功。假如你的规则条件设置如下：请求参数中包含<code>id</code>，并且是3位数字。那么请求 <code>/http/order/findById?id=900</code> 就可以匹配上。</p><p><img src="/zh/assets/images/predicate-judge-regex-zh-5cf42a509fb0f12863c222b798b099c3.png"></p></li><li><p><code>contains</code></p><p><code>contains</code> 的方式表示请求的真实数据包含预设的条件数据。假如你的规则条件设置如下：请求<code>uri</code>中包含<code>findById</code>。那么请求 <code>/http/order/findById?id=1</code> 就可以匹配上。</p><p><img src="/zh/assets/images/predicate-judge-contains-zh-38132ad301724189cc6bd2ab4548a7d6.png"></p></li><li><p><code>TimeBefore</code></p><p><code>TimeBefore</code> 的方式表示请求时间在预设的条件时间之前才能匹配成功。假如你的规则条件设置如下：请求参数中包含<code>date</code>，并且<code>date</code>小于<code>2021-09-26 06:12:10</code>。那么请求 <code>/http/order/findById?id=100&date=2021-09-22 06:12:10</code> 就可以匹配上。</p><p><img src="/zh/assets/images/predicate-judge-timebefore-zh-b708a6a812ed3aec8a05dd3418995742.png"></p></li><li><p><code>TimeAfter</code></p><p><code>TimeAfter</code> 的方式表示请求时间在预设的条件时间之后才能匹配成功。假如你的规则条件设置如下：请求参数中包含<code>date</code>，并且<code>date</code>大于<code>2021-09-26 06:12:10</code>。那么请求 <code>/http/order/findById?id=100&date=2021-09-29 06:12:10</code> 就可以匹配上。</p><p><img src="/zh/assets/images/predicate-judge-timeafter-zh-f7b6af84e2c6e3debe202e3f43e0a871.png"></p></li><li><p><code>exclude</code></p><p><code>exclude</code> 的方式是 <code>match</code> 方式的反选，<code>match</code> 有的功能也都有，但是是匹配过滤。假如你的选择器条件设置如下，那么请求 <code>/http/order/findById</code> 就会过滤这个。</p><p><img src="/zh/assets/images/predicate-judge-exclude-zh-72b327ed83f00139fdcb03d28ae9bd24.png"></p></li><li><p><code>startsWith</code></p><p><code>startsWith</code> 的方式表示请求的真实数据的前缀和预设的条件数据相等。假如你的规则条件设置如下：请求<code>uri</code>中前缀等于<code>/http/</code>。那么请求 <code>/http/order/findById?id=1</code> 就可以匹配上。</p><p><img src="/zh/assets/images/predicate-judge-startswith-zh-ac50703963f7c72f29e89b82d1cf1ac9.png"></p></li><li><p><code>endsWith</code></p><p><code>endsWith</code> 的方式表示请求的真实数据的后缀和预设的条件数据相等。假如你的规则条件设置如下：请求<code>uri</code>中后缀等于<code>Id</code>。那么请求 <code>/http/order/findById?id=1</code> 就可以匹配上。</p><p><img src="/zh/assets/images/predicate-judge-endswith-zh-4a45bc3e458b36d9215bcdb20fe7c5d3.png"></p></li><li><p><code>pathPattern</code></p><p>跟 <code>match</code> 类似， <code>pathPattern</code> 支持模糊匹配（<code>/**</code>）。假如你的规则条件设置如下，那么请求 <code>/http/order/findById</code> 就可以匹配上；</p><p>但是注意：不支持将<code>**</code>写在path中间（如<code>/api/**/xxx</code>）!</p><p><img src="/zh/assets/images/predicate-judge-pathpattern-zh-1123d15b1604ceb9e11b0605f181715e.png"></p></li></ul><p>如果想更深入理解条件匹配策略，请阅读相关源码，包名是<code>org.apache.shenyu.plugin.base.condition.judge</code>：</p><table><thead><tr><th align="left">匹配策略</th><th align="left">源码类</th></tr></thead><tbody><tr><td align="left"><code>match</code></td><td align="left"><code>MatchPredicateJudge</code></td></tr><tr><td align="left"><code>=</code></td><td align="left"><code>EqualsPredicateJudge</code></td></tr><tr><td align="left"><code>regex</code></td><td align="left"><code>RegexPredicateJudge</code></td></tr><tr><td align="left"><code>contains</code></td><td align="left"><code>ContainsPredicateJudge</code></td></tr><tr><td align="left"><code>TimeBefore</code></td><td align="left"><code>TimerBeforePredicateJudge</code></td></tr><tr><td align="left"><code>TimeAfter</code></td><td align="left"><code>TimerAfterPredicateJudge</code></td></tr><tr><td align="left"><code>exclude</code></td><td align="left"><code>ExcludePredicateJudge</code></td></tr><tr><td align="left"><code>startsWith</code></td><td align="left"><code>StartsWithPredicateJudge</code></td></tr><tr><td align="left"><code>endsWith</code></td><td align="left"><code>EndsWithPredicateJudge</code></td></tr><tr><td align="left"><code>pathPattern</code></td><td align="left"><code>PathPatternPredicateJudge</code></td></tr></tbody></table><p>文中的示例是为了说明选择器和规则的使用，具体条件的设置需要根据实际情况选择。</p></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/apache/shenyu-website/edit/main/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/admin-usage/selector-and-rule.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_mS5F" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>编辑本文档</a></div><div class="col lastUpdated_wj+Z"></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/zh/docs/next/user-guide/admin-usage/role-management"><div class="pagination-nav__sublabel">上一篇</div><div class="pagination-nav__label">« 用户资源管理</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/zh/docs/next/user-guide/property-config/admin-property-config"><div class="pagination-nav__sublabel">下一篇</div><div class="pagination-nav__label">Admin属性配置 »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_vrFS thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#选择器" class="table-of-contents__link">选择器</a></li><li><a href="#规则" class="table-of-contents__link">规则</a></li><li><a href="#匹配方式" class="table-of-contents__link">匹配方式</a></li><li><a href="#条件参数" class="table-of-contents__link">条件参数</a></li><li><a href="#条件匹配策略" class="table-of-contents__link">条件匹配策略</a></li></ul></div></div></div></div></main></div></div></div> |
| <script src="/zh/assets/js/runtime~main.5fb8cba9.js"></script> |
| <script src="/zh/assets/js/main.7e01774b.js"></script> |
| </body> |
| </html> |
