在开发过程中,经常需要从数据库中获取数据,尤其是在使用Entity Framework和Entity Framework Core时。但是,有时候会遇到一些未映射到模型的共享视图,需要从中查询数据。本文将介绍如何为DbContext创建扩展方法,以便执行这些查询。
将为DbContext创建扩展方法,这些方法将支持Entity Framework和Entity Framework Core。扩展方法将允许使用SQL查询字符串和可选的DbParameter对象(用于参数化查询)。
以下是Entity Framework的扩展方法实现:
using System.Data;
using System.Data.Common;
using System.Data.Entity;
public static class DbContextExtensions
{
    public static DataTable DataTable(
        this DbContext context,
        string sqlQuery,
        params DbParameter[] parameters)
    {
        DataTable dataTable = new DataTable();
        DbConnection connection = context.Database.Connection;
        DbProviderFactory dbFactory = DbProviderFactories.GetFactory(connection);
        using (var cmd = dbFactory.CreateCommand())
        {
            cmd.Connection = connection;
            cmd.CommandType = CommandType.Text;
            cmd.CommandText = sqlQuery;
            if (parameters != null)
            {
                foreach (var item in parameters)
                {
                    cmd.Parameters.Add(item);
                }
            }
            using (DbDataAdapter adapter = dbFactory.CreateDataAdapter())
            {
                adapter.SelectCommand = cmd;
                adapter.Fill(dataTable);
            }
        }
        return dataTable;
    }
}
    
以下是Entity Framework Core的扩展方法实现:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Data;
using System.Data.Common;
using Microsoft.EntityFrameworkCore;
public static class DbContextExtensions
{
    public static DataTable DataTable(
        this DbContext context,
        string sqlQuery,
        params DbParameter[] parameters)
    {
        DataTable dataTable = new DataTable();
        DbConnection connection = context.Database.GetDbConnection();
        DbProviderFactory dbFactory = DbProviderFactories.GetFactory(connection);
        using (var cmd = dbFactory.CreateCommand())
        {
            cmd.Connection = connection;
            cmd.CommandType = CommandType.Text;
            cmd.CommandText = sqlQuery;
            if (parameters != null)
            {
                foreach (var item in parameters)
                {
                    cmd.Parameters.Add(item);
                }
            }
            using (DbDataAdapter adapter = dbFactory.CreateDataAdapter())
            {
                adapter.SelectCommand = cmd;
                adapter.Fill(dataTable);
            }
        }
        return dataTable;
    }
}
    
以下是如何使用这些扩展方法的示例:
var db = new MopDb();
DataTable allUser = db.DataTable(
    "SELECT * FROM [dbo].[tbl_test_role]"
);
    
var db = new MopDb();
DataTable searchUser = db.DataTable(
    "EXEC sp_test_role @name = @paramName",
    new SqlParameter("paramName", SqlDbType.NVarChar) { Value = "sa" }
);
DataTable likeUser = db.DataTable(
    "SELECT * FROM [dbo].[tbl_test_role] WHERE [name] LIKE '%' + @paramName +'%'",
    new SqlParameter("paramName", SqlDbType.NVarChar) { Value = "a" }
);
    
不同的数据库类型需要使用不同的DbParameter类型:
如果需要在参数化查询中传递NULL值,可以在SqlParameter级别或扩展方法中处理。以下是处理NULL值的示例:
int? isActive = 1;
var param = new SqlParameter("paramIsActive", SqlDbType.Bit) { Value = isActive ?? (object)DBNull.Value, IsNullable = true };
    
public static DataTable DataTable(
    this DbContext context,
    string sqlQuery,
    params DbParameter[] parameters)
{
    foreach (var parameter in parameters.Where(x => x.Value == null))
    {
        parameter.Value = DBNull.Value;
    }
    // ... 省略其他代码 ...
}
    
以下是创建和删除数据库对象的SQL脚本:
CREATE TABLE [dbo].[tbl_test_role] (
    [id] INT IDENTITY(1,1) NOT NULL,
    [name] NVARCHAR(50) NOT NULL,
    [details] NVARCHAR(150) NULL,
    PRIMARY KEY CLUSTERED ([id] ASC)
);
INSERT INTO [dbo].[tbl_test_role] (name) VALUES ('admin'), ('sa'), ('user');
CREATE PROCEDURE sp_test_role @name nvarchar(30) AS
BEGIN
    SELECT * FROM [dbo].[tbl_test_role] WHERE [name] = @name;
END;
DROP TABLE [dbo].[tbl_test_role];
DROP PROCEDURE sp_test_role;
    
这是一个Visual Studio 2017解决方案,包含两个项目:
以下是App.config和appsettings.json中的连接字符串配置:
<connectionStrings>
    <add name="MopDbConnection" connectionString="Data Source=10.10.15.13\DB002; Initial Catalog=TESTDB; PASSWORD=dhaka; USER ID=FSTEST;" providerName="System.Data.SqlClient" />
</connectionStrings>
    
{
    "ConnectionStrings": {
        "MopDbConnection": "server=10.10.15.13\\DB002;database=TESTDB; user id=FSTEST;password=dhaka"
    }
}
    
这种方法不使用实体,而是使用传统的SQL。Entity Framework旨在维护数据库和本地数据之间的状态。在这种情况下,可以使用以下代码将选定的数据列表转换为DataTable:
// 转换 DataTable 和 List 之间的代码
    
代码可能对未经测试的输入抛出意外错误。如果有任何问题,请告诉。