笔记大全

聊聊关于node后端路由自动加载

更新时间：2023-07-09

什么是路由自动加载?

路由是Web应用程序的一项重要功能之一，主要用于将Web请求路由到正确的处理程序上。通常，路由由手写的代码控制，并在应用启动时一次性加载，但是路由自动加载提供了一种更加简单和自动化的加载方式。路由自动加载允许应用程序在处理请求时根据需求自动加载路由，从而增加了应用程序的扩展性和灵活性。


// 手动路由加载
const express = require('express')
const app = express()

app.get('/api/users', (req, res) => {
  // 处理请求
})

app.post('/api/users', (req, res) => {
  // 处理请求
})


// 路由自动加载
const fs = require('fs')
const express = require('express')
const app = express()

const routePath = './routes' // 存放路由文件的文件夹

fs.readdirSync(routePath).forEach(file => {
  const route = require('./routes/' + file) // 加载路由文件
  app.use(route)
})

为什么需要路由自动加载?

当应用程序变得越来越复杂时，手写路由代码的可维护性降低了。在这种情况下，路由自动加载将有助于提高应用程序的可维护性和扩展性。路由自动加载可以根据约定和配置自动加载路由信息，从而消除了手写路由代码的需要，并让开发者可以更专注于业务逻辑的实现。


// 路由文件 example.js
const express = require('express')
const router = express.Router()

router.get('/example', (req, res) => {
  // 处理请求
})

module.exports = router


// 自动加载路由
const fs = require('fs')
const path = require('path')
const express = require('express')
const app = express()

const routePath = './routes' // 存放路由文件的文件夹

fs.readdirSync(routePath).forEach(file => {
  const route = require(path.join(routePath, file)) // 加载路由文件
  app.use('/api/' + path.basename(file, '.js'), route) // 根据文件名自动加载路由
})

路由自动加载实现方式

路由自动加载的实现方式主要有两种：扫描文件和声明式路由。扫描文件方式是在应用程序启动时扫描存放路由文件的目录，动态加载路由文件并注册路由，优点是简单易实现，缺点是可能存在安全隐患。声明式路由方式则是通过读取路由配置文件，动态生成路由，优点是高灵活性和可维护性，缺点是相对复杂。


// 扫描文件方式实现路由自动加载
const fs = require('fs')
const express = require('express')
const app = express()

const routePath = './routes' // 存放路由文件的文件夹

fs.readdirSync(routePath).forEach(file => {
  const route = require('./routes/' + file) // 加载路由文件
  app.use(route)
})


// 声明式路由方式实现路由自动加载
const fs = require('fs')
const express = require('express')
const app = express()

const routeConfig = require('./route.config.json') // 路由配置文件

routeConfig.forEach(config => {
  const router = express.Router()

  config.routes.forEach(route => {
    router[route.method || 'get'](route.path, route.handler) // 生成路由
  })

  app.use(config.prefix, router) // 注册路由
})

路由自动加载的缺点和优点

路由自动加载的优点主要是提高了应用程序的可维护性和扩展性，减少了手写路由代码的需要，让开发者可以更专注于业务逻辑的实现。路由自动加载的缺点主要是可能存在安全隐患，如果不加以限制，可能会导致恶意路由的加载和执行。此外，路由自动加载还可能会降低应用程序的性能，因为动态加载路由需要额外的时间和计算资源。

c语言编程笔录