将MongoDB与实体框架和 ASP .NET Core 集成

验证先决条件。

要创建快速入门应用程序，请在开发环境中安装以下软件：

创建 MongoDB Atlas 集群。

MongoDB Atlas is a fully managed cloud database service that hosts your MongoDB deployments. If you do not have a MongoDB deployment, you can create a MongoDB cluster for free by completing the MongoDB Get Started tutorial. The MongoDB Get Started tutorial also demonstrates how to load sample datasets into your cluster, including the sample_restaurants database that is used in this tutorial.

要连接到MongoDB 集群，必须使用连接字符串。要学习；了解如何检索连接字符串，请参阅MongoDB入门教程的添加连接字符串部分。

创建 ASP .NET Core项目。

从终端运行以下命令，创建一个名为 RestaurantODataApi 的新 ASP .NET Core Web API项目：

dotnet new webapi -n RestaurantODataApi
cd RestaurantODataApi

添加所需的依赖项。

在 RestaurantODataApi目录中，运行以下命令以添加所需的 NuGet 包：

dotnet add package MongoDB.EntityFrameworkCore
dotnet add package Microsoft.AspNetCore.OData

这些命令安装以下包：

• MongoDB.EntityFrameworkCore： MongoDB EF Core 提供商

• Microsoft.AspNetCore.OData：OData 对 ASP .NET Core 的支持

配置数据库连接。

导航到 RestaurantODataApi项目中的 appsettings.json文件并粘贴以下代码：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "MongoDB": {
    "ConnectionString": "<connection string>",
    "DatabaseName": "sample_restaurants"
  }
}

将 <connection string> 占位符替换为您从MongoDB入门教程中保存的连接字符串。

创建数据模型。

在 RestaurantODataApi目录中，创建 Models 子目录。然后，在 Models目录中创建名为 Restaurant.cs 的文件并添加以下代码：

using Microsoft.EntityFrameworkCore;
using MongoDB.Bson;
using MongoDB.Bson.Serialization.Attributes;
using System.ComponentModel.DataAnnotations;
namespace RestaurantODataApi.Models
{
    public class Restaurant
    {
        [Key]
        [BsonId]
        [BsonRepresentation(BsonType.ObjectId)]
        public string Id { get; set; } = string.Empty;
        [BsonElement("name")]
        public string? Name { get; set; }
        [BsonElement("cuisine")]
        public string? Cuisine { get; set; }
        [BsonElement("borough")]
        public string? Borough { get; set; }
    }
}

该模型类定义MongoDB sample_restaurants.restaurants集合中餐厅数据的结构，并包括实体框架和MongoDB序列化属性。

配置数据库连接。

在 RestaurantODataApi目录中，创建名为 RestaurantDbContext.cs 的文件并添加以下代码：

using Microsoft.EntityFrameworkCore;
using MongoDB.Driver;
using MongoDB.EntityFrameworkCore.Extensions;
using RestaurantODataApi.Models;
namespace RestaurantODataApi
{
    public class RestaurantDbContext : DbContext
    {
        public DbSet<Restaurant> Restaurants { get; set; }
        public RestaurantDbContext(DbContextOptions<RestaurantDbContext> options)
            : base(options)
        {
        }
        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            base.OnModelCreating(modelBuilder);
            // Configures the Restaurant entity to map to the "restaurants" collection
            modelBuilder.Entity<Restaurant>().ToCollection("restaurants");
        }
    }
}

This class derives from DBContext, which configures the relationship between your models and the underlying database. The code configures EF to work with MongoDB and maps the Restaurant entity to the sample_restaurants.restaurants collection.

创建 OData 控制器。

在 RestaurantODataApi目录中，创建 Controllers 子目录。然后，将名为 RestaurantsController.cs 的文件添加到子目录并粘贴以下代码：

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.OData.Query;
using Microsoft.AspNetCore.OData.Routing.Controllers;
using Microsoft.AspNetCore.OData.Routing.Attributes;
using RestaurantODataApi.Models;
namespace RestaurantODataApi.Controllers
{
    public class RestaurantsController : ODataController
    {
        private readonly RestaurantDbContext _context;
        public RestaurantsController(RestaurantDbContext context)
        {
            _context = context;
        }
        [EnableQuery(PageSize = 50, AllowedQueryOptions = AllowedQueryOptions.All)]
        public IQueryable<Restaurant> Get()
        {
            return _context.Restaurants;
        }
        [HttpGet("odata/GetRestaurantsByBorough(borough={borough})")]
        [EnableQuery(PageSize = 20)]
        public IQueryable<Restaurant> GetRestaurantsByBorough(string borough)
        {
            return _context.Restaurants.Where(r => r.Borough == borough);
        }
        [HttpGet("odata/GetRestaurantsByCuisine(cuisine={cuisine})")]
        [EnableQuery(PageSize = 20)]
        public IQueryable<Restaurant> GetRestaurantsByCuisine(string cuisine)
        {
            return _context.Restaurants.Where(r => r.Cuisine == cuisine);
        }
    }
}

此控制器定义以下 OData REST 终结点：

• GET /odata/Restaurants：检索 restaurants集合中的所有文档。EnableQuery 属性及其配置选项允许您在HTTP请求中使用 OData查询参数，例如 $filter 和 $orderby。

• GET /odata/GetRestaurantsByBorough(borough='{borough}')：检索具有指定 borough 值的文档。

• GET /odata/GetRestaurantsByCuisine(cuisine='{cuisine}')：检索具有指定 cuisine 值的文档。

定义应用程序逻辑。

导航到 Program.cs文件并将其内容替换为以下代码：

using Microsoft.AspNetCore.OData;
using Microsoft.EntityFrameworkCore;
using Microsoft.OData.ModelBuilder;
using MongoDB.Driver;
using RestaurantODataApi;
using RestaurantODataApi.Models;
var builder = WebApplication.CreateBuilder(args);
// Configures the MongoDB connection
var connectionString = builder.Configuration["MongoDB:ConnectionString"];
var databaseName = builder.Configuration["MongoDB:DatabaseName"] ?? "sample_restaurants";
if (string.IsNullOrEmpty(connectionString))
{
    throw new InvalidOperationException("MongoDB connection string is required. Please set MongoDB:ConnectionString in appsettings.json");
}
// Registers a MongoDB client
builder.Services.AddSingleton<IMongoClient>(sp => new MongoClient(connectionString));
// Registers the DbContext
builder.Services.AddDbContext<RestaurantDbContext>(options =>
{
    var mongoClient = new MongoClient(connectionString);
    options.UseMongoDB(mongoClient, databaseName);
});
// Configures the OData EDM model
var modelBuilder = new ODataConventionModelBuilder();
modelBuilder.EntitySet<Restaurant>("Restaurants");
modelBuilder.EntityType<Restaurant>().HasKey(r => r.Id);
// Registers the unbound functions
var getRestaurantsByBoroughFunction = modelBuilder.Function("GetRestaurantsByBorough");
getRestaurantsByBoroughFunction.Parameter<string>("borough");
getRestaurantsByBoroughFunction.ReturnsCollectionFromEntitySet<Restaurant>("Restaurants");
var getRestaurantsByCuisineFunction = modelBuilder.Function("GetRestaurantsByCuisine");
getRestaurantsByCuisineFunction.Parameter<string>("cuisine");
getRestaurantsByCuisineFunction.ReturnsCollectionFromEntitySet<Restaurant>("Restaurants");
// Configures OData with ASP.NET Core
builder.Services.AddControllers()
    .AddOData(opt => opt
        .AddRouteComponents("odata", modelBuilder.GetEdmModel())
        .Select()
        .Filter()
        .OrderBy()
        .Expand()
        .Count()
        .SetMaxTop(100));
var app = builder.Build();
app.UseRouting();
app.MapControllers();
app.Run();

此代码设置MongoDB连接、实体框架 DbContext 和 OData 服务。OData 配置代码启用以下查询参数，您可以在HTTP终结点中使用这些参数：

• $select：返回结果中的指定字段

• $filter：根据过滤器条件返回数据

• $orderby：按指定字段对结果进行排序

• $expand：在结果中包含相关数据

• $count：包括结果计数

• $top：设置最大结果数，限制为 100

启动 ASP .NET Core应用程序。

在 RestaurantODataApi目录中，运行以下命令以编译并启动应用程序：

dotnet run

如果成功，命令输出将类似于以下示例：

info: Microsoft.Hosting.Lifetime[14]
      Now listening on: http://localhost:5236
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.

测试您的 OData 终结点。

在另一个终端中，运行以下 curl 命令来测试 OData 终结点。每个终结点都返回 OData 格式的JSON数据，其中包括 sample_restaurants.restaurants集合中的餐厅信息。如果成功，您的 curl 命令将返回与所提供的示例输出类似的数据。这些命令还将结果限制为 5 个文档。

1. 检索所有餐厅。

   curl 'http://localhost:5236/odata/Restaurants?$top=5'

   View output

2. 按行政区筛选餐厅。

   以下命令检索 borough 值为 "Queens" 的餐厅：

   curl 'http://localhost:5236/odata/GetRestaurantsByBorough(borough=%27Queens%27)?$top=5'

   View output

3. 按菜系筛选餐厅。

   以下命令检索 cuisine 值为 "Mexican" 的餐厅：

   curl 'http://localhost:5236/odata/GetRestaurantsByCuisine(cuisine=%27Mexican%27)?$top=5'

   View output

测试 OData 的高级查询功能。

您可以通过包含 OData查询参数和操作符，使用终结点运行复杂查询。以下 curl 命令测试这些功能。

1. 按多个字段筛选。

   以下命令使用 OData查询运算符检索borough 值为 "Queens" 且 name 值包含 "Moon" 的文档：

   curl 'http://localhost:5236/odata/Restaurants?$filter=Borough%20eq%20%27Queens%27%20and%20contains(Name,%20%27Moon%27)'

   View output

2. 对结果进行排序和计数。

   以下命令按 name 值对与 cuisine 筛选器匹配的文档进行过滤，并计算匹配文档的总数：

   curl 'http://localhost:5236/odata/GetRestaurantsByCuisine(cuisine=%27Czech%27)?$orderby=Name&$count=true'

   View output