|
|
// 引入Express框架的核心模块，用于创建Web应用以及进行路由相关操作。Express是Node.js中广泛使用的Web框架，
|
|
|
// 借助它可以方便地搭建服务器、定义不同路径及请求方法对应的路由处理逻辑等，是整个Web应用开发的基础框架模块
|
|
|
var express = require('express');
|
|
|
|
|
|
// 创建一个Express路由器实例，方便后续在应用中进行模块化的路由定义与管理。通过使用路由器，
|
|
|
// 可以将不同功能模块相关的路由集中在一起，使代码结构更清晰，便于维护和扩展，比如将所有和订单相关的路由放在这里统一配置
|
|
|
var router = express.Router();
|
|
|
|
|
|
// 引入Node.js的path模块，主要用于处理文件路径相关的操作，例如拼接文件或模块的路径等。在实际应用中，
|
|
|
// 常常需要准确指定模块所在的位置，path模块提供的函数就可以帮助我们灵活地组合路径字符串，确保模块能被正确引入
|
|
|
var path = require("path");
|
|
|
|
|
|
// 获取自定义的验证模块，通过path.join方法将当前工作目录（process.cwd()）与相对路径（"/modules/authorization"）拼接起来，
|
|
|
// 准确地找到并引入该验证模块。这个验证模块在整个应用架构中起着关键作用，通常会负责诸如用户权限验证等相关功能，
|
|
|
// 只有通过了权限验证的操作才能继续执行，以此确保后续操作的合法性和安全性，防止非法访问和数据泄露等问题
|
|
|
var authorization = require(path.join(process.cwd(), "/modules/authorization"));
|
|
|
|
|
|
// 通过验证模块获取名为"OrderService"的服务对象，该服务对象应该封装了与订单相关的各种业务操作方法，例如订单的增删改查等功能。
|
|
|
// 这样在后续的路由处理中，就可以方便地调用这些方法来实现具体的订单相关业务逻辑，无需在路由代码中重复编写复杂的数据库操作等代码
|
|
|
var orderServ = authorization.getService("OrderService");
|
|
|
|
|
|
// 定义处理获取订单列表的GET请求的路由，路径为根路径 "/"，这意味着当客户端向服务器发送GET请求到根路径时，
|
|
|
// 将会进入这个路由对应的处理逻辑，以获取相应的订单列表数据，一般会从数据库等数据存储中查询并返回符合条件的订单信息给客户端
|
|
|
router.get("/",
|
|
|
// 第一个中间件函数，用于对请求参数进行验证。在Express框架中，中间件函数可以在请求到达最终的路由处理函数之前，
|
|
|
// 对请求进行预处理，比如检查请求携带的参数是否符合业务要求，确保后续基于这些参数进行的业务操作不会因为参数错误而出现异常
|
|
|
function (req, res, next) {
|
|
|
// 验证pagenum参数是否存在且大于0，如果该参数不存在或者小于等于0，则返回错误响应，状态码400表示请求参数有误。
|
|
|
// pagenum参数通常用于分页查询操作，表示要获取的页码，从逻辑上来说，页码应该是大于0的正整数，若不符合此要求则不符合分页查询的正常规则
|
|
|
if (!req.query.pagenum || req.query.pagenum <= 0) return res.sendResult(null, 400, "pagenum 参数错误");
|
|
|
// 验证pagesize参数是否存在且大于0，如果该参数不存在或者小于等于0，则返回错误响应。
|
|
|
// pagesize参数同样常用于分页查询操作，用于指定每页显示的订单数量，也应当是大于0的正整数，否则无法正确进行分页展示订单数据
|
|
|
if (!req.query.pagesize || req.query.pagesize <= 0) return res.sendResult(null, 400, "pagesize 参数错误");
|
|
|
// 参数验证通过后，调用next()将控制权传递给下一个中间件或路由处理函数，这是Express中间件机制中实现流程控制的关键操作，
|
|
|
// 通过调用next()来保证请求能按照顺序依次经过各个中间件进行相应处理，若不调用则请求会被阻塞在当前中间件处，无法继续后续流程
|
|
|
next();
|
|
|
},
|
|
|
// 第二个中间件函数，用于处理获取订单列表的业务逻辑，在前面的参数验证中间件通过后，就会进入这个中间件来执行具体的获取订单列表操作，
|
|
|
// 例如根据前面验证通过的参数去数据库中查询符合条件的订单数据，然后将查询结果返回给客户端展示
|
|
|
function (req, res, next) {
|
|
|
var conditions = {
|
|
|
// 将请求中的pagenum参数添加到查询条件对象中，该参数常用于分页查询操作，指定要获取的页码，
|
|
|
// 后续在调用获取订单列表的方法时，可以依据这个页码来确定从数据库中取出哪一部分订单数据返回给客户端，实现分页功能
|
|
|
"pagenum": req.query.pagenum,
|
|
|
// 将请求中的pagesize参数添加到查询条件对象中，用于指定每页显示的订单数量，这样就能准确控制每次返回给客户端的订单数据量，
|
|
|
// 方便用户分页浏览订单列表，提升用户体验
|
|
|
"pagesize": req.query.pagesize
|
|
|
};
|
|
|
|
|
|
// 如果请求中包含user_id参数，则将其添加到查询条件对象中，可用于根据用户ID筛选订单。比如在电商系统中，
|
|
|
// 用户可能只想查看自己的订单，通过传入自己的用户ID作为筛选条件，就能获取到与之对应的订单信息，实现个性化的数据查询需求
|
|
|
if (req.query.user_id) {
|
|
|
conditions["user_id"] = req.query.user_id;
|
|
|
}
|
|
|
// 如果请求中包含pay_status参数，则将其添加到查询条件对象中，可能用于根据支付状态筛选订单。例如，
|
|
|
// 商家可能想查看已支付、未支付或者部分支付的订单情况，就可以通过传入相应的支付状态值来筛选出符合要求的订单列表，便于进行业务管理
|
|
|
if (req.query.pay_status) {
|
|
|
conditions["pay_status"] = req.query.pay_status;
|
|
|
}
|
|
|
// 如果请求中包含is_send参数，则将其添加到查询条件对象中，也许用于根据订单是否已发送来筛选订单。像物流相关的业务场景中，
|
|
|
// 可以通过这个参数筛选出已发货或者未发货的订单，方便跟踪订单的物流状态以及进行相应的后续操作
|
|
|
if (req.query.is_send) {
|
|
|
conditions["is_send"] = req.query.is_send;
|
|
|
} // 如果请求中包含order_fapiao_title参数，则将其添加到查询条件对象中，可能是用于根据发票抬头筛选订单之类的业务需求
|
|
|
if (req.query.order_fapiao_title) {
|
|
|
conditions["order_fapiao_title"] = req.query.order_fapiao_title;
|
|
|
}
|
|
|
//这段代码整体实现了一个获取订单列表的路由功能，先是通过中间件对请求参数进行了必要的验证，确保
|
|
|
//分页相关参数以及可能的筛选参数是合法有效的，后续准备基于这些参数去执行获取订单列表的实际业务
|
|
|
//逻辑，不过目前代码还未完整展示出调用服务获取订单列表以及返回结果的部分。
|
|
|
// 如果请求中包含order_fapiao_company参数，则将其添加到查询条件对象中，也许是根据发票所属公司来筛选订单。
|
|
|
// 在实际业务场景中，例如企业财务统计或者税务相关需求时，可能需要按照发票所属公司来查看对应的订单情况，所以通过这个参数进行筛选
|
|
|
if (req.query.order_fapiao_company) {
|
|
|
conditions["order_fapiao_company"] = req.query.order_fapiao_company;
|
|
|
}
|
|
|
// 如果请求中包含order_fapiao_content参数，则将其添加到查询条件对象中，可能用于根据发票内容筛选订单。
|
|
|
// 比如根据发票开具的具体商品或服务内容来查找特定类型的订单，方便财务核算或者业务分析等操作
|
|
|
if (req.query.order_fapiao_content) {
|
|
|
conditions["order_fapiao_content"] = req.query.order_fapiao_content;
|
|
|
}
|
|
|
// 如果请求中包含consignee_addr参数，则将其添加到查询条件对象中，可用于根据收件人地址筛选订单。
|
|
|
// 像物流配送部门可能会根据收件人地址来统计不同地区的订单量、查看特定区域的订单发货情况等，以此实现针对性的业务管理
|
|
|
if (req.query.consignee_addr) {
|
|
|
conditions["consignee_addr"] = req.query.consignee_addr;
|
|
|
}
|
|
|
|
|
|
// 调用orderServ服务对象的getAllOrders方法，传入构建好的查询条件对象，用于获取符合条件的订单列表。
|
|
|
// getAllOrders方法应该是在OrderService中定义的用于从数据库等数据存储中查询出满足各种筛选条件的订单数据的方法，
|
|
|
// 它是一个异步操作，涉及到数据库查询语句的执行、数据的获取及整理等操作，所以需要通过回调函数来处理操作完成后的结果情况
|
|
|
orderServ.getAllOrders(
|
|
|
conditions,
|
|
|
function (err, result) {
|
|
|
// 如果在执行获取订单列表的异步操作过程中出现错误（err不为null），例如数据库连接失败、查询语句语法错误等情况，
|
|
|
// 则返回包含错误信息的响应，状态码为400表示请求出现错误，同时将具体的错误信息（err）传递给客户端，让客户端知晓请求失败的原因
|
|
|
if (err) return res.sendResult(null, 400, err);
|
|
|
// 如果获取订单列表操作成功，也就是成功从数据库等数据源获取到了符合条件的订单数据，
|
|
|
// 则返回包含订单列表数据（result）的响应，状态码为200表示请求成功，并且附带提示信息"获取成功"，告知客户端操作已顺利完成
|
|
|
res.sendResult(result, 200, "获取成功");
|
|
|
}
|
|
|
)(req, res, next);
|
|
|
});
|
|
|
|
|
|
// 定义处理添加订单的POST请求的路由，路径为 "/"，这意味着当客户端向服务器的根路径发送POST请求时，
|
|
|
// 将会进入这个路由对应的处理逻辑，通常POST请求用于向服务器提交数据来创建新的资源，在这里就是用于添加新的订单
|
|
|
router.post("/",
|
|
|
// 参数验证中间件，当前这里直接调用next()，意味着暂时没有进行额外的参数验证逻辑，可能后续需要补充相关验证代码。
|
|
|
// 按照正常的业务逻辑，添加订单时请求体应该包含如商品信息、用户信息、收货地址等创建订单所必需的各种信息，需要对这些信息的完整性和合法性进行验证
|
|
|
function (req, res, next) {
|
|
|
next();
|
|
|
},
|
|
|
// 业务逻辑中间件，用于处理添加订单的具体操作，在参数验证中间件（虽然当前为空验证）通过后，
|
|
|
// 会进入这个中间件来执行实际的添加订单操作，比如将订单数据插入到数据库等数据存储中，完成新订单的创建
|
|
|
function (req, res, next) {
|
|
|
// 获取请求体中的参数，这些参数（params）应该包含了创建订单所需的各种信息，例如商品信息、用户信息、收货地址等，
|
|
|
// 具体的参数结构和内容取决于前端传递的数据格式以及后端创建订单业务逻辑的要求
|
|
|
var params = req.body;
|
|
|
// 调用orderServ服务对象的createOrder方法，传入订单参数，用于创建新的订单。
|
|
|
// createOrder方法应该是在OrderService中定义的用于向数据存储（如数据库）中插入新订单记录的方法，
|
|
|
// 它是一个异步操作，会涉及到数据库连接、插入语句执行等操作，所以通过回调函数来处理操作完成后的结果情况
|
|
|
orderServ.createOrder(params, function (err, newOrder) {
|
|
|
// 如果在执行创建订单的异步操作过程中出现错误（err不为null），例如数据库插入失败、参数不符合数据库表结构要求等情况，
|
|
|
// 则返回包含错误信息的响应，状态码为400表示请求出现错误，同时将具体的错误信息（err）传递给客户端，告知客户端创建订单失败的原因
|
|
|
if (err) return res.sendResult(null, 400, err);
|
|
|
// 如果创建订单操作成功，也就是成功在数据库等数据存储中插入了新的订单记录，
|
|
|
// 则返回包含新创建订单信息（newOrder）的响应，状态码为201表示资源创建成功，并且附带提示信息"创建订单成功"，告知客户端订单已成功创建
|
|
|
return res.sendResult(newOrder, 201, "创建订单成功");
|
|
|
})(req, res, next);
|
|
|
|
|
|
}
|
|
|
);
|
|
|
|
|
|
// 定义处理更新订单的PUT请求的路由，路径中包含订单ID参数，格式为 "/:id"，这里用于更新订单的发送状态（从代码上下文推测），
|
|
|
// 一般PUT请求常用于对已存在的资源进行部分更新操作，在这里就是针对特定订单（通过订单ID来确定）进行相关信息的更新，比如修改订单的发货状态等
|
|
|
router.put("/:id",
|
|
|
// 参数验证中间件，当前这里直接调用next()，暂时没有进行参数验证相关逻辑，也许后续需要添加如验证订单ID合法性等代码。
|
|
|
// 因为要更新指定的订单，必须先确保传入的订单ID是合法有效的，例如不能为空且格式正确等，否则无法准确找到对应的订单记录进行更新操作
|
|
|
function (req, res, next) {
|
|
|
next();
|
|
|
},
|
|
|
// 业务逻辑中间件，用于处理更新订单的具体操作，在前面参数验证中间件（虽然当前为空验证）通过后，
|
|
|
// 会进入这个中间件来执行实际的更新订单操作，比如修改数据库中对应订单记录的相关字段值，完成订单信息的更新
|
|
|
function (req, res, next) {
|
|
|
var params = req.body;
|
|
|
// 调用orderServ服务对象的updateOrder方法，传入订单ID（req.params.id）和更新的参数（params），用于更新指定订单的相关信息。
|
|
|
// updateOrder方法应该是在OrderService中定义的用于根据订单ID修改对应订单记录中相关字段信息的方法，
|
|
|
// 它是一个异步操作，涉及到数据库连接、更新语句执行等操作，通过回调函数来处理操作完成后的结果情况
|
|
|
orderServ.updateOrder(req.params.id, params, function (err, newOrder) {
|
|
|
// 如果在执行更新订单的异步操作过程中出现错误（err不为null），例如数据库更新失败、传入的更新参数不符合要求等情况，
|
|
|
// 则返回包含错误信息的响应，状态码为400表示请求出现错误，同时将具体的错误信息（err）传递给客户端，告知客户端更新订单失败的原因
|
|
|
if (err) return res.sendResult(null, 400, err);
|
|
|
// 如果更新订单操作成功，也就是成功在数据库等数据存储中修改了对应订单记录的相关信息，
|
|
|
// 则返回包含更新后订单信息（newOrder）的响应，状态码为201表示资源更新成功，并且附带提示信息"更新订单成功"，告知客户端订单已成功更新
|
|
|
return res.sendResult(newOrder, 201, "更新订单成功");
|
|
|
})(req, res, next);
|
|
|
}
|
|
|
);
|
|
|
|
|
|
// 定义处理获取指定订单详情的GET请求的路由，路径中包含订单ID参数，格式为 "/:id"，这表示当客户端向服务器发送GET请求并携带具体的订单ID时，
|
|
|
// 将会进入这个路由对应的处理逻辑，用于获取对应订单的详细信息，比如订单包含的商品详情、下单时间、收货地址、订单状态等各种具体信息
|
|
|
router.get("/:id", function (req, res, next) {
|
|
|
// 调用orderServ服务对象的getOrder方法，传入订单ID（req.params.id），用于获取指定订单的详细信息。
|
|
|
// getOrder方法应该是在OrderService中定义的用于从数据库等数据存储中查询出对应订单的详细记录信息的方法，
|
|
|
// 它是一个异步操作，涉及到数据库查询语句的执行以及数据的提取和整理等操作，所以通过回调函数来处理操作完成后的结果情况
|
|
|
orderServ.getOrder(req.params.id, function (err, result) {
|
|
|
// 如果在执行获取订单详情的异步操作过程中出现错误（err不为null），例如数据库查询失败、订单ID对应的记录不存在等情况，
|
|
|
// 则返回包含错误信息的响应，状态码为400表示请求出现错误，同时将具体的错误信息（err）传递给客户端，让客户端知晓获取订单详情失败的原因
|
|
|
if (err) return res.sendResult(null, 400, err);
|
|
|
// 如果获取订单详情操作成功，也就是成功从数据库等数据源获取到了指定订单的详细信息，
|
|
|
// 则返回包含订单详细信息（result）的响应，状态码为200表示请求成功，并且附带提示信息"获取成功"，告知客户端操作已顺利完成
|
|
|
return res.sendResult(result, 200, "获取成功");
|
|
|
})(req, res, next);
|
|
|
});
|
|
|
|
|
|
// 将配置好的路由器对象导出，以便在主应用中引入并挂载到对应的路径上，使这些路由能够响应客户端相应的HTTP请求。
|
|
|
// 只有在主应用中进行了挂载操作后，客户端发送的对应请求（如获取订单列表、添加订单、更新订单、获取订单详情等请求）才能被正确路由到这里定义的处理逻辑中进行处理
|
|
|
module.exports = router;
|
|
|
//这段代码围绕订单相关的操作定义了多个路由及其对应的处理逻辑，涵盖了获取订单列表、添加订单、更
|
|
|
//新订单以及获取订单详情等功能。每个路由处理逻辑基本都遵循先进行参数验证（部分目前还未完善验证
|
|
|
//逻辑），再执行相应业务操作，最后根据操作结果向客户端返回合适响应信息的流程，整体用于实现后端
|
|
|
//与订单相关的接口服务功能。
|
