类型安全与交互体验的碰撞：TypeScript swagger 智能提示校验的实现与优化

2023-09-14 01:51:42

优化TypeScript中接口智能提示和校验的代码

在软件开发中，接口扮演着至关重要的角色，因为它定义了对象或函数的结构和行为。在TypeScript中，泛型和统一的接口类型提供了强大的工具，可以实现接口智能提示和校验。

优化代码

创建用于校验接口的函数时，代码的简洁性和可读性至关重要。通过优化代码结构并减少重复部分，我们可以提升代码质量。

function createValidator<T extends object>(schema: T): (data: unknown) => data is T {
  const keys = Object.keys(schema);

  return (data: unknown): data is T => {
    if (typeof data !== 'object' || data === null) {
      return false;
    }

    for (const key of keys) {
      if (!data.hasOwnProperty(key)) {
        return false;
      }

      const value = schema[key];

      if (typeof value === 'object' && value !== null) {
        if (!createValidator(value)(data[key])) {
          return false;
        }
      } else if (typeof value === 'function') {
        if (!value(data[key])) {
          return false;
        }
      } else {
        if (data[key] !== value) {
          return false;
        }
      }
    }

    return true;
  };
}

优化后的代码更简洁，并通过提前获取接口的键名列表来提高效率。

完善提示和校验

为了完善智能提示和校验，我们添加了一个schemaName参数，以便在出现错误时提供更有意义的反馈。此外，我们还添加了一个catch块来捕获代码中的任何错误，防止服务器崩溃。

function validateRequest<T extends object>(schemaName: string, schema: T) {
  return (req: Request, res: Response, next: NextFunction) => {
    const data = req.body;

    const validator = createValidator(schema);

    try {
      if (!validator(data)) {
        res.status(400).json({
          error: `Invalid request data for ${schemaName}`,
        });

        return;
      }
    } catch (error) {
      res.status(500).json({
        error: 'Internal server error',
      });
    }

    next();
  };
}