zan-proxy
Version:
617 lines (303 loc) • 22.8 kB
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="usage.html" />
<link rel="prev" href="./" />
</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="../configure/">
<a href="../configure/">
代理配置
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="../configure/host.html">
<a href="../configure/host.html">
Host管理
</a>
</li>
<li class="chapter " data-level="1.3.2" data-path="../configure/rule.html">
<a href="../configure/rule.html">
转发规则
</a>
</li>
<li class="chapter " data-level="1.3.3" data-path="../configure/project.html">
<a href="../configure/project.html">
工程路径
</a>
</li>
<li class="chapter " data-level="1.3.4" data-path="../configure/mock.html">
<a href="../configure/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="./">
<a href="./">
自定义插件
</a>
<ul class="articles">
<li class="chapter active" data-level="1.5.1" data-path="code.html">
<a href="code.html">
编写插件
</a>
</li>
<li class="chapter " data-level="1.5.2" data-path="usage.html">
<a href="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">
<!-- Title -->
<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>ZanProxy插件是是一个<strong>npm包</strong>，这个npm包需要导出一个类，这个类要实现两个方法：<code>proxy</code>和<code>manage</code>，<strong>除此之外没有任何特殊要求</strong>。 <code>proxy</code>方法用于请求的处理，<code>manage</code>方法用于插件的配置。</p>
<p>可以参考的例子：<a href="https://github.com/youzan/zan-proxy/tree/master/plugin-examples" target="_blank">点击这里</a>。</p>
<p><strong>注意</strong></p>
<p>写好ZanProxy插件包后需要发包，可以发布到私有仓库，添加时可以指定私有仓库的地址。</p>
<h2 id="proxy方法">proxy方法</h2>
<p>proxy方法需要返回一个ZanProxy<code>中间件</code>，该<code>中间件</code>会被加载到代理服务器中。</p>
<h3 id="中间件">中间件</h3>
<p>ZanProxy中间件是一个处理请求的函数，形如<code>async (ctx, next) => {...}</code>。其中<code>ctx</code>是请求的上下文，默认有两个属性<code>req</code>和<code>res</code>。</p>
<p><code>req</code>是一个<code>http.IncomingMessage</code>实例，代表着请求。如果<code>req.body</code>被赋值，则请求体的body会被替代。目前<code>req.body</code>只支持字符串类型。</p>
<p><code>res</code>是一个<code>http.ServerResponse</code>实例，代表着响应。如果<code>res.body</code>被赋值，则响应体的body会被替代，<em>且请求不会被转发</em>。<code>res.body</code></p>
<h4 id="添加access-control-allow-origin响应头的中间件的例子">添加Access-Control-Allow-Origin响应头的中间件的例子</h4>
<pre><code class="lang-javascript"> <span class="hljs-keyword">async</span> (ctx, next) => {
ctx.res.setHeader(<span class="hljs-string">'Access-Control-Allow-Origin'</span>, <span class="hljs-string">'*'</span>);
<span class="hljs-keyword">await</span> next()
}
</code></pre>
<h2 id="manage方法">manage方法</h2>
<p>manage方法需要返回一个Koa的App，该app会被挂载到ZanProxy管理服务器的<code>/plugins/{插件名}</code>路径，用于插件的可视化数据管理。该app可以有自己的http接口和静态资源。</p>
<h3 id="管理access-control-allow-origin响应头数据的manage例子">管理Access-Control-Allow-Origin响应头数据的manage例子</h3>
<pre><code class="lang-javascript"> manage() {
<span class="hljs-keyword">const</span> router = <span class="hljs-keyword">new</span> Router();
<span class="hljs-keyword">const</span> root = path.join(__dirname, <span class="hljs-string">'../ui/site/'</span>) <span class="hljs-comment">// 静态页面的路径</span>
router.post(<span class="hljs-string">'/save'</span>, <span class="hljs-keyword">async</span> ctx => {
<span class="hljs-keyword">const</span> cors = ctx.request.body.cors;
<span class="hljs-keyword">this</span>.cors = cors;
ctx.body = {
status: <span class="hljs-number">200</span>,
msg: <span class="hljs-string">'OK'</span>
}
})
router.get(<span class="hljs-string">'/cors'</span>, <span class="hljs-keyword">async</span> ctx => {
ctx.body = {
status: <span class="hljs-number">200</span>,
msg: <span class="hljs-string">'OK'</span>,
data: {
cors: <span class="hljs-keyword">this</span>.cors
}
}
})
<span class="hljs-keyword">const</span> app = <span class="hljs-keyword">new</span> Koa()
app
.use(bodyparser())
.use(router.routes())
.use(router.allowedMethods())
.use(KoaStatic(root))
<span class="hljs-keyword">return</span> app;
}
</code></pre>
<h2 id="完整的添加access-control-allow-origin响应头的插件的例子">完整的添加Access-Control-Allow-Origin响应头的插件的例子</h2>
<pre><code class="lang-javascript"> <span class="hljs-keyword">const</span> Router = <span class="hljs-built_in">require</span>(<span class="hljs-string">'koa-router'</span>);
<span class="hljs-keyword">const</span> KoaStatic = <span class="hljs-built_in">require</span>(<span class="hljs-string">'koa-static'</span>);
<span class="hljs-keyword">const</span> path = <span class="hljs-built_in">require</span>(<span class="hljs-string">'path'</span>);
<span class="hljs-keyword">const</span> bodyparser = <span class="hljs-built_in">require</span>(<span class="hljs-string">'koa-bodyparser'</span>);
<span class="hljs-keyword">const</span> Koa = <span class="hljs-built_in">require</span>(<span class="hljs-string">'koa'</span>);
<span class="hljs-built_in">module</span>.exports = <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">CorsPlugin</span> </span>{
<span class="hljs-keyword">constructor</span>() {
<span class="hljs-keyword">this</span>.cors = <span class="hljs-string">'*'</span>
}
manage() {
<span class="hljs-keyword">const</span> router = <span class="hljs-keyword">new</span> Router();
<span class="hljs-keyword">const</span> root = path.join(__dirname, <span class="hljs-string">'../ui/site/'</span>) <span class="hljs-comment">// 静态页面的路径</span>
router.post(<span class="hljs-string">'/save'</span>, <span class="hljs-keyword">async</span> ctx => {
<span class="hljs-keyword">const</span> cors = ctx.request.body.cors;
<span class="hljs-keyword">this</span>.cors = cors;
ctx.body = {
status: <span class="hljs-number">200</span>,
msg: <span class="hljs-string">'OK'</span>
}
})
router.get(<span class="hljs-string">'/cors'</span>, <span class="hljs-keyword">async</span> ctx => {
ctx.body = {
status: <span class="hljs-number">200</span>,
msg: <span class="hljs-string">'OK'</span>,
data: {
cors: <span class="hljs-keyword">this</span>.cors
}
}
})
<span class="hljs-keyword">const</span> app = <span class="hljs-keyword">new</span> Koa()
app
.use(bodyparser())
.use(router.routes())
.use(router.allowedMethods())
.use(KoaStatic(root))
<span class="hljs-keyword">return</span> app;
}
proxy() {
<span class="hljs-keyword">return</span> <span class="hljs-keyword">async</span> (ctx, next) => {
ctx.res.setHeader(<span class="hljs-string">'Access-Control-Allow-Origin'</span>, <span class="hljs-keyword">this</span>.cors || <span class="hljs-string">'*'</span>);
<span class="hljs-keyword">await</span> next()
}
}
}
</code></pre>
<p><img src="https://img.yzcdn.cn/public_files/2018/04/20/02a9d0f12242ef24cd81c30e504ed1fe.png"></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="./" class="navigation navigation-prev " aria-label="Previous page: 自定义插件">
<i class="fa fa-angle-left"></i>
</a>
<a href="usage.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.5.1","depth":2,"next":{"title":"使用插件","level":"1.5.2","depth":2,"path":"plugin/usage.md","ref":"plugin/usage.md","articles":[]},"previous":{"title":"自定义插件","level":"1.5","depth":1,"path":"plugin/README.md","ref":"plugin/README.md","articles":[{"title":"编写插件","level":"1.5.1","depth":2,"path":"plugin/code.md","ref":"plugin/code.md","articles":[]},{"title":"使用插件","level":"1.5.2","depth":2,"path":"plugin/usage.md","ref":"plugin/usage.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":"plugin/code.md","mtime":"2018-07-05T02:36:20.583Z","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>