在Lua中,在很多场景下table就是一个object。与objects类似,table也有相关的状态;table也有一个独立于其值(table中的元素)的标识符(self);特别是,两个具有相同值(table中的所有元素都相等)的table是不同的对象。此外,与objects类似,table也有一个独立的生命周期。

Object通常都有它们自己的操作,tables也可以有自己的操作行为,看如下代码片段:

Account = {balance = 0}

function Account.withDraw(v)
  Account.balance = Account.balance - v 
  
end   

在上面的定义中,创建了一个新的函数,并将其保存在Account对象的withDraw字段中,然后我们可以通过如下的方式来调用:

Account.withDraw(100.00)

这种类型的函数也就是我们所说的method。然而,在我们的编程实践中,我们会发现在函数内部使用一个全局变量其实是一件十分可怕的事情。首先,这样会使得函数只能用于某一个特定的对象;其次,即使针对该特定对象,函数也只能对保存在该特定全局变量的对象工作正常。假如我们更改了object的名称,withDraw可能就不能正常的工作了:

a, Account = Account, nil
a.withdraw(100.00) -- ERROR!

这样的行为表现就破坏了面向对象的基本准则:object拥有读了的生命周期

一种更符合标准的方法就是为相关的操作提供一个receiver,为此我们可以在对应的method中添加一个额外的参数用于存储receiver。该额外的参数通常会命名为self或者this:

function Account.withdraw (self, v)
  self.balance = self.balance - v
end

现在,我们就可以指定需要在哪个object上执行对应的操作:

a1 = Account; Account = nil
...
a1.withdraw(a1, 100.00) -- OK

通过使用self参数,我们就可以对不同的对象使用相同的method:

a2 = {balance=0, withdraw = Account.withdraw}
...
a2.withdraw(a2, 260.00)

在任何面向对象的编程语言当中,self参数都是一个中心要点。对于大多数的OO语言,都有相应的机制来为编程人员隐藏此参数。Lua也可以通过使用:操作符来隐藏此参数。下面我们来重写前面的withDraw()方法:

function Account:withdraw (v)
   self.balance = self.balance - v
end

之后,我们就可以使用a2:withDraw(260.00)来调用了。

通过使用冒号操作符(:),自动的在函数定义中添加了一个隐藏的参数,同时在调用的时候也是会自动的加上此参数。但是值得指出的是,这里:操作符仅仅只是一个语法糖,并没有引入新的东西。我们可以使用.这种方式来定义method,然后通过:这种方式来调用,或者相反。例如:

Account = { balance=0,
  withdraw = function (self, v)
    self.balance = self.balance - v
  end
}
function Account:deposit (v)
  self.balance = self.balance + v
end

Account.deposit(Account, 200.00)
Account:withdraw(100.00)

1. Classes

到目前为止,我们的objects已经有了identity、state以及对应state下的operations。但现在仍然缺乏如下概念:

  • class system

  • inheritance

  • privacy

现在我们来处理第一个问题:如何创建多个具有相似行为的object?特别是,我们如何创建多个Account呢?

大多数面向对象的编程语言都提供了class的概念,其作为创建object的模板。在这些编程语言中,每一个object都是一个特定class的实例。在Lua语言中,并没有class的概念;metatable的概念与此有几分类似,但是如果将metadata作为class也并不能使得我们可以走的太远,毕竟metadata只是类似,还有很多的机制是不支持的。相反,在Lua中,我们可以参考prototype-based language(比如Self, Javascript也是遵循此路线来实现的面向对象编程)来默认class。在这些语言中,objects(这里称为A)并没有classes,相反每一个object都有一个prototype,prototype本身其实也是一个object(这里称为B):当A对某些operation不能识别的时候,其就会到prototype这个对象中来查找。在这样一些语言当中,为了表示class,我们会简单的创建一个object来作为其他对象的prototype。因此,从这个意义上来说,可以认为classes和prototypes都可以作为存放多个objects公共行为的场所。

在Lua中,我们可以使用继承的思想来实现prototypes,其实我们在上一章The __index metamethod一章中就已经介绍过。特别是,假如我们有两个object,分别为A和B,我们需要做的就是将B设置为A的一个prototype:

setmetatable(A, {__index = B})

这样设置之后,当A中没有相关的operations时,其就会自动的在B中进行查找。这样只是从另一个角度将B看成了A对象的class。

现在我们回到上面关于银行账户的例子。为了创建与Account具有相似行为的其他账户,通过使用__index元方法,我们安排这些新创建的对象都继承自Account:

Account = { balance=0}

function Account:withDraw(v)
  self.balance = self.balance - v
end
  
function Account:deposit (v)
  self.balance = self.balance + v
end



local mt = {__index = Account}

function Account.new (o)
  o = o or {} -- create table if user does not provide one
  setmetatable(o, mt)
  return o
end

编写完上述代码之后,当我们采用如下的方式来创建一个account时会发生什么呢?

a = Account.new{balance = 0}
a:deposit(100.00)

当我们创建一个银行账户a,其就由一个mt来作为其metatable。因此,当我们调用a:diposit(100.00)函数时,其实实际会调用a.diposit(a, 100.00);这里冒号(:)仅仅只是一个语法糖。然而,Lua并不能在table a中找到diposit,因此就会查询到metatable中的__index,实际的调用过程就类似于如下:

Account.deposit(a, 100.00)

即,Lua会调用metatable中的deposit()函数,并向其传递一个self参数。因此,新的银行账户就从Account中继承了deposit()方法。通过相同的机制,它也从Account中继承了所有的fields。

在这里,我们可以有两个小的改进。第一个改进就是我们并不需要为metatable角色单独创建一个table,相反我们可以使用Account表本身来实现此目的;第二个改进就是我们可以对new()函数本身也使用冒号(:)语法:

function Account:new (o)
  o = o or {}
  self.__index = self
  setmetatable(o, self)
  return o
end

现在,当我们调用Account:new()时,隐藏参数self的值就是Account,并且我们将Account.__index设置为了其本身,且将Account设置为了新创建对象的object的metatable。到这里,我们发现似乎并没有从这种更改(冒号语法)中获得太大的收益,但其实不然,其中的优势就在于当我们介绍类继承的时候,self就会变得非常有用(我们会在下一节讲解)。

类的继承不仅仅在于method,同样在新的银行账户对象中也会继承其他的字段。因此,class不仅可以提供methods,也可以为实例提供常量和默认值。请记住,在我们定义Account第一版代码中,我们为balance设置了0。因此,假如我们创建一个新的对象,在其中我们并没有给balance赋初始值的话,那么其将会继承自Account:

b = Account:new()
print(b.balance) --> 0

当我们在object b上调用diposit()函数,其就等价于运行如下代码:

b.balance = b.balance + v

首先会评估b.balance的值为0,然后赋值函数会给b.balance设置一个新的初始值。后面再通过b.balance来获取账户余额时,将不会再调用到__index metamethod,因为现在object b已经有了其自己的balance字段了。

下面给出两个很容易混淆的示例,以进一步加深对其中微妙关系的理解:

  • 示例1
Account = { balance=0 }

local mt = {__index = Account}

function Account.new (o)
  o = o or {} -- create table if user does not provide one
  setmetatable(o, mt)
  return o
end

function Account:withDraw(v)
    self.balance = self.balance - v
end
  
function Account:deposit (v)
  self.balance = self.balance + v
end

a = Account:new()
b = Account:new()

a:deposit(100.00)
print(a.balance)

b:deposit(200.00)
print(a.balance)
print(b.balance)

编译运行:

100.0
300.0
300.0
  • 示例2
Account = { balance=0 }

local mt = {__index = Account}

function Account:new (o)
  o = o or {} -- create table if user does not provide one
  
  self.__index = self 
  setmetatable(o, mt)
  return o
end

function Account:withDraw(v)
    self.balance = self.balance - v
end
  
function Account:deposit (v)
  self.balance = self.balance + v
end

a = Account:new()
b = Account:new()

a:deposit(100.00)
print(a.balance)

b:deposit(200.00)
print(a.balance)
print(b.balance)

编译运行:

100.0
100.0
200.0
  • 示例3
Account = { balance=0 }

function Account:new (o)
  o = o or {} -- create table if user does not provide one
  self.__index = self
  setmetatable(o, self)
  return o
end

function Account:withDraw(v)
    self.balance = self.balance - v
end
  
function Account:deposit (v)
  self.balance = self.balance + v
end

a = Account:new()
b = Account:new()

a:deposit(100.00)
print(a.balance)

b:deposit(200.00)
print(a.balance)
print(b.balance)

编译运行:

100.0
100.0
200.0

2. Inheritance

由于classes也是objects,他们也可以从其他的class那里获取methods,这样一个关系使得在Lua中实现继承的语义变得十分简单。

现在我们假设有一个base-class Account,如下:

Account = {balance = 0}

function Account:new (o)
  o = o or {}
  self.__index = self
  setmetatable(o, self)
  return o
end

function Account:deposit (v)
  self.balance = self.balance + v
end

function Account:withdraw (v)
  if v > self.balance then
    error"insufficient funds"
  end
  
  self.balance = self.balance - v
end

从上面的基类中,我们想要派生出一个子类: SpecialAccount,该类账户允许用户提取超过其越的资金。我们首先创建一个empty class来从基类中继承相关的方法:

SpecialAccount = Account:new()

到这里,SpecialAccount仅仅只是Account的一个实例。微妙之处就发生在这里:

s = SpecialAccount:new{limit=1000.00}

SpecialAccount从Account那里继承了new()方法,然而此时当new()函数被执行时,通过self这个隐含的参数传递的就是SpecialAccount了,因此s的metatable就变为SpecialAccount了。之后,当我们调用s:deposit(100.00)时,Lua在s中找不到deposit字段,因此其就会向上查找到SpecialAccount,在SpecialAccount中也找不到deposit字段,因此会再向上查找到Account中,然后在那里找到了deposit()的原始实现。

接下来在SpecialAccount中,我们可以实现对父类方法的重写:

function SpecialAccount:withdraw (v)
  if v - self.balance >= self:getLimit() then
    error"insufficient funds"
  end
  self.balance = self.balance - v
end


function SpecialAccount:getLimit ()
  return self.limit or 0
end

现在我们调用s:withdraw(200.00),Lua就不会再找入到Account中了,因为其会在SpecialAccount中叨叨withdraw字段。由于s.limit设置的透支余额为1000,因此当调用withdraw()方法时会返回一个负数余额。

在Lua中,object有趣的一个方面在于我们并不需要创建新的class来添加新的行为。假如只有某一个对象需要特定行为的话,我们可以直接在该对象中实现对应行为。例如,假设账户s代表某一个特定客户,其limit总是为其账户余额的10%,那么我们就可以单独修改此账户:

function s:getLimit ()
  return self.balance * 0.10
end

这样修改完成之后,当我们调用s:withdraw(200.00)时,其会调用的SpecialAccount:withdraw()方法,然后当调用到self:getLimit()时就会调用到我们这里定义的s:getLimit()。

3. Multiple Inheritance

在Lua中,由于object并不是基础原语,我们可以有多种方式来实现面向对象编程。正如我们上面所介绍的,我们可以使用metamethod的index来实现(这也可能是最简单、高效和灵活的是现房方式)。无论如何,也还有一些其他的实现方式,并且在某一些特定的场景可能会更适合。这里我们会看到另外一种实现方式,并且其可以实现多继承。

本实现方式的关键核心要点在于使用__index这一metamethod。记住,当一个table的metatable中含有__index字段时,Lua如果在其原表中不能找到所请求的字段,那么就会调用__index字段所保存的函数。__index函数就可以在其想要的parent中找缺失的key。

多继承意味着一个class拥有不止一个superclass,因此我们不应该使用父类方法来创建子类(subclasses)。相反,我们会定义专门的独立方法createClass来实现此目的,createClass()的参数有创建新class所需要的全部父类。参看如下Figure 21.2示例,该函数会创建一个table来表示新的类,然后通过__index来实现多继承。不管多继承如何实现,每一个object实例仍然只属于一个class对象,然后会从该class处找到所有的方法。因此,class、superclass之间的关系 与 instance、class之间的关系是不同的。 特别是,类不能同时是其instance及子类的metatable。在如下的例子中,我们将class设置为instance的metatable,但是会创建一个新的table来作为class的metatable.

Figure 21.2 An implementation of multiple inheritance

--[[

   look up for 'k' in list of tables 'plist'
   
--]]


local function search (k, plist)
  for i = 1, #plist do
    local v = plist[i][k] -- try 'i'-th superclass
    if v then 
      return v 
    end
  end
  
end


function createClass (...)
  local c = {} -- new class
  local parents = {...} -- list of parents

  -- class searches for absent methods in its list of parents
  setmetatable(c, 
    {
      __index = function (t, k)
        return search(k, parents)
      end
    })
  
  
  -- prepare 'c' to be the metatable of its instances
  c.__index = c
  
  -- define a new constructor for this new class
  function c:new (o)
    o = o or {}
    setmetatable(o, c)
    return o
  end
  
  return c -- return new class
  
end

如下我们通过简单的例子来演示一下createClass()的使用。假设我们其中的一个父类为Account;另一个父类为Named,其有两个方法: setname()与getname(),如下:

Named = {}
function Named:getname ()
  return self.name
end

function Named:setname (n)
  self.name = n
end

这里我们要创建一个新的类NamedAccount,其父类为Account和Named,我们可以简单的调用createClass()方法:

NamedAccount = createClass(Account, Named)

然后我们再创建一个实例:

account = NamedAccount:new{name = "Paul"}
print(account:getname()) --> Paul

现在我们来看一下account::getname()的执行过程,其实说的更明确一点就是account[“getname”]的执行过程。Lua在account这个table中不能直接找到getname字段,因此就会查找对应metatable的__index,在我们例子中account的metatable就是NamedAccount。在NamedAccount中也找不到getname字段,因此就会再往上一级查找NamedAccount的metatable的__index。此时__index字段的值为一个函数,因此就调用该函数。在search()函数中会分别在Account和Named两个基类中进行查找,当查找到一个非空的值,就返回。

当然,由于底层查找的复杂性,多继承的性能会比单继承低。提高性能的一个简单的方法就是直接拷贝所继承的方法到子类中。使用该技术,类的index metamethod的实现方式如下:

setmetatable(c, {
  __index = function (t, k) 
    local v = search(k, parents)
    t[k] = v -- save for next access
    return v
  end
})

使用此技巧,除了第一次访问继承方法外,后续再访问就会像访问local method一样快。而这样做的缺点就在于,当程序已经运行之后,我们再改变基类的方法时,其并不能马上扩散到子类。

4. Privacy

作为一个完整的面向对象的编程语言,很多人都会考虑privacy(也被称为information hiding: object的状态应该是其内部的事情。在有一些面向对象的编程语言中,比如C++、Java,我们可以控制一个成员变量、或成员函数的可见性;而另一种流行的面向对象编程语言smalltalk,则是所有的成员变量都是私有的,而成员函数都是公有的;而作为第一个实现面向对象的Simula语言,其并没有提供任何保护机制。

在前面的章节我们看到,在Lua中object的标准实现并没有提供privacy机制。部分原因是我们使用通用的数据结构table来表示objects,而更为重要的原因是Lua为了避免冗余及一些人为的限制。假如你不想访问object中的某一些字段,那么just do not do it。根据过往的实践,我们通常将不想暴露的私有成员以_开头来命名。

无论如何,Lua的另一个目标就是灵活性,其提供了meta-mechanisms来给开发人员以模仿许多不同的机制。尽管Lua对object的基本设计并没有提供privacy机制,但是我们可以用另一种方式来实现object,从而达到对访问的控制。尽管开发人员并不会经常使用此机制来实现,但是我们也可以了解一下,不仅仅因为其会涉及到Lua的一些有趣的方面,还因为其是对某一类特定问题的很好的解决方案。

这种设计的基本思路在于通过两个table来表示一个object: 其中一个table用于存储状态,另一个table用于存储operations。我们通过第二个table来访问对象本身,即通过object所暴露的接口来操作。为了避免非授权访问,用于保存object状态的table并不会保存为另一个table的field,相反其仅作为对应实现函数的闭包(closure)。例如,采用本设计思路来表示银行账户,我们可以通过如下的工厂方法(factory function)来创建对象:

function newAccount (initialBalance)
  local self = {balance = initialBalance}
  
  local withdraw = function (v)
    self.balance = self.balance - v
  end
  
  local deposit = function (v)
    self.balance = self.balance + v
  end
  
  local getBalance = function ()
    return self.balance
  end
  
  return {
    withdraw = withdraw,
    deposit = deposit,
    getBalance = getBalance
  }
  
end

在上面的newAccount()函数中首先创建了一个table来保存object的状态,将状态保存在局部变量self中。然后又在函数中为object创建了对应的方法。最后通过一个table将object所拥有的方法导出并返回。这里的关键点在于这些方法并没有将self作为额外的参数,相反它们可以直接访问self。由于并没有额外的参数,我们并不需要使用冒号(:)语法来操作这种object,我们可以直接像普通函数那样来调用:

acc1 = newAccount(100.00)
acc1.withdraw(40.00)
print(acc1.getBalance()) --> 60

这种设计方式使得存储在self这个table中所有字段都是私有的。在newAccount()函数返回之后,将再没有方法直接访问到该table。我们只能够通过newAccount()中所设置的函数来访问。尽管在我们的例子中我们只在私有成员中放置了一个实例变量,但其实我们可以将所有需要保存的私有成员都放入该table。此外,我们也可以定义private方法: 它们类似于public方法,只是并不会将其放入到导出列表。例如,我们的银行账户可能会给一些达到一定资产的用户10%的信用额度,但是我们并不想用户直接访问到相关的详细信息。我们可以通过如下的方式来实现此功能:

function newAccount (initialBalance)
  local self = {
    balance = initialBalance,
    LIM = 10000.00,
  }
  
  local extra = function ()
    if self.balance > self.LIM then
      return self.balance*0.10
    else
      return 0
    end
  end
  
  local getBalance = function ()
    return self.balance + extra()
  end
  
  as before

这样,用户也不能够直接访问到extra()函数。

4. The Single-Method Approach

面向对象编程中有一个特殊的场景就是object只有一个method。在这种场景下,我们并不需要创建一个interface table,我们只需要返回该唯一方法作为object的表示。这听起来有点怪异,但是记住很多iterators的实现都是采用此方式,比如io.lines、string.gmatch。iterator直接在内部保持相关状态,这通过一个single-method object就可以做到。

single-method object的另一个有趣的场景就是: single-method仅仅作为一个dispatch method,其根据参数来处理不同的任务。典型的实现如下:

function newObject (value)
  return function (action, v)
    if action == "get" then return value
	elseif action == "set" then value = v
	else error("invalid action")
	end
  end
end

此时,我们可以直接使用:

d = newObject(0)
print(d("get")) --> 0
d("set", 10)
print(d("get")) --> 10

这种不同寻常的实现方式其实十分高效。上面的d("set", 10)语法,尽管看起来有点怪异,但仅仅只比我们通常所使用的d:set(10)长两个字符。在上面的实现中,每一个object都单独使用一个闭包(closure),这通常比使用一个table更轻量、廉价。并没有继承,但我们实现了全private控制: 访问object的唯一方式就是通过该函数。

5. Dual Representation

另一种实现privacy的有趣的方法是使用dual representation。下面我们来看看dual representation的实现。

通常我们会使用key的方式来为table关联属性,例如:

table[key] = value

然而,我们可以使用dula representation: 将对象本身作为另一个table的key。例如:

key = {}
...
key[table] = value

这里的关键点在于,在Lua中不仅可以使用numbers、strings来索引table,也可以使用任何值(包括tables)。

以我们上面的银行账户的实现为例,我们会将所有账户的余额信息都存入一个表balance中,而不是将它们保存在账户表中。按此设计,withdraw()方法可以改写成如下:

function Account.withdraw (self, v)
balance[self] = balance[self] - v
end

通过这样,我们实现了privacy。即使有一个函数需要访问账户,它都不能直接访问其余额信息,除非该函数也有访问balance表的权限。假如表balance保存为Account模块的一个local变量,那么就只会有模块内的函数可以访问balance,因此我们就只能通过这些函数来操作balance。

在我们进一步讲解之前,这里我必须指出此种实现方式存在的一个很大的缺陷。一旦我们使用account作为key来索引balance表,那么该account对象将不会被GC回收。对应的account对象将会一直存在,直到在代码中显式的将此账户移除。这对于银行账户场景来说通常不会存在很大的问题(账户被销毁通常都需要显示的关闭账户),但是对于其他场景则会是一个严重的问题。在后面Object Attributes一节中,我们将会介绍如何解决该问题。此处,我们可以暂时忽略该问题。

下面的代码展示了如何通过dual representation来实现银行账户:

--[[

  Accounts using a dual representation

--]]

local balance = {}
Account = {}

function Account:withdraw (v)
  balance[self] = balance[self] - v
end

function Account:deposit (v)
  balance[self] = balance[self] + v
end

function Account:balance ()
  return balance[self]
end

function Account:new (o)
  o = o or {} -- create table if user does not provide one
  setmetatable(o, self)
  self.__index = self
  balance[o] = 0 -- initial balance
  return o
end

之后我们就可以像往常一样使用该类:

a = Account:new{}
a:deposit(100.00)
print(a:balance())

然而,我们并不能够直接干预一个账户的余额信息。通过将balance表设置为对应module的private变量,这样就确保了成员变量的安全性。

实现继承也并不需要做任何修改。本实现方式的代价与标准实现方式类似(在内存与耗时方面均相似)。在新建对象的时候,会创建一个新的table,并在私有成员变量balance中添加一个新的entry。对balance[self]的访问会比self.balance略慢,主要是因为后者是一个局部变量,而前者使用的是一个外部变量。通常情况下这一点的不同是忽略不计的。在稍后我们会看到,在进行GC的时候我们也需要做一些额外的操作。



参看:

  1. 面向对象(Object-Oriented)编程