0

0

C#如何实现链式调用 Fluent API设计与实现教程

星降

星降

发布时间:2025-12-15 06:27:16

|

485人浏览过

|

来源于php中文网

原创

链式调用是通过方法返回当前或新对象实现连续点号调用的API设计风格,如builder.SetName().SetAge().Build(),核心在于返回this、语义明确与阶段可控。

c#如何实现链式调用 fluent api设计与实现教程

什么是链式调用与Fluent API

链式调用是指方法调用后返回当前对象(this)或新构建的对象,从而支持连续点号调用,比如 builder.SetName("Tom").SetAge(25).Build()。它不是语法特性,而是通过精心设计的返回值实现的可读性强、意图明确的API风格,常用于配置类、查询构造器、Builder模式等场景。

基础实现:返回 this 实现简单链式

最直接的方式是在每个设置方法中返回 this,让调用方能继续操作同一实例:

```csharp
public class PersonBuilder
{
    private string _name;
    private int _age;

    public PersonBuilder SetName(string name)
    {
        _name = name;
        return this;
    }

    public PersonBuilder SetAge(int age)
    {
        _age = age;
        return this;
    }

    public Person Build() => new Person(_name, _age);
}
```

这样就能写成:var p = new PersonBuilder().SetName("Alice").SetAge(30).Build();

进阶技巧:不可变性与泛型约束提升健壮性

为防止误用(如调用完 Build 后继续 Set),可引入状态控制或使用泛型分阶段类型:

晓象AI资讯阅读神器
晓象AI资讯阅读神器

晓象-AI时代的资讯阅读神器

下载
  • 用只读字段 + 私有构造器保证构建过程不可逆
  • 定义多个接口(如 IStep1, IStep2)并让方法返回下一阶段接口,编译期强制调用顺序
  • 对 Builder 方法加 where T : class 约束,配合泛型返回类型支持继承链扩展

例如,强制先调用 WithName() 才能调用 WithAge(),可通过接口拆分实现:

```csharp
public interface IHaveName { PersonBuilder WithName(string name); }
public interface IHaveAge : IHaveName { PersonBuilder WithAge(int age); }

public class PersonBuilder : IHaveName, IHaveAge
{
    private string _name;
    private int _age;

    public PersonBuilder WithName(string name)
    {
        _name = name;
        return this;
    }

    public PersonBuilder WithAge(int age)
    {
        _age = age;
        return this;
    }
}
```

实用建议与注意事项

Fluent API 不是越链越多越好,关键在表达力和安全性:

  • 避免过度嵌套,单行不宜超过 3–4 次调用,必要时换行提升可读性
  • 不要在链式方法中抛异常(如参数校验失败),否则中断链;应提前验证或延迟到 Build 时统一检查
  • 若涉及异步操作(如 .ThenAwait().ThenDo()),需返回 Task 并用 await 配合,此时无法真“链式”,建议用 async/await + LINQ-style 扩展方法替代
  • 考虑 XML 文档注释 + IDE 支持,让 IntelliSense 清晰提示每一步能做什么

基本上就这些——链式调用不复杂但容易忽略细节,核心就是:返回对象、语义清晰、阶段可控。

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

318

2023.08.02

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1886

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2087

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

1017

2024.11.28

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

318

2023.08.02

int占多少字节
int占多少字节

int占4个字节,意味着一个int变量可以存储范围在-2,147,483,648到2,147,483,647之间的整数值,在某些情况下也可能是2个字节或8个字节,int是一种常用的数据类型,用于表示整数,需要根据具体情况选择合适的数据类型,以确保程序的正确性和性能。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

538

2024.08.29

c++怎么把double转成int
c++怎么把double转成int

本专题整合了 c++ double相关教程,阅读专题下面的文章了解更多详细内容。

53

2025.08.29

C++中int的含义
C++中int的含义

本专题整合了C++中int相关内容,阅读专题下面的文章了解更多详细内容。

197

2025.08.29

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

2026.01.19

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
10分钟--Midjourney创作自己的漫画
10分钟--Midjourney创作自己的漫画

共1课时 | 0.1万人学习

Midjourney 关键词系列整合
Midjourney 关键词系列整合

共13课时 | 0.9万人学习

AI绘画教程
AI绘画教程

共2课时 | 0.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号