构建和测试

从源代码克隆

克隆 Garnet 仓库。Garnet 位于该仓库的主分支上。

  1. git clone git@github.com:microsoft/garnet.git

构建项目

确保已安装 .NET 8，按照 这里 的指示进行。您可以使用 Linux 或 Windows；Garnet 在两个平台上同样出色。

转到仓库的根文件夹并使用 dotnet 构建，或者打开 Garnet.sln 并使用 Visual Studio 2022 构建（我们推荐使用预览版以获取最新功能）。通过检查更新，确保 Visual Studio 是最新的。

  1. cd garnetdotnet restoredotnet build -c Release

运行我们的测试套件

作为一项健全性检查，您可以运行我们的测试套件。以下是在 .NET 8 的 Release 模式下运行测试并输出详细控制台输出的命令（确保您在仓库的根文件夹中）。

  1. dotnet test -c Release -f net8.0 -l "console;verbosity=detailed"

提示

如果未设置环境变量 RunAzureTests 为 yes 并且没有运行 Azurite，则会跳过使用 Azure 云存储的测试。

部署 Garnet 服务器

现在，您已准备好部署 Garnet 服务器。这很简单，运行以下命令：

  1. cd main/GarnetServerdotnet run -c Release -f net8.0

提示

默认情况下，Garnet 监听 TCP 端口 3278，请在需要从远程机器访问服务器时调整您的防火墙设置。

要查看可配置选项及其默认值，请运行以下命令。您可以配置索引大小、内存大小、页面大小、数据文件路径和检查点路径、要绑定到的 IP 地址、要运行的端口号等。

  1. dotnet run -c Release -f net8.0 -- --help

提示

要使用 512MB 的索引大小（而不是默认值）运行服务器，请运行此命令：

  1. dotnet run -c Release -f net8.0 -- -i 512m

使用 RESP 客户端连接

Garnet 使用 RESP 协议，因此您可以使用任何 Redis 客户端在您喜欢的客户端语言中与 Garnet 服务器通信。对于 C# 应用程序，您可以使用 StackExchange.Redis 或我们自己的 C# 客户端，称为 GarnetClient。

在 Windows 上，您可以通过 WSL（Linux）安装 redis-cli，RedisInsight 它具有图形界面，或者安装 Memurai（它在 Windows 上提供 Redis）并使用他们的 memurai-cli 命令行工具。

使用这些客户端中的任何一个时，只需确保在连接到 Garnet 服务器时使用正确的端口（例如，3278）。