流式接口
✍ dations ◷ 2025-07-04 12:42:21 #流式接口
流式接口(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'
相关
- 法国国家统计与经济研究所法国国家统计与经济研究所(法语: Institut National de la Statistique et des Études Économiques, ,缩写为INSEE),为法国的一家从事统计、经济研究的国家研究机构。法国国家
- 排名这是于2017年推估人口超过5万的俄罗斯城市/城镇(英语:Types of inhabited localities in Russia)名单,并附上2010年的人口普查结果。统计数字仅包含其本身范围内的人口,而不含其
- 嘉峪关嘉峪关位于甘肃省嘉峪关市向西5公里处,是明长城西端的第一重关,也是古代“丝绸之路”的交通要冲。嘉峪关关城,位于嘉峪关最狭窄的山谷中部,地势最高的嘉峪山上,城关两翼的城墙横
- 硝酸锆硝酸锆是一种无机化合物,化学式为Zr(NO3)4,存在五水合物和无水物。和其他硝酸盐一样,硝酸锆是一种氧化剂。无水硝酸锆可由四氯化锆和五氧化二氮反应得到:其水合物通过氢氧化锆和
- 阿塞拜疆国家足球队 格鲁吉亚 1–1 阿塞拜疆
(乔治亚提比里斯, 1927)
阿塞拜疆国家足球代表队是阿塞拜疆的国家足球代表队,由阿塞拜疆足球协会管理,现时属于国际足联及欧洲足球联合会成员
- 科克伦峰坐标:79°39′S 84°39′W / 79.650°S 84.650°W / -79.650; -84.650科克伦峰(英语:Cochran Peak),是南极洲的山峰,位于埃尔斯沃思地,处于吉福德峰南部,属于埃尔斯沃思山脉中赫里蒂
- 卡里姆·本泽马卡里姆·穆斯塔法·本泽马(法语:Karim Mostafa Benzema,1987年12月19日-),出生于法国里昂,是一名法国职业足球员,司职前锋。目前效力于西甲俱乐部皇家马德里。本泽马效力里昂时协助
- 小行星9256小行星9256(英语:9256 Tsukamoto)是一颗围绕太阳公转的小行星。1973年9月29日,C. J. 万·豪敦、I. 万·豪敦-格勒内费尔德、T. 赫雷尔斯在帕洛马山发现了此天体。这颗小行星的绝
- 丘多米尔·亚历山德罗夫丘多米尔·阿森诺夫·亚历山德罗夫(英语:Chudomir Asenov Alexandrov,保加利亚语:Чудомир Асенов Александров,1936年7月26日-1998年8月18日),是保加利亚共
- 希军登陆士麦那希军胜利并占领士麦那(英语:occupation of Smyrna)希军登陆士麦那是希军于1919年5月15日起针对士麦那及周边地区发起的军事行动。协约国批准并监督了行动计划,指示希军占领一些关键地点,还将军舰驶入士麦那港口。登陆期间有人向1/38埃夫佐尼团(英语:1/38 Evzone Regiment)开火,随后希军和士麦那的希腊公民参加了大规模暴力活动。这次重要事件成为希土战争的导火线,并开启了士麦那长达三年的希腊占领期(英语:occupation of Smyrna)。随着第一次世界大战奥斯曼帝