OpenRobot.Framework.EntityFrameworkCore 1.1.0

OpenRobot.Framework.EntityFrameworkCore

OpenRobot.Framework.EntityFrameworkCore 是 OpenRobot Web 框架的数据访问层，提供 Entity Framework Core 的完整实现、数据库迁移、仓储模式和多种数据库提供程序支持。

主要特性

• Entity Framework Core 8.0.8 - 基于最新的 EF Core
• 多数据库支持 - 支持 PostgreSQL、SQLite 等多种数据库
• ABP 集成 - 与 ASP.NET Boilerplate 深度集成
• 仓储模式 - 泛型仓储和自定义仓储支持
• 数据库迁移 - 完整的 Code First 迁移支持
• 多租户 - 支持多租户数据过滤
• 自定义配置 - 灵活的 DbContext 配置

安装

dotnet add package OpenRobot.Framework.EntityFrameworkCore

或在 Visual Studio 的 NuGet 包管理器控制台中运行：

Install-Package OpenRobot.Framework.EntityFrameworkCore

快速开始

定义 DbContext

using Abp.EntityFrameworkCore;
using OpenRobot.Framework.Core.Authorization.Users;

namespace OpenRobot.Framework.EntityFrameworkCore
{
    public class WebFrameworkDbContext : AbpZeroDbContext<Tenant, Role, User, WebFrameworkDbContext>
    {
        public WebFrameworkDbContext(DbContextOptions<WebFrameworkDbContext> options)
            : base(options)
        {
        }

        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            base.OnModelCreating(modelBuilder);

            // 自定义实体配置
            modelBuilder.Entity<MyEntity>(b =>
            {
                b.ToTable("MyEntities");
                b.Property(x => x.Name).IsRequired().HasMaxLength(256);
            });
        }
    }
}

配置数据库连接

using Microsoft.EntityFrameworkCore;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddDbContext<WebFrameworkDbContext>(options =>
            options.UseNpgsql(
                Configuration.GetConnectionString("WebFramework"),
                npgsqlOptions => npgsqlOptions.UseQuerySplittingBehavior(
                    QuerySplittingBehavior.SplitQuery)
                )
            );
    }
}

使用仓储

using Abp.Domain.Repositories;

public class MyEntityAppService : ApplicationService
{
    private readonly IRepository<MyEntity, long> _repository;

    public MyEntityAppService(IRepository<MyEntity, long> repository)
    {
        _repository = repository;
    }

    public async Task<MyDto> CreateAsync(CreateMyDto input)
    {
        var entity = ObjectMapper.Map<MyEntity>(input);
        await _repository.InsertAsync(entity);
        return ObjectMapper.Map<MyDto>(entity);
    }

    public async Task<List<MyDto>> GetAllAsync()
    {
        var entities = await _repository.GetAllListAsync();
        return ObjectMapper.Map<List<MyDto>>(entities);
    }
}

数据库迁移

创建迁移

cd web/OpenRobot.Framework.EntityFrameworkCore
dotnet ef migrations add AddMyEntity

更新数据库

dotnet ef database update

生成 SQL 脚本

dotnet ef migrations script

依赖项

系统要求

• .NET 8.0 或更高版本
• PostgreSQL 12+（使用 PostgreSQL 时）
• SQLite 3.x（使用 SQLite 时）

在框架中的位置

OpenRobot.Framework.Web.Core
    └── OpenRobot.Framework.EntityFrameworkCore ✓
        ├── OpenRobot.Framework.Core ✓
        └── OpenRobot.Framework.EFCommon ✓

数据库配置

连接字符串配置 (appsettings.json)

{
  "ConnectionStrings": {
    "WebFramework": "Host=localhost;Port=5432;Database=webframework;Username=postgres;Password=your_password",
    "SQLite": "Data Source=webframework.db"
  }
}

数据库提供程序选择

框架支持以下数据库提供程序：

• PostgreSQL (Npgsql.EntityFrameworkCore.PostgreSQL) - 生产环境推荐
• SQLite (Microsoft.EntityFrameworkCore.Sqlite) - 开发和小型应用
• SQL Server (Microsoft.EntityFrameworkCore.SqlServer) - 需要额外添加包

核心功能

仓储模式

框架提供以下仓储接口：

• IRepository<TEntity, TPrimaryKey> - 主键仓储
• IRepository<TEntity> - 简化仓储（默认 int 主键）

多租户支持

// 自动过滤当前租户的数据
var entities = await _repository.GetAllListAsync();

// 禁用租户过滤
using (CurrentUnitOfWork.DisableFilter(AbpDataFilters.MayHaveTenant))
{
    var allEntities = await _repository.GetAllListAsync();
}

软删除

// 自动过滤已删除的实体
var activeEntities = await _repository.GetAllListAsync();

// 包含已删除的实体
using (CurrentUnitOfWork.DisableFilter(AbpDataFilters.SoftDelete))
{
    var allEntities = await _repository.GetAllListAsync();
}

自定义配置

IDbContextConfigurer

using Abp.EntityFrameworkCore;

public class CustomDbConfigurer : IDbContextConfigurer
{
    public void Configure(ISetupDbContext setupContext)
    {
        setupContext.DbContextOptions.UseNpgsql(
            setupContext.ConnectionString,
            options =>
            {
                options.UseQuerySplittingBehavior(QuerySplittingBehavior.SplitQuery);
                options.EnableRetryOnFailure(3);
            }
        );
    }
}

目录结构

OpenRobot.Framework.EntityFrameworkCore/
├── EntityFrameworkCore/
│   ├── WebFrameworkDbContext.cs      # 主 DbContext
│   └── DbSnapshots/                  # 迁移快照
├── Migrations/                       # 数据库迁移
└── Repositories/                     # 自定义仓储（可选）

相关模块

• OpenRobot.Framework.Core - 领域实体
• OpenRobot.Framework.EFCommon - EF Core 共享配置
• OpenRobot.Framework.Application - 应用程序服务层

许可证

本项目采用 MIT 许可证。

作者

OpenRobot

反馈与贡献

欢迎通过以下方式提供反馈：

• 提交 Issue
• 发起 Pull Request
• 联系维护者