第五章 Caché 定义和调用方法

第五章 定义和调用方法

方法介绍

方法是由类定义的可执行元素。Caché 支持两种类型的方法:实例方法和类方法。从类的特定实例调用实例方法，并通常执行与该实例相关的一些操作。类方法是无需引用任何对象实例即可调用的方法;这些在其他语言中称为静态方法。

方法通常指的是实例方法。更具体的类方法用于引用类方法。

因为没有对象的实例就不能执行实例方法，所以实例方法只有在对象类中定义时才有用。相反，可以在任何类中定义类方法。

定义方法

要将类方法添加到类中，请在类定义中添加如下元素:

ClassMethod MethodName(Arguments) as Classname [ Keywords]
{
//method implementation
}

• MethodName 是方法的名称,最长180个字符。
• Arguments 参数以逗号分割。
• Classname 是一个可选的类名，表示此方法返回的值的类型。如果方法不返回值，则省略As Classname部分。

类可以是数据类型类、对象类，或者(不太常见的)无类型类。类名可以是完整的类名，也可以是简短的类名。（如果用IMPORT 关键字可以使用简称）

• Keywords 代表关键字
• 方法的实现取决于实现语言和方法的类型;

要将实例方法添加到类中，请使用与方法相同的语法，而不是使用ClassMethod:

Method MethodName(arguments) as Classname [ Keywords]
{
 //method implementation
}

实例方法只与对象类相关。

指定方法参数:基础

方法可以接受任意数量的参数。方法定义必须指定它所接受的参数。还可以为每个参数指定类型和默认值。(在这个上下文中，type指的是任何类型的类，而不是特定的数据类型类。)

通用类方法定义:

ClassMethod MethodName(Arguments) as Classname [ Keywords]
{
 //method implementation
}

这里参数可以有以下形式

argname1 as type1 = value1, argname2 as type2 = value2, argname3 as type3 = value3, [and so on]

• argname1, argname2, argname3, and so on 是参数名，这些名称必须遵循变量名称的规则。
• type1, type2, type3, and so on 是类名 方法定义的这一部分旨在向可能使用此方法的程序员描述要传递什么类型的值作为相应的参数。通常，显式地指定每个方法参数的类型是一个好习惯。

通常，类型是数据类型类或对象类。

类名可以是完整的类名，也可以是简短的类名。（IMPORT关键字导入类可使用简名）

可以忽略这部分语法。如果你这样做了，也可以省略as部分。

• value1, value2, value3, and so on 是参数值，如果在没有为参数提供值的情况下调用方法，则该方法将自动将参数设置为该值。

每个值可以是一个字符串(“abc”或42)，也可以是一个用大括号括起来的Caché ObjectScript表达式。例如:

ClassMethod Test(flag As %Integer = 0)
{
 //method implementation
}

或

ClassMethod Test(time As %Integer = {$horolog} )
{
 //method implementation
}

可以忽略这部分语法。如果这样做了，也可以省略等号(=)。

例如，下面是一个带有三个参数的Calculate()方法:

ClassMethod Calculate(count As %Integer, name, state As %String = "CA")
{
 // ...
}

其中count和state分别声明为%Integer和%String。默认情况下，参数是%String数据类型，因此未指定类型的参数是%String。以上示例中的name就是这种情况。

如何传递参数

方法定义还表明，对于可能使用该方法的程序员，如何传递每个参数。参数可以通过值或引用传递(ref)

通过引用传递特定的参数可能明智，也可能不明智。细节取决于方法实现。因此，在定义方法时，应该使用方法签名向其他程序员表明如何使用每个参数。

要指示应通过引用传递参数，请在方法签名中参数名称之前包含ByRef修饰符。

下面的示例使用了ByRef的两个参数:

/// Swap value of two integers
Method Swap(ByRef x As %Integer, ByRef y As %Integer)
{
    Set temp = x
    Set x = y
    Set y = temp
}

类似地，为了指示参数应该通过引用传递，并且不希望传入值，在方法签名中在参数名之前包含Output修饰符。

例如:

Method CreateObject(Output newobj As MyApp.MyClass) As %Status
{
    Set newobj = ##class(MyApp.MyClass).%New()
    Quit $$$OK
}

可变数量的参数

可以定义一个接受可变数量参数的方法。为此，包括…在最后一个参数的名称之后，如下面的示例所示。这个例子还展示了如何使用这个特性。

ClassMethod MultiArg(Arg1... As %String)
{
 Write "Invocation has ",
     $GET(Arg1, 0),
     " element",
     $SELECT(($GET(Arg1, 0)=1):"", 1:"s"),
     !
 For i = 1 : 1 : $GET(Arg1, 0)
 {
     Write:($DATA(Arg1(i))>0) "Argument[", i , "]:", 
         ?15, $GET(Arg1(i), ""), !
 }
 Quit
}

下面的终端会话展示了这个方法的行为:

SAMPLES>do ##class(VarNumArg.Demo).MultiArg("scooby","shaggy","velma","daphne","fred")
Invocation has 5 elements
Argument[1]:   scooby
Argument[2]:   shaggy
Argument[3]:   velma
Argument[4]:   daphne
Argument[5]:   fred

注意：$GET(Arg1, 0) 如果为空，第二个参数是代表默认值

返回值

要定义一个方法以便它返回一个值，请在该方法中使用下列任一项(如果在Caché ObjectScript中实现该方法):

 Return returnvalue

或

 Quit returnvalue

其中returnvalue是方法返回的合适值。这应该与方法声明的返回类型一致。如果返回类型是数据类型类，则该方法应该返回一个文字值。如果返回类型是一个对象类，那么该方法应该返回该类的一个实例(特别是OREF)。

例如

ClassMethod Square(input As %Numeric) As %Numeric
{
    Set returnvalue = input * input
    Return returnvalue
}

返回对象

/// w ##class(PHA.OP.MOB.Test).FindPerson(2)
ClassMethod FindPerson(id As %String) As PHA.OP.MOB.Android
{
    Set person = ##class(User.DHCPHARWIN).%OpenId(id)
    Return person
}
DHC-APP>w ##class(PHA.OP.MOB.Test).FindPerson(2)
DHC-APP 2e1>w person
[email protected]
DHC-APP 2e1>zw person
person=