0

0

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

蓮花仙者

蓮花仙者

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

|

835人浏览过

|

来源于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);
    };
  };
}

使用示例:

TicNote
TicNote

出门问问推出的Agent AI智能硬件

下载
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工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

45

2026.02.13

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

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

186

2026.02.25

string转int
string转int

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

970

2023.08.02

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

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

252

2023.09.22

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

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

1049

2024.03.01

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

846

2023.08.22

php中foreach用法
php中foreach用法

本专题整合了php中foreach用法的相关介绍,阅读专题下面的文章了解更多详细教程。

225

2025.12.04

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

471

2023.10.18

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

23

2026.03.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 10.3万人学习

Django 教程
Django 教程

共28课时 | 4.8万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号