流式接口
✍ dations ◷ 2025-08-21 02:49:01 #流式接口
流式接口(fluent interface)是软件工程中面向对象API的一种实现方式,以提供更为可读的源代码。最早由Eric Evans(英语:Eric Evans (technologist))与Martin Fowler于2005年提出。
通常采取方法瀑布调用(英语:enmethod cascading) (具体说是方法链式调用(英语:method chaining))来转发一系列对象方法调用的上下文 。这个上下文(context)通常是指:
C++的iostream流式调用就是一个典型的例子。Smalltalk在1970年代就实现了方法瀑布调用(英语:enmethod cascading)。
用于数据库查询的jQuery,例如https://github.com/Medium/dynamite :
// getting an item from a tableclient.getItem('user-table') .setHashKey('userId', 'userA') .setRangeKey('column', '@') .execute() .then(function(data) { // data.result: the resulting object })
JavaScript使用原型继承与`this`.
// example from http://schier.co/post/method-chaining-in-javascript// define the classvar Kitten = function() { this.name = 'Garfield'; this.color = 'brown'; this.gender = 'male';};Kitten.prototype.setName = function(name) { this.name = name; return this;};Kitten.prototype.setColor = function(color) { this.color = color; return this;};Kitten.prototype.setGender = function(gender) { this.gender = gender; return this;};Kitten.prototype.save = function() { console.log( 'saving ' + this.name + ', the ' + this.color + ' ' + this.gender + ' kitten...' ); // save to database here... return this;};// use itnew Kitten() .setName('Bob') .setColor('black') .setGender('male') .save();
Java
jOOQ库模拟了SQL
Author author = AUTHOR.as("author");create.selectFrom(author) .where(exists(selectOne() .from(BOOK) .where(BOOK.STATUS.eq(BOOK_STATUS.SOLD_OUT)) .and(BOOK.AUTHOR_ID.eq(author.ID))));
C#
C#在LINQ中大量使用 与扩展方法。
var translations = new Dictionary<string, string> { {"cat", "chat"}, {"dog", "chien"}, {"fish", "poisson"}, {"bird", "oiseau"} };// Find translations for English words containing the letter "a",// sorted by length and displayed in uppercaseIEnumerable<string> query = translations .Where (t => t.Key.Contains("a")) .OrderBy (t => t.Value.Length) .Select (t => t.Value.ToUpper());// The same query constructed progressively:var filtered = translations.Where (t => t.Key.Contains("a"));var sorted = filtered.OrderBy (t => t.Value.Length);var finalQuery = sorted.Select (t => t.Value.ToUpper());
流式接口可用于一系列方法,他们运行在同一对象上。
// Defines the data contextclass Context{ public string FirstName { get; set; } public string LastName { get; set; } public string Sex { get; set; } public string Address { get; set; }}class Customer{ private Context _context = new Context(); // Initializes the context // set the value for properties public Customer FirstName(string firstName) { _context.FirstName = firstName; return this; } public Customer LastName(string lastName) { _context.LastName = lastName; return this; } public Customer Sex(string sex) { _context.Sex = sex; return this; } public Customer Address(string address) { _context.Address = address; return this; } // Prints the data to console public void Print() { Console.WriteLine("First name: {0} nLast name: {1} nSex: {2} nAddress: {3}", _context.FirstName, _context.LastName, _context.Sex, _context.Address); }}class Program{ static void Main(string args) { // Object creation Customer c1 = new Customer(); // Using the method chaining to assign & print data with a single line c1.FirstName("vinod").LastName("srivastav").Sex("male").Address("bangalore").Print(); }}
C++
下述代码对比了传统的风格与流式接口的实现风格:
// Basic definition class GlutApp { private: int w_, h_, x_, y_, argc_, display_mode_; char **argv_; char *title_; public: GlutApp(int argc, char** argv) { argc_ = argc; argv_ = argv; } void setDisplayMode(int mode) { display_mode_ = mode; } int getDisplayMode() { return display_mode_; } void setWindowSize(int w, int h) { w_ = w; h_ = h; } void setWindowPosition(int x, int y) { x_ = x; y_ = y; } void setTitle(const char *title) { title_ = title; } void create(){;} }; // Basic usage int main(int argc, char **argv) { GlutApp app(argc, argv); app.setDisplayMode(GLUT_DOUBLE|GLUT_RGBA|GLUT_ALPHA|GLUT_DEPTH); // Set framebuffer params app.setWindowSize(500, 500); // Set window params app.setWindowPosition(200, 200); app.setTitle("My OpenGL/GLUT App"); app.create(); } // Fluent wrapper class FluentGlutApp : private GlutApp { public: FluentGlutApp(int argc, char **argv) : GlutApp(argc, argv) {} // Inherit parent constructor FluentGlutApp &withDoubleBuffer() { setDisplayMode(getDisplayMode() | GLUT_DOUBLE); return *this; } FluentGlutApp &withRGBA() { setDisplayMode(getDisplayMode() | GLUT_RGBA); return *this; } FluentGlutApp &withAlpha() { setDisplayMode(getDisplayMode() | GLUT_ALPHA); return *this; } FluentGlutApp &withDepth() { setDisplayMode(getDisplayMode() | GLUT_DEPTH); return *this; } FluentGlutApp &across(int w, int h) { setWindowSize(w, h); return *this; } FluentGlutApp &at(int x, int y) { setWindowPosition(x, y); return *this; } FluentGlutApp &named(const char *title) { setTitle(title); return *this; } // It doesn't make sense to chain after create(), so don't return *this void create() { GlutApp::create(); } }; // Fluent usage int main(int argc, char **argv) { FluentGlutApp(argc, argv) .withDoubleBuffer().withRGBA().withAlpha().withDepth() .at(200, 200).across(500, 500) .named("My OpenGL/GLUT App") .create(); }
Ruby
Ruby语言允许修改核心类,这使得流式接口成为原生易于实现。
# Add methods to String classclass String def prefix(raw) "#{raw} #{self}" end def suffix(raw) "#{self} #{raw}" end def indent(raw) raw = " " * raw if raw.kind_of? Fixnum prefix(raw) endend # Fluent interfacemessage = "there"puts message.prefix("hello") .suffix("world") .indent(8)
Scala
Scala supports a fluent syntax for both method calls and class mixins, using traits and the with keyword. For example:
class Color { def rgb(): Tuple3 }object Black extends Color { override def rgb(): Tuple3 = ("0", "0", "0"); }trait GUIWindow { // Rendering methods that return this for fluent drawing def set_pen_color(color: Color): this.type def move_to(pos: Position): this.type def line_to(pos: Position, end_pos: Position): this.type def render(): this.type = this // Don't draw anything, just return this, for child implementations to use fluently def top_left(): Position def bottom_left(): Position def top_right(): Position def bottom_right(): Position}trait WindowBorder extends GUIWindow { def render(): GUIWindow = { super.render() .move_to(top_left()) .set_pen_color(Black) .line_to(top_right()) .line_to(bottom_right()) .line_to(bottom_left()) .line_to(top_left()) }}class SwingWindow extends GUIWindow { ... }val appWin = new SwingWindow() with WindowBorderappWin.render()
Perl 6
In Perl 6, there are many approaches, but one of the simplest is to declare attributes as read/write and use the given
keyword. The type annotations are optional, but the native gradual typing makes it much safer to write directly to public attributes.
class Employee { subset Salary of Real where * > 0; subset NonEmptyString of Str where * ~~ /S/; # at least one non-space character has NonEmptyString $.name is rw; has NonEmptyString $.surname is rw; has Salary $.salary is rw; method gist { return qq:to; Name: $.name Surname: $.surname Salary: $.salary END }}my $employee = Employee.new();given $employee { .name = 'Sally'; .surname = 'Ride'; .salary = 200;}say $employee;# Output:# Name: Sally# Surname: Ride# Salary: 200
PHP
在PHP中,可以使用表示实例的特殊变量$this返回当前对象。因此返回$this将使方法返回实例。下面的示例定义了一个Employee类和三个方法来设置它的名称、姓和薪水。每个Employee类的实例允许调用这些方法。
<?phpclass Employee{ public $name; public $surName; public $salary; public function setName($name) { $this->name = $name; return $this; } public function setSurname($surname) { $this->surName = $surname; return $this; } public function setSalary($salary) { $this->salary = $salary; return $this; } public function __toString() { $employeeInfo = 'Name: ' . $this->name . PHP_EOL; $employeeInfo .= 'Surname: ' . $this->surName . PHP_EOL; $employeeInfo .= 'Salary: ' . $this->salary . PHP_EOL; return $employeeInfo; }}# Create a new instance of the Employee class, Tom Smith, with a salary of 100:$employee = (new Employee()) ->setName('Tom') ->setSurname('Smith') ->setSalary('100');# Display the value of the Employee instance:echo $employee;# Display:# Name: Tom# Surname: Smith# Salary: 100
Python
Python通过在实例方法中返回`self`:
class Poem(object): def __init__(self, content): self.content = content def indent(self, spaces): self.content = " " * spaces + self.content return self def suffix(self, content): self.content = self.content + " - " + content return self
>>> Poem("Road Not Travelled").indent(4).suffix("Robert Frost").content' Road Not Travelled - Robert Frost'
相关
- 大学生运动会世界大学生运动会(英语:Universiade),简称世界大学运动会、大学生运动会、大运会,是一项专供大学生运动员参加的青年国际综合性体育活动,主办组织为国际大学运动总会。世界大学生
- 1905年法国政教分离法1905年法国政教分离法(法语:loi du 9 décembre 1905 concernant la séparation des Églises et de l'État)由法兰西第三共和国众议院于1905年12月9日通过的一项法律。该法
- 导带导带(英语:conduction band),又名传导带,是指半导体或是绝缘体材料中,一种电子所具有能量的范围。这个能量的范围高于价带(valence band),而所有在导带中的电子均可经由外在的电场加
- 勒德拉宫勒德拉宫(Ledra Palace)在塞浦路斯北部的尼科西亚。它的位置在欧盟所设立用以分隔塞浦路斯共和国及未被承认的北塞浦路斯土耳其共和国的分界线绿线上。现时,勒德拉宫西侧的城
- 动作片演员动作片演员又称武打演员、打仔,是属于动作类型电影里的灵魂人物,观众要求此等演员演技多于一般普通演员,使用武器需出手俐落,还会功夫,并且不可时常使用替身演员,较知名动作片演员
- 帕特蒂奥姆帕特蒂奥姆(Pattiom),是印度喀拉拉邦Kannur县的一个城镇。总人口19948(2001年)。该地2001年总人口19948人,其中男性9204人,女性10744人;0—6岁人口1900人,其中男946人,女954人;识字率85
- 莎哟娜拉!小黑《莎哟娜拉!小黑》(日语:さよなら、クロ),以1960年日本长野县松本市松本深志高中发生的真人真事为基础改编的电影。由妻夫木聪主演。
- 塞浦路斯的夏洛特塞浦路斯的夏洛特(英语:Charlotte, Queen of Cyprus,1444年6月28日-1487年7月16日),塞浦路斯女王,1458年至1463年在位。1456年,夏洛特与科英布拉的约翰(英语:John of Coimbra, Prince
- 三津田信三三津田 信三(みつだ しんぞう),日本小说家,奈良县出身。三津田信三小时候曾阅读江户川乱步“少年侦探”系列与朱尔·凡尔纳青年文学、卡斯顿·勒胡‘黄色房间的秘密’与艾伦·亚
- 何塞·佩德罗·佩雷斯-略尔卡何塞·佩德罗·佩雷斯-略尔卡·罗德里戈(西班牙语:José Pedro Pérez-Llorca Rodrigo,1940年11月30日-2019年3月6日),是西班牙加的斯出身的律师。曾在1980年至1982年间出任西班牙