余晖落尽暮晚霞，黄昏迟暮远山寻
本站
当前位置：网站首页 > 编程知识 > 正文

NoSQL | MongoDB入门实战教程(5)

xiyangw 2023-05-13 16:25 12 浏览 0 评论

【NoSQL】| 总结/Edison Zhou

前面我们学习了MongoDB的基本查询命令操作，作为后端开发的我们大部分场景都是在应用程序中和MongoDB进行交互，因此本篇我们来学习一下如何在ASP.NET Core中集成MongoDB。

NoSQL | MongoDB入门实战教程(5)

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

总结

本文总结了如何在ASP.NET Core/ASP.NET 5应用程序中操作MongoDB，展示了一个麻雀虽小但五脏俱全的示例，希望能对你有所帮助。

参考资料

Microsoft Doc，使用ASP.NET Core和MongoDB创建WebAPI

唐建法，《MongoDB高手课》（极客时间）

郭远威，《MongoDB实战指南》（图书）

相关推荐

辞旧迎新，新手使用Containerd时的几点须知

相信大家在2020年岁末都被Kubernetes即将抛弃Docker的消息刷屏了。事实上作为接替Docker运行时的Containerd在早在Kubernetes1.7时就能直接与Kubelet集成使...

分布式日志系统ELK+skywalking分布式链路完整搭建流程

开头在分布式系统中，日志跟踪是一件很令程序员头疼的问题，在遇到生产问题时，如果是多节点需要打开多节点服务器去跟踪问题，如果下游也是多节点且调用多个服务，那就更麻烦，再者，如果没有分布式链路，在生产日志...

Linux用户和用户组管理

1、用户账户概述-AAA介绍AAA指的是Authentication、Authorization、Accounting，即认证、授权和审计。?认证：验证用户是否可以获得权限，是3A的第一步，即验证身份...

linux查看最后N条日志

其实很简单，只需要用到tail这个命令tail-100catalina.out输入以上命令，就能列出catalina.out的最后100行。...

解决linux系统日志时间错误的问题

今天发现一台虚拟机下的系统日志：/var/log/messages，文件时间戳不对，跟正常时间差了12个小时。按网上说的执行了servicersyslogrestart重启syslog服务，还是不...

全程软件测试(六十二):软件测试工作如何运用Linux—读书笔记

从事过软件测试的小伙们就会明白会使用Linux是多么重要的一件事，工作时需要用到，面试时会被问到，简历中需要写到。对于软件测试人员来说，不需要你多么熟练使用Linux所有命令，也不需要你对Linux...

Linux运维之为Nginx添加错误日志(error_log)配置

Nginx错误日志信息介绍配置记录Nginx的错误信息是调试Nginx服务的重要手段，属于核心功能模块（nginx_core_module）的参数，该参数名字为error_log,可以放在不同的虚机主...

Linux使用swatchdog实时监控日志文件的变化

1.前言本教程主要讲解在Linux系统中如何使用swatchdog实时监控日志文件的变化。swatchdog(SimpleWATCHDOG)是一个简单的Perl脚本，用于监视类Unix系统(比如...

syslog服务详解

背景：需求来自于一个客户想将服务器的日志转发到自己的日志服务器上，所以希望我们能提供这个转发的功能，同时还要满足syslog协议。1什么是syslog服务1.1syslog标准协议如下图这里的fa...

linux日志文件的管理、备份及日志服务器的搭建

日志文件存放目录:/var/log[root@xinglog]#cd/var/log[root@xinglog]#lsmessages：系统日志secure：登录日志———————————...

运维之日志管理简介

日志简介在运维过程中，日志是必不可少的东西，通过日志可以快速发现问题所在。日志分类日志分类，对不同的日志进行不同维度的分析。操作系统日志操作系统是基础，应用都是在其之上；操作系统日志的分析，可以反馈出...

Apache Log4j 爆核弹级漏洞，Spring Boot 默认日志框架就能完美躲过

这两天沸沸扬扬的Log4j2漏洞门事件炒得热火朝天：突发！ApacheLog4j2报核弹级漏洞。。赶紧修复！！|Java技术栈|Java|SpringBoot|Spring...

Linux服务器存在大量log日志，如何快速定位错误?

来源：blog.csdn.net/nan1996jiang/articlep/details/109550303针对大量log日志快速定位错误地方tail/head简单命令使用：附加针对大量log日志...

Linux中查看日志文件的正确姿势，求你别tail走天下了!

作为一个后端开发工程师，在Linux中查看查看文件内容是基本操作了。尤其是通常要分析日志文件排查问题，那么我们应该如何正确打开日志文件呢？对于我这种小菜鸡来说，第一反应就是cat，tail，vi（或...

分享几款常用的付费日志系统，献给迷茫的你!

概述在前一篇文章中，我们分享了几款免费的日志服务器。他们各有各的特点，但是大家有不同的需求，有时免费的服务器不能满足大家的需要，下面推荐几款付费的日志服务器。1.Nagios日志服务器Nagio...

取消回复欢迎 你 发表评论:

一周热门
标签列表
最新留言
本站文章转载自互联网及网友投稿，文章内容仅供学习参考，不构成建议，也不代表本站赞同其观点。
如有侵权请联系jellybean52032@gmail.com，提供原文链接地址以及资料原创证明，本站将会立即删除。