Node.js入门教程——项目结构与配置

1. 项目目录结构及介绍

在Node.js的入门项目中，目录结构通常清晰明了，以下是一个基本的目录结构及其说明：

getting-started/
├── bin/                     # 存放命令行相关脚本
├── doc/                     # 项目文档
├── examples/                # 示例代码
├── lib/                     # 存放项目的核心库代码
├── node_modules/            # 项目依赖的模块
├── scripts/                 # 自定义脚本，例如构建、测试脚本
├── test/                    # 测试用例和测试脚本
├── .gitignore               # 指定git应该忽略的文件和目录
├── .npmignore               # 指定npm publish时应该忽略的文件和目录
├── package.json             # 项目元数据文件和依赖管理
├── package-lock.json        # 记录项目依赖精确版本
└── README.md                # 项目说明文件

• bin/: 存放可执行文件，可以通过npm全局安装后直接使用。
• doc/: 存放项目文档，可以包括API文档、用户手册等。
• examples/: 提供了项目如何使用的示例代码。
• lib/: 存放项目的主要库代码，即项目的核心逻辑。
• node_modules/: 通过npm安装的第三方模块。
• scripts/: 自定义脚本，可以执行特定的任务，如启动服务器、执行测试等。
• test/: 存放测试代码，用于验证项目的功能是否符合预期。
• .gitignore: 指定git在提交时应该忽略的文件，例如日志文件、编辑器临时文件等。
• .npmignore: 类似.gitignore，但是用于npm publish时。
• package.json: 定义了项目依赖、脚本和元数据等。
• package-lock.json: 确保在不同环境安装时，项目依赖的版本保持一致。
• README.md: 提供项目的基本信息，通常是用户阅读的第一个文件。

2. 项目的启动文件介绍

在Node.js项目中，通常使用package.json中的scripts字段定义启动脚本。例如：

"scripts": {
  "start": "node lib/server.js"
}

上面的配置定义了一个start脚本，它通过node命令运行lib/server.js文件。当你在命令行中执行npm start时，就会启动这个脚本。

server.js可能是这样的：

const http = require('http');

const hostname = '127.0.0.1';
const port = 3000;

const server = http.createServer((req, res) => {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end('Hello World\n');
});

server.listen(port, hostname, () => {
  console.log(`Server running at http://${hostname}:${port}/`);
});

这段代码创建了一个简单的HTTP服务器，监听3000端口，并在访问时返回"Hello World"。

3. 项目的配置文件介绍

在Node.js项目中，配置文件通常用来定义项目运行时需要的参数。一个常见的配置文件是.env文件，它包含了环境变量，可以被dotenv这样的库加载到process.env中。

例如，.env文件可能看起来像这样：

DB_HOST=localhost
DB_USER=root
DB_PASS=s1mpl3

你可以在你的Node.js代码中使用dotenv库来加载这些变量：

require('dotenv').config();

console.log(process.env.DB_HOST); // 输出: localhost
console.log(process.env.DB_USER); // 输出: root
console.log(process.env.DB_PASS); // 输出: s1mpl3

通过这种方式，你可以方便地管理不同环境（开发、测试、生产）下的配置。