Facil 开源项目最佳实践教程

颜德崇

于 2025-05-27 09:00:41 发布

阅读量304

点赞数 5

本文链接：https://blog.csdn.net/gitblog_00195/article/details/148244894

版权

Facil 开源项目最佳实践教程

Facil Facil generates F# data access source code from SQL queries and stored procedures. Optimized for developer happiness. 项目地址: https://gitcode.com/gh_mirrors/fac/Facil

1. 项目介绍

Facil 是一个开源的 F# 数据访问代码生成工具，它可以从 SQL 查询和存储过程中生成 F# 数据访问源代码。该工具针对开发者体验进行了优化，使得开发者可以更加便捷地操作 SQL 服务器中的数据。

Facil 的主要特点包括：

简单易用的配置，支持高度自定义的 YAML 配置文件。
生成代码具有良好的 API 设计，简洁、易于发现，无需编写模板代码。
支持 SQL Server 2012 及以上版本。
面向 .NET Standard 2.0。
提供全面的测试。
高性能，内部异步读取循环使用 C# 原生的 async/await。
支持将结果集映射到指定的记录类型。
支持表值参数和存储过程的输出参数。

2. 项目快速启动

安装

首先，确保你的开发环境满足以下要求：

SQL Server 2012 或更高版本（构建时）。
.NET 6.0 或更高版本（运行生成器时）。

接下来，从 NuGet 安装 Facil：

Install-Package Facil

配置

安装完成后，你会在项目目录中生成一个 facil.yaml 配置文件。编辑该文件，至少设置一个连接字符串。以下是一个配置示例：

rulesets:
  -
    connectionString: 'YOUR CONNECTION STRING HERE'
    procedures:
      - include: '*'
    scripts:
      - include: '**/*.sql'

生成代码

配置完成后，重新构建你的项目。Facil 将生成数据访问代码。将生成的文件添加到你的项目中。

使用生成的代码

以下是如何使用 Facil 生成的代码的示例：

open DbGen.Procedures.dbo

let getUser (connStr: string) (UserId userId) : Async<User option> =
    GetUserById.WithConnection(connStr)
                .WithParameters(userId)
                .AsyncExecuteSingle()

let searchProducts (connStr: string) (args: ProductSearchArgs) : Async<ResizeArray<Product>> =
    async {
        let dtoWithPrimitiveParams = ProductSearchArgs.toDto args
        return! GetUserById.WithConnection(connStr)
                          .WithParameters(dtoWithPrimitiveParams)
                          .AsyncExecute()
    }