简介
@midwayjs/fcli-plugin-create 是一个基于 Midway.js 的插件,可以帮助你快速创建 Midway.js 项目。
安装
使用 npm 安装:
npm i -g @midwayjs/fcli @midwayjs/fcli-plugin-create
或者使用 yarn 安装:
yarn global add @midwayjs/fcli @midwayjs/fcli-plugin-create
创建项目
使用 fcli create
命令创建项目:
fcli create --type=web --template=typescript
参数 --type
是项目类型,目前支持 web
、function
和 script
;参数 --template
是项目模板,目前支持 javascript
和 typescript
。
执行上述命令后,将会生成一个基于 Midway.js 框架的 Web 类型的 TypeScript 项目。
配置
fcli create 命令会在新建项目的根目录生成 src/config/config.${env}.ts
和 src/config/config.default.ts
两个文件。
以 config.default.ts
为例,它可以设置各种配置,例如数据库配置、中间件配置等等。
-- -------------------- ---- ------- ------ - ------------- ----------- ------------ - ---- --------- ------ ------- --------- ----------- -- - ----- ------ - -- -- --------------------------- ----------- - ------------ - ---------------------- -- ----- ----------------- - - -------------- -- -------------- - - -------- ---- - ---------------------- -------- - - -------- ------------ ------ ---------- -- ---------- - ---------- -- ---- -- -- ------------- - - ------ ------- ------------- ------- -- -- ----- -------------- - - ----- -------- ----- ------------ ----- ----- --------- ------- --------- --- --------- -------- -- ------ ------- --
环境变量
Midway.js 支持使用环境变量来配置部分参数,例如端口号、数据库连接信息等等。在项目启动时,Midway.js 会自动从环境变量中读取对应的配置项并覆盖 config.default.ts
中的配置项。
例如,可以通过设置 PORT
环境变量来修改监听端口号:
PORT=4000 npm run dev
此时项目将启动在 4000
端口上。
多环境配置
在实际开发中,很可能需要针对不同的环境配置不同的参数,例如开发环境和生产环境的数据库连接地址不同,这时可以使用 Midway.js 提供的环境变量 EGG_SERVER_ENV
来区分不同的环境,并在不同的环境中加载不同的配置文件。
例如,在项目根目录下创建 src/config/config.local.ts
、src/config/config.dev.ts
和 src/config/config.prod.ts
三个文件,分别对应本地开发环境、开发环境和生产环境。可以在 package.json
中配置不同的启动命令来设置不同的环境变量 EGG_SERVER_ENV
:
-- -------------------- ---- ------- - ------- --------- ---------- -------- ---------- - ------ --------------------- --- --- ----------- ------------ ----------- ----- ------------- ----------- ------ - -
此时,Midway.js 启动时会自动加载对应环境的配置文件。
示例代码
更完整的示例代码可以参考 midway-examples 仓库。
小结
本篇文章介绍了如何使用 @midwayjs/fcli-plugin-create
插件快速创建 Midway.js 项目,并介绍了如何进行项目配置。Midway.js 是一个功能强大的 Node.js 框架,可以在企业级应用和云原生应用中发挥出很强的作用。建议开发者仔细阅读官方文档,深入学习 Midway.js 的原理和用法。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5f17eafb403f2923b035c3f5