JSON Fliox使用指南

项目介绍

JSON Fliox 是一个专为 .NET 设计的ORM（对象关系映射）库，旨在简化对NoSQL及SQL数据库的高效访问，特别是在Web应用程序领域。它通过创建单一类来实现对表或容器记录的查询、创建、更新或删除操作，提供类型安全和验证支持，批处理以及事务处理等功能。JSON Fliox独到之处在于其两套模式模型，允许在列中存储单个实体属性（默认的关联模式），或者将整个实体存储在一个名为json_data的JSON列中，以便于灵活地处理数据库架构变更，无需迁移，并且减少了ORM阻抗不匹配的问题。

快速启动

安装依赖

首先，确保你的开发环境已经配置好.NET环境。接着，通过NuGet安装Friflo.Json.Fliox和相关依赖以进行本地数据库操作：

dotnet add package Friflo.Json.Fliox.Hub
dotnet add package Friflo.Json.Fliox.Hub.SQLite

示例应用

让我们创建一个简单的待办事项管理器：

1. 创建一个新的控制台应用。
2. 在Program.cs文件中，定义一个代表数据库操作的客户端TodoClient并连接至SQLite数据库。

using Friflo.Json.Fliox;

public class TodoClient : FlioxClient
{
    public readonly EntitySet<long, Job> Jobs;
    
    public TodoClient(FlioxHub hub, string dbName = null) : base(hub, dbName)
    {
        Jobs = GetEntitySet<long, Job>("jobs");
    }
}

public class Job
{
    [Key]
    public long Id { get; set; }
    [Required]
    public string Title { get; set; }
    public bool Completed { get; set; }
}

static async Task Main(string[] args)
{
    var schema = DatabaseSchema.Create<TodoClient>();
    var database = new SQLiteDatabase("todo.db", "Data Source=./todo.db", schema);
    await database.SetupDatabaseAsync();
    
    var hub = new FlioxHub(database);
    var client = new TodoClient(hub);
    
    // 添加示例任务
    client.Jobs.UpsertRange(new[]
    {
        new Job {Id = 1, Title = "Buy Milk", Completed = true},
        new Job {Id = 2, Title = "Walk Dog", Completed = false}
    });
    
    // 查询未完成的任务
    var tasks = await client.Jobs.Query(job => job.Completed == false);
    
    foreach (var task in tasks.Result)
    {
        Console.WriteLine($"Id: {task.Id}, Title: {task.Title}");
    }
}

运行上述代码以执行数据库操作并展示结果。

应用案例和最佳实践

在Web应用程序中集成JSON Fliox，可以利用其ORM功能轻松地与后端NoSQL数据库交互，例如在ASP.NET Core项目中设置RESTful API服务，结合WebSocket支持实时数据推送。最佳实践包括充分利用其类型安全的查询能力，通过FlioxClient来避免硬编码SQL，以及在前端应用中采用HTTP或WebSocket客户端与Hub通信，实现数据同步。

典型生态项目

JSON Fliox不仅适用于独立的.NET应用，也完美融入微服务架构，尤其是那些利用NoSQL数据库如MongoDB、Azure Cosmos DB的项目。它与现代Web框架的高兼容性意味着开发者能在诸如Blazor、React或Vue.js等技术栈中，通过API调用来实现复杂的数据交互逻辑，确保高性能和数据一致性。此外，JSON Fliox的Hub组件允许快速部署数据库服务，支持通过REST或GraphQL接口进行数据操作，是构建云原生应用的理想选择。

通过上述步骤和说明，您可以开始探索如何利用JSON Fliox提升您的数据库操作效率和Web应用性能了。记得查阅官方文档和GitHub仓库获取最新信息和技术细节。