import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; # 创建第一个应用 ## 技术选型 Midway 有多套技术方案可以选择,我们以部署的方式来做区分: | 技术选型 | 描述 | | --------------- | ------------------------------------------------------------ | | 纯 Node.js 项目 | Midway 传统项目,纯 Node.js 研发,以 `@midwayjs/koa` 为代表的模块,最完整的支持后端项目,采用 **依赖注入 + Class** 为技术栈。 | | Serverless 项目 | Midway 为 Serverless 场景单独开发的技术栈,以 `@midwayjs/faas` 为代表的模块,使用轻量的方式接入不同的 Serverless 平台。 | | 一体化项目 | Midway 创新技术方案,采用前后端一体化开发方式,节省前后端联调时间,以 `@midwayjs/core/functional`、`@midwayjs/web-bridge` 为代表,使用 **函数式** 为主要编码范式。 | :::tip 本章节及后续的文档将以 **纯 Node.js 项目** 作为基础示例,如需使用 Serverless 项目,请跳转到 [Serverless](serverless/serverless_intro),如需了解一体化项目,请访问 [函数式](functional/intro)。 ::: ## 快速初始化 使用 `npm init midway` 查看完整的脚手架列表,选中某个项目后,Midway 会自动创建示例目录,代码,以及安装依赖。 ```bash $ npm init midway@latest -y ``` 针对 v4 项目,请选择 `koa-v4`,注意 [Node.js 环境要求](/docs/intro#环境准备工作)。 示例将创建一个类似下面的目录结构,其中最精简的 Midway 项目示例如下。 ``` ➜ my_midway_app tree . ├── src ## midway 项目源码 │ └── controller ## Web Controller 目录 │ └── home.controller.ts ├── test ├── package.json └── tsconfig.json ``` 整个项目包括了一些最基本的文件和目录。 - `src` 整个 Midway 项目的源码目录,你之后所有的开发源码都将存放于此 - `test` 项目的测试目录,之后所有的代码测试文件都在这里 - `package.json` Node.js 项目基础的包管理配置文件 - `tsconfig.json` TypeScript 编译配置文件 除了整个目录,我们还有一些其他的目录,比如 `controller` 目录。 ## 开发习惯 Midway 对目录没有特别的限制,但是我们会遵守一些简单的开发习惯,将一部分常用的文件进行归类,放到一些默认的文件夹中。 以下 ts 源码文件夹均在 `src` 目录下。 常用的有: - `controller` Web Controller 目录 - `middleware` 中间件目录 - `filter` 过滤器目录 - `aspect` 拦截器 - `service` 服务逻辑目录 - `entity` 或 `model` 数据库实体目录 - `config` 业务的配置目录 - `util` 工具类存放的目录 - `decorator` 自定义装饰器目录 - `interface.ts` 业务的 ts 定义文件 随着不同场景的出现,目录的习惯也会不断的增加,具体的目录内容会体现在不同的组件功能中。 ## Web 框架选择 Midway 设计之初就可以兼容多种上层框架,比如常见的 `Express`、`Koa` 和 `EggJS` 。 从 v3 开始,我们使用 Koa 来做基础示例的演示。 这些上层框架在 Midway 中都以组件的能力提供,都可以使用 Midway 提供的装饰器能力,但是 Midway 不会对特有的能力做出封装,比如 Egg.js 的插件体系,或者 Express 的中间件能力,如果你对其中的某个框架比较熟悉,或者希望使用特定框架的能力,就可以选择它作为你的主力 Web 框架。 | 名称 | 描述 | | --- | --- | | @midwayjs/koa | 默认,Koa 是一个 Express 的替代框架,它默认支持了异步中间件等能力,是第二大通用的 Node.js Web 框架。 | | @midwayjs/web | Egg.js 是国内相对常用的 Web 框架,包含一些默认插件。 | | @midwayjs/express | Express 是一个众所周知的 node.js 简约 Web 框架。 这是一个经过实战考验,适用于生产的库,拥有大量社区资源。 | 如果你希望替代默认的 Web 框架,请参考对应的 [egg](extensions/egg) 或者 [express](extensions/express) 章节。 ## 启动项目 ```bash $ npm run dev $ open http://localhost:7001 ``` Midway 会启动 HTTP 服务器,打开浏览器,访问 `http://127.0.0.1:7001` ,浏览器会打印出 `Hello midwayjs!` 的信息。 ![image.png](https://img.alicdn.com/imgextra/i2/O1CN01KoUxO91jydMw41Vv4_!!6000000004617-2-tps-1268-768.png) 如果需要修改开发的启动端口,可以在 `package.json` 的 scripts 段落里修改,如修改为 6001: ```typescript "scripts": { //... "dev": "cross-env NODE_ENV=local mwtsc --watch --run @midwayjs/mock/app.js --port 6001", }, ``` ```typescript "scripts": { //... "dev": "cross-env NODE_ENV=local midway-bin dev --ts --port=6001", }, ``` ## 常见问题 ### windows eslint 报错 :::caution Windows 可能会碰到 eslint 报错的问题,请关注 [windows 下换行问题](faq/git_problem#XCAgm)。 :::