在 Koa 中，Controller 负责处理用户请求并返回响应。Controller 的编写质量直接影响了整个应用的可维护性和可扩展性。本文将介绍如何编写高质量的 Koa Controller。
1. Controller 的基本结构
一个典型的 Koa Controller 包含以下几个部分：
-- -------------------- ---- -------
----- -------------- -
----- --------- -
-- --------
-
----- ----------- -
-- --------
-
----- ----------- -
-- --------
-
----- ----------- -
-- --------
-
-
-------------- - ---------------其中，每个方法对应一个 HTTP 请求的处理逻辑。Controller 可以通过 Koa 的上下文对象（ctx）获取请求的参数、请求头、请求体等信息。
2. Controller 的职责
Controller 应该专注于处理请求和返回响应，不应该涉及业务逻辑和数据存储。业务逻辑和数据存储应该由 Service 层来处理。这样可以使 Controller 更加清晰、易于测试和重用。
例如，下面是一个不好的示例：
-- -------------------- ---- -------
----- -------------- -
----- ----------- -
----- - ----- ------ -------- - - -----------------
-- ----------
----- ---- - ----- -------------- ---- ---
-- ------ -
---------- - ----
-------- - - -------- -------- --
-------
-
-- ----
----- ------- - --- ------ ----- ------ -------- ---
----- ---------------
---------- - ----
-------- - - -------- -------- --
-
-在上面的示例中，Controller 既涉及业务逻辑（检查用户名是否已存在），又涉及数据存储（创建用户）。这样会使 Controller 变得复杂、难于测试和重用。
改进的方式是将业务逻辑和数据存储分离到 Service 层：
-- -------------------- ---- -------
----- -------------- -
------------------------ -
---------------- - ------------
-
----- ----------- -
----- - ----- ------ -------- - - -----------------
-- ----
----- ----------- - ----- --------------------------------- ------ ----------
---------- - ----
-------- - - -------- --------- ----- ----------- --
-
-3. Controller 的错误处理
Controller 应该对错误进行适当的处理，并返回有意义的错误信息。Koa 提供了一种方便的方式来处理错误：中间件。
例如，下面是一个处理错误的中间件：
async function errorHandler(ctx, next) {
try {
await next();
} catch (err) {
ctx.status = err.status || 500;
ctx.body = { message: err.message };
}
}该中间件会捕获所有的错误，并将错误信息返回给客户端。
4. Controller 的参数验证
在处理请求时，Controller 应该对参数进行验证，以确保参数的正确性和安全性。Koa 提供了一些方便的中间件来进行参数验证，例如 koa-bodyparser 和 koa-validate。
例如，下面是一个使用 koa-validate 进行参数验证的示例：
-- -------------------- ---- -------
----- --------- - ------------------------
----- -------------- -
----- ----------- -
----- - ----- ------ -------- - - -----------------
-- ----
---------------------------------
---------------------------------
-------------------------------------
-- ------------ -
---------- - ----
-------- - - -------- -------- ------- ---------- --
-------
-
-- ----
----- ----------- - ----- --------------------------------- ------ ----------
---------- - ----
-------- - - -------- --------- ----- ----------- --
-
-
-- ------ --------- ---
---------------------5. Controller 的单元测试
Controller 应该编写单元测试来确保其正确性和稳定性。单元测试应该覆盖 Controller 的所有方法，并对参数验证、错误处理等进行测试。
例如，下面是一个使用 mocha 和 supertest 编写的 Controller 单元测试：
-- -------------------- ---- -------
----- ------- - ---------------------
----- --- - ------------------
----- -------------- - -------------------------------
----- ----------- - ----------------------------
-------------------------- -- -- -
--- ------------
--- ---------------
------------- -- -
----------- - --- --------------
-------------- - --- ----------------------------
---
-------------------- -- -- -
---------- ------ - --- ------ ----- -- -- -
----- --- - ----- -----------------------
---------------
------- ----- -------- ------ -------------------- --------- ---------- --
-------------
-------------------------------
---------------------------------------------
----------------------------------------------------------
---
---------- ------ --- -- ---- -- ------- ----- -- -- -
----- --- - ----- -----------------------
---------------
------- ----- --- ------ -------------------- --------- ---------- --
-------------
---------------------------------
--------------------------------------
---
---------- ------ --- -- ----- -- --- ------- ----- -- -- -
----- --- - ----- -----------------------
---------------
------- ----- -------- ------ --------------- --------- ---------- --
-------------
---------------------------------
---------------------------------------
---
-- ---
---
-- ---
---结论
编写高质量的 Koa Controller 需要遵循一些基本原则：专注于处理请求和返回响应、分离业务逻辑和数据存储、错误处理和参数验证、单元测试等。通过遵循这些原则，可以使 Controller 更加清晰、易于测试和重用，从而提高整个应用的可维护性和可扩展性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/675e8eeee49b4d071617e946