Microsoft Garnet项目构建与测试指南

Microsoft Garnet项目构建与测试指南

garnet 项目地址: https://gitcode.com/gh_mirrors/garnet4/garnet

前言

Microsoft Garnet是一个高性能的键值存储系统，兼容Redis协议(RESP)。本文将详细介绍如何从源码构建Garnet项目，运行测试套件，部署服务器以及使用客户端连接。通过本指南，您将掌握Garnet的基本构建和运行流程。

环境准备

在开始构建Garnet之前，需要确保您的开发环境满足以下要求：

1. .NET 8 SDK：Garnet基于.NET 8构建，必须安装最新版本的.NET 8 SDK
2. 开发平台：支持Windows和Linux操作系统
3. 可选工具：
   • Visual Studio 2022（推荐使用预览版以获取最新功能）
   • 代码编辑器（如VS Code）

获取源码

首先需要获取Garnet项目的源代码。使用以下命令克隆代码库：

git clone <garnet代码库地址>

克隆完成后，进入项目根目录：

cd garnet

构建项目

Garnet提供两种构建方式：

1. 使用命令行构建

dotnet restore
dotnet build -c Release

2. 使用Visual Studio构建

1. 打开Garnet.sln解决方案文件
2. 确保Visual Studio已更新至最新版本
3. 选择"Release"配置
4. 执行构建

运行测试套件

构建完成后，建议运行测试套件验证功能完整性。执行以下命令运行测试：

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

注意事项：

• 默认会跳过使用Azure云存储的测试
• 如需运行Azure相关测试，需设置环境变量RunAzureTests=yes并启动Azurite服务

部署Garnet服务器

测试通过后，可以部署Garnet服务器：

cd main/GarnetServer
dotnet run -c Release -f net8.0

服务器配置选项

Garnet提供多种可配置参数，查看所有选项：

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

常用配置示例：

• 设置索引大小为512MB：

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

• 绑定特定IP地址：

  dotnet run -c Release -f net8.0 -- --bind 0.0.0.0
  

网络注意事项：

• 默认监听TCP端口6379
• 默认绑定所有网络接口(IPAddress.Any和IPAddress.IPv6Any)
• 如需远程访问，需配置防火墙规则

客户端连接

Garnet兼容Redis协议(RESP)，可以使用多种客户端连接：

1. 通用Redis客户端

任何支持RESP协议的Redis客户端都可以连接Garnet服务器，包括：

• StackExchange.Redis（C#）
• GarnetClient（Garnet自带的C#客户端）
• 其他语言的Redis客户端库

2. 图形化工具

• RedisInsight（图形界面和CLI）
• Memurai（Windows平台）的memurai-cli工具

3. 命令行工具

在Linux/WSL环境下可以使用redis-cli连接：

1. 确保Garnet服务器绑定0.0.0.0
2. 将GarnetServer.exe添加到防火墙例外
3. 在WSL中获取主机IP地址
4. 使用redis-cli连接

redis-cli -h <主机IP地址>

常见问题解决

1. 连接问题：

   • 检查防火墙设置
   • 确认服务器绑定正确的IP地址
   • 验证端口是否开放

2. Windows-WSL连接问题：

   • 尝试使用Windows 11 22H2或更高版本的镜像网络模式

3. 性能调优：

   • 根据工作负载调整索引大小(-i参数)
   • 合理配置内存大小

结语

通过本文，您已经掌握了Microsoft Garnet项目的完整构建、测试和部署流程。Garnet作为一个高性能键值存储系统，既保留了Redis协议的兼容性，又提供了更好的性能表现。建议初次使用时从默认配置开始，逐步根据实际需求调整参数。

garnet 项目地址: https://gitcode.com/gh_mirrors/garnet4/garnet