如何用nest中对环境变量等文件进行配置

已于 2023-05-29 18:00:23 修改
阅读量894 收藏 1
点赞数 2
分类专栏： nestjs 文章标签： javascript node.js typescript
于 2023-05-29 17:58:01 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_63204040/article/details/130930899
版权

环境变量在我们的开发中很常见，开发环境以及生产环境对项目的影响也不相同,这个时候我们可以对环境变量进行配置，这里我简单分为少配置文件以及多配置文件两种模式

目录

少配置文件

一个注意点!!!

多文件配置

一般写法

命名空间

两种类型提示方式

第一种用ts手写实现

第二种用config包自带的功能

写在最后

少配置文件

首先安装一个依赖 @nest/config用于自动读取配置文件

 接着在根目录下创建.env文件  我们简单配置一下用例APP_NAME

接着在app.module.ts中引入ConfigModule,它的内部向外暴露的forRoot工厂函数用于我们来读取配置项, isGlobal熟悉模块应该知道，给它全局使用

接着在app.controller.ts中我们来使用一下

 

 这样我们就读到了环境变量

还有一种方式,在node中我们还可以利用process.env来获取环境变量

 

一个注意点!!!

如果我们把项目开源，提交到仓库时，一定要注意，如果有阿里云密钥或者类似APP_SCRECT这样的密钥，提交时一定要在.gitignore文件中加上.env文件,防止泄露

多文件配置

一般写法

当我们的环境变量有很多种类有不同,类似数据库，文件格式等等，这个时候我们可以用模块化的思想把它们提取到不同文件中，最后再统一导出

 我们创建了一个app.config.ts里面定义了不同种类的环境变量,在ConfigModule的load配置项中引入,它可以将我们创建的config.ts模块与.env文件结合

 

 我们发现这样也是可以的，但是有个弊端就是每个环境变量都放在一个文件里里面，不好管理。

我们可以提取不同到的文件中 

 在src下面创建一个config文件夹专门存放配置文件，最后由index.ts导出

 接下来在app.module中重新导入,注意需要用到展开语法

 到这一步其实已经实现了所有功能，但是没有类型提示，我们又引申出了命名空间的方式

命名空间

 

 创建了一个database.config，将其在index.ts中导出

注意命名空间这种写法在ConfigModule中处理方式不一样,他的处理就像这样

 所以我们在controller中用的时候要用依赖注入的方式,注意这里的@Inject()里面的写法是匹配到key 也就'database'

 

 到这里也是基本完成了，但是我们注意到我这里database类型是any

接下来就是类型提示的问题了

两种类型提示方式

第一种用ts手写实现

type getType<T extends () => any> = T extends () => infer U ? U : T;
type k = typeof databaseConfig;
type databaseType = getType<k>;

第二种用config包自带的功能

 两种方式都可以实现类型提示

写在最后

关于两种配置方式，一般来说在.env文件里面配置这些已经足够了，不过这种模块化的思想还是值得学习的，里面有一些细节需要注意，希望能帮到大家！

前端不是渣男
关注
  • 2
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
nest学习：使用环境变量
weixin_44828005的博客
05-10 3311
文章问题导向 随着项目越来越大，如果都把文件引入配置放在的全局配置中，1.不好管理，2.不够安全。 如何抽离配置？更好地管理项目？ 如果你都有了答案，可以忽略本文章，或去nest学习导图寻找更多答案 环境变量 根据使用环境的不同而设置不一样的配置 为什么要使用环境变量？ 1，保护隐私数据 2，根据环境动态配置，如开发环境和生产环境配置不同，需要区分配置 node对象 全局对象：process是node中的全局对象，无需引入即可使用 环境变量：process.env则是用于配置环境变量 设置
nest配置及环境变量
junjiahuang的博客
05-23 1256
nestjs 配置， 环境配置
探秘NestJS Config：强大的配置管理库
最新发布
gitblog_00080的博客
04-18 312
探秘NestJS Config：强大的配置管理库 项目地址:https://gitcode.com/nestjs/config NestJS Config 是一个面向Node.js开发者的模块，用于在NestJS应用中方便地管理和处理配置。它提供了一种优雅的方式，使得你可以根据环境（如开发、测试或生产）动态加载和组织不同的配置文件，极大地提高了代码的可维护性和灵活性。 技术解析 多环境支持：N...
nestjs-config：nestjs配置模块
02-15
巢状设定模组 参照官方@ nestjs / config 描述 基于的配置模块。 区别 删除dotenv支持，转向js-yaml支持 官方结构过于复杂 load功能关闭，此只能加载配置，直接配置文件就行，场景不明 待支持： load增加加载类的可能性，用于扩展configService configService在读取时可能发生错误，因为key不存在，发生错误 安装 $ npm i @donews/nestjs-config 快速开始 预先一个目录结构，其中包含${rootPath}/config /root /config development.yaml /src app.module.ts 1.模块介绍 import { Module } from '@nestjs/common' ; import { ConfigModule
【nest.js_02】nest.js配置文件-nest-redis多环境配置
页面仔的博客
09-06 1798
nest 中使用 dotenv、joi 实现各环境中数据库密码账号等配置以及校验 链接 mysql，Redis 之前，我们需要准备好如何配置各环境中不同的变量，这非常重要 首先，要确保密码，密钥等重要信息不可保留在代码中 其次要为部署测试环境，生产环境使用的有可能是不一样的配置的准备 安装依赖包 yarn add dotenv joi 使用 dotenv 可以让我们免于在各个文件中引入配置文件将环境相关的配置独立于代码之外，也可以很好的解决敏感信息的泄漏 joi 模块，主要用来实现验证数据是否符合指定的规
Nest.js权限管理系统开发（三）环境变量与配置文件
Mamong's blog
02-24 768
这样生成环境的NODE_ENV 就是命令中指定的值了，我们可以根据这个加载不同配置文件。想要加载配置文件，NestJS 给我们提供了我们创建一个config文件夹来专门存放配置文件。在其中创建不同环境对应的配置文件：创建一个ts文件来读取和解析 YAML 文件，我们可以利用js-yaml包。安装包后，我们使用yaml#load在构建过程中，Nest CLI 不会自动将 "assets"（非 TS 文件）移动到dist文件夹。为了确保你的 YAML 文件被复制，你必须在文件的对象中指定它。例如，如果。
UserMicroservice：具有使用NestJS构建的身份验证的用户微服务
02-03
- `.env` 文件：用于存储环境变量，如 API 密钥或数据库连接字符串。 - `package.json`：项目依赖和脚本的配置文件。 - `nest-cli.json`：NestJS CLI 配置文件。 **开发流程** 1. 安装依赖：使用 `npm install` 或...
config:适用于NestJS的灵活，基于Docker的，基于Dotenv的配置模块
05-17
NestJS配置管理器适用于NestJS的灵活，基于Docker的，基于Dotenv的配置模块主要特点：例如，在开发/测试中使用.env文件，在生产中使用环境变量，或任意组合基于的环境变量验证.env文件的名称/位置的完全动态和可...
nest-boilerplate：NestJS的样板，支持数据库，svagger，配置，速率限制，日志记录，验证，异常处理，docker，测试和CI
01-30
Nest Starter 一种boilerplage ，使用Fastify。 请参阅Express分支（非常陈旧）。产品特点安装$ yarn install跑步# development$ yarn run start# watch mode$ yarn run start:dev# production mode$ yarn run start...
nest-server：:rocket:可能是nest.js服务器端开发的最佳支架
03-04
- `.env`: 环境变量配置文件。 - `README.md`: 项目的说明文档。 **开发流程** 1. **环境配置**：安装必要的依赖，如 Node.js、npm 或 yarn，以及 Nest.js CLI。 2. **初始化项目**：使用 Nest.js CLI 创建项目，...
task-management-nestjs:使用NestJs构建的任务管理后端应用
04-04
- `.env`（可能）：环境变量配置文件，用于存储敏感信息或环境特定配置。 - `tsconfig.json`：TypeScript编译配置。 - `.gitignore`：指定哪些文件和目录不被Git版本控制系统跟踪。 ### 结论 `task-management-...
nestjs-config：使用dotenv的nestjs的配置模块
02-06
Nestjs配置 NestJ的配置组件。 产品特点 使用Glob加载您的配置文件 感谢支持不同的环境配置 在运行时更改和加载配置 安装 纱 yarn add nestjs-config NPM npm install nestjs-config --save 入门 假设我们在项目中有一个名为src/config的文件夹，其中包含几个配置文件。 /src ├── app.module.ts ├── config │ ├── express.ts │ ├── graphql.ts │ └── grpc.ts 让我们在app.module.ts注册配置模块 import { Mo
nestjs-config:开箱即用的类型转换和验证的模块化配置:scroll:
05-02
nestjs-config 描述 适用于应用程序的便捷模块化配置 类型转换（ environment所有内容都是字符串），例如'true'->布尔值... 运行时验证 与typescript兼容，您将输入配置 模块化-您可以为项目中的每个模块定义配置 通过设计从环境变量获取配置 使用 / class-validator便捷的配置定义 安装 npm install --save @ukitgroup/nestjs-config 或者 yarn add @ukitgroup/nestjs-config 简短的例子 覆盖环境中特定模块的配置 .env CAT__WEIGHT=5 cat.config.ts @ Config ( 'CAT' ) export class CatConfig { @ Env ( 'WEIGHT' ) @ Number ( ) readonly
【Nestjs实操】环境变量和全局配置
IT飞牛
03-09 1177
dotenv安装。根目录下创建.env。
angular的配置文件_在NestJS应用中使用Angular风格的环境配置文件
weixin_26738395的博客
09-09 333
angular的配置文件Managing different environment configurations for a Web App is an essential task. NestJS provides an out-of-box config package based on .env files. However, my personal preference is to us...
【NestJS】环境变量的配置与使用
Superman_H的博客
04-08 1925
# @nestjs/config NestJS 内置了 dotenv，并将其封装到 @nestjs/config 里面了 1. `npm i @nestjs/config` 2. 在 .env 文件中编写环境变量： ```typescript TOKEN_SECRET = 'superman' DB = 'mysql' DB_HOST = '127.0.0.1' ``` 3. 在 app.module.ts 文件中全局配置 `ConfigModule`： ```typescript import
NestJS 7.x 折腾记: (2) 环境变量及配置维护
CRPER
11-07 3047
前言 在写后端的时候,我们一般提倡配置文件分离.所以.env就可以很方面来维护我们的环境变量,封装对应的工厂函数也能组合更复杂的配置! 比如我们用镜像(Docker),就可以外部映射配置文件目录;达到不同环境使用差异化配置的需求!(运行时加载是允许的!) 其他不多说,往下可以看看我的配置分离思路~~ 实战 安装 @nestjs/config : 基于dotenv 封装的Nest配置中心 joi : 一个很灵活的schema校验工具 @types/hapi__joi : joi的typescript声明
NestJS学习（一）：项目搭建与环境配置
小羽苏的博客
10-12 557
学习nestjs基础的项目创建，以及通过官方库config模块配置环境，设置环境参数变量
Nestjs中利用nestjs-config模块实现多运行环境配置
lxmuyu的专栏
06-02 2235
在做 Nestjs 开发时，会涉及开发环境、生产环境等切换，可以通过nestjs-config进行配置文件统一管理，通过向启动命令传参的方式运行不同环境下的 Nest 应用。 使用 Git 做版本管理 测试脚手架 curl 127.0.01:3000 得到结果 2.2. 安装并配置 nestjs-config 安装 nestjs-config 创建配置文件 src/config/environment.ts，新增两个模式（此处为数据库配置，可根据业务增删） 在 Nest 应用中
nestjs 环境配置
09-17
nestjs提供了@nestjs/config包来方便我们对环境进行配置。在安装依赖后，可以创建一个名为config的文件夹来存放配置文件。根据项目需求，可以在该文件夹下创建多个配置文件，比如common.ts（放置公共配置）、development.ts（放置开发环境配置）和production.ts（放置线上环境配置）。通过设置环境变量来读取不同的配置文件。在libs/common/src/config/env/index.ts中，根据环境变量选择相应的配置文件，然后将公共配置和选择的配置合并并导出。这样就可以根据不同的环境加载不同的配置。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值