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);
    };
  };
}

使用示例:

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

调用时自动校验:

Magician
Magician

Figma插件,AI生成图标、图片和UX文案

下载
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 虽无原生注解,但通过装饰器、高阶函数或第三方库,完全可以实现优雅的参数校验机制。选择哪种方式,取决于项目复杂度和技术

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

832

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

737

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

734

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16925

2023.08.03

Java 桌面应用开发(JavaFX 实战)
Java 桌面应用开发(JavaFX 实战)

本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

36

2026.01.14

热门下载

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

精品课程

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

共48课时 | 7.1万人学习

Django 教程
Django 教程

共28课时 | 3.1万人学习

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

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