Laravel 自定义存在规则 - TypeScript

Laravel 是一个优秀的 PHP 框架，它拥有非常强大的数据验证机制。在实际应用中，我们经常需要使用自定义存在规则来满足业务需求。本文将介绍如何在 Laravel 中使用 TypeScript 编写自定义存在规则。

一、定义规则类

首先，我们需要创建一个规则类。规则类需要实现 Illuminate\Contracts\Validation\Rule 接口。下面是一个例子：

import { Rule } from 'laravel-validation';

export default class CustomExistsRule implements Rule {
  constructor(private tableName: string) {}

  async passes(attribute: string, value: any): Promise<boolean> {
    // TODO: 实现规则逻辑
  }

  message(): string {
    return `The selected ${attribute} is invalid.`;
  }
}

在上面的代码中，我们定义了一个 CustomExistsRule 类，它有一个构造函数，需要传递表名。passes 方法用于验证字段值是否存在于指定的表中，message 方法用于返回验证失败的提示信息。由于 passes 方法需要进行异步查询，我们使用了 async/await 语法。

二、定义验证器

接下来，我们需要定义一个验证器类，用于应用自定义的规则。下面是代码示例：

import { Validator, Rule } from 'laravel-validation';
import CustomExistsRule from './CustomExistsRule';

export default class CustomValidator extends Validator {
  protected async exists(
    attribute: string,
    value: any,
    parameter: string,
    validator: Validator
  ): Promise<boolean> {
    const segments = parameter.split(',');
    const table = segments[0];
    const column = segments[1];

    const rule = new CustomExistsRule(table);

    if (validator) {
      rule.setConnectionResolver(validator.resolver);
    }

    if (attribute && typeof value !== 'undefined' && value !== null) {
      rule.setAttribute(attribute);
      rule.setParameters([column, value]);
    }

    return rule.passes(attribute, value);
  }
}

在上面的代码中，我们定义了一个 CustomValidator 类，继承自 Validator。它覆盖了 exists 方法，用于应用自定义的规则。在方法内部，我们解析出表名和字段名，并创建一个 CustomExistsRule 实例。为了支持多个数据库连接，我们需要调用 setConnectionResolver 设置连接器解析器。最后，我们调用 passes 方法验证字段值是否存在于指定的表中。

三、注册验证器

最后，我们需要将自定义的验证器注册到应用程序。下面是一个例子：

import { Validation } from 'laravel-validation';
import CustomValidator from './CustomValidator';

Validation.register('custom_exists', CustomValidator, 'The selected :attribute is invalid.');

在上面的代码中，我们通过 Validation.register 方法注册了 custom_exists 验证器，并指定了默认的验证失败提示信息 The selected :attribute is invalid.。

四、使用自定义规则

现在，我们可以在验证规则中使用 custom_exists 验证器了。下面是一个例子：

import { Validation } from 'laravel-validation';

const data = { user_id: 1 };
const rules = { user_id: 'custom_exists:users,id' };

const validator = Validation.make(data, rules);

if (validator.fails()) {
  console.log(validator.errors.all());
} else {
  console.log('Validation passed.');
}

在上面的代码中，我们定义了一个数据对象 data 和验证规则 rules，其中对 user_id 字段应用了 custom_exists 验证器。最后，我们使用 Validation.make 方法创建一个验证器实例，并通过 fails 方法验证数据是否符合规则。

五、总结

本文介绍了如何在 Laravel 中使用 TypeScript 编写自定义存在规则。通过定义规则类、定义验证器类以及注册验证器等步骤，我们可以很方便地扩展 Laravel 的数据验证机制，满足各种业务需求。