koa-framework

基于 Koa.js 的简单应用框架。

使用

const createApp = require('@luobotang/koa-framework')
const appRoot = __dirname
const appConfig = { /* log4js: { ... }, ... */ }

createApp(appRoot, appConfig).listen(8080, () => console.log('on 8080..'))

约定

创建应用时，koa-framework 在应用根目录下依次查找一下目录或文件并同步加载其中的模块：

• plugin 目录：扩展 app 对象，业务无关
• service 目录：全局服务，业务相关；按模块名称添加到 app.service 和 ctx.service
• middleware 目录：全局中间件；按模块名称添加到 app.middlewares
• interceptor 目录：特定路由拦截器；按模块名称添加到 app.interceptor
• controller 目录：路由处理；按模块名称添加到 app.controller
• router.js 文件：初始化应用路由

plugin 目录

示例（plugin/db.js）：

const mysql = require('mysql')

module.exports = (app) => {
  const pool = mysql.createPool(app.config.mysql)
  app.db = app.context.db = {
    async query(sql, params) {
      return new Promise((resolve, reject) => {
        pool.query(sql, params, (error, result) => {
          if (error) return reject(error)
          resolve(result)
        })
      })
    }
  }
}

service 目录

示例（service/user.js）：

module.exports = (app) => {
  return {
    async selectUserById(user_id) {
      return await app.db.query(`
        SELECT user_id, user_name, user_status FROM TB_USER WHERE user_id = ?
      `, [user_id])[0]
    }
  }
}

middleware 目录

示例（middleware/access.js）：

module.exports = (app) => {
  const logger = app.getFileLogger(__filename)
  return async (ctx, next) => {
    logger.info(ctx.method, ctx.path, ctx.ip)
    await next()
  }
}

interceptor 目录

示例（interceptor/log.js）：

modile.exports = (app) => {
  const logger = app.getFileLogger(__filename)
  return (action) => async (ctx, next) => {
    logger.info(action, ctx.query)
    await next()
  }
}

controller 目录

示例（controller/user.js）：

exports.byId = async (ctx) => {
  const { user_id } = ctx.query
  ctx.body = await ctx.service.user.selectUserById(user_id)
}

router.js 文件

示例：

module.exports = ({ router, middlewares, interceptor, controller }) => {
  router.use(middlewares.access)

  router.get('/user', interceptor.log('query-user'), controller.user.byId)
}

插件

插件通过 app.config.plugins 指定，指定的插件按顺序依次记载。

插件在 extend 之前加载。

API

• app
  • .root: 应用根目录
  • .config: 应用配置
  • .service
  • .interceptor
  • .interceptor
  • .middlewares
  • .controller
  • .router: koa-trie-router 路由实例，方法包括 router.use(...middleware)、router.get(path, ...middleware)、router.post(path, ...middleware) 等
  • .coreLogger
  • .loggers: 代理对象，app.loggers.xxx 等价于 app.getLogger('xxx')
  • .log(...args): 等价于 app.coreLogger.info(...args)
  • .getLogger(category)
  • .getFileLogger(__filename)
  • .require(moduleId): 加载 <app.root>/modules 目录下的模块，moduleId 为模块名称
  • .$load_dir(dirname, cb): 加载 <app.root>/<dirname> 目录下的所有模块
  • .$load_file(filename, cb): 加载 <app.root>/<filename> 文件，filename 必须以 .js 结尾
  • .$load_plugin(id): 加载 id 指定的模块，以插件方式初始化（require(id)(app)）
• ctx
  • .service
  • .loggers
  • .log(...args)
  • .getLogger(category)
  • .getFileLogger(__filename)