skyconfig.js

// 这里存的是默认配置，使用该框架前，可以考虑把这里的配置拷贝出去，也可以只拷贝需要覆盖的配置。
const path = require('path')
module.exports = {
  /**
   * 项目名称，启动时，会以3D字体的形式在控制台打印
   * */

  name: 'skybase',

  /**
   * token 保存key值
   * */

  tokenName: 'skybase',

  /**
   * 入口文件的路径
   *
   * 如果不填，或者转为布尔值为false，则使用 process.mainModule.filename 的路径，即本node应用的入口文件
   * */

  rootDir: path.dirname(process.mainModule.filename),

  /**
   * api定义所在目录
   *
   * 如果 middlewares 中有 sky-api-register ，此项必填
   *
   * 填写相对于 rootDir 的相对路径
   * */

  apiDir: './model/api',

  /**
   * 控制器所在目录
   *
   * 如果 middlewares 中有 sky-api-register ，此项必填
   *
   * 填写相对于 rootDir 的相对路径
   * */

  routerDir: './router',

  /**
   * service所在目录
   *
   * 框架会自动加载service，并为每个service指定一个固定的错误码，当该service发生错误时，会打印该错误码
   * 如果不要该功能，把此配置设为空即可
   *
   * 填写相对于 rootDir 的相对路径
   * */

  serviceDir: '',

  /**
   * 是否打印日志
   * */

  logger: true,

  /**
   * 自定义中间件所在目录
   *
   * 如果要用中间件，除了把中间件放在这个目录下，还要在 middlewares 中填写中间件名称
   *
   * 填写相对于 rootDir 的相对路径
   * */

  middlewareDir: './middleware',

  /**
   * 静态服务的路径
   *
   * 如果 middlewares 中有 sky-static-server ，此项必填
   *
   * 填写相对于 rootDir 的相对路径
   * */

  staticDir: './www',

  /**
   * 中间件
   * ps. 填写中间件的文件名（如果不填文件后缀，则认为是.js），自定义的中间件一定要放在项目根目录的 middleware 文件夹里，不然找不到。
   * ps. 中间件的加载顺序就是按照这个数组的顺序来的
   * ps. 如果自定义的中间件和框架自带的中间件重名，则优先使用自定义的
   * ps. koa2对中间件的使用是根据洋葱圈模型来设计的，写中间件之前，建议先看这篇文章了解洋葱圈模型 https://eggjs.org/zh-cn/intro/egg-and-koa.html
   * ps. 一定要在中间件中使用next，否则后续的中间件将不会执行
   *
   * 框架自带的中间件：
   *  0 用户自定义中间件后，执行顺序，按照用户配置定，如果找不到，会从skybase/lib/middleware查找
   * cors --- 跨域允许
   * bodyParse --- 解析body，可以解析各种方式的body，甚至可以接收文件
   * staticServer --- 静态文件服务器，一般是开发环境需要，生产环境的前端一般不会让后端代理
   * koaLogger --- 使用koa-logger，功能太少，现在已经不用它了，改用孔哥自制的
   * checkParam --- 检查参数，根据 /models/api/ 下的api定义来检查参数
   * output --- 记录api操作日志
   * apiRegister --- 注册api，要在以上两个之后注册，因为以上两个要记录api的执行时间。一般这个都放在数组最后，因为api不会再next后续的中间件了
   * */

  middlewares: [
    'sky-cors',
    'sky-body-parse',
    'sky-static-server',
    'sky-check-param',
    'sky-check-token', // 自己实现的token 可以替换这个
    'sky-output',
    'sky-api-register'
  ],

  // 重定向配置，逻辑放在中间件 sky-check-param 内，所以必须要使用该中间件，此功能才生效
  redirect: {
    // '/original': '/redirect'
  },

  /**
   * 限制post来的数据，这个配置将在 sky/middleware/bodyParse.js 中使用
   */

  bodyParse: {
    multipart: !0,
    maxFileSize: 1024 * 1024 * 1024, //  1000M 文件上传限制 和下面的formLimit需要一起改
    formLimit: '1000mb', // 1000M 文件上传限制
    jsonLimit: '2mb', // body中json格式大小限制
    textLimit: '2mb', //
    extendTypes: {
      custom: ['text/xml']
    }
  },

  /**
   * rts queueName名称
   * */

  rtsQueueName: 'skybaseRtsQueueName'
}