zan-proxy

<!DOCTYPE HTML> <html lang="" > <head> <meta charset="UTF-8"> <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> <title>转发规则 · ZanProxy</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta name="description" content=""> <meta name="generator" content="GitBook 3.2.3"> <link rel="stylesheet" href="../gitbook/style.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css"> <meta name="HandheldFriendly" content="true"/> <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> <meta name="apple-mobile-web-app-capable" content="yes"> <meta name="apple-mobile-web-app-status-bar-style" content="black"> <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png"> <link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon"> <link rel="next" href="project.html" /> <link rel="prev" href="host.html" /> </head> <body> <div class="book"> <div class="book-summary"> <div id="book-search-input" role="search"> <input type="text" placeholder="Type to search" /> </div> <nav role="navigation"> <ul class="summary"> <li class="chapter " data-level="1.1" data-path="../"> <a href="../"> 简介 </a> </li> <li class="chapter " data-level="1.2" data-path="../quick-start/"> <a href="../quick-start/"> 快速开始 </a> <ul class="articles"> <li class="chapter " data-level="1.2.1" data-path="../quick-start/pre-install.html"> <a href="../quick-start/pre-install.html"> 前置条件 </a> </li> <li class="chapter " data-level="1.2.2" data-path="../quick-start/install.html"> <a href="../quick-start/install.html"> 安装 </a> </li> <li class="chapter " data-level="1.2.3" data-path="../quick-start/launch.html"> <a href="../quick-start/launch.html"> 启动 </a> </li> <li class="chapter " data-level="1.2.4" data-path="../quick-start/cert.html"> <a href="../quick-start/cert.html"> 证书安装 </a> </li> </ul> </li> <li class="chapter " data-level="1.3" data-path="./"> <a href="./"> 代理配置 </a> <ul class="articles"> <li class="chapter " data-level="1.3.1" data-path="host.html"> <a href="host.html"> Host管理 </a> </li> <li class="chapter active" data-level="1.3.2" data-path="rule.html"> <a href="rule.html"> 转发规则 </a> </li> <li class="chapter " data-level="1.3.3" data-path="project.html"> <a href="project.html"> 工程路径 </a> </li> <li class="chapter " data-level="1.3.4" data-path="mock.html"> <a href="mock.html"> mock数据 </a> </li> </ul> </li> <li class="chapter " data-level="1.4" data-path="../usage/"> <a href="../usage/"> 使用代理 </a> <ul class="articles"> <li class="chapter " data-level="1.4.1" data-path="../usage/chrome.html"> <a href="../usage/chrome.html"> chrome代理配置 </a> </li> <li class="chapter " data-level="1.4.2" data-path="../usage/mobile.html"> <a href="../usage/mobile.html"> 手机代理设置 </a> </li> <li class="chapter " data-level="1.4.3" data-path="../usage/enable.html"> <a href="../usage/enable.html"> 规则启用/禁用 </a> </li> <li class="chapter " data-level="1.4.4" data-path="../usage/monitor.html"> <a href="../usage/monitor.html"> 请求监控 </a> </li> </ul> </li> <li class="chapter " data-level="1.5" data-path="../plugin/"> <a href="../plugin/"> 自定义插件 </a> <ul class="articles"> <li class="chapter " data-level="1.5.1" data-path="../plugin/code.html"> <a href="../plugin/code.html"> 编写插件 </a> </li> <li class="chapter " data-level="1.5.2" data-path="../plugin/usage.html"> <a href="../plugin/usage.html"> 使用插件 </a> </li> </ul> </li> <li class="chapter " data-level="1.6" data-path="../cooperation/"> <a href="../cooperation/"> 团队协作 </a> <ul class="articles"> <li class="chapter " data-level="1.6.1" data-path="../cooperation/remoteRule.html"> <a href="../cooperation/remoteRule.html"> 远程规则 </a> </li> </ul> </li> <li class="divider"></li> <li> <a href="https://www.gitbook.com" target="blank" class="gitbook-link"> Published with GitBook </a> </li> </ul> </nav> </div> <div class="book-body"> <div class="body-inner"> <div class="book-header" role="navigation">  <h1> <i class="fa fa-circle-o-notch fa-spin"></i> <a href=".." >转发规则</a> </h1> </div> <div class="page-wrapper" tabindex="-1" role="main"> <div class="page-inner"> <div id="book-search-results"> <div class="search-noresults"> <section class="normal markdown-section"> <h1 id="转发规则">转发规则</h1> <p>可点击管理页面主菜单上的<code>Http转发</code>进行转发规则的管理</p> <p><img src="https://img.yzcdn.cn/public_files/2018/04/18/fcf0f039bf43a67f4c37a458adfbcd59.png"></p> <p><img src="https://img.yzcdn.cn/public_files/2018/03/30/3a7f3c2c682180c496f2e748cf05851e.png"></p> <h2 id="规则导入">规则导入</h2> <p>可以导入远程规则、本地规则。方便团队之间共享规则文件。导入的<code>远程规则</code>会在服务器启动时自动同步。</p> <p><img src="https://img.yzcdn.cn/public_files/2018/04/18/3ec2a61d3f982109ccdabb5c5ada18ed.png"></p> <h2 id="规则导出">规则导出</h2> <p>将规则文件导出，可以放到服务器上，方便别人导入。 </p> <h2 id="规则配置">规则配置</h2> <p>ZanProxy中一个规则集可对应多个规则，每个规则集和每个规则都可单独配置是否生效。(如a规则在A规则集下，当A规则不生效时，无论a规则是否被勾选，都不生效)。 <img src="https://img.yzcdn.cn/public_files/2018/03/30/3a7f3c2c682180c496f2e748cf05851e.png"></p> <h2 id="规则编辑">规则编辑</h2> <p><img src="https://img.yzcdn.cn/public_files/2018/03/30/4e6849fa6536d5c067e7dfb8fe732c6b.png"></p> <h4 id="匹配过程">匹配过程</h4> <p>URL特征为该请求是否被ZanProxy所转发的主要判定方式。其判定规则如下：</p> <ol> <li><p>优先将URL特征当成一个字符去匹配所有请求，当某一请求的url中包含URL特征，则视为该请求符合该URL特征。</p> </li> <li><p>当规则1无法匹配时，将该URL特征实例化为一个正则表达式，再对所有请求进行匹配（RegExp.prototype.test方法）。</p> </li> </ol> <h2 id="请求动作">请求动作</h2> <p>请求动作会根据添加顺序依次执行</p> <h3 id="请求动作：转发请求">请求动作：转发请求</h3> <p>将请求转发到本地、或者另一个地址</p> <h3 id="请求动作：返回自定义数据">请求动作：返回自定义数据</h3> <p>将指定的数据文件返回给浏览器</p> <h3 id="请求动作：增加请求头">请求动作：增加请求头</h3> <p>增加请求的header，常见的如cookie、user-agent等</p> <h3 id="请求动作：增加响应头">请求动作：增加响应头</h3> <p>增加服务器响应的header，常见的如access-control-allow-origin</p> <h3 id="进阶">进阶</h3> <p>在使用正则写URL特征时，ZanProxy支持在处理类型的转发中写$占位符，用于替换为正则匹配后第N个获取组。</p> <h4 id="示例">示例</h4> <p>请求url为：<a href="https://b.yzcdn.cn/v2/build/wap/showcase/sku_58590c11af.js" target="_blank">https://b.yzcdn.cn/v2/build/wap/showcase/sku_58590c11af.js</a><br>要拦截的请求的url特征为：build/wap/(.<em>?)<em>[^</em>]</em>$<br>请求转发路径为：<%=wapproject%>/js/$1/main.js。<br>则最终请求路径中的$1将被替换为showcase/sku</p> <h4 id="特别注意">特别注意</h4> <p>在使用正则写URL特征时，ZanProxy在处理时会对完整的请求路径<strong>包括请求参数</strong>进行处理。</p> <p>请求url为：<a href="https://b.yzcdn.cn/v2/build/wap/showcase/sku_58590c11af.js?date=12345" target="_blank">https://b.yzcdn.cn/v2/build/wap/showcase/sku_58590c11af.js?date=12345</a></p> <p>要拦截的请求的url特征为：build/wap/(.*)</p> <p>请求转发路径为：/my/project/js/$1</p> <p>则最终实际的转发路径会是：/my/project/js/showcase/sku_58590c11af.js?date=12345</p> <p><strong>如需过滤请求参数，请使用正则进行过滤</strong>。上述例子可以把url特征改为：<code>build/wap/(.*)(?:\?.*)</code>, 这样实际的转发路径就会变成<code>/my/project/js/showcase/sku_58590c11af.js</code>，不再包含请求参数。</p> </section> </div> <div class="search-results"> <div class="has-results"> <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> </div> </div> </div> </div> </div> </div> <a href="host.html" class="navigation navigation-prev " aria-label="Previous page: Host管理"> <i class="fa fa-angle-left"></i> </a> <a href="project.html" class="navigation navigation-next " aria-label="Next page: 工程路径"> <i class="fa fa-angle-right"></i> </a> </div> <script> var gitbook = gitbook || []; gitbook.push(function() { gitbook.page.hasChanged({"page":{"title":"转发规则","level":"1.3.2","depth":2,"next":{"title":"工程路径","level":"1.3.3","depth":2,"path":"configure/project.md","ref":"configure/project.md","articles":[]},"previous":{"title":"Host管理","level":"1.3.1","depth":2,"path":"configure/host.md","ref":"configure/host.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":false,"twitter":false,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":[]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"ZanProxy","links":{"gitbook":false,"sharing":{"google":false,"facebook":false,"twitter":false,"all":false}},"gitbook":"*"},"file":{"path":"configure/rule.md","mtime":"2018-07-10T06:08:05.042Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-07-10T06:08:40.504Z"},"basePath":"..","book":{"language":""}}); }); </script> </div> <script src="../gitbook/gitbook.js"></script> <script src="../gitbook/theme.js"></script> <script src="../gitbook/gitbook-plugin-search/search-engine.js"></script> <script src="../gitbook/gitbook-plugin-search/search.js"></script> <script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script> <script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script> <script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script> <script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script> </body> </html>