使用 Visual Studio 连接服务添加 Azure Cache for Redis

在 Visual Studio 中,通过使用连接服务功能可将以下任何服务连接到 Azure Cache for Redis:

  • .NET Framework 控制台应用
  • ASP.NET 模型-视图-控制器 (MVC) (.NET Framework)
  • ASP.NET Core
  • .NET Core(包括控制台应用、WPF、Windows 窗体、类库)
  • .NET Core 辅助角色
  • Azure Functions
  • 通用 Windows 平台应用
  • Xamarin
  • Cordova

连接服务功能可将所有需要的引用和连接代码添加到项目,并相应地修改配置文件。

先决条件

使用连接服务连接到 Azure Cache for Redis

  1. 在 Visual Studio 中打开项目。

  2. 解决方案资源管理器中,右键单击连接服务节点,并在上下文菜单中选择添加连接服务

    如果未看到“连接的服务”节点,请选择项目>连接的服务>添加

  3. 在“连接服务”选项卡中,选择“服务依赖项”的 + 图标。

    显示菜单窗格中所选的连接的服务的屏幕截图。突出显示了“+”图标。

  4. 在“添加依赖项”页中,选择“Azure Cache for Redis”。

    “添加依赖项”页的屏幕截图。已选择“Azure Cache for Redis”。

    如果还没有登录,请登录到 Azure 帐户。 如果没有 Azure 帐户,可以注册免费试用版

  5. 配置 Azure Cache for Redis 屏幕中,选择现有 Azure Cache for Redis 组件,然后选择下一步

    如果需要创建新组件,请转到下一步。 否则,请跳到步骤 7。

    “配置 Azure Cache for Redis”屏幕的屏幕截图。突出显示了“下一步”。

  6. 若要创建 Azure Cache for Redis:

    1. 选择屏幕底部的创建新的 Azure Redis 缓存

    2. 填写“Azure Cache for Redis: 新建”屏幕,然后选择“创建”。

      用于新建 Azure Cache for Redis 的页面的屏幕截图。突出显示了“创建”。

    3. 当显示“配置 Azure Cache for Redis”屏幕时,新数据库将出现在列表中。 在列表中选择新数据库,并选择下一步

  7. 输入连接字符串名称或选择默认值,然后选择是希望连接字符串存储在本地机密文件中,还是存储在 Azure Key Vault 中。

    Azure Cache for Redis 连接信息页的屏幕截图。突出显示了“下一步”。

  8. “更改摘要”屏幕显示了在完成该过程后将对项目进行的所有修改。 如果更改看起来正常,请选择“完成”。

    “更改摘要”页的屏幕截图。突出显示了“完成”。

  9. 连接显示在“连接服务”选项卡的“服务依赖项”部分下。

    显示已配置的服务依赖项列表的屏幕截图。

注意

对于 .NET Framework 项目,连接的服务 UI 略有不同。 若要查看差异,请与此页面的 Visual Studio 2019 版本进行比较。

  1. 在 Visual Studio 中打开项目。

  2. 在“解决方案资源管理器”中,右键单击“连接的服务”节点,并在上下文菜单中选择“添加”,打开可用服务的菜单。

    显示“连接的服务”上下文菜单选项的屏幕截图。

    如果未看到“连接的服务”节点,请选择项目>连接的服务>添加

  3. 选择 Azure Cache for Redis。 随即显示连接到依赖项页。 应看到两个选项,一个用于本地模拟器,即容器上的 Redis 缓存(本地),另一个用于连接到实时 Azure Cache for Redis 服务。 可以从本地模拟器开始降低成本并简化早期开发。 稍后可以通过重复执行这些步骤并选择另一个选项来迁移到实时服务。

    显示 Azure Cache for Redis 选项的屏幕截图

    如果在本地选择 Azure Cache for Redis,则请单击下一步以进入连接到容器上的 Redis 缓存屏幕。

    显示本地容器中 Azure Cache for Redis 的连接选项的屏幕截图。

    指定容器名称容器映像和端口映射或接受默认值,然后单击下一步以查看更改摘要屏幕,其中显示了将对项目进行的更改。 NuGet 包引用和本地模拟器的连接代码被添加到项目中。

    如果要连接到 Azure 服务,请继续执行下一步;如果尚未登录,请先登录到 Azure 帐户,然后再继续。 如果没有 Azure 帐户,可以注册免费试用版

  4. 若要使用实时服务,请选择“Azure Cache for Redis”。

    “添加依赖项”页的屏幕截图。已选择“Azure Cache for Redis”。

    如果还没有登录,请登录到 Azure 帐户。 如果没有 Azure 帐户,可以注册免费试用版

  5. 配置 Azure Cache for Redis 屏幕中,选择现有 Azure Cache for Redis 组件,然后选择下一步

    如果需要创建新组件,请转到下一步。 否则,请跳到步骤 7。

    “配置 Azure Cache for Redis”屏幕的屏幕截图。突出显示了“下一步”。

  6. 若要创建 Azure Cache for Redis:

    1. 选择屏幕底部的创建新的 Azure Redis 缓存

    2. 填写“Azure Cache for Redis: 新建”屏幕,然后选择“创建”。

      用于新建 Azure Cache for Redis 的页面的屏幕截图。突出显示了“创建”。

    3. 当显示“配置 Azure Cache for Redis”屏幕时,新数据库将出现在列表中。 在列表中选择新数据库,并选择下一步

  7. 输入连接设置名称,或接受默认值。

    Azure Cache for Redis 连接信息页的屏幕截图。突出显示了“下一步”。

    注意

    为了提高安全性,在 Visual Studio 17.12 及更高版本中,此步骤将创建连接设置名称;以前的版本创建连接字符串。 存储在本地文件系统中的连接字符串可能会导致安全风险(如果无意中公开)。

  8. 单击“其他设置”并选择是想要将连接设置存储在本地机密文件中,还是存储在 Azure 密钥库中。

    Azure Redis 缓存其他设置页的屏幕截图。

  9. 更改摘要屏幕显示了在完成该过程后将对项目进行的所有修改。 如果更改看起来正常,请选择“完成”。

    “更改摘要”页的屏幕截图。突出显示了“完成”。

  10. 在“解决方案资源管理器”中,双击“连接的服务”节点以打开“连接的服务”选项卡。连接显示在“服务依赖项”部分下:

    显示已配置的服务依赖项列表的屏幕截图。

    如果单击添加的依赖项旁边的三个点,可以看到各种选项(例如“连接”)以重新打开向导并更改连接。 还可以单击窗口右上角的三个点,查看用于启动本地依赖项、更改设置等的选项。

后续步骤

对于 ASP.NET 应用,Azure Cache for Redis 的常见用例是缓存会话状态或页面输出(HTTP 响应)。 ASP.NET Core 为这些用例提供内置服务,应在使用 ASP.NET Core 时改用这些服务。

若要在 ASP.NET 应用中缓存会话状态,请参阅 ASP.NET 会话状态提供程序

若要在 ASP.NET 应用中缓存页面输出,请参阅 ASP.NET 输出缓存提供程序