EFCorePowerTools 中 PostgreSQL 存储过程与函数映射的实现

在数据库应用开发中，存储过程和函数是重要的数据库对象，它们封装了业务逻辑并提高了代码复用性。EFCorePowerTools 作为一个强大的 Entity Framework Core 工具扩展，最近实现了对 PostgreSQL 存储过程和函数的映射支持，为开发者提供了更便捷的数据库访问方式。

PostgreSQL 函数与存储过程的区别

PostgreSQL 中有两种可执行数据库对象：函数(Function)和存储过程(Procedure)。它们在调用方式和功能上有明显区别：

1. 函数(Function)：

   • 可以嵌入到任何 SQL 查询中
   • 通过 SELECT * FROM func() 方式调用
   • 可以返回结果集或标量值
   • 支持多种语言实现(PL/pgSQL, PL/Python等)

2. 存储过程(Procedure)：

   • 通过 CALL proc() 方式调用
   • 不能嵌入到其他 SQL 语句中
   • 可以控制事务(函数不能)
   • 通常用于执行操作而非返回数据

实现原理

EFCorePowerTools 通过查询 PostgreSQL 的系统目录表来获取函数和存储过程的元数据：

1. 元数据查询：

   • 从 information_schema.routines 获取函数基本信息
   • 结合 pg_catalog.pg_proc 获取更详细的函数属性
   • 查询 information_schema.parameters 获取参数信息

2. 结果集形状检测：

   • 对于返回自定义类型的函数，通过查询 information_schema.columns 获取返回结果的列信息
   • 确定返回结果的列名、数据类型和顺序

3. 类型映射：

   • 将 PostgreSQL 数据类型映射到 .NET 类型和 NpgsqlDbType
   • 处理特殊类型如 bit/varbit 的转换

生成的代码结构

工具会为每个返回结果集的函数生成对应的 C# 方法，主要包含以下部分：

1. 参数定义：

   • 为每个函数参数创建 NpgsqlParameter 对象
   • 设置正确的参数名、类型和值

2. 函数调用：

   • 使用 SELECT * FROM schema.func_name(@param1, @param2) 语法调用函数
   • 通过 FromSqlRaw 或 SqlQueryAsync 执行查询

3. 结果映射：

   • 为每个返回结果集生成对应的实体类
   • 自动映射列名到属性

使用示例

生成的典型调用代码如下：

var parameters = new [] {
    new NpgsqlParameter {
        ParameterName = "CustomerID",
        Value = customerId ?? Convert.DBNull,
        NpgsqlDbType = NpgsqlDbType.Char
    }
};

var results = await _context.SqlQueryAsync<CustOrderHistResult>(
    "SELECT * FROM \"public\".\"CustOrderHist\" (@CustomerID)", 
    parameters, 
    cancellationToken);

注意事项

1. 参数绑定：

   • 目前 EF Core 6 不支持 PostgreSQL 的位置参数($1, $2)
   • 需要使用命名参数(@paramName)方式

2. 标识符引用：

   • 在生成的 SQL 中，标识符(如表名、函数名)需要适当引用
   • 但 PostgreSQL 通常不需要引用简单的标识符

3. C# 代码生成：

   • 考虑使用 C# 11 的原始字符串字面量(""")来避免转义引号
   • 但需要根据目标项目的 C# 版本决定

未来改进方向

1. 支持存储过程：

   • 实现通过 CALL 语法调用的存储过程映射
   • 处理存储过程特有的事务控制能力

2. 更智能的类型映射：

   • 增强对复杂 PostgreSQL 类型的支持
   • 优化类型转换逻辑

3. 性能优化：

   • 改进元数据查询效率
   • 优化生成的 SQL 语句

EFCorePowerTools 的这一功能为 PostgreSQL 开发者提供了更完整的 ORM 支持，使得在 .NET 应用中使用 PostgreSQL 的存储过程和函数变得更加简单和高效。随着后续功能的不断完善，它将为开发者带来更加强大的数据库访问能力。