Fluent API — 流畅API(基于Java介绍)

midoll 348 2022-11-01

Fluent API — 流畅API(基于Java介绍)

Fluent API ,流畅API, 也称作流式API。
Fluent API 是一种面向对象的API,主要基于方法链。
这个概念由Eric Evans​和​Martin Fowler​于 2005 年创建, 旨在通过创建特定领域语言(DSL)来提高代码的可读性。
流畅API的好处是不需要记住接下来的步骤和方法, 允许一个自然连续的序列。

Fluent API 的组成

一般来说, Fluent API 包括:

  1. 最终的对象或结果,总的来说,fluent-API 类似于构建器模式,但最强大的动态与 DSL 相结合。在这两种情况下,结果往往是代表流程或新实体结果的实例。
  2. 选项:在这种情况下,是将用作“我们的交互式菜单”的接口或类的集合。从一个动作来看,这个想法是按照直观的顺序只显示下一步可用的选项。
  3. 结果:在所有这个过程之后,答案可能会或可能不会导致实体、策略等的实例。关键点是结果必须是有效的。

Java 实现 Fluent 风格的代码

不使用Fluent 风格

在不使用Fluent 风格, 定义一个Usr 类, 有name 和age 两个属性。


public class Usr {

	private String name;
	private int age;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

}

该类型实例化的代码如下:

		Usr usr = new Usr();
	    usr.setName("张三");
	    usr.setAge(20);

使用Fluent 风格

使用Fluent 风格的类定义如下:


public class Usr {

	private String name;
	private int age;

	public String getName() {
		return name;
	}

	public Usr setName(String name) {
		this.name = name;
		return this;
	}

	public int getAge() {
		return age;
	}

	public Usr setAge(int age) {
		this.age = age;
		return this;
	}
	
	public static Usr build() {
		return new Usr();
	}

}
Usr usr = Usr.build().setName("张三").setAge(20);

Java 中的Fluent API

Java有很多组件提供了流式API 。

  • JDOQ 框架。 Java和关系数据库之间的通信
Query query = create.select(BOOK.TITLE, AUTHOR.FIRST_NAME, AUTHOR.LAST_NAME)
                    .from(BOOK)
                    .join(AUTHOR)
                    .on(BOOK.AUTHOR_ID.eq(AUTHOR.ID))
                    .where(BOOK.PUBLISHED_IN.eq(1948));

String sql = query.getSQL();
List<Object> bindValues = query.getBindValues();
  • Jakarta NoSQL, Java操作非关系型数据库
DocumentQuery query = select().from("Person").where(eq(Document.of("_id", id))).build();
Optional<Person> person = documentTemplate.singleResult(query);
System.out.println("Entity found: " + person);
  • Java Stream API
  • Java Time API
  • JPA Query Builder
  • Lombok builders