zenweb

常用模块的脚手架

此包的功能仅仅是把一个 webapp 项目最常用的几个模块给整合在了一起。

内置模块

整合的模块如下：

模块	介绍
@zenweb/core	核心包，用于模块加载、服务启动
@zenweb/inject	依赖注入
@zenweb/controller	控制器 - 依赖注入的入口
@zenweb/meta	运行时基本信息，处理耗时，版本信息
@zenweb/log	日志支持
@zenweb/router	路由支持
@zenweb/messagecode	消息代码格式化
@zenweb/body	提交内容解析
@zenweb/result	返回结果处理
@zenweb/helper	输入数据类型转换与校验

使用

创建一个 webapp 启动器

import { create } from 'zenweb';

const app = create();
app.start();

单独配置模块的选项

如需要修改内置模块的配置选项只需要修改 create() 方法的第一个参数对象。

// 例如：修改 result 模块的返回结果包装器
create({
  result: {
    success(ctx, data) {
      return { code: 100, data, msg: 'ok' };
    }
  }
});

每个选项的名称对应着模块的名称，使用 TypeScript 会自动提示代码。

具体模块选项请参考模块说明。

使用其他模块

在项目中使用其他模块需要使用 Core.setup() 方法来加载模块

例如需要 xml-body 支持：

import { create } from 'zenweb';
import modXmlBody from '@zenweb/xml-body';

create()
.setup(modXmlBody()) // 安装模块
.start();