You need to enable JavaScript to run this app. TypeScript如何结合字符串枚举与类属性实现权限属性类型校验
优惠活动
大模型
产品
解决方案
定价
更多

TypeScript如何结合字符串枚举与类属性实现权限属性类型校验

现有实现与痛点

现有代码

User 类定义

export class User {
    public id: number;

    // 基础信息
    public email: string;
    public firstName: string;
    public lastName: string;

    // 权限字段
    public canHangSocks: boolean;
    public canDrinkEggnot: boolean;
    public canReachMistletoe: boolean;
    public canSleepWhileSantaInChimney: boolean;
}

权限校验指令

@Directive({
  selector: '[checkPermission]'
})
export class ActionButtonCheckerDirective {
  private currentUser: User;
  @Input() checkPermission: string;

  constructor(
    private host: NbActionComponent,
    private rootStore: Store<ApplicationState>
  ) { }

  ngOnInit() {
    this.rootStore.pipe(select(fromApp.getCurrentUser)).subscribe((user: User) => {
      this.currentUser = user;
      this.host.disabled = this.validateUserPermission(this.checkPermission);
    });
  }

  validateUserPermission(permissionName: string): boolean {
    return !this.currentUser[permissionName];
  }
}

指令使用方式

<nb-action checkPermission="canHangSocks" nbTooltip="Hang Socks"></nb-action>

当前存在的问题

  • 指令输入为任意字符串,传值时拼错权限名(比如把canHangSocks写成canHangSockts)不会触发编译错误,只能运行时发现
  • 权限字段散落在User类中,缺少集中的权限源,后续增删权限容易漏改
目标实现方案

TypeScript 不支持类直接继承枚举拿到属性,但可以通过类型约束的方式实现完全等价的强类型效果,同时保持代码简洁:

第一步:定义集中管理的权限字符串枚举

把所有权限的字符串值统一放在枚举中,作为唯一的权限来源:

export enum Permission {
  CanHangSocks = 'canHangSocks',
  CanDrinkEggnot = 'canDrinkEggnot',
  CanReachMistletoe = 'canReachMistletoe',
  CanSleepWhileSantaInChimney = 'canSleepWhileSantaInChimney',
}

第二步:建立枚举与User类的绑定关系

可以根据严格程度需求,选择两种绑定方式,实现“枚举成员自动作为User的布尔属性”的效果:

方式1:简洁模式(索引签名)

通过索引签名让User类自动匹配所有枚举值,无需手写每个权限字段:

export class User {
  public id: number;
  public email: string;
  public firstName: string;
  public lastName: string;

  // 索引签名:自动匹配Permission枚举的所有值作为布尔属性
  [key: Permission]: boolean;
}

TypeScript会自动校验:只要是Permission枚举中定义的权限,都可以通过user[Permission.XXX]安全访问,类型为boolean;如果访问了枚举中不存在的属性,会直接报类型错误。

方式2:严格模式(接口实现)

如果希望显式声明所有字段,避免隐式属性带来的不透明感,可以通过实现Record接口,让编译器强制校验所有枚举对应的字段都被定义:

export class User implements Record<Permission, boolean> {
  public id: number;
  public email: string;
  public firstName: string;
  public lastName: string;

  // 漏写任何一个枚举对应的权限字段,编译器都会直接报错提醒补充
  public canHangSocks: boolean;
  public canDrinkEggnot: boolean;
  public canReachMistletoe: boolean;
  public canSleepWhileSantaInChimney: boolean;
}

第三步:给指令加强类型输入约束

把原来的string类型输入替换为Permission枚举类型,从根源上避免非法传值:

@Directive({
  selector: '[checkPermission]'
})
export class ActionButtonCheckerDirective {
  private currentUser: User;
  // 强类型约束:输入仅接受Permission枚举的合法值
  @Input() checkPermission!: Permission;

  constructor(
    private host: NbActionComponent,
    private rootStore: Store<ApplicationState>
  ) { }

  ngOnInit() {
    this.rootStore.pipe(select(fromApp.getCurrentUser)).subscribe((user: User) => {
      this.currentUser = user;
      this.host.disabled = this.validateUserPermission(this.checkPermission);
    });
  }

  validateUserPermission(permission: Permission): boolean {
    return !this.currentUser[permission];
  }
}

第四步:模板中使用枚举绑定

把原来的硬编码字符串传值替换为枚举值绑定,IDE会自动补全枚举选项,拼错直接触发类型报错:

  1. 先在使用该指令的组件中把枚举暴露给模板:
    // 组件类内定义,供模板访问
    readonly Permission = Permission;
    
  2. 修改模板写法:
    <!-- 绑定枚举值,IDE自动补全,非法值直接报编译错误 -->
    <nb-action [checkPermission]="Permission.CanHangSocks" nbTooltip="Hang Socks"></nb-action>
    
方案优势
  • 权限定义集中管理,后续新增权限只需要在枚举中加一行,编译器会自动提示所有关联的代码需要同步修改,不会漏改
  • 全链路类型安全:从指令输入到User类属性访问,所有权限值都是强类型约束,不存在字符串拼写错误的问题
  • 代码简洁:无需重复手写权限属性的类型定义,枚举和User类的绑定由TypeScript自动完成

内容的提问来源于stack exchange,提问作者noamyg

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.11 22:54:03