快来玩玩便捷、高效的Demo练习场

Demo练习场

Vonajs 提供了一个 Demo 练习场的功能,允许我们非常方便、快捷的对代码做测试,对想法做验证

步骤

简而言之,Demo练习场的使用只需两步:第一步写代码,第二步执行终端命令。具体说明如下:

1. 新建demo文件

我们需要在项目中新建源码文件:src/backend/demo/index.ts。当前,我们并不需要手工创建此文件,而是执行以下命令,自动创建该文件:

bash 复制代码
$ npm run demo

2. 编写测试代码

在文件demo/index.ts中,我们写入测试代码:

diff 复制代码
export async function main(app: VonaApplication, _argv: IArgv) {
+  console.log('server listen: ', app.config.server.listen);
}

3. 执行demo文件

由于demo文件已经存在,再次执行同样的终端命令,就会自动加载此demo文件,并运行

bash 复制代码
$ npm run demo

更多例子

1. 模拟请求的上下文环境ctx

diff 复制代码
export async function main(app: VonaApplication, _argv: IArgv) {
+  await app.bean.executor.mockCtx(async () => {
+    // do something in ctx
+  });
}
  • app.bean: 全局ioc容器
  • app.bean.executor: 从ioc容器获取全局bean实例executor。executor提供一组工具方法,其中,mockCtx用于创建一个模拟的上下文环境ctx

2. 访问Api

比如我们访问首页 Api:

diff 复制代码
export async function main(app: VonaApplication, _argv: IArgv) {
  await app.bean.executor.mockCtx(async () => {
+    const homeBody = await app.bean.executor.performAction('get', '//');
+    console.log(homeBody); // Hello Vona!
  });
}
  • performAction用于直接访问Api,method参数和path参数都支持类型提示

我们也可以模拟中文的 ctx,然后访问首页 Api:

diff 复制代码
export async function main(app: VonaApplication, _argv: IArgv) {
  await app.bean.executor.mockCtx(async () => {
+    const homeBody = await app.bean.executor.performAction('get', '//');
+    console.log(homeBody); // 您好, Vona!
+  }, { locale: 'zh-cn' });
}

3. 模拟登录和退出登录

我们也可以模拟登录,然后执行业务逻辑,最后再退出登录

diff 复制代码
export async function main(app: VonaApplication, _argv: IArgv) {
  await app.bean.executor.mockCtx(async () => {
+    // signin as user: admin
+    await app.bean.passport.signinMock();
+    // do something
+    // signout
+    await app.bean.passport.signout();
  });
}

结语

Vonajs已开源:https://github.com/vonajs/vona

Vonajs作者正在B站直播撰写技术文档,工作日每晚8:30,欢迎围观:濮水代码

开发一个功能完备的Nodejs框架固然费时费力,但是撰写技术文档更加费尽心思。写文档的过程同时也是再次梳理思路的过程,即便是围观,也有利于加深对框架设计的理解,探索不一样的架构设计路径。目前已完成部分文档,更多精彩正在逐步展开,欢迎参与

相关推荐
Goodbaibaibai37 分钟前
创建一个简洁的Vue3 + TypeScript + Vite + Pinia + Vue Router项目
javascript·vue.js·typescript
一生躺平的仔18 小时前
NestJS Swagger 使用说明文档
nestjs
codehub19 小时前
TypeScript 高频面试题与核心知识总结
typescript
张志鹏PHP全栈20 小时前
TypeScript 第一天,认识TypeScript
typescript
plusone1 天前
【Nest指北系列-源码】(七)请求生命周期
nestjs
羊八井1 天前
类型、分类定义时使用 type 还是 kind ?
rust·typescript·代码规范
MR_发1 天前
万字实现带@和表情包的输入框
vue.js·typescript
OEC小胖胖1 天前
告别 undefined is not a function:TypeScript 前端开发优势与实践指南
前端·javascript·typescript·web
三水气象台2 天前
用户中心Vue3网页开发(1.0版)
javascript·css·vue.js·typescript·前端框架·html·anti-design-vue
難釋懷2 天前
TypeScript-webpack
javascript·webpack·typescript