Midway 一体化研发 2.0 - 更快、更具生产力-阿里云开发者社区

开发者社区> 开发者小助手> 正文

Midway 一体化研发 2.0 - 更快、更具生产力

简介: Midway 是一个面向未来的云端一体 Node.js 框架。
+关注继续查看
作者 | 繁易

image.png

Midway 是一个面向未来的云端一体 Node.js 框架。开源仓库地址:https://github.com/midwayjs/midway,欢迎关注。

在经过近 6 个月的孵化与研发,Midway 一体化 正式发布 2.0 版本,本次更新速览:

新功能

运行时升级

在 1.0 版本中,我们通过编译器来实现 Hooks 的功能。但这也带来了启动速度慢、语法限制、TS 版本兼容等一系列的问题。

而在 2.0 版本中,我们移除了原有的编译器实现,通过 Node.js AsyncLocalStorage 来实现对 Hooks 功能的支持。而新版本运行时的实现,不仅移除了之前的诸多问题,同时也解锁了更多的可能性。

1、减少语法限制

在 1.0 中,为了能让编译器正确识别 Hooks,我们要求对 Hooks 的命名、调用、定义均作出了限制。对于开发者而言,命名与使用时都存在一定的负担。

image.png

而在 2.0 中,得益于运行时的升级,原有的规则与限制均不复存在。你可以在任何函数中使用 Hooks,不受命名的限制。

如下面的代码,实际上是可以运行的。

image.png

当然,我们依然推荐在调用 Hooks 的函数使用 use 命名,便于开发者识别到这是一个 Hooks 调用。

2、代码复用

在 1.0 中,由于编译器的限制,Hooks 代码仅能在项目中编写及使用,并不支持发布为 npm 包供其它项目复用。在一定程度上造成了不必要的冗余。

而在 2.0 中,我们支持了 Hooks 代码复用。你可以像开发任何 npm 包一样,去开发可复用的 Hooks,无需额外的处理,项目中使用时正常导入即可。

如下图所示,使用第三方的 Hooks 包,加速开发。(图中的包为示例代码,实际并不存在)

image.png

3、极速启动

在 1.0 版中,服务启动时存在大量的编译工作,因此新项目首次启动时间 > 10 秒,并随着后端文件的增加,编译时间也会变长,从而导致了项目越大,开发速度越慢的问题。

1.0 启动流程

image.png

而在 2.0 版本中,得益于纯运行时方案,新项目启动与重启时间 < 2 秒,且文件数量的增长并不会影响启动时间。在大型项目中将有效减少等待时间。

同时,由于不再需要编译器,2.0 版本在运行时也不会产生 .faas_debug_tmp 此类的缓存文件夹,项目目录更加整洁。

单元测试

单元测试是 Midway Hooks 在函数式支持上的一块重要拼图。我们希望你能轻松愉悦的完成应用的测试,就像测试纯函数那么简单。

在新版本中,我们支持 runFunctionrequest 两种测试方式,帮助你快速完成接口的测试。

接口代码

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 应用的测试

image.png

插件化与函数式配置

在 1.0 中,我们通过 faas-cli 的插件来为项目启用一体化功能。Midway Hooks 与项目是高度定制化且绑定的。

而在 2.0 中,我们将 Midway Hooks 变为了 Midway 的 Component,你可以在任何 Midway 新版本中,启用 Hooks 功能,而不受项目类型,部署模式的限制。

这也意味着,你不仅可以在一体化项目中使用 Hooks,也可以在纯接口开发或 Midway Web 应用开发时使用 Midway Hooks。

新版本的启用方式

import { hooks, createConfiguration } from '@midwayjs/hooks';

export default createConfiguration({
  imports: [hooks()]
});

同时我们也支持了 createConfiguration,支持以函数的方式创建 Midway Configuration,减少 Class 与函数式混用所带来的迷惑感。

Hooks 中间件

在 1.0 版本中,我们对单函数中间件做了支持,但中间件依然遵照 Koa 中间件的语法,也无法在内部使用 Hooks,会给使用者带来困扰。

而在 2.0 版本中,我们新增了 Hooks 中间件的支持,同时也支持了全局中间件与文件级中间件。

原有 1.0 版本的单函数中间件依然保持兼容,你可以手动重构从而使用新的语法。

1、语法

中间件仅有 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 版本中,Midway Hooks 支持三种形式的中间件,用来覆盖不同的使用诉求。

  • 2.0 全局,对所有 Api 调用都生效
  • 2.0 文件,对文件内部所有 Api 生效
  • 1.0 函数,仅对该 Api 函数生效

2、全局中间件

全局中间件在 configuration.ts 中定义,可以传入任何框架支持的中间件

import { hooks, createConfiguration } from '@midwayjs/hooks';
import logger from './logger';

// Global Middleware
export default createConfiguration({
  imports: [
    hooks({
      middleware: [logger],
    }),
  ],
});

3、文件级中间件

文件级中间件在 Api 文件中定义,通过导出 config.middleware,使得其对该文件内所有 Api 函数生效。

import { ApiConfig } from '@midwayjs/hooks';
import logger from './logger';

// File Level Middleware
export const config: ApiConfig = {
  middleware: [logger],
};

export default async (message: string) => {
  return { type: 'POST', message }
};

项目配置

在 2.0 版本中,我们开放了 Hooks 项目的配置,帮助用户来更好的开发代码。

1、新配置文件

在 1.0 版本中,我们将部分项目的配置存放于 f.yml 中。由于 f.yml 仅适用于 FaaS,且纯文本无法满足用户自定义的诉求。因此,我们在 2.0 版本中推出了新的配置文件:midway.config.ts

你可以通过 @midwayjs/hooks 提供的 defineConfig 来配置项目。

基础配置速览

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
  }
}

2、文件路由配置

在 1.0 中,文件路由在 f.yml 配置。而在 2.0 版本中,文件路由统一在 midway.config.ts 中配置。

在 2.0 中,我们了开放 Hooks 目录的配置,从而适配不同类型的项目。

  • 默认配置:/src/apis
  • 自定义:/src/server
  • 纯接口项目:/src

同时我们也大幅度简化了配置的层级,默认支持 HTTP 路由的配置,从而降低开发者的阅读成本。

3、DevServer 配置

在 2.0 中,我们也支持了 devServer 的配置。

你可以通过传入 dev.ignorePattern 来决定哪些请求应该被 FaaS 函数托管,适用于需要匹配类似 /download/a.css 这种处理文件的情况。

多场景

在 2.0 版本中,我们带来了更多场景的支持。

纯接口场景

在 2.0 中,得益于 Hooks 与 Midway 体系的打通,我们支持了非一体化项目的开发。

纯接口项目的目录结构

image.png

你可以使用 Hooks 来快速创建接口,并在任何地方调用。而在前后端分离的场景下,我们也在考虑如何为 Hooks 纯接口项目生成前端 SDK 供其它项目使用。

Web 场景

在 2.0 版本中,我们新增了 Web 服务器部署的支持,这也意味着除了使用 FaaS 平台外,你也可以部署到自己购买的服务器了。

在 Web 场景下,我们默认使用 Koa 作为底层服务框架,这也意味着你可以使用任何 Koa 中间件来开发应用。

例子:使用 koa-bodyparser 来解析 body

import { hooks, createConfiguration } from '@midwayjs/hooks';
import bodyParser from 'koa-bodyparser';

export default createConfiguration({
  imports: [
    hooks({
      // Global Middleware
      middleware: [bodyParser()],
    }),
  ],
});

而在使用上,Web 与 FaaS 的语法是一致的,只是 useContext 传递的上下文变成了 Koa 的 Context

你可以自定义 useKoaContext 来确保拿到正确的上下文定义

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

image.png

Prisma

对于 Midway Hooks 而言,未来很重要的一个方向是建设类型安全的解决方案,而 Prisma 能帮助我们实现这个目标。

Prisma 是新一代的数据库 ORM,通过 Schema 来生成对应的客户端代码,从而帮助你专注于业务逻辑中。

image.png

由于数据库客户端是通过 Schema 生成的,因此在生成时就带有类型信息,是可以实现从前后端再到数据库的类型安全解决方案的。

image.png

开源仓库地址:https://github.com/midwayjs/midway


image.png

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
怎么设置阿里云服务器安全组?阿里云安全组规则详细解说
阿里云服务器安全组设置规则分享,阿里云服务器安全组如何放行端口设置教程
6845 0
使用OpenApi弹性释放和设置云服务器ECS释放
云服务器ECS的一个重要特性就是按需创建资源。您可以在业务高峰期按需弹性的自定义规则进行资源创建,在完成业务计算的时候释放资源。本篇将提供几个Tips帮助您更加容易和自动化的完成云服务器的释放和弹性设置。
7737 0
windows server 2008阿里云ECS服务器安全设置
最近我们Sinesafe安全公司在为客户使用阿里云ecs服务器做安全的过程中,发现服务器基础安全性都没有做。为了为站长们提供更加有效的安全基础解决方案,我们Sinesafe将对阿里云服务器win2008 系统进行基础安全部署实战过程! 比较重要的几部分 1.
5412 0
阿里云服务器安全组设置内网互通的方法
虽然0.0.0.0/0使用非常方便,但是发现很多同学使用它来做内网互通,这是有安全风险的,实例有可能会在经典网络被内网IP访问到。下面介绍一下四种安全的内网互联设置方法。 购买前请先:领取阿里云幸运券,有很多优惠,可到下文中领取。
9407 0
腾讯云服务器 设置ngxin + fastdfs +tomcat 开机自启动
在tomcat中新建一个可以启动的 .sh 脚本文件 /usr/local/tomcat7/bin/ export JAVA_HOME=/usr/local/java/jdk7 export PATH=$JAVA_HOME/bin/:$PATH export CLASSPATH=.
2121 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,云吞铺子总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系统盘、创建快照、配置安全组等操作如何登录ECS云服务器控制台? 1、先登录到阿里云ECS服务器控制台 2、点击顶部的“控制台” 3、通过左侧栏,切换到“云服务器ECS”即可,如下图所示 通过ECS控制台的远程连接来登录到云服务器 阿里云ECS云服务器自带远程连接功能,使用该功能可以登录到云服务器,简单且方便,如下图:点击“远程连接”,第一次连接会自动生成6位数字密码,输入密码即可登录到云服务器上。
16745 0
1326
文章
282
问答
来源圈子
更多
+ 订阅
文章排行榜
最热
最新
相关电子书
更多
文娱运维技术
立即下载
《SaaS模式云原生数据仓库应用场景实践》
立即下载
《看见新力量:二》电子书
立即下载