Tarantool Cartridge 开发指南：构建分布式应用的最佳实践

引言

Tarantool Cartridge 是一个用于构建分布式应用的强大框架，它结合了 Tarantool 的高性能数据库和应用程序服务器能力。本文将深入介绍如何使用 Cartridge 开发分布式应用，从环境搭建到集群部署的全流程。

开发环境准备

在开始开发前，需要安装以下工具：

1. Cartridge CLI：用于开发、部署和管理 Tarantool 应用的工具
2. Git：版本控制系统
3. npm：Node.js 包管理器
4. unzip：文件解压工具

创建新项目

使用以下命令创建新项目：

cartridge create --name myapp /path/to/

这会创建一个包含以下结构的项目目录：

• myapp-scm-1.rockspec：应用依赖描述文件
• deps.sh：依赖解析脚本
• init.lua：应用入口文件
• .git：Git 仓库文件
• .gitignore：Git 忽略规则
• env.lua：环境配置
• custom-role.lua：自定义角色模板

应用入口配置

在 init.lua 中，需要调用 cartridge.cfg() 进行初始化：

local cartridge = require('cartridge')

cartridge.cfg({
    workdir = '/var/lib/tarantool/app',
    advertise_uri = 'localhost:3301',
    cluster_cookie = 'super-cluster-cookie',
    roles = {'custom-role'},
}, {
    memtx_memory = 1000000000,
})

注意：不要直接调用 box.cfg()，集群会在适当时机自动配置。

集群角色系统

Cartridge 使用角色(roles)来组织实例功能，角色是实现了特定功能的 Lua 模块。

内置角色

Cartridge 提供两个内置角色用于自动分片：

• vshard-router：处理计算密集型工作负载
• vshard-storage：处理事务密集型工作负载

自定义角色开发

创建自定义角色的步骤：

1. 在 app/roles/ 目录下创建角色模块
2. 实现必要的生命周期函数
3. 在 cartridge.cfg() 中注册角色

示例角色模板：

local role_name = 'custom-role'

local function init(opts)
    if opts.is_master then
        -- 创建空间和索引
        local customer = box.schema.space.create('customer', 
            { if_not_exists = true }
        )
        customer:format({
            {'customer_id', 'unsigned'},
            {'bucket_id', 'unsigned'},
            {'name', 'string'},
        })
        customer:create_index('customer_id', {
            parts = {'customer_id'},
            if_not_exists = true,
        })
    end
end

local function stop()
    -- 清理工作
end

return {
    role_name = role_name,
    init = init,
    stop = stop,
}

角色生命周期

角色有以下关键生命周期函数：

1. init()：初始化函数，在角色启用时调用
2. stop()：终止函数，在角色禁用时调用
3. validate_config()：配置验证函数
4. apply_config()：配置应用函数

角色依赖

可以在角色中定义依赖关系：

return {
    role_name = 'my-role',
    dependencies = {'cartridge.roles.vshard-router'},
    -- 其他函数
}

多 vshard 组配置

可以为 vshard 存储角色配置多个组：

cartridge.cfg({
    vshard_groups = {'hot', 'cold'},
    -- 其他配置
})

访问特定组的路由器：

local router_role = cartridge.service_get('vshard-router')
router_role.get('hot'):call(...)

角色配置管理

可以在集群配置中为角色添加专属配置：

my_role:
  notify_url: "https://localhost:8080"

然后在角色中处理配置变更：

local notify_url = 'http://localhost'

function my_role.apply_config(conf, opts)
    local conf = conf['my_role'] or {}
    if conf.notify_url ~= nil then
        notify_url = conf.notify_url
    end
end

开发建议

1. 在 init() 中执行空间和索引创建等初始化工作
2. 使用 opts.is_master 判断主实例，避免复制冲突
3. 为长时间运行的任务实现 stop() 清理逻辑
4. 妥善处理配置变更

通过本文介绍的方法，您可以充分利用 Tarantool Cartridge 的功能，构建高性能、可扩展的分布式应用。