Clojure 宏：用疯狂的方式实现 UI 组件库的测试和文档

Clojure 宏一直是我最喜欢的功能之一，它可以让我们以非常直接、甚至是疯狂的方式操作代码。在 Clojure 中，宏有两种使用方式：一种是避免过度使用它们，专注于简单任务；另一种则是放开手脚，利用宏实现令人惊叹的效果。

最近，在开发 Humble UI 组件库的过程中，我遇到了一个有趣的挑战：如何同时记录代码、展示组件、并且进行集成测试？这种需求激发了我一个想法：如果我们能够直接在应用中展示组件的源代码，同时验证它是否能按预期运行，那会怎么样？

于是，我开始设计一个功能，它能够在 UI 中渲染出一个包含组件代码和其渲染效果的表格。为了让这个过程更透明，我想要确保展示的源代码与实际执行的代码完全一致——这不仅是为了展示代码，也是为了测试代码的有效性。

宏的实现

实现这个功能的方式其实很简单：通过 Clojure 的宏来解析代码并生成 UI。我们可以编写一个宏，接收一组组件示例，并生成一个 UI 表格，每一行显示左边是代码，右边是渲染的结果。这就是我实现的第一个宏：

 
 
 

  
  
  

   
   
   

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

   
   
   
   
   
   
(defmacro table [& examples]  (list 'ui/grid {:cols 2}    (for [[_ code] (partition 2 examples)]      (list 'list        code (pr-str code)))))
  
  
  
 
 
 

这个宏接受一个变长参数列表 examples，通过 partition 将其分为代码和展示内容两部分。然后，宏会构造一个 UI 表格，左侧是原始代码，右侧是经过 pr-str 格式化的源代码字符串。

宏和源代码的关系

在 Clojure 中，宏是通过操作 AST（抽象语法树）来转换代码的。简单来说，宏的作用是接受 Clojure 代码作为数据结构（AST），然后对它进行转换。生成的代码会通过再次求值来执行，因此宏本质上是一个代码生成工具。

这种方式是 Clojure 宏最常见的用法之一——它将输入代码转换为输出代码，但问题在于，这种转换常常会丢失代码的格式化信息。代码中原本的空格、缩进和换行符都会消失，生成的代码看起来是“无格式的”。

格式化代码的挑战

想要让宏输出的代码与原始代码在格式上保持一致，是一个挑战。由于宏操作的是已经解析过的 AST，而不是源代码本身，所有的空格和缩进都丢失了。为了恢复原有格式，我尝试使用了一些现有的格式化库，比如 clojure.pprint、zprint 和 cljfmt，但这些工具并没有完全满足我的需求。

问题出在一个细节上：有时代码中的某些向量不仅仅是数据结构，它们可能还代表 UI 组件的结构。如果我们不加以区分，就会丢失一些信息，导致格式化后的代码无法正确反映出组件的结构。

然后，我意识到，问题的关键在于格式——其实，最好的格式已经在源代码中存在。源文件中每个字符、每个缩进都精确表达了代码的层次和结构。于是，我开始思考是否可以通过读取源文件来解决这个问题。

读取源文件中的代码

如果我们能够读取源代码，直接从文件中获取相关的代码片段，便能将其原汁原味地展示出来。幸运的是，Clojure 中的 *file* 变量保存了当前文件的路径，而且通过 slurp 函数，我们可以方便地读取文件内容。

于是，我写了一个小函数 slurp-source，它能够从源文件中提取出与指定键（代码片段）相关的部分，并将其格式化后输出：

 
 
 

  
  
  

   
   
   

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

    
    
    

   
   
   
   
   
   
(defn slurp-source [file key]  (let [content      (slurp (io/resource file))        key-str      (pr-str key)        idx          (str/index-of content key)        content-tail (subs content (+ idx (count key-str)))        reader       (clojure.lang.LineNumberingPushbackReader.                       (java.io.StringReader.                         content-tail))        indent       (re-find #"\s+" content-tail)        [_ form-str] (read+string reader)]    (->> form-str      str/split-lines      (map #(if (str/starts-with? % indent)              (subs % (count indent))              %)))))
  
  
  
 
 
 

这个函数的逻辑大致如下：

1. 读取指定文件的内容；

2. 根据关键字 key 查找代码片段在文件中的位置；

3. 提取该位置之后的内容；

4. 使用 LineNumberingPushbackReader 读取代码形式（保留原始缩进）；

5. 格式化代码，将缩进去除后返回。

最终，slurp-source 函数能够在运行时获取代码源并按原样格式化输出。

警告与反思

尽管这种方法在 Clojure 中显得非常简便且有效，但它并不是一种推荐的做法。直接从文件中读取源代码、动态拼接代码字符串，显然是非常脆弱的做法。它依赖于文件路径、文件内容、代码格式等多个方面，这些都可能在不同的环境下发生变化，导致代码不可预测的行为。

然而，这种“疯狂”的方式也展示了 Clojure 的独特魅力。在 Clojure 中，很多看似复杂的任务可以通过简单的语言特性、极少的依赖和几行代码轻松实现。这种灵活性和简洁性，正是 Clojure 作为编程语言的最大亮点之一。

总结

Clojure 宏不仅仅是一种代码转换工具，它还是探索和创新的实验场。在开发过程中，我通过宏实现了代码的自展示和自测试，这一过程虽然充满了非标准和不推荐的做法，但也体现了 Clojure 强大的表达能力和灵活性。

通过这次尝试，我更深刻地体会到，Clojure 是一种非常“自由”的语言，它允许开发者通过宏、元编程等技术，以非常大胆和创造性的方式，解决各种看似不可能的难题。尽管这种方式可能有些“疯狂”，但正是这些不拘一格的尝试，使得 Clojure 成为我最喜欢的编程语言之一。

希望通过这个例子，能够激发你对 Clojure 更深的兴趣，去探索那些看似疯狂但充满可能性的编程方式。