路线建筑的最佳实践

Question

我正在尝试为后端设置路线。我有两种方法试过设置这些路线，我想知道哪种方式适合最佳实践（或者都不适合？）。差异很小，但是我很想知道这里是否有一个客观的“最好”。

以下是我的尝试：

const express = require("express");
const router = express.Router();
const flashcardController = require('../controllers/flashcardController');

router.get('/', flashcardController.readFlashcard);
router.post('/', flashcardController.createFlashcard);
router.patch('/', flashcardController.updateFlashcard);
router.delete('/', flashcardController.deleteFlashcard);

module.exports = router

当然

const express = require("express");
const router = express.Router();
const flashcardController = require('../controllers/flashcardController');


module.exports = (app) => {
    router.get('/api/flashcard', flashcardController.readFlashcard);
    router.post('/api/flashcard', flashcardController.createFlashcard);
    router.patch('/api/flashcard', flashcardController.updateFlashcard);
    router.delete('/api/flashcard', flashcardController.deleteFlashcard);

    app.use('/', router);
};

，我的app.js（我的后端的入口点）文件将需要针对每个选项中的每个选项略有不同。

Answer 1

如果您认为路由器的工作就是处理它收到的一些请求，而这是通话代码的工作，将路由器放置在呼叫代码希望其操作的任何路径上，那么只有您的第一个选项才能做到那。这将允许呼叫者在所需的任何路径上使用这些路线。

如果您希望实现路由完全自给自足并将路由安装在希望它们打开的路径上的模块，则只有第二个选项可以。

我要说的是，“通常”和更多的“灵活”方案是呼叫者将路线放在需要它们的路径上的第一个方案。但是，您可以自由选择想要的哪种样式。

第二种选择不是特别有效地实施，因此可以改进。根本不需要路由器，因为可以直接将路由直接安装在App对象上。并且，可以避免多次重复/api/flashcard。

例如，第二个选项可能是：

const controller = require('../controllers/flashcardController');
const routePath = '/api/flashcard';

module.exports = (app) => {
    app.get(routePath, controller.readFlashcard);
    app.post(routePath, controller.createFlashcard);
    app.patch(routePath, controller.updateFlashcard);
    app.delete(routePath, controller.deleteFlashcard);
};

或者甚至是这样：

const controller = require('../controllers/flashcardController');

module.exports = (app) => {
    app.route('/api/flashcard')
        .get(controller.readFlashcard)
        .post(controller.createFlashcard)
        .patch(controller.updateFlashcard)
        .delete(controller.deleteFlashcard);
};

并且，第一个选项可以简化为：

const router = require("express").Router();
const controller = require('../controllers/flashcardController');

router.route('/')
  .get(controller.readFlashcard)
  .post(controller.createFlashcard)
  .patch(controller.updateFlashcard)
  .delete(controller.deleteFlashcard);

module.exports = router