Express.js 中控制器函数的命名规范:分离表单渲染与数据处理逻辑

星涛同学_1463

星涛同学_1463

2026-05-24

451人浏览

原创

Express.js 中控制器函数的命名规范:分离表单渲染与数据处理逻辑

在 Express.js 应用中,同一资源路径(如 /car/import)常需分别响应 GET(渲染表单)和 POST(处理提交),推荐采用语义清晰、动词前置的驼峰命名法(如 getCarImport / postCarImport),兼顾可读性与 REST 实践,并建议将 HTML 渲染路由与 JSON API 路由分层隔离。

在 express.js 应用中,同一资源路径(如 `/car/import`)常需分别响应 get(渲染表单)和 post(处理提交),推荐采用语义清晰、动词前置的驼峰命名法(如 `getcarimport` / `postcarimport`),兼顾可读性与 rest 实践,并建议将 html 渲染路由与 json api 路由分层隔离。

在构建 Express.js 控制器时,为同一业务场景(如“导入汽车数据”)定义两个职责分明的处理函数是常见且合理的设计模式:一个负责呈现表单界面(GET),另一个负责接收并处理表单数据(POST)。此时,函数命名不应仅追求技术可达性(如 import_get/import_post),而应体现语义意图、符合团队协作惯例,并为未来扩展(如添加 PUT/PATCH 支持)预留一致性空间。

推荐命名方案:动词前置 + 驼峰式(PascalCase 或 camelCase)

  • ✅ 推荐(小驼峰,更贴近 JavaScript 生态习惯):

    // controllers/CarController.js
    exports.getCarImport = function (req, res) {
      res.render('car_import_page', { /* initial data */ });
    };
    
    exports.postCarImport = async function (req, res) {
      const { cars } = req.body;
      await importCars(cars);
      res.status(200).json({ message: 'Imported successfully' });
    };
  • ✅ 也可接受(帕斯卡命名,强调操作类型):

    exports.GetCarImport = ...  // 首字母大写,适合类方法或严格风格项目
    exports.PostCarImport = ...

⚠️ 避免使用下划线后缀(如 import_get)——它易与私有方法约定(_helper)混淆,且不符合主流 Node.js/Express 社区实践(参考 Express 官方示例、Passport、Morgan 等中间件命名风格)。

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载

路由注册保持清晰对应

// routes/Router.js
const router = Express.Router();
const CarController = require('../controllers/CarController');

router.get('/car/import', CarController.getCarImport);
router.post('/car/import', CarController.postCarImport);

这种命名使路由映射一目了然,也便于 IDE 自动补全和静态分析工具识别行为意图。

进阶建议:分离视图层与 API 层(强烈推荐)

虽然技术上允许 GET /car/import 返回 HTML、POST /car/import 返回 JSON,但混合响应类型违反 REST 原则中的「资源语义一致性」,也增加前端耦合与缓存复杂度。更健壮的架构应明确分层:

请求方式 路径 响应类型 用途
GET /car/import text/html 渲染表单页面(面向用户)
GET /api/v1/cars application/json 获取汽车列表(面向客户端)
POST /api/v1/cars/import application/json 提交导入任务(面向 API)

这样既满足 SEO 与直访需求,又为前后端分离、移动端集成、自动化测试提供清晰边界。你可在 Express 中轻松实现路由前缀隔离:

// 主应用入口
app.use('/', require('./routes/views'));     // HTML 页面路由
app.use('/api/v1', require('./routes/api')); // JSON API 路由

总结

  • 命名核心原则:动词前置 + 语义完整 + 风格统一(优先 getCarImport);
  • 避免技术后缀(_get/_post),提升可维护性与专业感;
  • 将服务端渲染(SSR)与 JSON API 在路径层级上解耦,是长期可扩展架构的关键一步;
  • 最终目标不是“能跑”,而是让新成员一眼读懂:这个函数做什么?何时被调用?返回什么?

遵循这些约定,你的控制器将不仅工作正常,更成为团队高效协作与系统持续演进的坚实基础。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Node.js后端开发与Express框架实践
Node.js后端开发与Express框架实践

本专题针对初中级 Node.js 开发者,系统讲解如何使用 Express 框架搭建高性能后端服务。内容包括路由设计、中间件开发、数据库集成、API 安全与异常处理,以及 RESTful API 的设计与优化。通过实际项目演示,帮助开发者快速掌握 Node.js 后端开发流程。

2026.02.10

761

17

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

2023.06.20

4296

8

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.28

1315

5

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1718

5

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

2023.08.17

9843

11

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

960

4

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2644

5

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.14

1549

5

js截取字符串的方法介绍
js截取字符串的方法介绍

JavaScript字符串截取方法,包括substring、slice、substr、charAt和split方法。这些方法可以根据具体需求,灵活地截取字符串的不同部分。在实际开发中,根据具体情况选择合适的方法进行字符串截取,能够提高代码的效率和可读性 。

2023.09.21

4529

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.8万人学习