ASP.NET6 + Mongo + OData

准备工作

• Docker环境
  
• Mongo数据库
  
• 配置Mongo数据库
  

ASP.NET6 集成Mongo

安装MongoDB.Driver

1. {
2.     "Logging": {
3.         "LogLevel": {
4.             "Default": "Information",
5.             "Microsoft.AspNetCore": "Warning"
6.             }
7.     },
8.     "BookStoreDatabase": {
9.         "ConnectionString": "mongodb://localhost",
10.         "DatabaseName": "BookStore",
11.         "BooksCollectionName": "Books"
12.         },
13.     "AllowedHosts": "*"
14. }

复制代码

1. public class BookStoreDatabaseSettings
2. {
3.     public string ConnectionString { get; set; } = null!;
5.     public string DatabaseName { get; set; } = null!;
7.     public string BooksCollectionName { get; set; } = null!;
8. }

复制代码

1. using MongoDB.Bson;
2. using MongoDB.Bson.Serialization.Attributes;
4. namespace MongoExample.Models;
6. public class Book
7. {
8.     [BsonId]
9.     [BsonRepresentation(BsonType.ObjectId)]
10.     public string? Id { get; set; }
12.     [BsonElement("Name")]
13.     public string BookName { get; set; } = null!;
14.    
15.     public decimal Price { get; set; }
17.     public string Category { get; set; } = null!;
19.     public string Author { get; set; } = null!;
20. }

复制代码

1. using MongoDB.Driver;
2. using MongoExample.Models;
3. using Microsoft.Extensions.Options;
5. namespace MongoExample.Services;
7. public class BookService
8. {
9.     private readonly IMongoCollection<Book> _bookCollection;
11.     public BookService(IOptions<BookStoreDatabaseSettings> bookStoreDatabaseSettings)
12.     {
13.         var mongoClient = new MongoClient("mongodb://admin:000000@localhost:27017");
14.         var mongoDatabase = mongoClient.GetDatabase(bookStoreDatabaseSettings.Value.DatabaseName);
15.         _bookCollection = mongoDatabase.GetCollection<Book>(bookStoreDatabaseSettings.Value.BooksCollectionName);
16.     }
18.     public async Task<List<Book>> GetBooksAsync() => await _bookCollection.Find(_ => true).ToListAsync();
20.     public async Task<Book> GetBookAsync(string id) => await _bookCollection.Find(x=>x.Id == id).FirstOrDefaultAsync();
22.     public async Task CreateAsync(Book book) => await _bookCollection.InsertOneAsync(book);
24.     public async Task UpdateAsync(string id, Book updatedBook) => await _bookCollection.ReplaceOneAsync(x=>x.Id == id, updatedBook);
26.     public async Task RemoveAsync(string id) => await _bookCollection.DeleteOneAsync(x=>x.Id ==id);
27. }

复制代码

1. using Microsoft.AspNetCore.Mvc;
2. using Microsoft.AspNetCore.OData.Query;
3. using MongoExample.Models;
4. using MongoExample.Services;
6. namespace MongoExample.Controllers;
8. [ApiController]
9. [Route("/api/[controller]")]
10. public class BooksController : ControllerBase
11. {
12.     private readonly BookService _bookService;
14.     public BooksController(BookService bookService)
15.     {
16.         this._bookService = bookService;
17.     }
19.     [HttpGet]
20.     [EnableQuery]
21.     public async Task<List<Book>> Get() => await _bookService.GetBooksAsync();
23.     [HttpGet("{id:length(24)}")]
24.     public async Task<ActionResult<Book>> GetBook(string id)
25.     {
26.         var book = await _bookService.GetBookAsync(id);
27.         if (book == null)
28.         {
29.             return NotFound();
30.         }
32.         return book;
33.     }
35.     [HttpPost]
36.     public async Task<ActionResult> Create(Book book)
37.     {
38.         await _bookService.CreateAsync(book);
39.         return CreatedAtAction("Get", new { id = book.Id }, book);
40.     }
42.     [HttpPut("{id:length(24)}")]
43.     public async Task<IActionResult> Update(string id, Book updatedBook)
44.     {
45.         var book = await _bookService.GetBookAsync(id);
46.         if (book == null)
47.         {
48.             return NotFound();
49.         }
51.         updatedBook.Id = book.Id;
52.         await _bookService.UpdateAsync(id, updatedBook);
53.         return NoContent();
54.     }
56.     [HttpDelete("{id:length(24)}")]
57.     public async Task<IActionResult> Delete(string id)
58.     {
59.         var book = await _bookService.GetBookAsync(id);
60.         if (book == null)
61.         {
62.             return NotFound();
63.         }
65.         await _bookService.RemoveAsync(id);
66.         return NoContent();
67.     }
68. }

复制代码

ASP.NET6 集成OData

VS22022基于.NET6基础上创建的asp.net core web api模板已经合并了Startup和Program类， 所有的服务注入，中间件注入都合并在了Program类中， 好久没写C#了，这个类这次变化有点大。
安装OData

合并后的模板只有Program.cs类，没有了Startup类，也就是之前的服务注入都是通过ConfigServices方法，IServiceCollection实现。 如果不习惯的话也可以自己手动创建一个Startup类，然后在Program类中调用该类。

1. using Microsoft.AspNetCore.OData;
2. using MongoExample.Models;
3. using MongoExample.Services;
5. var builder = WebApplication.CreateBuilder(args);
7. builder.Services.AddControllers();
8. builder.Services.AddEndpointsApiExplorer();
9. builder.Services.AddSwaggerGen();
10. builder.Services.Configure<BookStoreDatabaseSettings>(builder.Configuration.GetSection("BookStoreDatabase"));
11. builder.Services.AddSingleton<BookService>();
12. //这里注入OData查询方法
13. builder.Services.AddControllers().AddOData(options => options.Select().Filter().OrderBy());
15. var app = builder.Build();
17. if (app.Environment.IsDevelopment())
18. {
19.     app.UseSwagger();
20.     app.UseSwaggerUI();
21. }
23. app.UseAuthorization();
25. app.MapControllers();
27. app.Run();

复制代码

测试OData Query

查询Category和BookName字段
http://localhost:5220/api/books?$select=Category,BookName
响应JSON值

1. [{"Category":"Computer","BookName":"Design Patters"},{"Category":"Software","BookName":"Java In Action"},{"Category":"Software","BookName":"C# In Action"}]

复制代码

查询Category和BookName字段并且用Category倒叙排列

1. [{"Category":"Software","BookName":"Java In Action"},{"Category":"Software","BookName":"C# In Action"},{"Category":"Computer","BookName":"Design Patters"}]

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！