TypeScript 中环境变量的正确使用技巧

面试官:小伙子,你的数组去重方式惊艳到我了

引言

在开发前端应用时,我们经常需要使用环境变量来控制应用程序的行为,例如 API 地址,应用程序的名称等。这些变量可以根据不同的部署环境(如开发、测试、生产)进行设置,以便在不同的环境中使用不同的配置。TypeScript 作为一种强类型的静态语言,可以帮助我们在开发中更加准确和安全地使用环境变量。本文将介绍 TypeScript 中环境变量的正确使用技巧和最佳实践。

正文

安装依赖

我们可以使用 dotenv这个 npm 包来读取和管理环境变量。运行以下指令安装 dotenv

- --- ------- ------ ----------

添加 .env 文件

在 TypeScript 项目中,我们将环境变量存储在.env 文件中。.env 文件是一个文本文件,里面包含一些用 KEY=VALUE 格式表示的环境变量。例如:

- ----
-----------------------------

注意:.env 文件应该被添加到 .gitignore 中,以防止将敏感信息提交到源代码控制系统中。

配置环境变量

在 TypeScript 项目中,我们可以使用以下代码读取 .env 文件中定义的环境变量:

-- ------------------
------ ------ ---- ---------
----------------

----- ----------- - -
  ------- ------------------- -- ------------------------
--

------ ------- ------------

上述代码会将 .env 文件中的 API_URL 变量读取到 environment 对象中。使用 process.env 对象读取环境变量时需要使用 || 操作符提供一个默认值。这样,如果没有设置该环境变量,它的默认值就是 http://localhost:3000

使用环境变量

在 TypeScript 项目中,我们可以将环境变量作为常量来使用,并为不同的环境设置不同的值。例如,在 React.js 应用程序中,我们可以使用以下方法将环境变量传递给组件:

-- -----------
------ ----- ---- --------
------ ----------- ---- ----------------

-------- ----- -
  ----- ------ - -------------------

  ------ -
    -----
      ----------- -- -- --------
      ------ ---- ------------
    ------
  --
-

------ ------- ----

上述代码会将 .env 文件中的 API_URL 变量传递给 App 组件,并在组件中使用它。

使用 TypeScript 类型

为了保证我们对环境变量的使用在编译期间就进行验证,我们可以使用 TypeScript 类型来定义环境变量的类型和默认值。例如:

-- ------------------
------ ------ ---- ---------
----------------

--------- ----------- -
  ------- -------
-

----- ------------ ----------- - -
  ------- ------------------- -- ------------------------
--

------ ------- ------------

上面的代码使用了一个名为 Environment 的接口来定义环境变量的类型。这样,当我们在其他地方使用 environment 对象时,TypeScript 将自动检查我们是否使用了正确的类型。

使用 .env.example 文件

为了帮助其他人了解我们需要哪些环境变量以及它们应该设置为什么值,我们可以在项目中添加一个 .env.example 文件。.env.example 文件中包含了我们需要的环境变量及其默认值,供其他人参考。例如:

- ------------
-----------------------------

构建环境

在构建 TypeScript 应用程序时,我们使用不同的环境变量来控制应用程序的行为。例如,在应用程序发布之前,我们应该使用生产环境变量来构建应用程序。这样,应用程序将使用正确的 API 地址,并且没有多余的调试信息。

我们可以使用以下命令来构建生产环境应用程序:

- --- --- ----------

这个命令将执行以下步骤:

  1. 删除 dist 文件夹。
  2. 使用 tsc 命令编译 TypeScript 代码。
  3. 使用 cross-env 命令设置环境变量。
  4. 使用 terser 命令压缩 JavaScript 代码。
  5. 将所有代码复制到 dist 文件夹中。
-
  ---------- -
    ------------- ------- ---- -- --- -- --------- ------------------- ------ --- -- ---- ---------- --------------
    ---------------- ---- --- ------------
    ------------- ---------- ------------------- ---- --------------
  --
  ------------------ -
    ------------ ---------
    --------- ---------
    --------- --------
  -
-

结论

在 TypeScript 应用程序中正确使用环境变量可以减少错误并提高效率。本文介绍了使用 dotenv npm 包读取和管理环境变量的技巧。我们还介绍了如何使用 TypeScript 类型来保证在编译期间就进行验证。最后,我们介绍了如何在构建环境中使用环境变量。希望读者们能够从本文中受益,并在自己的项目中正确使用环境变量。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/670507dad91dce0dc8516c56


猜你喜欢

  • 如何在 Next.js 中使用 Tailwind CSS 框架?

    引言 Tailwind CSS 是一个灵活且易于定制的 CSS 框架。它采用了一种独特的方式,通过在 HTML 中嵌入一系列 CSS 类来快速构建界面样式,尤其适合于快速迭代和原型开发。

    10 天前
  • 初学者必看:PWA 技术快速入门

    随着移动互联网的兴起,Web 应用程序越来越受到关注。但是,这些 Web 应用程序必须要克服一个很大的问题:缺乏 Native 应用程序的可用性和性能。在过去,Web 应用程序无法与桌面或移动应用程序...

    10 天前
  • Promise 如何处理嵌套回调函数的问题?

    背景: 在前端开发中,回调函数常常被使用来处理异步操作。但是,当存在大量异步操作的时候,回调函数嵌套的层数会非常深,这样不仅难以阅读,而且还容易出现BUG,给代码的维护带来非常大的困难。

    10 天前
  • CSS Grid 布局中常见的 5 个错误及解决方案

    介绍 在前端开发中,CSS 布局扮演了非常重要的角色,而 CSS Grid 布局则是其中的一个重要部分。CSS Grid 布局提供了一种新的方式来实现网站的布局,提供了更高效、更灵活的方式来设计和排版...

    10 天前
  • Sequelize 中如何使用 TransactionManager 实现数据事务操作

    在实际的应用开发过程中,数据库操作是非常常见的一项任务。而在某些特定场景中,需要将多个数据库操作作为一组操作来执行,这时我们需要使用到事务(transaction)。

    10 天前
  • 从传统 API 过渡到 GraphQL 的成功故事

    随着互联网技术的不断发展,传统的 API 设计已经逐渐无法满足现代应用的需求。GraphQL 作为一种新的 API 设计方式,已经被越来越多的前端开发者所采用。 本文将介绍一个从传统 API 过渡到 ...

    10 天前
  • 深入理解 ES6 字面量手动实现 Symbol

    JavaScript 是一门伟大的语言,但在 ES5 版本之前,它仅支持字符串和数字作为对象属性名,这使得在开发中为新属性名分配唯一值变得非常麻烦。由于这个原因,Symbol 在 ES6 中被引入,它...

    10 天前
  • Angular 中的路由懒加载(Lazy Loading)

    在开发单页面应用程序时,路由是不可或缺的一部分。在应用程序中使用路由,可以使用户在导航时流畅地运行,并且还可以优化应用程序的加载速度。然而,随着应用程序变得越来越复杂,路由的数量也会变得越来越多。

    10 天前
  • 详解 Deno 的权限管理机制

    Deno 是一个新兴的 JavaScript 运行时环境,它是由 Node.js 的创始人 Ryan Dahl 所创建的,与 Node.js 相比,Deno 做了一些不同的尝试,其中比较显著的就是“安...

    10 天前
  • 使用 Fastify 和 GraphQL 构建 API

    前端开发者需要掌握各种技术来构建应用程序。在 Web 应用程序中,构建可伸缩和高性能 API 是至关重要的。Fastify 是一个快速、轻量、易于使用,并且底层使用 Node.js 构建的 Web 框...

    10 天前
  • 如何用 Enzyme 对 React 样式组件进行测试

    如何用 Enzyme 对 React 样式组件进行测试 React 是一个广泛使用的前端框架,而 Enzyme 是一种用于 React 组件测试的 JavaScript 测试工具,它可以非常方便地测试...

    10 天前
  • Mocha 在浏览器中的使用方法及注意事项

    Mocha 是一种流行的 JavaScript 测试框架,它支持在浏览器上进行单元测试和集成测试。本文将详细介绍如何在浏览器中使用 Mocha 进行测试,并提供一些注意事项,以便您正确地使用它进行测试...

    10 天前
  • 搭建 Headless CMS 的成本分析与技术选型

    前言 Headless CMS 是一种新兴的 CMS 架构模式,他将原本紧密耦合的页面展示和数据管理进行分离,使得平台可以灵活地对数据进行管理,并通过 API 接口向不同的客户端提供数据,包括 Web...

    10 天前
  • Serverless 如何集成安全认证

    Serverless 如何集成安全认证 随着云计算的快速发展,Serverless 成为了一种越来越流行的架构方式。与传统的基于服务器的架构相比,Serverless 架构具有更高的可扩展性,更低的维...

    10 天前
  • 关于 ES7 中的对象展开运算符详解

    在现代前端开发中,ES7 中的对象展开运算符被广泛使用,它可以方便地将对象或数组中的属性或元素展开并与其他对象或数组合并。本文将深入探讨对象展开运算符的使用方法、注意事项以及示例代码,并为读者提供指导...

    10 天前
  • Web Components—— 你的组件库可否成为 “姐妹花”

    前言 在现代 Web 开发中,组件化已经成为了最流行的技术趋势之一。为了方便地复用和维护代码,许多前端工程师都会开发自己的组件库。然而,随着应用程序规模不断扩大和复杂性增加,组件之间的依赖关系变得越来...

    10 天前
  • 在 ECMAScript 2020 中使用 try {} catch {} 代替 try { } catch(error) { }

    前言 在 JavaScript 中,我们经常使用 try...catch 来处理异常。在过去的版本中,我们通常这样使用: --- - -- ---- ---- - ----- ------- - ...

    10 天前
  • 如何最大化 GraphQL 的成本效益

    GraphQL 是一种在现代 Web 开发中越来越流行的查询语言。它为前端开发者提供了一种更加灵活和高效的方式来获取数据,并且与现有的 API 和数据源无缝集成。但是,GraphQL 的成本效益并非自...

    10 天前
  • 如何在响应式设计中处理导航栏的布局

    在如今多种设备类型的情况下,响应式设计已经成为了设计师和开发者们必须掌握的技能之一。 而对于导航栏这样经常使用到的组件来说,如何在响应式设计下做到既美观又实用,无疑就成为了一个很重要的问题。

    10 天前
  • Deno 中如何优雅地处理错误

    前言 Deno 是一个用 Rust 和 TypeScript 构建的新一代 JavaScript 运行时环境,自 2020 年 5 月发布以来备受关注。与 Node.js 相比,Deno 具有更好的安...

    10 天前

相关推荐

    暂无文章