编写插件

ZanProxy插件是是一个npm包，这个npm包需要导出一个类，这个类要实现两个方法：proxy和manage，除此之外没有任何特殊要求。 proxy方法用于请求的处理，manage方法用于插件的配置。

可以参考的例子：点击这里。

注意

写好ZanProxy插件包后需要发包，可以发布到私有仓库，添加时可以指定私有仓库的地址。

proxy方法

proxy方法需要返回一个ZanProxy中间件，该中间件会被加载到代理服务器中。

中间件

ZanProxy中间件是一个处理请求的函数，形如async (ctx, next) => {...}。其中ctx是请求的上下文，默认有两个属性req和res。

req是一个http.IncomingMessage实例，代表着请求。如果req.body被赋值，则请求体的body会被替代。目前req.body只支持字符串类型。

res是一个http.ServerResponse实例，代表着响应。如果res.body被赋值，则响应体的body会被替代，且请求不会被转发。res.body

添加Access-Control-Allow-Origin响应头的中间件的例子

    async (ctx, next) => {
        ctx.res.setHeader('Access-Control-Allow-Origin', '*');
        await next()
    }

manage方法

manage方法需要返回一个Koa的App，该app会被挂载到ZanProxy管理服务器的/plugins/{插件名}路径，用于插件的可视化数据管理。该app可以有自己的http接口和静态资源。

管理Access-Control-Allow-Origin响应头数据的manage例子

    manage() {
        const router = new Router();
        const root = path.join(__dirname, '../ui/site/') // 静态页面的路径
        router.post('/save', async ctx => {
            const cors = ctx.request.body.cors;
            this.cors = cors;
            ctx.body = {
                status: 200,
                msg: 'OK'
            }
        })
        router.get('/cors', async ctx => {
            ctx.body = {
                status: 200,
                msg: 'OK',
                data: {
                    cors: this.cors
                }
            }
        })
        const app = new Koa()
        app
            .use(bodyparser())
            .use(router.routes())
            .use(router.allowedMethods())
            .use(KoaStatic(root))
        return app;
    }

完整的添加Access-Control-Allow-Origin响应头的插件的例子

    const Router = require('koa-router');
    const KoaStatic = require('koa-static');
    const path = require('path');
    const bodyparser = require('koa-bodyparser');
    const Koa = require('koa');

    module.exports = class CorsPlugin {
        constructor() {
            this.cors = '*'
        }
        manage() {
            const router = new Router();
            const root = path.join(__dirname, '../ui/site/') // 静态页面的路径
            router.post('/save', async ctx => {
                const cors = ctx.request.body.cors;
                this.cors = cors;
                ctx.body = {
                    status: 200,
                    msg: 'OK'
                }
            })
            router.get('/cors', async ctx => {
                ctx.body = {
                    status: 200,
                    msg: 'OK',
                    data: {
                        cors: this.cors
                    }
                }
            })
            const app = new Koa()
            app
                .use(bodyparser())
                .use(router.routes())
                .use(router.allowedMethods())
                .use(KoaStatic(root))
            return app;
        }
        proxy() {
            return async (ctx, next) => {
                ctx.res.setHeader('Access-Control-Allow-Origin', this.cors || '*');
                await next()
            }
        }
    }