CLOS 是 “Common Lisp Object System” 的缩写,是所有语言中最强大的对象系统之一。

有以下的特性:

  • 动态(dynamic),在 Lisp 的 REPL(即解释器)中写起来很舒服。比如说,当一个类的定义改变了,之前类所创建的对象也会随之更新,这样操作对象也更直观明了;
  • 多派生(multiple) 以及 多继承(multiple inheritance)
  • 内省(introspection)
  • 元对象接口(meta-object protocol),提供 CLOS 标准接口,可以用来创建一个新的对象系统。

CLOS 最初是在 1984 年 Steele 的 “Common Lisp, the Language” 第一版中出现,十年后被正式定义为 ANSI 标准。

本章旨在讲解 CLOS 的使用,但只是简单的介绍了下 MOP。

想要深入了解的话,推荐下面两本书:

当然,也可以参见下面的链接。

类和实例

首先,用个完整的例子来讲解下类的定义,对象的创建,属性的访问,方法的构造以及继承关系。

  1. (defclass person ()
  2. ((name
  3. :initarg :name
  4. :accessor name)
  5. (lisper
  6. :initform nil
  7. :accessor lisper)))
  8. ;; => #<STANDARD-CLASS PERSON>
  9. (defvar p1 (make-instance 'person :name "me" ))
  10. ;; ^^^^ initarg
  11. ;; => #<PERSON {1006234593}>
  12. (name p1)
  13. ;;^^^ accessor
  14. ;; => "me"
  15. (lisper p1)
  16. ;; => nil
  17. ;; ^^ initform (slot unbound by default)
  18. (setf (lisper p1) t)
  19. (defclass child (person)
  20. ())
  21. (defclass child (person)
  22. ((can-walk-p
  23. :accessor can-walk-p
  24. :initform t)))
  25. ;; #<STANDARD-CLASS CHILD>
  26. (can-walk-p (make-instance 'child))
  27. ;; T

定义类 (defclass)

defclass 是个宏,在 CLOS 中定义新的数据类型。

  1. (defclass person ()
  2. ((name
  3. :initarg :name
  4. :accessor name)
  5. (lisper
  6. :initform nil
  7. :accessor lisper)))

以上代码创建了一个 person 类,有两个属性:namelisper.

  1. (class-of p1)
  2. #<STANDARD-CLASS PERSON>
  3. (type-of p1)
  4. PERSON

以下是 defclass 的标准格式:

  1. (defclass <class-name> (list of super classes)
  2. ((slot-1
  3. :slot-option slot-argument)
  4. (slot-2, etc))
  5. (:optional-class-option
  6. :another-optional-class-option))

上面的 person 类没有继承自其他的类(父类的名字会定义在类名字后面的括号中)。当然,person 默认是继承自 t 类和 standard-object,以为在 CLOS 中,所以的类都继承自这两个类。下面的继承的章节会提到。

可以定义一个简单的无属性的 point

  1. (defclass point ()
  2. (x y z))

或者再简单点,连属性名都不写:(defclass point () ())

创建对象 (make-instance)

创建对象是要使用 make-instance 类:

  1. (defvar p1 (make-instance 'person :name "me" ))

一般来说,最好是在创建个构造函数:

  1. (defun make-person (name &key lisper)
  2. (make-instance 'person :name name :lisper lisper))

有了构造函数,就可以更好的控制一些特定的参数,同时在使用包时,就可以不用去看类的创建,直接调用构造函数就好。

属性 (Slots)

slot-value

slot-value 可以通过 (slot-value <object> <slot-name>) 的格式随时访问对象的属性,

回到定义的 point 类上,这个类没有定义属性的访问接口。

  1. (defvar pt (make-instance 'point))
  2. (inspect pt)
  3. The object is a STANDARD-OBJECT of type POINT.
  4. 0. X: "unbound"
  5. 1. Y: "unbound"
  6. 2. Z: "unbound"

以上虽然创建了一个 POINT 对象,但是其属性都没有绑定默认值,访问其属性时就会报 UNBOUND-SLOT 异常:

  1. (slot-value pt 'x) ;; => condition: the slot is unbound

slot-value 可以使用 setf 来进行设置:

  1. (setf (slot-value pt 'x) 1)
  2. (slot-value pt 'x) ;; => 1

初始化、默认值 (initarg, initform)

  • :initarg :foo:使用 make-instance 创建是通过属性名(slots)来给属性赋值的,其中后面的 :foo 就属性名。
  1. (make-instance 'person :name "me")

在次强调,属性默认是不会绑定属性名(slots)的。

  • :initform <val>:当没有定义其属性名(initarg)时,:initform 后面的值就是该属性的默认值。在 defclass 的词法作用域中,在需要时,这个表达式就会运行。

一个可以清楚的知道需要给属性赋值的技巧:

  1. (defclass foo ()
  2. ((a
  3. :initarg :a
  4. :initform (error "you didn't supply an initial value for slot a"))))
  5. ;; #<STANDARD-CLASS FOO>
  6. (make-instance 'foo) ;; => enters the debugger.

Getters and setters (accessor, reader, writer)

  • :accessor foo:既是 getter 也是 setter:accessor 后面接的参数将会成为 通用函数.
  1. (name p1) ;; => "me"
  2. (type-of #'name)
  3. STANDARD-GENERIC-FUNCTION
  • :reader and :writer:这才是你想要的,只有 :writer 可以使用 setf 进行赋值.

如果不使用以上这些的话, slot-value 也同样可以修改属性的值.

同一属性可以有多个 :accessor:reader:initarg.

下面将介绍两个宏,这两个宏在输出类的属性值时会很方便:

1- with-slots,可以同时访问多个属性值,第一个参数是个包含了属性名的列表,第二个参数是个对象实例,之后的是由 progn 所包含的一些语句,或者说是其主体部分,在主体的词法作用域中,调用第一个参数列表中的变量类似于使用 slot-value 去访问实例的属性值。

  1. (with-slots (name lisper)
  2. c1
  3. (format t "got ~a, ~a~&" name lisper))
  1. (with-slots ((n name)
  2. (l lisper))
  3. c1
  4. (format t "got ~a, ~a~&" n l))

2- with-accessors:于 with-slots 类似,只不过第一个参数是访问属性的函数(accessor functions)

  1. (with-accessors ((name name)
  2. ^^variable ^^accessor
  3. (lisper lisper))
  4. p1
  5. (format t "name: ~a, lisper: ~a" name lisper))

类 VS 实例属性

:allocation:定义属性是 本地的 还是 共享的,也就是所谓的私有属性和公有属性。

  • 属性默认是私有的,就是说每个实例的属性值都不同。这种情况下,:allocation 等价于 :instance
  • 公有属性可以被该类的所有值访问,且保持一致,定义方法为::allocation :class

下面是个公有属性的例子:

  1. (defclass person ()
  2. ((name :initarg :name :accessor name)
  3. (species
  4. :initform 'homo-sapiens
  5. :accessor species
  6. :allocation :class)))
  7. ;; Note that the slot "lisper" was removed in existing instances.
  8. (inspect p1)
  9. ;; The object is a STANDARD-OBJECT of type PERSON.
  10. ;; 0. NAME: "me"
  11. ;; 1. SPECIES: HOMO-SAPIENS
  12. ;; > q
  13. (defvar p2 (make-instance 'person))
  14. (species p1)
  15. (species p2)
  16. ;; HOMO-SAPIENS
  17. (setf (species p2) 'homo-numericus)
  18. ;; HOMO-NUMERICUS
  19. (species p1)
  20. ;; HOMO-NUMERICUS
  21. (species (make-instance 'person))
  22. ;; HOMO-NUMERICUS
  23. (let ((temp (make-instance 'person)))
  24. (setf (species temp) 'homo-lisper))
  25. ;; HOMO-LISPER
  26. (species (make-instance 'person))
  27. ;; HOMO-LISPER

属性文档

每个属性都有个 :documentation 的参数

属性的类型

属性类型使用 :type 来定义。如果是第一次接触 CLOS,建议你跳过这节,然后自己去构造类型检查的类。

事实上,属性的类型会不会检查并没有定义出来。详见 Hyperspec.

只有少部分解释器会对类的属性类型进行检查。其中由 Clozure CL,SBCL 是在2019年11月时发行的 1.5.9 版本才开始支持,或者是进行了高安全性的设置((declaim (optimise safety))

想要使用别的方法的话,参考 this Stack-Overflow answerquid-pro-quo

find-class, class-name, class-of

  1. (find-class 'point)
  2. ;; #<STANDARD-CLASS POINT 275B78DC>
  3. (class-name (find-class 'point))
  4. ;; POINT
  5. (class-of my-point)
  6. ;; #<STANDARD-CLASS POINT 275B78DC>
  7. (typep my-point (class-of my-point))
  8. ;; T

CLOS 中的类也是 CLOS 类的一个实例,如下面代码所示:

  1. (class-of (class-of my-point))
  2. ;; #<STANDARD-CLASS STANDARD-CLASS 20306534>

注: 这是第一次介绍 MOP,不必进行深究

对象 my-pointpoint 类的一个实例,而 point 类又是 standard-class 的一个实例。因此,我们将 standard-class 称为 my-point元类(metaclass) (即类的类,有点绕😂)。之后会讲到如何使用元类。

子类和继承

在上面的例子中,childperson 的子类。

所有的对象都继承自 standard-objectt 这两个类。

所有 child 的实例同时也是 person 的实例。

  1. (type-of c1)
  2. ;; CHILD
  3. (subtypep (type-of c1) 'person)
  4. ;; T
  5. (ql:quickload "closer-mop")
  6. ;; ...
  7. (closer-mop:subclassp (class-of c1) 'person)
  8. ;; T

closer-mop 库用来做 CLOS/MOP 的一些操作很湿方便。

子类会继承父类所有的属性,同时也能重写父类的属性。

以下是 child 的继承关系:

  1. child <- person <-- standard-object <- t

所以可以得到如下的结果:

  1. (closer-mop:class-precedence-list (class-of c1))
  2. ;; (#<standard-class child>
  3. ;; #<standard-class person>
  4. ;; #<standard-class standard-object>
  5. ;; #<sb-pcl::slot-class sb-pcl::slot-object>
  6. ;; #<sb-pcl:system-class t>)

但是,child 的直接父类只能是 person

  1. (closer-mop:class-direct-superclasses (class-of c1))
  2. ;; (#<standard-class person>)

可以调用 class-direct-[subclasses, slots, default-initargs] 和其他的函数来对类进行一些确认。

以下是属性继承的规则:

  • :accessor:reader:继承,同时会被组合起来。
  • :initarg:同 :accessor:reader
  • :initform: 最详细的,就是说,和 class-precedence-list 一样。
  • :allocation:不继承,默认与 :instance 一致。

最后一点,在使用继承时要注意点,因为继承确实很容易被误用,而多继承有将难度以倍数增加。所以,写的时候注意点,确定是否是确实需要继承。建议是当属性相同时,可以使用继承,但是属性不同时,最好还是不要使用继承。

多继承

CLOS 同时也支持多继承。

  1. (defclass baby (child person)
  2. ())

父类列表中第一个类要是最底层的那个类,而后一次递推,且这些类都是提前定义好了的。

重定义或修改类

本节将讲解以下两点:

  • 类的重定义
  • 将实例指向其他的类

类的重定义只需使用 defclass 定义成新的就好了,而且只需要编译以下重定义的类,之前该类的实例都会进行相对应的更新,这点就很酷吧。

比如说,将 person 类重定义:

  1. (defclass person ()
  2. ((name
  3. :initarg :name
  4. :accessor name)
  5. (lisper
  6. :initform nil
  7. :accessor lisper)))
  8. (setf p1 (make-instance 'person :name "me" ))

修改、添加、删除等都可以这样操作:

  1. (lisper p1)
  2. ;; NIL
  3. (defclass person ()
  4. ((name
  5. :initarg :name
  6. :accessor name)
  7. (lisper
  8. :initform t ;; <-- from nil to t
  9. :accessor lisper)))
  10. (lisper p1)
  11. ;; NIL (of course!)
  12. (lisper (make-instance 'person :name "You"))
  13. ;; T
  14. (defclass person ()
  15. ((name
  16. :initarg :name
  17. :accessor name)
  18. (lisper
  19. :initform nil
  20. :accessor lisper)
  21. (age
  22. :initarg :arg
  23. :initform 18
  24. :accessor age)))
  25. (age p1)
  26. ;; => slot unbound error. This is different from "slot missing":
  27. (slot-value p1 'bwarf)
  28. ;; => "the slot bwarf is missing from the object #<person…>"
  29. (setf (age p1) 30)
  30. (age p1) ;; => 30
  31. (defclass person ()
  32. ((name
  33. :initarg :name
  34. :accessor name)))
  35. (slot-value p1 'lisper) ;; => slot lisper is missing.
  36. (lisper p1) ;; => there is no applicable method for the generic function lisper when called with arguments #(lisper).

change-class 用来修改一个实例的类:

  1. (change-class p1 'child)
  2. ;; we can also set slots of the new class:
  3. (change-class p1 'child :can-walk-p nil)
  4. (class-of p1)
  5. ;; #<STANDARD-CLASS CHILD>
  6. (can-walk-p p1)
  7. ;; T

上面例子中,p1person 变成了 child,同时也继承了 can-walk-p 的默认属性。

美化输出

每次创建对象时,总会得到个类似下面的输出:

  1. #<PERSON {1006234593}>

没有任何意义。

如果想要看到更多的信息该怎么办呢?比如说想看到如下的格式:

  1. #<PERSON me lisper: t>

可以通过定制这个类的通用方法 print-object 就可以美化输出了:

  1. (defmethod print-object ((obj person) stream)
  2. (print-unreadable-object (obj stream :type t)
  3. (with-accessors ((name name)
  4. (lisper lisper))
  5. obj
  6. (format stream "~a, lisper: ~a" name lisper))))

这将会得到以下输出:

  1. p1
  2. ;; #<PERSON me, lisper: T>

print-unreadable-object 将打印 #<...>,表明不能访问该对象内部。对象的 :type t 参数会要求打印对象类型的前缀,也就是说 PERSON。如果没有函数的话,就会得到#<me, lisper: T>

当让,对于简单的类来说,使用 with-accessors 宏就足够了。

  1. (defmethod print-object ((obj person) stream)
  2. (print-unreadable-object (obj stream :type t)
  3. (format stream "~a, lisper: ~a" (name obj) (lisper obj))))

注:访问未绑定默认值的属性时,会报错。可以用 slot-boundp 先进行确认。

参考下面的代码,这个是默认的输出。

  1. (defmethod print-object ((obj person) stream)
  2. (print-unreadable-object (obj stream :type t :identity t)))

这里, :identity 设为 t 时会打印 {1006234593} 的地址。

普通类型的类

也有方法可以不用 CLOS 来创建对象。

通常来说,上一小节中提到的函数也适用于非 CLOS 实例对象。

  1. (find-class 'symbol)
  2. ;; #<BUILT-IN-CLASS SYMBOL>
  3. (class-name *)
  4. ;; SYMBOL
  5. (eq ** (class-of 'symbol))
  6. ;; T
  7. (class-of ***)
  8. ;; #<STANDARD-CLASS BUILT-IN-CLASS>

从上面代码可以看出,symbol 就是系统类的实例。这只是对应语言中 75 种类型相对应的的类的其中一个类。许多系统类都与 CLOS 本身相关。然而,以下 33 中类型还是传统的 lisp 类型;

|array|hash-table|readtable|
|bit-vector|integer|real|
|broadcast-stream|list|sequence|
|character|logical-pathname|stream|
|complex|null|string|
|concatenated-stream|number|string-stream|
|cons|package|symbol|
|echo-stream|pathname|synonym-stream|
|file-stream|random-state|t|
|float|ratio|two-way-stream|
|function|rational|vector|

注意,以上表格并不包含所有的传统 lisp 类型(比如说:atomfixnumshort-float

t 这个类型就比较有趣了。因为每个 lisp 对象的类型都是 t,同时每个 lisp 对象也是 t 类的子类。这个个同时属于多个类的简单示例,存在 继承 相关问题,这个问题将在将在后面详细讨论。

  1. (find-class t)
  2. ;; #<BUILT-IN-CLASS T 20305AEC>

除了与 lisp 类型对应的类之外,定义的每个结构类型都有一个 CLOS 类:

  1. (defstruct foo)
  2. FOO
  3. (class-of (make-foo))
  4. ;; #<STRUCTURE-CLASS FOO 21DE8714>

structure-object 的元类是 structure-class
无论传统 lisp 对象的元类是 standard-classstructure-class 还是 built-in-class,都依赖于实现。
以下是其使用限制:

|built-in-class| May not use make-instance, may not use slot-value, may not use defclass to modify, may not create subclasses.|
|structure-class| May not use make-instance, might work with slot-value (implementation-dependent). Use defstruct to subclass application structure types. Consequences of modifying an existing structure-class are undefined: full recompilation may be necessary.|
|standard-class|None of these restrictions.|

自省(Introspection)

我们已经见过一些自省的函数了。

最好是去查看 closer-mop 库,同时也经常去看看 CLOS & MOP specifications

更多自省的函数:

  1. closer-mop:class-default-initargs
  2. closer-mop:class-direct-default-initargs
  3. closer-mop:class-direct-slots
  4. closer-mop:class-direct-subclasses
  5. closer-mop:class-direct-superclasses
  6. closer-mop:class-precedence-list
  7. closer-mop:class-slots
  8. closer-mop:classp
  9. closer-mop:extract-lambda-list
  10. closer-mop:extract-specializer-names
  11. closer-mop:generic-function-argument-precedence-order
  12. closer-mop:generic-function-declarations
  13. closer-mop:generic-function-lambda-list
  14. closer-mop:generic-function-method-class
  15. closer-mop:generic-function-method-combination
  16. closer-mop:generic-function-methods
  17. closer-mop:generic-function-name
  18. closer-mop:method-combination
  19. closer-mop:method-function
  20. closer-mop:method-generic-function
  21. closer-mop:method-lambda-list
  22. closer-mop:method-specializers
  23. closer-mop:slot-definition
  24. closer-mop:slot-definition-allocation
  25. closer-mop:slot-definition-initargs
  26. closer-mop:slot-definition-initform
  27. closer-mop:slot-definition-initfunction
  28. closer-mop:slot-definition-location
  29. closer-mop:slot-definition-name
  30. closer-mop:slot-definition-readers
  31. closer-mop:slot-definition-type
  32. closer-mop:slot-definition-writers
  33. closer-mop:specializer-direct-generic-functions
  34. closer-mop:specializer-direct-methods
  35. closer-mop:standard-accessor-method

更多

defclass/std: 编写短类

defclass/std 库提供了一个比 defclass 格式更简短的宏。

默认情况下,会自动添加 accessor,initarg 并将 iniform 设为 nil
By default, it adds an accessor, an initarg and an initform to nil to your slots definition:

  1. (defclass/std example ()
  2. ((slot1 slot2 slot3)))

实际展开就是这样的:

  1. (defclass example ()
  2. ((slot1
  3. :accessor slot1
  4. :initarg :slot1
  5. :initform nil)
  6. (slot2
  7. :accessor slot2
  8. :initarg :slot2
  9. :initform nil)
  10. (slot3
  11. :accessor slot3
  12. :initarg :slot3
  13. :initform nil)))

这个库能做的有很多,也很灵活,但是 Common Lisp 社区几乎不怎么使用:自行承担风险©。

方法

在次回忆下最开始定义的 personchild 类:

  1. (defclass person ()
  2. ((name
  3. :initarg :name
  4. :accessor name)))
  5. ;; => #<STANDARD-CLASS PERSON>
  6. (defclass child (person)
  7. ())
  8. ;; #<STANDARD-CLASS CHILD>
  9. (setf p1 (make-instance 'person :name "me"))
  10. (setf c1 (make-instance 'child :name "Alice"))

下面,我们将创建方法,定制方法,并组合使用方法(before,after,around)和使用限定词。

  1. (defmethod greet (obj)
  2. (format t "Are you a person ? You are a ~a.~&" (type-of obj)))
  3. ;; style-warning: Implicitly creating new generic function common-lisp-user::greet.
  4. ;; #<STANDARD-METHOD GREET (t) {1008EE4603}>
  5. (greet :anything)
  6. ;; Are you a person ? You are a KEYWORD.
  7. ;; NIL
  8. (greet p1)
  9. ;; Are you a person ? You are a PERSON.
  10. (defgeneric greet (obj)
  11. (:documentation "say hello"))
  12. ;; STYLE-WARNING: redefining COMMON-LISP-USER::GREET in DEFGENERIC
  13. ;; #<STANDARD-GENERIC-FUNCTION GREET (2)>
  14. (defmethod greet ((obj person))
  15. (format t "Hello ~a !~&" (name obj)))
  16. ;; #<STANDARD-METHOD GREET (PERSON) {1007C26743}>
  17. (greet p1) ;; => "Hello me !"
  18. (greet c1) ;; => "Hello Alice !"
  19. (defmethod greet ((obj child))
  20. (format t "ur so cute~&"))
  21. ;; #<STANDARD-METHOD GREET (CHILD) {1008F3C1C3}>
  22. (greet p1) ;; => "Hello me !"
  23. (greet c1) ;; => "ur so cute"
  24. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  25. ;;; Method combination: before, after, around.
  26. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  27. (defmethod greet :before ((obj person))
  28. (format t "-- before person~&"))
  29. #<STANDARD-METHOD GREET :BEFORE (PERSON) {100C94A013}>
  30. (greet p1)
  31. ;; -- before person
  32. ;; Hello me
  33. (defmethod greet :before ((obj child))
  34. (format t "-- before child~&"))
  35. ;; #<STANDARD-METHOD GREET :BEFORE (CHILD) {100AD32A43}>
  36. (greet c1)
  37. ;; -- before child
  38. ;; -- before person
  39. ;; ur so cute
  40. (defmethod greet :after ((obj person))
  41. (format t "-- after person~&"))
  42. ;; #<STANDARD-METHOD GREET :AFTER (PERSON) {100CA2E1A3}>
  43. (greet p1)
  44. ;; -- before person
  45. ;; Hello me
  46. ;; -- after person
  47. (defmethod greet :after ((obj child))
  48. (format t "-- after child~&"))
  49. ;; #<STANDARD-METHOD GREET :AFTER (CHILD) {10075B71F3}>
  50. (greet c1)
  51. ;; -- before child
  52. ;; -- before person
  53. ;; ur so cute
  54. ;; -- after person
  55. ;; -- after child
  56. (defmethod greet :around ((obj child))
  57. (format t "Hello my dear~&"))
  58. ;; #<STANDARD-METHOD GREET :AROUND (CHILD) {10076658E3}>
  59. (greet c1) ;; Hello my dear
  60. ;; call-next-method
  61. (defmethod greet :around ((obj child))
  62. (format t "Hello my dear~&")
  63. (when (next-method-p)
  64. (call-next-method)))
  65. ;; #<standard-method greet :around (child) {100AF76863}>
  66. (greet c1)
  67. ;; Hello my dear
  68. ;; -- before child
  69. ;; -- before person
  70. ;; ur so cute
  71. ;; -- after person
  72. ;; -- after child
  73. ;;;;;;;;;;;;;;;;;
  74. ;; Adding in &key
  75. ;;;;;;;;;;;;;;;;;
  76. ;; In order to add "&key" to our generic method, we need to remove its definition first.
  77. (fmakunbound 'greet) ;; with Slime: C-c C-u (slime-undefine-function)
  78. (defmethod greet ((obj person) &key talkative)
  79. (format t "Hello ~a~&" (name obj))
  80. (when talkative
  81. (format t "blah")))
  82. (defgeneric greet (obj &key &allow-other-keys)
  83. (:documentation "say hi"))
  84. (defmethod greet (obj &key &allow-other-keys)
  85. (format t "Are you a person ? You are a ~a.~&" (type-of obj)))
  86. (defmethod greet ((obj person) &key talkative &allow-other-keys)
  87. (format t "Hello ~a !~&" (name obj))
  88. (when talkative
  89. (format t "blah")))
  90. (greet p1 :talkative t) ;; ok
  91. (greet p1 :foo t) ;; still ok
  92. ;;;;;;;;;;;;;;;;;;;;;;;
  93. (defgeneric greet (obj)
  94. (:documentation "say hello")
  95. (:method (obj)
  96. (format t "Are you a person ? You are a ~a~&." (type-of obj)))
  97. (:method ((obj person))
  98. (format t "Hello ~a !~&" (name obj)))
  99. (:method ((obj child))
  100. (format t "ur so cute~&")))
  101. ;;;;;;;;;;;;;;;;
  102. ;;; Specializers
  103. ;;;;;;;;;;;;;;;;
  104. (defgeneric feed (obj meal-type)
  105. (:method (obj meal-type)
  106. (declare (ignorable meal-type))
  107. (format t "eating~&")))
  108. (defmethod feed (obj (meal-type (eql :dessert)))
  109. (declare (ignorable meal-type))
  110. (format t "mmh, dessert !~&"))
  111. (feed c1 :dessert)
  112. ;; mmh, dessert !
  113. (defmethod feed ((obj child) (meal-type (eql :soup)))
  114. (declare (ignorable meal-type))
  115. (format t "bwark~&"))
  116. (feed p1 :soup)
  117. ;; eating
  118. (feed c1 :soup)
  119. ;; bwark

泛型函数 (defgeneric, defmethod)

泛型函数 是一个 lisp 函数,它与一组方法相关联,并在调用时分派它们。所有具有相同函数名的方法都属于相同的泛型函数。

defmethod 的格式类似于 defun。将代码体与函数名相关联,但是只有当参数的类型与 lambda 列表声明的模式相匹配时,才会执行该代码体。

参数类型有可选参数、关键字和 &rest 参数。

defgeneric 定义了泛型函数。当写了一个 defmethod 而没有相应的 defgeneric,一个泛型函数就会自动创建(参见例子)。

通常,编写 defgeneric 是个好主意。可以添加默认的实现,甚至一些文档。

  1. (defgeneric greet (obj)
  2. (:documentation "says hi")
  3. (:method (obj)
  4. (format t "Hi")))

方法中的 lambda 列表中需要的参数有以下三种形式:

1- 简单的变量:

  1. (defmethod greet (foo)
  2. ...)

上面这种方法能接受任何参数,且总能适用。

变量 foo 通常绑定到相应的参数值。

2- 变量和特殊类型,如下:

  1. (defmethod greet ((foo person))
  2. ...)

在本例中,只有当变量 foo 是 特殊类型的类 person 或其子类,比如 child(实际上,child 也是 person)时,才会绑定到相应的参数。

如果任何参数不能匹配其特殊类型,那么该方法就不适用,并且不能用那些参数执行。将得到一个错误消息,如 “当使用参数yyy调用泛型函数xxx时,没有适用的方法”。

只有必需的参数可以指定。不能指定可选的 &key 参数。

3- 变量和eql specializer

  1. (defmethod feed ((obj child) (meal-type (eql :soup)))
  2. (declare (ignorable meal-type))
  3. (format t "bwark~&"))
  4. (feed c1 :soup)
  5. ;; "bwark"

eql specializer 可以是任何lisp形式,而不是简单的符号(:soup)。它与 defmethod 同一时间执行。

只要 lambda 列表的形式与泛型函数的形式全等,就可以使用相同的函数名,但使用不同的 specializer 来定义任意数量的方法。系统会选择最具体的适用方法并执行其主体。最具体的方法是其 specializer 最接近参数的 class-precedence-list 的头部的方法(lambda列表左侧的类更具体)。specializers 的方法更适合没有 specializer 的方法。

注意事项:

  • 定义与普通函数同名的方法会报错。真的想这样做的话,使用阴影机制(shadow mechanism)。
  • 要向现有泛型方法的 lambda 列表添加或删除 keysrest 参数,可以用 fmakunbound (或 C-c C-u(slime -undefine-function) 将光标放在 Slime 中的函数上删除声明,然后重新开始)。否则,你会看到:
  1. attempt to add the method
  2. #<STANDARD-METHOD NIL (#<STANDARD-CLASS CHILD>) {1009504233}>
  3. to the generic function
  4. #<STANDARD-GENERIC-FUNCTION GREET (2)>;
  5. but the method and generic function differ in whether they accept
  6. &REST or &KEY arguments.
  • 方法可以重定义(和普通函数一样).
  • 定义方法的顺序无关紧要,但是是它们的 specializer 类必须已经定义了。
  • 非专门化参数或多或少相当于专门化类 t。唯一的区别是所有的专门化参数都被隐式地认为是“被引用的”(在声明忽略的意义上)。
  • 每个 defmethod 会生成(并返回)一个 CLOS 中 standard-method 的实例。
  • eql 专门化器不能像处理字符串那样工作。实际上,字符串是通过 equalequalp 进行比较。但是,我们可以将字符串赋值给一个变量,并在 eql specializer和函数调用中使用该变量。
  • 所有相同函数名的方法都属于相同的泛型函数。
  • 所有 defclass 中定义的 accessor 和 reader 都是方法。它们可以重写或被相同泛型函数上的其他方法重写。

更多参见 defmethod on the CLHS.

多态

多态显式明确的制定了多个泛型函数所需的参数。

这些参数不属于特定的类。这意味着,我们不必像在其他语言中那样,必须决定调用这个方法的最佳类。

  1. (defgeneric hug (a b)
  2. (:documentation "Hug between two persons."))
  3. ;; #<STANDARD-GENERIC-FUNCTION HUG (0)>
  4. (defmethod hug ((a person) (b person))
  5. :person-person-hug)
  6. (defmethod hug ((a person) (b child))
  7. :person-child-hug)

更多参见 Practical Common Lisp.

控制 setters (setf-ing methods)

在 Lisp 中,可以定义函数或方法的 setf 副本。也许你想要让在如何更新对象上有更多的控制。

  1. (defmethod (setf name) (new-val (obj person))
  2. (if (equalp new-val "james bond")
  3. (format t "Dude that's not possible.~&")
  4. (setf (slot-value obj 'name) new-val)))
  5. (setf (name p1) "james bond") ;; -> no rename

如果你了解 Python的话,这种操作与 @property 装饰器一样。

调度机制和下个方法

当调用泛型函数时,应用程序不能直接调用方法。调度机制的过程如下:

  1. 计算适用方法的列表
  2. 如果没有方法可用,则抛出异常
  3. 将适用的方法按特异性排序
  4. 调用最特定的方法

greet 泛型函数有三个可以方法:

  1. (closer-mop:generic-function-methods #'greet)
  2. (#<STANDARD-METHOD GREET (CHILD) {10098406A3}>
  3. #<STANDARD-METHOD GREET (PERSON) {1009008EC3}>
  4. #<STANDARD-METHOD GREET (T) {1008E6EBB3}>)

在方法的执行过程中,仍然可以通过本地函数 call-next-method 访问其他可用的方法。此函数在方法体中具有词法范围,但范围不确定。调用下一个最 specific 的方法,并返回该方法返回的任何值。call-next-method 可以用以下两种方式调用:

  • 无参数,下个方法 也将接收与该方法相同的参数,或是
  • 显式参数,在这种情况下,要求适用于新参数的排序顺序集必须与第一次调用泛型函数的参数顺序相同。

例如:

  1. (defmethod greet ((obj child))
  2. (format t "ur so cute~&")
  3. (when (next-method-p)
  4. (call-next-method)))
  5. ;; STYLE-WARNING: REDEFINING GREET (#<STANDARD-CLASS CHILD>) in DEFMETHOD
  6. ;; #<STANDARD-METHOD GREET (child) {1003D3DB43}>
  7. (greet c1)
  8. ;; ur so cute
  9. ;; Hello Alice !

当没有下一个方法时调用 call-next-method 会抛出异常。可以通过调用本地函数 next-method-p (有词法作用域和不确定范围)来确定下一个方法是否存在。

最后注意,每个方法的主体都建立了一个与方法的泛型函数同名的块。如果 return-from 这个函数名,则退出当前方法,而不是对所包含的泛型函数的调用。

方法修饰符(before, after, around)

在本章序的例子中,已经知道了 :before:after:around 修饰符的用法:

  • (defmethod foo :before (obj) (...))
  • (defmethod foo :after (obj) (...))
  • (defmethod foo :around (obj) (...))

默认情况下,在 CLOS 提供的标准方法组合框架中,只能使用这三个限定符中的一个,控制流程如下:

  • 调用before-method 会在主方法调用前。如果有很多 before-method,那么就调用所有的。从最后一个子类开始,然后是其父类,父类的父类(child before person)。
  • 调用最底层的使用的 primary method ,只调用一个方法。
  • 调用所有适用的 after-methods 。 调用方法按继承顺序,显示子类,然后是父类,父类的父类……

泛型函数返回主方法的值。前置方法和后置方法返回值都会忽略。其返回值只是在对应的范围内有用。

然后是 around-methods。这就是刚才描述的核心机制的包装器。对于捕获返回值或围绕主方法设置环境(设置捕获、锁、执行计时……)非常有用。

如果分派机制找到 around 方法,它将调用该方法并返回其结果。如果 around 方法有 call-next-method,它就会调用下一个最适用的around-方法。只有当我们到达主方法时,我们才开始调用前置和后置方法。

因此,泛型函数的完整调度机制如下所示:

  1. 统计可用的方法,根据其修饰符分别放置在不同的列表中
  2. 没有找到主方法是将会抛出异常
  3. 将每个方法列表按继承关系排序
  4. 执行最底层的 :around 方法并返回该方法的返回值
  5. :around 方法调用 call-next-method,执行次底层 :around 方法;
  6. 如果不存在 :around 方法,或是 :around 方法调用 call-next-method 时没有下一个 :around 方法时,将按照以下的顺序执行:
    a. 按照继承顺序依次调用所有的 :before 方法,直到没有 call-next-methodnext-method-p
    b. 执行最底层的主方法;
    c. 当主方法有 call-next-method,按照继承顺序依次调用;
    d. 当主方法调用 call-next-method,但是没有下一个主方法时,抛出异常;
    e. 执行完主方法后,按照继承顺序依次调用所有的 :after 方法,直到没有 call-next-methodnext-method-p

将这个流程看作一个洋葱,所有的 :around 方法在最外层,:before:after 方法在中间层,主方法在内部。

其他方法组合

刚才看到的默认方法组合类型叫 standard,但也可以使用其他组合方法,不用用多说,你可以定义自己的方法组合类型。

内建的类型有:

  1. progn + list nconc and max or append min

注意到这些类型是以 lisp 操作符命名的。实际上,它们所做的是定义一个框架,该框架将适用的主要方法组合在对该名称的 lisp 操作符的调用中。例如,使用 progn 组合类型相当于逐个调用所有的主要方法:

  1. (progn
  2. (method-1 args)
  3. (method-2 args)
  4. (method-3 args))

这里,与标准机制不同,调用所有适用于给定对象的主要方法时,首先调用最详细的方法。

为了改变组合类型,设置了 defgeneric:method-combination 选项,并将其用作方法的限定符:

  1. (defgeneric foo (obj)
  2. (:method-combination progn))
  3. (defmethod foo progn ((obj obj))
  4. (...))

以下是 progn 的例子:

  1. (defgeneric dishes (obj)
  2. (:method-combination progn)
  3. (:method progn (obj)
  4. (format t "- clean and dry.~&"))
  5. (:method progn ((obj person))
  6. (format t "- bring a person's dishes~&"))
  7. (:method progn ((obj child))
  8. (format t "- bring the baby dishes~&")))
  9. ;; #<STANDARD-GENERIC-FUNCTION DISHES (3)>
  10. (dishes c1)
  11. ;; - bring the baby dishes
  12. ;; - bring a person's dishes
  13. ;; - clean and dry.
  14. (greet c1)
  15. ;; ur so cute --> only the most applicable method was called.

类似地,使用 list 类型相当于返回方法值的列表。

  1. (list
  2. (method-1 args)
  3. (method-2 args)
  4. (method-3 args))
  1. (defgeneric tidy (obj)
  2. (:method-combination list)
  3. (:method list (obj)
  4. :foo)
  5. (:method list ((obj person))
  6. :books)
  7. (:method list ((obj child))
  8. :toys))
  9. ;; #<STANDARD-GENERIC-FUNCTION TIDY (3)>
  10. (tidy c1)
  11. ;; (:toys :books :foo)

Around 方法 是可以使用的:

  1. (defmethod tidy :around (obj)
  2. (let ((res (call-next-method)))
  3. (format t "I'm going to clean up ~a~&" res)
  4. (when (> (length res)
  5. 1)
  6. (format t "that's too much !~&"))))
  7. (tidy c1)
  8. ;; I'm going to clean up (toys book foo)
  9. ;; that's too much !

注意,这些操作符不支持 beforeafteraround 方法(实际上,它们已经没有空间了)。它们确实支持 around 方法,其中也可以调用 call-next-method ,但是不支持在主方法中调用 call-next-method(这确实是多余的,因为所有的主方法都被调用了,却笨拙地调用一个主方法)。

CLOS 允许将新的操作符定义为方法组合类型,无论是 lisp 函数、宏还是特殊形式。需要是可以查询文中所提到的一些书籍链接。

Debugging: 跟踪方法组合

可以跟踪方法组合,但这取决于实现。

在 SBCL 中,可以使用 (trace foo :methods t)。详情参见 this post by an SBCL core developer.

下面是个通用的例子:

  1. (defgeneric foo (x)
  2. (:method (x) 3))
  3. (defmethod foo :around ((x fixnum))
  4. (1+ (call-next-method)))
  5. (defmethod foo ((x integer))
  6. (* 2 (call-next-method)))
  7. (defmethod foo ((x float))
  8. (* 3 (call-next-method)))
  9. (defmethod foo :before ((x single-float))
  10. 'single)
  11. (defmethod foo :after ((x double-float))
  12. 'double)

追踪以下:

  1. (trace foo :methods t)
  2. (foo 2.0d0)
  3. 0: (FOO 2.0d0)
  4. 1: ((SB-PCL::COMBINED-METHOD FOO) 2.0d0)
  5. 2: ((METHOD FOO (FLOAT)) 2.0d0)
  6. 3: ((METHOD FOO (T)) 2.0d0)
  7. 3: (METHOD FOO (T)) returned 3
  8. 2: (METHOD FOO (FLOAT)) returned 9
  9. 2: ((METHOD FOO :AFTER (DOUBLE-FLOAT)) 2.0d0)
  10. 2: (METHOD FOO :AFTER (DOUBLE-FLOAT)) returned DOUBLE
  11. 1: (SB-PCL::COMBINED-METHOD FOO) returned 9
  12. 0: FOO returned 9
  13. 9

MOP

这里收集了一些使用元对象协议提供的框架的例子,这个可配置的对象系统决定了 Lisp 对象系统。本节涉及到了高级概念,所以,刚开始学习的话,不要担心:你必理解本节内容就可以使用 Common Lisp 对象系统。

这里不会过多地讲解 MOP,但希望能够充分展示看到它的可能性,或者帮助理解一些CL库是如何构建的。感兴趣的话可以看看介绍中提到的书。

元类

元类是用来控制其他类的一些行为操作的。

As announced, we won’t talk much. See also Wikipedia for metaclasses or CLOS.

标准的元类是 standard-class:

  1. (class-of p1) ;; #<STANDARD-CLASS PERSON>

但可以将 standard-class 修改成自己的元类。这样就可以 计算实例创建的个数 了。同样的机制可以运用在数据库的主键的自动增加上,用来记录创建对象等。

该元类继承自 standard-class:

  1. (defclass counted-class (standard-class)
  2. ((counter :initform 0)))
  3. #<STANDARD-CLASS COUNTED-CLASS>
  4. (unintern 'person)
  5. ;; this is necessary to change the metaclass of person.
  6. ;; or (setf (find-class 'person) nil)
  7. ;; https://stackoverflow.com/questions/38811931/how-to-change-classs-metaclass#38812140
  8. (defclass person ()
  9. ((name
  10. :initarg :name
  11. :accessor name))
  12. (:metaclass counted-class)) ;; <- metaclass
  13. ;; #<COUNTED-CLASS PERSON>
  14. ;; ^^^ not standard-class anymore.

:metaclass 选项只能出现一次。

事实上,应该得到一个实现 validate-superclass 的消息。同样的,调用 closer-mop 库:

  1. (defmethod closer-mop:validate-superclass ((class counted-class)
  2. (superclass standard-class))
  3. t)

现在就可以控制创建 person 类的实例了。

  1. (defmethod make-instance :after ((class counted-class) &key)
  2. (incf (slot-value class 'counter)))
  3. ;; #<STANDARD-METHOD MAKE-INSTANCE :AFTER (COUNTED-CLASS) {1007718473}>

:after 关键词是个很好的选择,这样可以让标注的方法正常运行,然后返回一个新的实例

&key 是必须的, 注意,这个是用来接收 make-instanceinitargs 的.

现在再试试看:

  1. (defvar p3 (make-instance 'person :name "adam"))
  2. #<PERSON {1007A8F5B3}>
  3. (slot-value p3 'counter)
  4. ;; => error. No, our new slot isn't on the person class.
  5. (slot-value (find-class 'person) 'counter)
  6. ;; 1
  7. (make-instance 'person :name "eve")
  8. ;; #<PERSON {1007AD5773}>
  9. (slot-value (find-class 'person) 'counter)
  10. ;; 2

这样就正常了。

控制实例的初始值 (initialize-instance)

为了进一步控制创建对象实例,可以制定一些 initialize-instance 方法。该方法会在 实例创建后但还没有对其进行初始化时被make-instance 所调用,

Keene 建议创建 after 方法,因为创建主方法将阻止属性初始化。

  1. (defmethod initialize-instance :after ((obj person) &key) ;; note &key
  2. (do something with obj))

下面的例子可以对初始值进行验证。该代码会确保 personname 长度不少于 3 个字符。

  1. (defmethod initialize-instance :after ((obj person) &key)
  2. (with-slots (name) obj
  3. (assert (>= (length name) 3))))

所以,以下的代码运行会出错:

  1. (make-instance 'person :name "me" )
  2. ;; The assertion (>= #1=(LENGTH NAME) 3) failed with #1# = 2.
  3. ;; [Condition of type SIMPLE-ERROR]

因此,可以给 debugger 加个 “name” 的特性:

  1. (defmethod INITIALIZE-INSTANCE :after ((obj person) &key)
  2. (with-slots (name) obj
  3. (assert (>= (length name) 3)
  4. (name) ;; creates a restart that offers to change "name"
  5. "The value of name is ~a. It should be longer than 3 characters." name)))

上面的代码将会得到以下的输出:

  1. The value of name is me. It should be longer than 3 characters.
  2. [Condition of type SIMPLE-ERROR]
  3. Restarts:
  4. 0: [CONTINUE] Retry assertion with new value for NAME. <--- new restart
  5. 1: [RETRY] Retry SLIME REPL evaluation request.
  6. 2: [*ABORT] Return to SLIME's top level.

另一个比较合理的是, CLOS 中 make-instance 实现的两个阶段:申请新的对象,然后将这个对象和参数传给通用函数 initialize-instance。解释器和程序员通过定义 initialize-instance:after 方法,来对实例的属性值进行初始化。系统提供的主要方法会将 (a) :initform:initarg 定义的值 和 (b) 通过 makt-instance 的关键词传递进来的参数绑定在一起。可以使用其他的方法来进行拓展。比如说,可以通过访问数据库对特定的属性进行填充。 initialize-instance 的 lambda 列表为:

  1. initialize-instance instance &rest initargs &key &allow-other-keys

更多的相关的知识,去看看本章推荐的书吧 !