写点什么

在 2024 年如何启动一个 Node.js 项目

作者:高端章鱼哥
  • 2024-05-23
    福建
  • 本文字数:2089 字

    阅读完需:约 7 分钟

在 2024 年如何启动一个 Node.js 项目

现代 Node.js 的开发体验,已经不输 Golang、Rust 这些新兴编程语言。而且,比起使用它的兄弟语言 Deno、Bun,使用 Node 开发项目,坑更少一些,生态也更好一些。

Node.js 的一个特点就是轻便。这个特点我想主要是相比 Java 这种略显笨重的语言来说的。据说,国外的创新项目大部分都是用 Node 来开发的。(在很久以前,是用 PHP 或者 Ruby on Rails 开发。)猜测其原因之一,是前后端统一用一种编程语言能方便代码复用减少切换。国内的项目,由于前后端职责分离,后端程序员使用 Java、Golang 较多。

在 2024 年,创建一个全新的 Node.js 项目并获得不错的开发体验,例如类型校验、格式化、风格检查、单元测试、打包部署,变得非常简单。我们采用的开发工具有:

  • vscode - 开源免费 IDE

  • pnpm - Node 包管理器

创建空项目

pnpm initmkdir srcmkdir test
复制代码

设置 TypeScript

pnpm add -D typescript @types/node
复制代码

更新 package.json,采用 ESM 并加上构建脚本。

{    "type": "module",    "scripts": {        "build": "tsc"    },}
复制代码

增加 tsconfig.json,含有下面这些选项。

{    "compilerOptions": {        "module": "nodenext",        "moduleResolution": "nodenext",        "target": "esnext",        "sourceMap": true,        "outDir": "dist"    },    "include": [        "src",        "test"    ]}
复制代码

试运行

在 src 下增加项目的源文件,比如 hello.ts

import { createServer } from 'node:http';const server = createServer((req, res) => {    res.writeHead(200, { 'Content-Type': 'text/plain' });    res.end('Hello World!\n');});// starts a simple http server locally on port 3000server.listen(3000, '127.0.0.1', () => {    console.log('Listening on 127.0.0.1:3000');});
复制代码

构建并运行

pnpm installpnpm buildnode dist/hello.js> Listening on 127.0.0.1:3000
复制代码

为了获得最佳的开发体验,可以选用以下配置

格式化和风格检查

pnpm add -D -E @biomejs/biomepnpm biome initpnpm biome check srcpnpm biome check src --apply
复制代码

推荐安装 vscode 的插件,在保存的时候自动格式化。

单元测试

在 test 下增加测试用例的源文件,比如 hello.test.ts

import assert from 'node:assert';import test from 'node:test';test('that 1 is equal 1', () => {    assert.strictEqual(1, 1);});test('that throws as 1 is not equal 2', () => {    // throws an exception because 1 != 2    assert.strictEqual(1, 2);});
复制代码

构建并运行测试用例

pnpm buildnode --test dist/test
复制代码

断点调试

在 .vscode 下新增 launch.json

{    "version": "0.2.0",    "configurations": [        {            "type": "node",            "request": "launch",            "name": "Launch Debug",            "skipFiles": [                "<node_internals>/**"            ],            "program": "${workspaceFolder}/src/hello.ts",            "outFiles": [                "${workspaceFolder}/dist/**/*.js",                "!**/node_modules/**"            ]        }    ]}
复制代码

打包成单文件(部署)

pnpm add -D -E esbuildpnpm esbuild src/hello.ts --bundle --platform=node --target=node18 --outfile=dist/main.js
复制代码

生成的 dist/main.js 能在任何安装了 node18 的环境下运行,不需要安装依赖。

总结

最终项目的目录像这个样子

.├── biome.json├── package.json├── tsconfig.json├── src│   └── hello.ts└── test    └── hello.test.ts
复制代码

使用到下面这些命令

pnpm installpnpm buildpnpm biome check src testnode --test dist/testnode dist/src/hello.js
复制代码

在 2024 年, Node.js 及其生态已经出现了一些现代化的开发工具,能够简洁的创建项目并获得不错的开发体验。一个支持类型校验、格式化、风格检查、单元测试的新项目只包含 5 个文件,极大程度的降低了新项目的门槛和“样板代码”的数量。

最后

关于 Node 的内容已经说完了,但是我还想说点别的,主要想说一下我们应该学习哪些技术才能让它更加保值。

在我看来,越偏向于业务的技术越不容易过时,为什么呢?需求在变,技术一直在变,业务也一直在迭代。前端技术的发展非常快,也涌现出很多的框架(例如 HTML4 到 HTML5 的升级,或者从 jQuery 到前端三大框架的转变),但是总归就是两个字:效率。

作为开发者,我们需要保持好奇心和学习热情,不断探索新的技术,只有这样,我们才能在这个快速发展的时代中立于不败之地。

介绍一款程序员都应该知道的软件JNPF快速开发平台,很多人都尝试用过它,它是功能的集大成者,任何信息化系统都可以基于它开发出来。

JNPF 可以实现应用从创建、配置、开发、测试到发布、运维、升级等完整生命周期的管理。减少了传统应用程序的代码编写量,通过图形化、可视化的界面,以拖放组件的方式,即可快速生成应用程序的产品,大幅降低了开发企业管理类软件的难度。

当然,我更建议大家成为一个全栈,不要把自己的定位局限于前端。

用户头像

还未添加个人签名 2023-06-19 加入

还未添加个人简介

评论

发布
暂无评论
在 2024 年如何启动一个 Node.js 项目_高端章鱼哥_InfoQ写作社区