在生成实例期间如何强制检查插槽的类型?

时间:2018-08-07 10:00:03

标签: common-lisp clos

假设我有以下类声明:

(defclass foo-class ()
  ((bar :initarg :bar
        :type list)))

当我创建此类的实例时,make-instance将不会检查传递的参数是否满足插槽类型。因此,我可以这样创建“无效”对象:

> (make-instance 'foo-class :bar 'some-symb)
#<FOO-CLASS {102BEC5E83}>

但是,我希望看到的行为类似于创建结构实例的行为,在该实例中检查类型:

(defstruct foo-struct
  (bar nil :type list))

> (make-foo-struct :bar 'some-symb)
;; raises contition:
;;
;; The value
;; SOME-SYMB
;; is not of type
;; LIST
;; when setting slot BAR of structure FOO-STRUCT

有什么办法可以做到这一点?

2 个答案:

答案 0 :(得分:12)

对于结构和CLOS实例,是否都不确定是否检查插槽类型

许多实现将对结构执行此操作-但不是全部。

很少有实现可用于CLOS实例-例如Clozure CL实际上做到了。

SBCL还可以检查CLOS插槽类型-安全性很高时:

* (declaim (optimize safety))

NIL
* (progn
(defclass foo-class ()
  ((bar :initarg :bar
        :type list)))
(make-instance 'foo-class :bar 'some-symb))

debugger invoked on a TYPE-ERROR: The value SOME-SYMB is not of type LIST.

Type HELP for debugger help, or (SB-EXT:EXIT) to exit from SBCL.

restarts (invokable by number or by possibly-abbreviated name):
  0: [ABORT] Exit debugger, returning to top level.

((SB-PCL::SLOT-TYPECHECK LIST) SOME-SYMB)
0] 

否则怎么办?

这是一个高级主题,可能需要一些CLOS元对象协议黑客。两种变体:

  • 为SHARED-INITALIZE定义一种检查init参数的方法。

  • 为您的类定义一个元类,并在SET-SLOT-VALUE-USING-CLASS上定义一个方法。但是然后您需要确保您的实现确实提供并使用SET-SLOT-VALUE-USING-CLASS。这是通用功能,是MOP的一部分。有些实现提供了它,但是有些仅在需要时才使用它(否则设置插槽可能会降低速度)。

对于后者,这是自建的 SBCL 版本,用于检查写入插槽的类型:

首先是元类:

; first a metaclass for classes which checks slot writes
(defclass checked-class (standard-class)
  ())

; this is a MOP method, probably use CLOSER-MOP for a portable version
(defmethod sb-mop:validate-superclass
           ((class checked-class)
            (superclass standard-class))
   t)

现在,我们检查该元类的所有插槽写入:

; this is a MOP method, probably use CLOSER-MOP for a portable version    
(defmethod (setf sb-mop:slot-value-using-class) :before
              (new-value (class checked-class) object slot)
  (assert (typep new-value (sb-mop:slot-definition-type slot))
      ()
    "new value ~a is not of type ~a in object ~a slot ~a"
    new-value (sb-mop:slot-definition-type slot) object slot))

我们的示例类使用该元类:

(defclass foo-class ()
  ((bar :initarg :bar :type list))
  (:metaclass checked-class))

使用它:

* (make-instance 'foo-class :bar 42)

debugger invoked on a SIMPLE-ERROR in thread
#<THREAD "main thread" RUNNING {10005605B3}>:
  new value 42 is not of type LIST
  in object #<FOO-CLASS {1004883143}>
  slot #<STANDARD-EFFECTIVE-SLOT-DEFINITION COMMON-LISP-USER::BAR>

Type HELP for debugger help, or (SB-EXT:EXIT) to exit from SBCL.

restarts (invokable by number or by possibly-abbreviated name):
  0: [CONTINUE] Retry assertion.
  1: [ABORT   ] Exit debugger, returning to top level.

答案 1 :(得分:0)

sanity-clause库昨天刚刚为此合并了一个功能。

  

Sanity子句是数据验证/合同库。您可以将其用于配置数据,验证api响应或数据存储中的文档。在动态类型的语言中,它可以帮助您定义明确定义的疑问和不确定性区域。我们应该爱我们的用户,但我们永远不要盲目地信任他们的输入。

     

要使用它,您可以定义模式,该模式可以是带有:class:sanity-clause.field:field

的键和实例的符号的属性列表。

所以:

(defclass person ()
     ((favorite-dog :type symbol
                    :field-type :member
                    :members (:wedge :walter)
                    :initarg :favorite-dog
                    :required t)
      (age :type (integer 0)
           :initarg :age
           :required t)
      (potato :type string
              :initarg :potato
              :required t))
     (:metaclass sanity-clause.metaclass:validated-metaclass))

;; bad dog:
(make-instance 'person :favorite-dog :nope)
; Evaluation aborted on Error converting value for field #<MEMBER-FIELD {1004BFA973}>: 
Value "NOPE" couldn't be found in set (WEDGE WALTER)

;; bad age:
(make-instance 'person :age -1 :favorite-dog :walter)
; Evaluation aborted on Error validating value -1 in field #<INTEGER-FIELD {1004BFF103}>:
* Value -1 didn't satisfy condition "must be larger than 0"

;; missing potato:
(make-instance 'person :age 7 :favorite-dog :walter)
; Evaluation aborted on A value for field POTATO is required but none was provided..

;; all OK:
(make-instance 'person :age 1 :favorite-dog :walter :potato "patate")
#<PERSON {10060371E3}>