Midway 是一个面向未来的云端一体 Node.js 框架。
开源仓库地址：https://github.com/midwayjs/midway，欢迎关注。
在经过近 6 个月的孵化与研发，Midway 一体化 正式发布 2.0 版本，本次更新速览：
新功能
▐ 运行时升级
在 1.0 版本中，我们通过编译器来实现 Hooks 的功能。但这也带来了启动速度慢、语法限制、TS 版本兼容等一系列的问题。
而在 2.0 版本中，我们移除了原有的编译器实现，通过 Node.js AsyncLocalStorage 来实现对 Hooks 功能的支持。而新版本运行时的实现，不仅移除了之前的诸多问题，同时也解锁了更多的可能性。
减少语法限制
在 1.0 中，为了能让编译器正确识别 Hooks，我们要求对 Hooks 的命名、调用、定义均作出了限制。对于开发者而言，命名与使用时都存在一定的负担。
而在 2.0 中，得益于运行时的升级，原有的规则与限制均不复存在。你可以在任何函数中使用 Hooks，不受命名的限制。
如下面的代码，实际上是可以运行的。
当然，我们依然推荐在调用 Hooks 的函数使用 use 命名，便于开发者识别到这是一个 Hooks 调用。
代码复用
在 1.0 中，由于编译器的限制，Hooks 代码仅能在项目中编写及使用，并不支持发布为 npm 包供其它项目复用。在一定程度上造成了不必要的冗余。
而在 2.0 中，我们支持了 Hooks 代码复用。你可以像开发任何 npm 包一样，去开发可复用的 Hooks，无需额外的处理，项目中使用时正常导入即可。
如下图所示，使用第三方的 Hooks 包，加速开发。（图中的包为示例代码，实际并不存在）
极速启动
▐ 单元测试
export async function get () {return { type: 'GET' }}export async function post (message: string) {return { type: 'POST', message }}
使用 runFunction 测试
import { createApp } from '@midwayjs/hooks-testing-library';import { get, post } from './api'it('GET', async () => {const app = await createApp();expect(await app.runFunction(get);).toEqual({ type: 'GET' });expect(await app.runFunction(post, '2.0');).toEqual({ type: 'POST', message: '2.0' });});
使用 request 执行完整的 HTTP 测试
import { createApp } from '@midwayjs/hooks-testing-library';import { get, post } from './api'it('GET', async () => {const app = await createApp();const response = await app.request(get)expect(response.status).toEqual(200)expect(response.type).toEqual('application/json')const postResponse = await app.request(post, '2.0')expect(postResponse.status).toEqual(200)expect(postResponse.type).toEqual('application/json')});
对比与传统 Web 应用的测试，你无需关心单元测试的路径、入参、类型提示等。就像测试纯函数一样测试接口。
传统 Web 应用的测试
▐ 插件化与函数式配置
import { hooks, createConfiguration } from '@midwayjs/hooks';export default createConfiguration({imports: [hooks()]});
同时我们也支持了 createConfiguration，支持以函数的方式创建 Midway Configuration，减少 Class 与函数式混用所带来的迷惑感。
▐ Hook 中间件
在 1.0 版本中，我们对单函数中间件做了支持，但中间件依然遵照 Koa 中间件的语法，也无法在内部使用 Hooks，会给使用者带来困扰。
而在 2.0 版本中，我们新增了 Hooks 中间件的支持，同时也支持了全局中间件与文件级中间件。
原有 1.0 版本的单函数中间件依然保持兼容，你可以手动重构从而使用新的语法。
-
语法
中间件仅有 next 一个参数，ctx 需要通过 useContext 获得。你也可以在中间件中使用任意的 Hooks。
Logger 中间件
import { Context } from '@midwayjs/faas';import { useContext } from '@midwayjs/hooks';const logger = async (next: any) => {const ctx = useContext<Context>();console.log(`<-- [${ctx.method}] ${ctx.url}`);const start = Date.now();await next();const cost = Date.now() - start;console.log(`[${ctx.method}] ${ctx.url} ${cost}ms`);};
-
2.0 全局，对所有 Api 调用都生效
-
2.0 文件，对文件内部所有 Api 生效
-
1.0 函数，仅对该 Api 函数生效
全局中间件
全局中间件在 configuration.ts 中定义，可以传入任何框架支持的中间件
import { hooks, createConfiguration } from '@midwayjs/hooks';import logger from './logger';// Global Middlewareexport default createConfiguration({imports: [hooks({middleware: [logger],}),],});
文件级中间件
import { ApiConfig } from '@midwayjs/hooks';import logger from './logger';// File Level Middlewareexport const config: ApiConfig = {middleware: [logger],};export default async (message: string) => {return { type: 'POST', message }};
▐ 新配置文件项目配置
新配置文件
import { defineConfig } from '@midwayjs/hooks';export default defineConfig({source: 'src/apis',routes: [{baseDir: 'lambda',basePath: '/api',},],});
export interface UserConfig {/*** @default false* Enable superjson to serialize Set/Map/Error/BigInt, default is false*/superjson?: boolean// 后端文件夹source?: string// 前端路由routes: ServerRoute[]// devServer 配置dev?: {ignorePattern?: (req: { url: string; [key: string]: any }) => boolean}}
文件路由配置
-
默认配置：/src/apis
-
自定义：/src/server
-
纯接口项目：/src
DevServer 配置
多场景
在 2.0 版本中，我们带来了更多场景的支持。
▐ 纯接口场景
在 2.0 中，得益于 Hooks 与 Midway 体系的打通，我们支持了非一体化项目的开发。
纯接口项目的目录结构
▐ Web 场景
import { hooks, createConfiguration } from '@midwayjs/hooks';import bodyParser from 'koa-bodyparser';export default createConfiguration({imports: [hooks({// Global Middlewaremiddleware: [bodyParser()],}),],});
import { useContext } from '@midwayjs/hooks';import { Context } from '@midwayjs/koa';function useKoaContext() {return useContext<Context>();}export default async () => {return {message: 'Hello World',method: useKoaContext().method,};};
开源
在 2.0 版本中，我们完全基于开源方式去开发。
同时，我们也在开源社区做了一些大胆的尝试，带来了以下新功能（目前只面向开源社区开放）。
▐ Vite
在 2.0 中，我们选择 Vite 作为默认支持的前端构建器。
如图所示，作为一个跨前端框架 + 启动速度极快 + 拥抱未来的前端构建器，它与 Midway Hooks 的理念是相匹配的，能为用户提供更好更快的开发体验。
Midway Hooks + Vite
▐ Prisma
由于数据库客户端是通过 Schema 生成的，因此在生成时就带有类型信息，是可以实现从前后端再到数据库的类型安全解决方案的。
开源仓库地址：https://github.com/midwayjs/midway
繁易
橙子君
本文分享自微信公众号 – 淘系技术（AlibabaMTT）。
如有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一起分享。
{{m.name}}
原创文章，作者：ItWorker，如若转载，请注明出处：https://blog.ytso.com/103404.html