一种“记住”代码的方法

几年前发生过一件事，当时被老东家裁员已经过去半年，然后有一天下班后在公交车上收到前同事的来电，问我一个功能写在哪里，我直接告诉他去X类里搜索AABBCC名称的一个dialog，显示这个对话框的下面一行有一个方法调用注册一个监听器，就是要找的代码。那个时候，纯粹是因为对那个代码印象深刻，所以能回忆起来。但这种方式记代码只能记住一些重要的或者印象深刻的代码。去年在学习PL相关理论的时候，想到了另一种“记住”代码的方法，之所以这个“记住”需要加引号，是因为这不需要去记忆，但是可以达到和记住代码一样的效果。本文就介绍下这种方法。

一、如何去“记住”

要表现的像是“记住”一样，意味着可以重现之前写的代码，所以针对同一功能，第二次编写的时候能写出和第一次一样的代码，那么是不是就跟记住了这段代码一样呢？

举例来说，大部分人并没有记住斐波那契第10个数，但可以很容易计算出“1,1,2,3,5,8,13,21,34,55”，最后得出第10个数是55，这不是跟“记住”有着类似的效果。这里之所以可以得到这个数是因为我们有一个明确的计算规则“这个数列从第3项开始，每一项都等于前两项之和”来指导我们得出这个数。

但写代码不同，因为写代码没有什么明确的规则得出最终代码，即便现在有了面向对象编程、函数式编程、响应式编程等等等等编程思想，但这些思想都是模糊的思想，而且可能得出不同的答案，这并不能达到“记住”的要求。我们需要有一种明确的规则来指导程序编写，并且针对同一需求只会得到一个程序（或者得到几种只有细微差别但整体结构相同的程序），即便这种规则具有局限性。

在学习EOPL的时候有一个，就是直接把需求说明当代码来用，这样需求就是代码，我得到了需求，也就得到了代码。不过很可惜，程序语言都有着严格的语法词法规范，而且绝大部分语言都不允许扩展这部分内容。所以就考虑把需求“直译”成代码，针对程序语言，对功能需求做一些词法和语法上的调整。比如经典示例“打印5行hello world”，就可以写成：

print(5, LINE, "hello world");

而“打印hello到控制台”就是：

print("hello").to(console)

我相信大部分人都有办法让上面的代码跑起来，顶多改几个名称。

二、示例

示例一：GUI程序的弹窗显示

功能描述：显示一个对话框，提示文案为“确认删除XXX？”，两个选项：选择“是”进行删除，选择“否”则什么都不做。

我们把这段描述稍微整理一下得到：

显示一个弹窗
    标题：“确认删除XXX？”
    选择选项“是”：进行删除
    选择选项“否”：什么都不做

我们把这段描述直译为代码：

Dialog
    .withTitle("确认删除XXX？")
    .onYesSelected(() -> deleteXXX());
    .onNoSelected(() -> {/*do nothing*/})
    .show();

示例二：求解逻辑约束的方程

功能描述：方程x + y = z + 1，其中x的值为10，y的值为5，那么z的值是多少？

这段功能可以通过绑定约束的方式来实现，最终得到代码：

Binding<Integer> x = Bindings.symbol("x");
Binding<Integer> y = Bindings.symbol("y");
Binding<Integer> z = symbol("z");
equal(
        add(x, y),
        add(z, value(1)));
x.is(10);
y.is(5);
int zValue = z.get();

（完整实现将来再分享）

示例三：JSON数据构建

功能描述：构建以下json字符串

{
    "id": 1, 
    "name": "test name"
}

可以利用以前分享过的JsonBuilder构建工具来实现：

JsonBuilder.forObject()
        .with("id", 1)
        .with("name", "test name")
        .build();

三、总结

相信所有看到这里的朋友都意识到了，这种方法有很大的局限性：

1. 所用的语言需要有一定的表达能力，可以定制自己的控制流，甚至扩展语法、语义，定义DSL。
2. 功能需求本身是定义明确的，或者说描述比较具体的。
3. 开发者有较强的表达能力。

另外，通过严格的规范、良好且稳定的编程习惯，也可以达到这样的“记住”代码的效果。