一个小型、快速、轻量级的 .NET NoSQL 嵌入式数据库

郑子铭

发布于 2023-02-12 10:41:43

1.9K0

发布于 2023-02-12 10:41:43

文章被收录于专栏：DotNet NB && CloudNativeDotNet NB && CloudNative

今天给大家推荐一个小型、快速、轻量级的 .NET NoSQL 嵌入式数据库LiteDB。LiteDB完全用 C# 托管代码开发，并且是免费和开源的，Github Star 数近 7k。它非常适合在移动应用（Xamarin iOS/Android）和小型的桌面/Web 应用中使用。

LiteDB 的灵感来自 MongoDB 数据库，所以它的 API 和 MongoDB 的 .NET API 非常相似。

功能特性

Serverless NoSQL 文档存储
类似于 MongoDB 的简单 API
100% C# 代码，支持 .NET 3.5 / .NET 4.0 / NETStandard 1.3 / NETStandard 2.0，单 DLL (小于 300 kb)
支持线程和进程安全
支持文档/操作级别的 ACID
支持写失败后的数据还原 (日志模式)
可使用 DES (AES) 加密算法进行数据文件加密
可使用特性或 fluent 映射 API 将你的 POCO 类映射为 BsonDocument
可存储文件与流数据 (类似 MongoDB 的 GridFS)
单数据文件存储 (类似 SQLite)
支持基于文档字段索引的快速搜索 (每个集合支持多达 16 个索引)
支持 LINQ 查询
开源，对所有人免费 - 包括商业应用

LiteDB支持类似SQL的语言进行数据和结构操作。您可以使用非常相似的 SQL 关系语言插入、更新、删除或查询数据库

LINQ 表达式（lambda 函数）可用于在 C# 代码中创建流畅的 API 查询

新的 LiteDB.Studio 管理工具支持所有 SQL 命令

还可以从查询引擎获取详细的解释计划，以检查查询是否以最佳性能运行

使用

安装依赖

dotnet add package LiteDB --version 5.0.15

或者

NuGet\Install-Package LiteDB -Version 5.0.15

建立实体类

public class Customer
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
    public string[] Phones { get; set; }
    public bool IsActive { get; set; }
}

打开数据库

using var db = new LiteDatabase(@"MyData.db");

使用方法

// 获取 Customers 集合
var col = db.GetCollection<Customer>("customers");  

// 创建一个对象
var customer = new Customer
{
    Name = "John Doe",
    Phones = new string[] { "8000-0000", "9000-0000" },
    Age = 39,
    IsActive = true
};

// 在 Name 字段上创建唯一索引
col.EnsureIndex(x => x.Name, true); 

// 数据插入
col.Insert(customer);

// 数据查询 
List<Customer> list = col.Find(x => x.Age > 20).ToList(); 
Customer user = col.FindOne(x => x.Age > 20);

// 数据删除 
col.Delete(user.Id);

使用 fluent 映射器和跨文档引用处理更复杂的数据模型

// DbRef 交叉引用
public class Order
{
    public ObjectId Id { get; set; }
    public DateTime OrderDate { get; set; }
    public Address ShippingAddress { get; set; }
    public Customer Customer { get; set; }
    public List<Product> Products { get; set; }
}        

// 重用全局实例的映射器
var mapper = BsonMapper.Global;

// "Produts" 和 "Customer" 来自其他集合 (而不是嵌入的文档)
mapper.Entity<Order>()
    .DbRef(x => x.Customer, "customers")   // 1 对 1/0 引用
    .DbRef(x => x.Products, "products")    // 1 对多引用
    .Field(x => x.ShippingAddress, "addr"); // 嵌入的子文档
            
using(var db = new LiteDatabase("MyOrderDatafile.db"))
{
    var orders = db.GetCollection<Order>("orders");
        
    // 当查询 Order 时，包含引用
    var query = orders
        .Include(x => x.Customer)
        .Include(x => x.Products) // 1 对多引用
        .Find(x => x.OrderDate <= DateTime.Now);

    // 每个 Order 实例都会加载 Customer/Products 引用
    foreach(var order in query)
    {
        var name = order.Customer.Name;
        ...
    }
}

应用场景