koa3-cli 1.0.7 → 1.0.9

package/app/controller/user.js

@@ -1,4 +1,27 @@
 const userService = require('../service/user');
+const { Joi, validateValue } = require('../lib/validator');
+
+const idParamSchema = Joi.object({
+  id: Joi.string().required().messages({ 'any.required': '用户 id 不能为空' })
+});
+
+const createUserBodySchema = Joi.object({
+  name: Joi.string().trim().min(1).max(100).required().messages({
+    'any.required': '用户名为必填',
+    'string.empty': '用户名不能为空',
+    'string.max': '用户名不能超过 100 个字符'
+  }),
+  email: Joi.string().email().allow('').optional(),
+  age: Joi.number().integer().min(0).max(150).optional()
+}).options({ stripUnknown: true });
+
+const updateUserBodySchema = Joi.object({
+  name: Joi.string().trim().min(1).max(100).optional(),
+  email: Joi.string().email().allow('').optional(),
+  age: Joi.number().integer().min(0).max(150).optional()
+}).min(1).messages({
+  'object.min': '至少需要提供一个要更新的字段'
+}).options({ stripUnknown: true });
 
 function logMeta(ctx, extra = {}) {
   return {
@@ -22,7 +45,7 @@ class UserController {
   }
 
   async detail(ctx) {
-    const { id } = ctx.state.validated ? ctx.state.validated.params : ctx.params;
+    const { id } = await validateValue(idParamSchema, ctx.params);
 
     try {
       const user = await userService.getUserById(id);
@@ -42,7 +65,7 @@ class UserController {
   }
 
   async create(ctx) {
-    const userData = ctx.state.validated ? ctx.state.validated.body : ctx.request.body;
+    const userData = await validateValue(createUserBodySchema, ctx.request.body);
 
     try {
       const user = await userService.createUser(userData);
@@ -56,8 +79,8 @@ class UserController {
   }
 
   async update(ctx) {
-    const { id } = ctx.state.validated ? ctx.state.validated.params : ctx.params;
-    const userData = ctx.state.validated ? ctx.state.validated.body : ctx.request.body;
+    const { id } = await validateValue(idParamSchema, ctx.params);
+    const userData = await validateValue(updateUserBodySchema, ctx.request.body);
 
     try {
       const user = await userService.updateUser(id, userData);
@@ -77,7 +100,7 @@ class UserController {
   }
 
   async delete(ctx) {
-    const { id } = ctx.state.validated ? ctx.state.validated.params : ctx.params;
+    const { id } = await validateValue(idParamSchema, ctx.params);
 
     try {
       const result = await userService.deleteUser(id);

package/app/lib/validator.js

@@ -43,7 +43,28 @@ function validate(schemas = {}) {
   };
 }
 
+/**
+ * 在控制器内校验单个对象，失败时抛出与 validate() 中间件相同形态的 422 错误
+ */
+async function validateValue(schema, value, validateOptions = { stripUnknown: true }) {
+  try {
+    return await schema.validateAsync(value ?? {}, validateOptions);
+  } catch (err) {
+    if (!Joi.isError(err)) {
+      throw err;
+    }
+    const validationError = new Error(err.message || 'Validation Failed');
+    validationError.status = 422;
+    validationError.details = err.details.map(d => ({
+      field: d.path.join('.'),
+      message: d.message
+    }));
+    throw validationError;
+  }
+}
+
 module.exports = {
   validate,
+  validateValue,
   Joi
 };

package/app/router.js

@@ -1,6 +1,4 @@
 const { Router } = require('@koa/router');
-const { validate } = require('./lib/validator');
-const userSchema = require('./schema/user');
 
 const router = new Router();
 
@@ -14,9 +12,9 @@ router.get('/', homeController.index);
 
 // 用户相关路由
 router.get('/api/user', userController.list);
-router.get('/api/user/:id', validate({ params: userSchema.idParam }), userController.detail);
-router.post('/api/user', validate({ body: userSchema.createUserBody }), userController.create);
-router.put('/api/user/:id', validate({ params: userSchema.idParam, body: userSchema.updateUserBody }), userController.update);
-router.delete('/api/user/:id', validate({ params: userSchema.idParam }), userController.delete);
+router.get('/api/user/:id', userController.detail);
+router.post('/api/user', userController.create);
+router.put('/api/user/:id', userController.update);
+router.delete('/api/user/:id', userController.delete);
 
 module.exports = router;

package/app/setup.js

@@ -16,12 +16,44 @@ const router = require('./router');
 
 const rootDir = path.join(__dirname, '..');
 
+/**
+ * 生成静态资源缓存配置。
+ *
+ * SPA 的入口 index.html 会引用最新一批带 hash 的 JS/CSS 文件，如果入口文件被浏览器或 CDN
+ * 长时间缓存，用户发布后仍会拿到旧入口，进而继续加载旧资源。这里仅禁止 index.html 缓存，
+ * 其他静态资源继续使用配置里的 maxAge，保证发布更新及时生效且不影响资源缓存性能。
+ *
+ * @param {Object} staticOptions koa-static 原始配置项
+ * @returns {Object} 注入 index.html 不缓存策略后的 koa-static 配置项
+ */
+function createStaticOptions(staticOptions = {}) {
+  const userSetHeaders = staticOptions.setHeaders;
+
+  return {
+    ...staticOptions,
+    setHeaders(res, filePath, stats) {
+      if (typeof userSetHeaders === 'function') {
+        userSetHeaders(res, filePath, stats);
+      }
+
+      // koa-send 在启用 gzip/brotli 时传入的是 index.html.gz / index.html.br，
+      // 需要去掉压缩扩展名后再判断，避免预压缩入口文件继续被长缓存。
+      const normalizedFileName = path.basename(filePath).replace(/\.(br|gz)$/i, '');
+      if (normalizedFileName === 'index.html') {
+        res.setHeader('Cache-Control', INDEX_HTML_CACHE_CONTROL);
+        res.setHeader('Pragma', 'no-cache');
+        res.setHeader('Expires', '0');
+      }
+    }
+  };
+}
+
 function setup(app, config, logger) {
   // 静态资源
   if (config.static && config.static.enable !== false) {
     const staticPath = path.join(rootDir, config.static.dir || 'public');
-    if (fs.existsSync(staticPath)) {
-      app.use(serveStatic(staticPath, config.static.options || {}));
+    if (fs.existsSync(staticPath)) {
+      app.use(serveStatic(staticPath, createStaticOptions(config.static.options || {})));
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koa3-cli",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Koa3脚手架",
   "main": "app.js",
   "bin": {

package/app/schema/user.js

@@ -1,29 +0,0 @@
-const { Joi } = require('../lib/validator');
-
-const idParam = Joi.object({
-  id: Joi.string().required().messages({ 'any.required': '用户 id 不能为空' })
-});
-
-const createUserBody = Joi.object({
-  name: Joi.string().trim().min(1).max(100).required().messages({
-    'any.required': '用户名为必填',
-    'string.empty': '用户名不能为空',
-    'string.max': '用户名不能超过 100 个字符'
-  }),
-  email: Joi.string().email().allow('').optional(),
-  age: Joi.number().integer().min(0).max(150).optional()
-}).options({ stripUnknown: true });
-
-const updateUserBody = Joi.object({
-  name: Joi.string().trim().min(1).max(100).optional(),
-  email: Joi.string().email().allow('').optional(),
-  age: Joi.number().integer().min(0).max(150).optional()
-}).min(1).messages({
-  'object.min': '至少需要提供一个要更新的字段'
-}).options({ stripUnknown: true });
-
-module.exports = {
-  idParam,
-  createUserBody,
-  updateUserBody
-};