如何为Ballerina Record字段添加约束并验证？

一、为Record字段添加约束 #

Ballerina支持直接在Record字段定义中通过内置约束规则或自定义逻辑添加验证条件，以下是针对你提供的User类型的具体实现：

1. 内置约束（长度、正则表达式） #

直接在字段类型后追加约束规则，满足常见的格式、长度要求：

type User record {|
    string username {length > 6}; // 要求用户名长度大于6个字符
    string password {
        length >= 8, // 密码至少8位
        pattern = r"^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[@$!%*?&])[A-Za-z\d@$!%*?&]{8,}$"
        // 强密码规则：包含大小写字母、数字、特殊字符
    };
    string email {
        pattern = r"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"
        // 匹配标准邮箱格式
    };
|};

2. 自定义约束函数 #

如果内置规则无法满足需求，可以编写自定义验证函数，通过constraint关键字绑定到字段：

// 自定义密码强度验证函数
function isStrongPassword(string password) returns boolean {
    return password.length() >= 8 &&
           password.matches(r".*[a-z].*") &&
           password.matches(r".*[A-Z].*") &&
           password.matches(r".*\d.*") &&
           password.matches(r".*[@$!%*?&].*");
}

// 绑定自定义约束的User类型
type User record {|
    string username {length > 6};
    string password {constraint isStrongPassword}; // 使用自定义验证逻辑
    string email {pattern = r"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"};
|};

二、验证Record约束 #

Ballerina提供多种方式触发约束验证，适配不同场景：

1. 初始化时自动验证 #

创建Record实例时，若字段不符合约束会直接抛出error，可通过check关键字处理错误：

public function main() returns error? {
    // 创建符合约束的用户实例
    User validUser = check {
        username: "john_doe123",
        password: "Passw0rd!",
        email: "john@example.com"
    };

    // 创建不符合约束的实例会抛出错误，被check捕获
    User invalidUser = check {
        username: "johnd", // 长度不足6
        password: "password", // 不满足强密码规则
        email: "john@example" // 邮箱格式错误
    };
}

2. 外部数据转换时验证 #

从JSON、外部API等获取数据后，可使用ballerina/record模块的validate函数手动验证并转换为目标Record类型：

import ballerina/record;

public function main() returns error? {
    // 模拟从外部获取的JSON数据
    json userJson = {
        username: "johnd",
        password: "password",
        email: "john@example"
    };

    // 验证JSON并转换为User类型，不符合约束则抛出错误
    User user = check record:validate(userJson, User);
}

3. 手动触发验证 #

如果需要单独验证已存在的Record实例，可调用record:validate函数传入实例本身：

import ballerina/record;

public function main() returns error? {
    User user = {
        username: "johnd",
        password: "password",
        email: "john@example"
    };

    // 手动验证实例的约束
    check record:validate(user);
}

内容的提问来源于stack exchange，提问作者Lakshan Weerasinghe