”工欲善其事,必先利其器。“—孔子《论语.录灵公》
首页 > 编程 > 如何在 Node.js (Express.js) 中构建后端代码

如何在 Node.js (Express.js) 中构建后端代码

发布于2024-08-25
浏览:399

How to Structure Your Backend Code in Node.js (Express.js)

使用 Express.js 开发 Node.js 应用程序时,有效构建代码库对于可维护性、可扩展性和易于协作至关重要。组织良好的项目结构使您能够管理复杂性,从而更轻松地导航和理解代码。在本博客中,我们将探索 Express.js 应用程序的典型文件夹结构,并解释每个目录和文件的用途。

项目结构概述
以下是 Express.js 应用程序的常见文件夹结构:

?
├── ? app.js
├── ? bin
├── ? config
├── ? controllers
│   ├── ? customer.js
│   ├── ? product.js
│   └── ...
├── ? middleware
│   ├── ? auth.js
│   ├── ? logger.js
│   └── ...
├── ? models
│   ├── ? customer.js
│   ├── ? product.js
│   └── ...
├── ? routes
│   ├── ? api.js
│   ├── ? auth.js
│   └── ...
├── ? public
│   ├── ? css
│   ├── ? js
│   ├── ? images
│   └── ...
├── ? views
│   ├── ? index.ejs
│   ├── ? product.ejs
│   └── ...
├── ? tests
│   ├── ? unit
│   ├── ? integration
│   ├── ? e2e
│   └── ...
├── ? utils
│   ├── ? validation.js
│   ├── ? helpers.js
│   └── ...
└── ? node_modules

各目录和文件说明
应用程序.js
app.js 文件是应用程序的入口点。您可以在其中初始化 Express 应用程序、设置中间件、定义路由并启动服务器。将其视为 Web 应用程序的控制中心。

const express = require('express');
const app = express();
const config = require('./config');
const routes = require('./routes');
// Middleware setup
app.use(express.json());
// Routes setup
app.use('/api', routes);
// Start server
const PORT = config.port || 3000;
app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});
module.exports = app;

垃圾桶
bin 目录通常包含用于启动 Web 服务器的脚本。这些脚本可用于设置环境变量或管理不同的环境(例如开发、生产)。

示例:bin/www

#!/usr/bin/env node
const app = require('../app');
const debug = require('debug')('your-app:server');
const http = require('http');
const port = normalizePort(process.env.PORT || '3000');
app.set('port', port);
const server = http.createServer(app);
server.listen(port);
server.on('error', onError);
server.on('listening', onListening);
function normalizePort(val) {
  const port = parseInt(val, 10);
  if (isNaN(port)) return val;
  if (port >= 0) return port;
  return false;
}
function onError(error) {
  if (error.syscall !== 'listen') throw error;
  const bind = typeof port === 'string' ? 'Pipe '   port : 'Port '   port;
  switch (error.code) {
    case 'EACCES':
      console.error(bind   ' requires elevated privileges');
      process.exit(1);
      break;
    case 'EADDRINUSE':
      console.error(bind   ' is already in use');
      process.exit(1);
      break;
    default:
      throw error;
  }
}
function onListening() {
  const addr = server.address();
  const bind = typeof addr === 'string' ? 'pipe '   addr : 'port '   addr.port;
  debug('Listening on '   bind);
}

配置
config 目录保存应用程序的配置文件,例如数据库连接、服务器设置和环境变量。

示例:config/index.js

module.exports = {
  port: process.env.PORT || 3000,
  db: {
    host: 'localhost',
    port: 27017,
    name: 'mydatabase'
  }
};

控制器
控制器包含处理传入请求和生成响应的逻辑。控制器目录中的每个文件通常对应于应用程序的不同部分(例如客户、产品)。

示例:controllers/customer.js

const Customer = require('../models/customer');
exports.getAllCustomers = async (req, res) => {
  try {
    const customers = await Customer.find();
    res.json(customers);
  } catch (err) {
    res.status(500).json({ message: err.message });
  }
};

中间件
中间件功能用于在请求到达控制器之前对其进行处理。它们可以处理身份验证、日志记录和请求验证等任务。

示例:middleware/auth.js

module.exports = (req, res, next) => {
  const token = req.header('Authorization');
  if (!token) return res.status(401).json({ message: 'Access Denied' });
  try {
    const verified = jwt.verify(token, process.env.JWT_SECRET);
    req.user = verified;
    next();
  } catch (err) {
    res.status(400).json({ message: 'Invalid Token' });
  }
};

模型
模型定义数据的结构并处理与数据库的交互。每个模型文件通常对应于不同的数据实体(例如,客户、产品)。

示例:models/customer.js

const mongoose = require('mongoose');
const customerSchema = new mongoose.Schema({
  name: {
    type: String,
    required: true
  },
  email: {
    type: String,
    required: true,
    unique: true
  },
  createdAt: {
    type: Date,
    default: Date.now
  }
});
module.exports = mongoose.model('Customer', customerSchema);

路线
路由定义了应用程序不同部分的路径并将它们映射到适当的控制器。

示例:routes/api.js

const express = require('express');
const router = express.Router();
const customerController = require('../controllers/customer');
router.get('/customers', customerController.getAllCustomers);
module.exports = router;

民众
公共目录包含直接向客户端提供服务的静态文件,例如 CSS、JavaScript 和图像。

示例:目录结构

public/
├── css/
├── js/
├── images/

观看次数
视图是为客户端呈现 HTML 的模板。使用 EJS、Pug 或 Handlebars 等模板引擎,您可以生成动态 HTML。

示例:views/index.ejs



  My App

Welcome to My App

测试
测试目录包含测试文件,以确保您的应用程序正常工作。测试通常分为单元测试、集成测试和端到端 (e2e) 测试。

示例:目录结构

tests/
├── unit/
├── integration/
├── e2e/

实用程序
实用函数和辅助模块存储在 utils 目录中。这些函数执行整个应用程序中使用的常见任务,例如验证和格式化。

示例:utils/validation.js

exports.isEmailValid = (email) => {
  const re = /^[^\s@] @[^\s@] \.[^\s@] $/;
  return re.test(String(email).toLowerCase());
};

节点模块
node_modules 目录包含您的项目所需的所有依赖项。该目录由 npm(或yarn)管理,包含从 npm 注册表安装的包。

结论
使用 Express.js 的结构良好的 Node.js 应用程序可以增强可维护性、可扩展性和协作性。结构中的每个目录和文件都有特定的用途,从处理配置和定义路由到管理中间件和渲染视图。通过有效地组织代码库,您可以轻松构建强大且可扩展的应用程序。

版本声明 本文转载于:https://dev.to/kafeel_ahmad/how-to-structure-your-backend-code-in-nodejs-expressjs-2e07?1如有侵犯,请联系[email protected]删除
最新教程 更多>
  • 将 Azure Functions 部署到 Azure 容器应用程序的两种方法的比较
    将 Azure Functions 部署到 Azure 容器应用程序的两种方法的比较
    昨天,我写了一篇题为“在 Azure 容器应用程序上部署 Java Azure Function”的文章。 在那篇文章中,我提到了使用 Azure 的集成管理功能,我想澄清这意味着什么以及它与本文中以前的方法有何不同。 旧方法:使用 az containerapp create 创建...
    编程 发布于2024-11-07
  • 如何使用 MinGW 在 Windows 上构建 GLEW?分步指南。
    如何使用 MinGW 在 Windows 上构建 GLEW?分步指南。
    使用 MinGW 在 Windows 上构建 GLEW:综合指南使用 GLEW,这是一个无缝集成 OpenGL 和 WGL 函数的纯头文件库,使用 MinGW 增强 Windows 上 OpenGL 应用程序的开发。为了使用 MinGW 有效构建 GLEW,需要一组特定的命令和步骤。首先,创建两个名...
    编程 发布于2024-11-07
  • 如何使用 CSS 创建带有对角线的双色调背景?
    如何使用 CSS 创建带有对角线的双色调背景?
    使用对角线创建双色调背景要使用 CSS 实现由对角线分为两部分的背景,请执行以下操作这些步骤:1。创建两个 Div:创建两个单独的 div 来表示两个背景部分。2.设置 Div 样式:将以下 CSS 应用于 div:.solid-div { background-color: [solid co...
    编程 发布于2024-11-07
  • 文档的力量:阅读如何改变我在 JamSphere 上使用 Redux 的体验
    文档的力量:阅读如何改变我在 JamSphere 上使用 Redux 的体验
    作为开发人员,我们经常发现自己一头扎进新的库或框架,渴望将我们的想法变为现实。跳过文档并直接跳到编码的诱惑很强烈——毕竟,这有多难呢?但正如我通过构建音乐管理平台 JamSphere 的经验所了解到的那样,跳过这一关键步骤可能会将顺利的旅程变成充满挑战的艰苦战斗。 跳过文档的魅力 当...
    编程 发布于2024-11-07
  • 如何在PHP多子域应用中精准控制Cookie域?
    如何在PHP多子域应用中精准控制Cookie域?
    在 PHP 中控制 Cookie 域和子域创建多子域站点时,有必要控制会话 cookie 的域确保每个子域的正确会话管理。然而,手动设置域时,PHP 的 cookie 处理似乎存在差异。默认情况下,session_start() 会使用当前子域分配会话 cookie。但是,尝试使用 ini_set(...
    编程 发布于2024-11-07
  • Java中的三元运算符可以不返回值吗?
    Java中的三元运算符可以不返回值吗?
    三元运算符:深入研究代码优化虽然三元运算符 (?:) 是 Java 中的一个强大工具,但它了解其局限性至关重要。一个常见的误解是可以在不返回值的情况下使用它。与这种看法相反,Java 不允许在没有 return 语句的情况下进行三元运算。三元运算符的目的是评估条件并将值分配给变量或表达式。如果没有返...
    编程 发布于2024-11-07
  • 为什么您应该在下一个 PHP 项目中尝试 Lithe?
    为什么您应该在下一个 PHP 项目中尝试 Lithe?
    Lithe 是寻求简单性与强大功能之间平衡的开发人员的完美 PHP 框架。如果您厌倦了使开发缓慢且令人困惑的繁琐框架,Lithe 提供了一种极简但极其灵活的方法,旨在使您的工作更快、更高效。 1. 轻量且超快 Lithe 的开发重点是轻量级,允许您以很少的开销创建应用程序。与其他提供...
    编程 发布于2024-11-07
  • 如何处理 Android 中的互联网连接变化?
    如何处理 Android 中的互联网连接变化?
    处理 Android 中的互联网连接变化问题集中在需要一个可以监视互联网连接变化的广播接收器,因为现有代码仅检测连接变化。为了解决这个问题,这里有一个替代方法:public class NetworkUtil { public static final int TYPE_WIFI = 1; ...
    编程 发布于2024-11-07
  • Python 3.x 的 Super() 在没有参数的情况下如何工作?潜在的陷阱是什么?
    Python 3.x 的 Super() 在没有参数的情况下如何工作?潜在的陷阱是什么?
    Python 3.x 的超级魔法:解开谜团Python 3.x 在其 super() 方法中引入了令人惊讶的转折,允许无参数调用。这种看似无害的变化在幕后却带来了重大的后果和内在的魔力。揭开魔力为了维护 DRY 原则,新的 super() 行为绕过了显式类命名。它有一个特殊的 class 单元,用于...
    编程 发布于2024-11-07
  • Tailwind Flex:Flexbox 实用程序初学者指南
    Tailwind Flex:Flexbox 实用程序初学者指南
    Tailwind Flex 提供了一种创建响应式布局的有效方法,无需编写复杂的 CSS。通过使用 flex、flex-row 和 flex-col 等简单的实用程序,您可以轻松对齐和排列元素。 Tailwind Flex 非常适合希望简化布局创建同时保持对对齐、方向和间距的完全控制的开发人员 - 所...
    编程 发布于2024-11-07
  • ETL:从文本中提取人名
    ETL:从文本中提取人名
    假设我们想要抓取chicagomusiccompass.com。 如您所见,它有几张卡片,每张卡片代表一个事件。现在,让我们看看下一篇: 注意事件名称是: jazmin bean: the traumatic livelihood tour 所以现在的问题是:我们如何从文本中提取艺术家的名字? 作为...
    编程 发布于2024-11-07
  • 如何控制 C++ ostream 输出中的浮点精度?
    如何控制 C++ ostream 输出中的浮点精度?
    在 Ostream 输出中维护浮点精度在 C 中,在 ostream 运算中使用“
    编程 发布于2024-11-07
  • 如何保证PHP会话的安全销毁?
    如何保证PHP会话的安全销毁?
    确保销毁 PHP 会话尽管信息存在冲突,但仍有有效的方法可以安全地消除 PHP 会话。要实现此最终终止,遵循多步骤流程至关重要。会话终止的基本步骤删除会话数据:启动会话后与 session_start() 一起,使用 unset() 删除与特定会话变量关联的任何存储数据,例如 $_SESSION[&...
    编程 发布于2024-11-07
  • 为什么我的 MongoDB 文档在 Go 中使用 TTL 索引 5 秒后没有过期?
    为什么我的 MongoDB 文档在 Go 中使用 TTL 索引 5 秒后没有过期?
    在 Go 中使用 MongoDB 在指定的秒数后使文档过期使用 TTL 索引,MongoDB 允许您在指定的秒数后自动使文档过期期间。本文演示了如何使用官方 mongo-go-driver 在 Go 中实现此目的。按照 MongoDB 文档,代码显示了如何:创建带有 expireAfterSecon...
    编程 发布于2024-11-07
  • 使用 JetForms 简化表单管理:完整指南
    使用 JetForms 简化表单管理:完整指南
    在当今的数字环境中,管理表单提交很快就会变得不堪重负,特别是当您跨不同平台处理多个表单时。无论是网站上的简单联系表单还是产品的全面调查,手动维护表单提交都是一件麻烦事。这就是 JetForms 的用武之地——一个简化流程、节省您时间和精力的精简平台。 在本指南中,我将引导您了解如何开始使用 JetF...
    编程 发布于2024-11-07

免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。

Copyright© 2022 湘ICP备2022001581号-3