在 Hacktoberfest 的第三周,我决定为一个较小但有前途的项目做出贡献:在线拍卖系统。尽管该项目仍处于早期阶段,但它已经显示出增长潜力,而且我看到了帮助改进其代码库的机会。我的任务是通过减少冗余代码和改进整体结构来重构项目,使其更具可维护性和可扩展性。
我的任务的核心目标是识别重复的代码模式并重构它们以使代码库更干净且更易于维护。代码冗余可能会导致不一致,使未来的更新更加困难,并增加出现错误的可能性。通过简化代码,我的目标是在不改变功能的情况下提高效率。
1.集中异步错误处理: Express.js 项目中的常见问题之一是用于处理异步路由中的错误的重复 try-catch 块。为了解决这个问题,我引入了一个名为 asyncHandler 的实用程序函数,它包装了所有异步函数,确保自动捕获任何错误并在整个应用程序中一致地处理。
// utils/asyncHandler.js const asyncHandler = (fn, errorMessage = "Internal server error") => (req, res, next) => Promise.resolve(fn(req, res, next)).catch((error) => { console.error(`Error: ${error.message}`); res.status(500).json({ error: errorMessage }); }); module.exports = asyncHandler;
此更改不仅删除了多余的 try-catch 块,而且使代码更简洁,更专注于业务逻辑,而不是错误处理。
2.数据库实用功能: 该项目有多个直接与数据库交互的路线,经常重复类似的查询。为了减少冗余,我创建了一组可重用的实用函数来处理常见的数据库查询,例如获取买家信息或检索交易。
// utils/dbUtils.js const getBuyerById = async (buyerId) => { const query = "SELECT * FROM Buyers WHERE Buyer_ID = $1"; const { rows } = await pool.query(query, [buyerId]); return rows.length > 0 ? rows[0] : null; }; const getTransactionsByBuyerId = async (buyerId) => { const query = "SELECT * FROM Transactions WHERE Buyer_ID = $1"; const { rows } = await pool.query(query, [buyerId]); return rows; }; module.exports = { getBuyerById, getTransactionsByBuyerId };
现在,代码库可以依赖这些实用函数,而不是直接在每个路由中编写 SQL 查询,从而减少重复并使逻辑更易于管理。
3.统一响应处理: 另一个改进领域是响应处理。不同的路由发送成功和错误响应的模式不一致。为了标准化这一点,我引入了实用函数,例如 send404、send500 和 sendSuccess。
由于该项目仍处于早期阶段,我注意到一些丢失的路线,例如我可以轻松创建的 POST、DELETE 和 PUT。然而,我决定坚持只问我的问题。
在评论中让我知道,你通常如何处理这种你可以贡献更多的情况......你会打开一个新问题,你只是创建它并执行 Pull 请求吗?我很想读一下你的经历。
免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。
Copyright© 2022 湘ICP备2022001581号-3