Node.js 项目初始化
本文主要围绕着,如何使用 npm 初始化一个 Node.js 后端项目。为接下来的Node学习奠定基础的Node.js开发概念
1. 项目初始化目标
初始化 Node.js 后端项目时,优先要完成三件事:
- 2. 使用 npm 生成
package.json,让项目具备标准的包描述文件。 - 3. 将初始化的项目使用
Koa或Express框架启动,预览效果
2. 快速了解
Node.js 与 npm 官方文档,主要规范的是“包”的组织方式,而不是某一种固定的 Web 后端分层目录。他是一种插件化,按需使用的模式,根据你项目所需进行依赖选择、使用的依赖库
- 1.
npm init 用于创建或更新 package.json。 - 2.
package.json 位于项目根目录,用来描述项目的名称、版本、入口、模块类型、脚本等信息。 - 3. 项目初始化后,你得到一个
package.json文件,围绕这个文件进行项目的其他开发
3. 初始化项目
参考文档https://docs.npmjs.com/cli/v11/commands/npm-initkoa文档https://koa.bootcss.comexpress文档https://www.expressjs.com.cn/starter/hello-world.html
创建项目目录
mkdir my-nodecd my-node
终端自定义输入初始化方式
npm init
默认配置初始化方式
npm init -y
初始化后,项目根目录会生成 package.json。建议随后手动检查并调整项目名称、描述、入口文件、模块类型、脚本和许可证等字段。

4. 推荐的初始 package.json
下面是一个适合 Node.js 后端项目起步的最小示例:
{"name":"my-node","version":"1.0.0","description":"如何创建一个纯净的nodejs项目","keywords":["init"],"license":"MIT","author":"xiaoli","type":"commonjs","main":"main.js","scripts":{"dev":"node main.js"}}
字段说明:
- 1.
name:项目名称,建议使用小写字母、数字和连字符。 - 2.
version:项目版本号,通常从 0.1.0 或 1.0.0 开始。我比较喜欢在上线前使用0.0.0,上线后使用1.0.0 - 4.
main:项目主入口文件,后端服务通常可以指向 app.js,我比较喜欢指向main.js。 - 5.
type:模块类型,设置为 module 时,.js 文件默认使用 ES Module 语法。不同的模块类型最明显区别是,js文件引入与导出时使用import/export与require/module.exports的区别 - 6.
private:项目是否私有化,内部项目建议设置为 true,避免误发布。 - 7.
scripts:常用命令入口,便于统一启动、测试和维护。代表性的就是我们在启动前端时使用的npm run dev,dev就是常用命令。 - 8.
license:项目许可证。代表你的项目开源情况,允许别人的使用方式。类似专利使用说明。
5.入口文件
以上步骤完成后你就已经创建好了一个node项目的基本包配置但还不够,因为当前你的目录下仅有一个package.json文件这时你需要新建一个入口文件,也就是上述的package.json文件main字段的入口文件
# 进入项目根目录cd /Users/lee/Desktop/githubProject/my-node # 新建入口文件touch main.js# 安装框架koanpm install koa
使用你的编辑器打开项目/Users/lee/Desktop/githubProject/my-node进入main.js文件中,将以下Koa或Express代码复制到文件中
constKoa = require("koa");const app = newKoa();// responseapp.use((ctx) => { ctx.body = "Hello Koa";});app.listen(3000);console.log("my-node启动成功: http://localhost:3000")
const express = require('express')const app = express()const port = 3000app.get('/', (req, res) => { res.send('Hello Express!')})app.listen(port, () => {console.log("my-node启动成功: http://localhost:3000")})
# 启动服务npm run dev# 访问网址http://localhost:3000
小提示node本身自带运行js环境,这时如果我们需要验证一个函数内的运行效果可以在指定文件夹目录内,新建一个test.js,打开终端或cmd进入到测试js文件目录内可通过编辑器打开test.js文件进行编辑,也可通过txt、notepad++或其他任何可编辑的IDE编辑完成,使用命令 node test.js 启动js运行环境,在终端或cmd中预览js文件内函数的运行效果很实用,举例:测试一个数组处理逻辑函数、测试一个正则处理结果、测试一个树结构解析函数、及其他等等
结语
到这里你就已经掌握了最简单的node项目,也是你了解node的火种