MongoDB入門實戰教程(5)
前面我們學習了MongoDB的基本查詢命令操作,作為後端開發的我們大部分場景都是在應用程式中和MongoDB進行互動,因此本篇我們來學習一下如何在ASP.NET Core中整合MongoDB。
1 配置MongoDB
首先,請參照之前的文章安裝部署好一個MongoDB節點或叢集。
然後,手動建立一個數據庫BookStoreDB 和 一個集合 Books。
use BookStoreDB db.CreateCollection('Books')
最後,預先插入兩條測試資料:
db.Books.insertMany([ {'Name':'Design Patterns','Price':54.93, 'Category':'Computers','Author':'Ralph Johnson', 'CreatedDate':ISODate("2012-10-02T07:58:51Z"), 'UpdatedDate':ISODate("2012-10-02T07:58:51Z")}, {'Name':'Clean Code','Price':43.15, 'Category':'Computers','Author':'Robert C. Martin', 'CreatedDate':ISODate("2012-10-02T07:58:51Z"), 'UpdatedDate':ISODate("2012-10-02T07:58:51Z")}])
2 配置ASP.NET Core專案
建立WebAPI專案
建立一個ASP.NET Core 或 ASP.NET 5的WebAPI專案。
通過NuGet安裝MongoDB.Driver:
PM>Install-Package MongoDB.Driver
目前MongoDB.Driver最新版本為2.12.4(2021年6月5日釋出)。一般來說,我們操作MongoDB都會選擇這個官方的Driver。
新增實體模型
在WebAPI專案中新增Models目錄,並增加Book 實體類:
public class Book : MongoDocBase { [BsonElement("Name")] public string BookName { get; set; } public decimal Price { get; set; } public string Category { get; set; } public string Author { get; set; } } public class MongoDocBase { [BsonId] [BsonRepresentation(BsonType.ObjectId)] public string Id { get; set; } [BsonDateTimeOptions(Kind = DateTimeKind.Local)] public DateTime? CreatedDate { get; set; } [BsonDateTimeOptions(Kind = DateTimeKind.Local)] public DateTime? UpdatedDate { get; set; } }
需要注意的是:MongoDB儲存時間型別資料時,都是先轉換為UTC時間,然後儲存到資料庫中。當我們取出儲存的時間時,就會出現時差的問題。因此,一般我們會給文件中的日期型別加上如下所示的註解,將它轉換為本地時間傳輸:
[BsonDateTimeOptions(Kind = DateTimeKind.Local)]
在實際應用中,我們會給實體類建立一些DTO,然後在應用層進行DTO向DO的轉換。因此,這裡我們假設會進行 建立Book 和 修改Book 的操作,建立兩個DTO類:
(1)CreateBookDto
public class CreateBookDto { public string BookName { get; set; } public decimal Price { get; set; } public string Category { get; set; } public string Author { get; set; } [JsonIgnore] public DateTime CreatedDate { get; set; } = DateTime.Now; }
(2)UpdateBookDto
public class UpdateBookDto : CreateBookDto { public string Id { get; set; } [JsonIgnore] public DateTime UpdatedDate { get; set; } = DateTime.Now; }
在本示例中,使用AutoMapper進行DTO和DO之間的互轉,因此,安裝 AutoMapper 及其 擴充套件:
PM>Install-Package AutoMapper
PM>Install-Package AutoMapper.Extensions.Microsoft.DependencyInjection
建立對映規則配置:
public class MappingConfigs : Profile { public MappingConfigs() { CreateMap<CreateBookDto, Book>().ReverseMap(); CreateMap<UpdateBookDto, Book>() .ForMember(dest => dest.CreatedDate, opt => opt.Ignore()) .ReverseMap(); } }
新增配置模型
首先,在appSettings.json中新增以下資料庫配置:
{ ...... "BookstoreDatabaseSettings": { "BooksCollectionName": "Books", "ConnectionString": "mongodb://mongo-master:27017", "DatabaseName": "BookStoreDB" } }
需要注意的是:這裡的連線字串指向的是一個沒有設定使用者名稱密碼的MongoDB節點。如果你的MongoDB節點設定了使用者名稱密碼 或者 複製集分片集 之類的,請修改為匹配的連線字串。
然後,建立一個配置項類,也放到Models目錄中:
namespace EDT.BookStore.API.Models { public class BookStoreDatabaseSettings : IBookStoreDatabaseSettings { public string BooksCollectionName { get; set; } public string ConnectionString { get; set; } public string DatabaseName { get; set; } } public interface IBookStoreDatabaseSettings { string BooksCollectionName { get; set; } string ConnectionString { get; set; } string DatabaseName { get; set; } } }
最後,將其加入到IoC容器中控制:
public void ConfigureServices(IServiceCollection services) { ..... // AutoMapper Settings services.AddAutoMapper(typeof(MappingConfigs)); // MongoDB Settings services.Configure<BookStoreDatabaseSettings>( Configuration.GetSection(nameof(BookStoreDatabaseSettings))); services.AddSingleton<IBookStoreDatabaseSettings>(sp => sp.GetRequiredService<IOptions<BookStoreDatabaseSettings>>().Value); }
這裡,IBookstoreDatabaseSettings介面使用單一例項服務生存期在 DI 中註冊。在注入時,介面例項時將解析為BookStoreDatabaseSettings物件。
新增BookService提供CRUD服務
在Services目錄下,建立IBookService介面:
namespace EDT.BookStore.API.Services { public interface IBookService { IList<Book> Get(); Task<IList<Book>> GetAsync(); Book Get(string id); Task<Book> GetAsync(string id); Book Create(Book book); Task<Book> CreateAsync(Book book); void Update(string id, Book bookIn); Task UpdateAsync(string id, Book bookIn); void Remove(string id); Task RemoveAsync(string id); } }
然後,建立BookService 實現 IBookService 介面。
namespace EDT.BookStore.API.Services { public class BookService : IBookService { private readonly IMongoCollection<Book> _books; public BookService(IBookStoreDatabaseSettings settings) { var mongoClient = new MongoClient(settings.ConnectionString); var mongoDatabase = mongoClient.GetDatabase(settings.DatabaseName); _books = mongoDatabase.GetCollection<Book>(settings.BooksCollectionName); } public Book Create(Book book) { _books.InsertOne(book); return book; } public async Task<Book> CreateAsync(Book book) { await _books.InsertOneAsync(book); return book; } public IList<Book> Get() { return _books.Find(book => true).ToList(); } public async Task<IList<Book>> GetAsync() { return await _books.Find(book => true).ToListAsync(); } public Book Get(string id) { return _books.Find(book => book.Id == id).FirstOrDefault(); } public async Task<Book> GetAsync(string id) { return await _books.Find(book => book.Id == id).FirstOrDefaultAsync(); } public void Remove(string id) { _books.DeleteOne(book => book.Id == id); } public async Task RemoveAsync(string id) { await _books.DeleteOneAsync(book => book.Id == id); } public void Update(string id, Book bookIn) { _books.ReplaceOne(book => book.Id == id, bookIn); } public async Task UpdateAsync(string id, Book bookIn) { await _books.ReplaceOneAsync(book => book.Id == id, bookIn); } } }
在上面的程式碼中,會通過建構函式從DI檢索IBookStoreDatabaseSettings例項獲取MongoDB連線字串、資料庫名 和 集合名。
當然,我們也可以使用 約定大於配置 的方式,統一採用實體類的名字 作為預設的 集合名,示例如下:
_books = mongoDatabase.GetCollection<Book>(typeof(Book).Name);
最後,將BookService也加入到IoC容器中:
services.AddSingleton<IBookService, BookService>();
這裡,將BookService作為單一例項注入,這是因為 BookService 直接依賴於 MongoClient,而根據官方Mongo Client重用準則,我們應該使用單一例項服務在IoC容器中注入MongoClient。
新增Controller提供應用層介面
在Controllers目錄下,新增 BookController 控制器:
namespace EDT.BookStore.API.Controllers { [ApiController] [Route("[controller]")] public class BookController : ControllerBase { private readonly IMapper _mapper; private readonly IBookService _bookService; public BookController(IMapper mapper, IBookService bookService) { _mapper = mapper; _bookService = bookService; } [HttpGet] [ProducesResponseType(typeof(IList<Book>), StatusCodes.Status200OK)] [ProducesResponseType(typeof(IList<Book>), StatusCodes.Status204NoContent)] public async Task<ActionResult<IList<Book>>> Get() { var books = await _bookService.GetAsync(); if (books == null) { return NoContent(); } return Ok(books); } [HttpGet("{id:length(24)}", Name = "GetBook")] [ProducesResponseType(typeof(Book), StatusCodes.Status200OK)] [ProducesResponseType(typeof(Book), StatusCodes.Status404NotFound)] public async Task<ActionResult<Book>> Get(string id) { var book = await _bookService.GetAsync(id); if (book == null) { return NotFound(); } return Ok(book); } [HttpPost] [ProducesResponseType(typeof(Book), StatusCodes.Status201Created)] public async Task<ActionResult<Book>> Create(CreateBookDto bookDto) { var book = _mapper.Map<Book>(bookDto); await _bookService.CreateAsync(book); return CreatedAtRoute("GetBook", new { id = book.Id.ToString() }, bookDto); } [HttpPut("{id:length(24)}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] public async Task<ActionResult> Update(string id, UpdateBookDto bookDto) { var book = await _bookService.GetAsync(id); if (book == null) { return NotFound(); } _mapper.Map(bookDto, book); await _bookService.UpdateAsync(id, book); return Ok(); } [HttpDelete("{id:length(24)}")] [ProducesResponseType(StatusCodes.Status200OK)] [ProducesResponseType(StatusCodes.Status404NotFound)] public async Task<ActionResult> Update(string id) { var book = await _bookService.GetAsync(id); if (book == null) { return NotFound(); } await _bookService.RemoveAsync(id); return Ok(); } } }
3 測試ASP.NET Core WebAPI
生成該ASP.NET Core WebAPI應用,啟動之後在Swagger頁面進行測試:
點選GET /Book介面,測試結果如下:
其他介面測試結果不再贅述,有興趣的童鞋可以自行跑起來測試一下。
示例github地址:https://github.com/EdisonChou/EDT.Mongo.Sample
4 總結
本文總結了如何在ASP.NET Core/ASP.NET 5應用程式中操作MongoDB,展示了一個麻雀雖小但五臟俱全的示例,希望能對你有所幫助。
參考資料
Microsoft Doc,使用ASP.NETCore和MongoDB建立WebAPI
唐建法,《MongoDB高手課》(極客時間)
郭遠威,《MongoDB實戰指南》(圖書)
△推薦訂閱學習
作者:周旭龍
出處:https://edisonchou.cnblogs.com
本文版權歸作者和部落格園共有,歡迎轉載,但未經作者同意必須保留此段宣告,且在文章頁面明顯位置給出原文連結。