讲师中心 微信公众号
AI工具推荐 视频效率加速

JS注解怎么做参数校验_ JS注解实现参数合法性校验的技巧

小磊小哥_3826

小磊小哥_3826

发布时间:2025-11-18 19:16:02

|

875人浏览过

|

来源于php中文网

原创

JavaScript无原生注解机制,但可通过装饰器、高阶函数或TypeScript结合class-validator模拟实现。1. 使用ES装饰器(如@validate)拦截方法调用并校验参数;2. 通过withValidation高阶函数封装校验规则,增强函数复用性;3. TypeScript项目可引入class-validator库,利用@IsString等装饰器进行DTO校验;4. 简单场景直接在函数内嵌校验逻辑。方案选择需权衡项目复杂度与技术栈。

js注解怎么做参数校验_ js注解实现参数合法性校验的技巧

JavaScript 没有原生的“注解”(Annotation)机制,像 Java 那样的 @Valid 或 @NotNull 注解无法直接使用。但通过一些设计模式和工具,可以模拟“注解式参数校验”,提升代码可读性和复用性。

1. 使用装饰器模拟注解行为(ES 装饰器)

虽然 JavaScript 不支持注解,但 ES 装饰器(目前处于 Stage 3)可以实现类似功能,尤其是在类方法上进行参数校验。

例如,定义一个 @validate 装饰器,自动检查函数参数是否符合规则:

function validate(target, propertyName, descriptor) {
  const method = descriptor.value;
  descriptor.value = function(...args) {
    // 校验逻辑:比如不允许 null 或 undefined
    if (args.some(arg => arg === null || arg === undefined)) {
      throw new Error(`调用 ${propertyName} 失败:参数不能为空`);
    }
    return method.apply(this, args);
  };
}

使用方式:

class UserService {
  @validate
  createUser(name, age) {
    console.log('创建用户:', name, age);
  }
}

注意:需启用装饰器支持(如 TypeScript 或 Babel)。

2. 自定义校验元数据 + 高阶函数模拟注解

在不使用装饰器的情况下,可以通过高阶函数封装校验逻辑,模拟“注解”效果。

定义一个校验包装器:

function withValidation(rules) {
  return function (targetFunc) {
    return function (...args) {
      rules.forEach((rule, index) => {
        if (rule.required && (args[index] === undefined || args[index] === null)) {
          throw new Error(`参数 ${index} 不能为空`);
        }
        if (rule.type && typeof args[index] !== rule.type) {
          throw new Error(`参数 ${index} 必须是 ${rule.type} 类型`);
        }
      });
      return targetFunc.apply(this, args);
    };
  };
}

使用示例:

Aria2 Json Rpc
Aria2 Json Rpc

通过 JSON‑RPC 2.0 与 aria2 下载管理器交互,使用自然语言命令管理下载、查询状态并控制任务。适用于 aria2、下载管理或种子操作。

下载
const createUser = withValidation([
  { required: true, type: 'string' }, // name
  { required: true, type: 'number' } // age
])(function(name, age) {
  console.log('创建用户:', name, age);
});

调用时自动校验:

createUser("Alice", 25); // 正常
createUser(null, 25); // 抛错

3. 利用 TypeScript + 运行时校验库(如 class-validator)

结合 TypeScript 的装饰器和 class-validator 库,能更接近“注解式校验”体验。

安装:

npm install class-validator class-transformer

示例:

import { IsString, IsInt, Min, validateSync } from 'class-validator'; class CreateUserDto {
  @IsString()
  name: string;
  @IsInt()
  @Min(0)
  age: number;
} function createUser(userData) {
  const dto = Object.assign(new CreateUserDto(), userData);
  const errors = validateSync(dto);
  if (errors.length > 0) {
    throw new Error('参数校验失败');
  }
  console.log('创建用户:', dto.name, dto.age);
}

这种方式结构清晰,适合大型项目或 API 接口参数校验。

4. 简化方案:函数内嵌校验或工具函数

对于小型项目,可以直接在函数开头进行参数检查,保持简洁:

function createUser(name, age) {
  if (!name || typeof name !== 'string') {
    throw new Error('name 必须是非空字符串');
  }
  if (typeof age !== 'number' || age
    throw new Error('age 必须是大于等于 0 的数字');
  }
  // 正常逻辑
}

或者封装通用校验函数:

function assert(condition, message) {
  if (!condition) throw new Error(message);
} function createUser(name, age) {
  assert(name && typeof name === 'string', 'name 无效');
  assert(typeof age === 'number' && age >= 0, 'age 无效');
}

基本上就这些。JS 虽无原生注解,但通过装饰器、高阶函数或第三方库,完全可以实现优雅的参数校验机制。选择哪种方式,取决于项目复杂度和技术栈。

热门AI工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

252

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

480

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

331

2026.03.13

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

246

2026.06.03

TypeScript Node.js 全栈工程化与Monorepo架构实践
TypeScript Node.js 全栈工程化与Monorepo架构实践

本专题围绕 TypeScript 在 Node.js 全栈开发中的工程化实践展开,系统讲解 Monorepo 架构设计、包管理策略、模块复用机制以及服务端与前端统一类型系统的构建方法。通过真实项目案例,帮助开发者提升大型全栈项目的可维护性与协作效率。

498

2026.06.16

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

5339

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

529

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1658

2024.03.01

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

160

2026.09.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
JavaScript OOP调试技巧视频教程
JavaScript OOP调试技巧视频教程

共5课时 | 1.1万人学习

WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn