Классы

В предыдущем упражнении для культур понадобились две таблицы: cropMethods с методами и метатаблица {__index = cropMethods}, новая для каждой культуры. Программисты на Lua обычно поручают обе работы одной таблице: она хранит методы, служит метатаблицей для каждой культуры, а её __index указывает на неё саму. Такая таблица называется классом:

local Crop = {}
Crop.__index = Crop

function Crop.new(name, days)
    local crop = {name = name, days = days, age = 0}
    setmetatable(crop, Crop)
    return crop
end

function Crop:grow()
    self.age = self.age + 1
end

function Crop:isReady()
    return self.age >= self.days
end

local wheat = Crop.new("Пшеница", 2)
local carrot = Crop.new("Морковь", 3)
wheat:grow()
wheat:grow()
carrot:grow()
print(wheat.name, wheat:isReady())
print(carrot.name, carrot:isReady())

Он выводит:

Пшеница	true
Морковь	false

Строка за строкой:

• local Crop = {} создаёт класс — обычную таблицу. Названия классов начинаются с заглавной буквы: Crop — класс, а wheat и carrot — культуры.
• Crop.__index = Crop — главный трюк. Crop станет метатаблицей каждой культуры, а её __index — это сам Crop. Поэтому когда у культуры нет какого-то ключа, Lua ищет его в Crop, где лежат методы.
• Crop.new — конструктор. Он создаёт таблицу с собственными данными культуры, назначает ей метатаблицей Crop и возвращает её. new — привычное имя конструктора в Lua. Вызывайте его через точку, Crop.new("Пшеница", 2): вы вызываете его у класса, когда ни одной культуры ещё нет, поэтому self здесь не нужен.
• function Crop:grow() определяет метод класса через двоеточие, а культуры вызывают его тоже через двоеточие: wheat:grow().

Объект, созданный классом, называется экземпляром этого класса: wheat и carrot — экземпляры Crop. Каждый хранит только свои данные, а методы лежат в Crop в единственном экземпляре. В отличие от многих других языков, в Lua нет специального ключевого слова для классов. Класс — это такой приём из таблицы, __index и конструктора, и вы найдёте его почти в любой большой программе на Lua.

setmetatable возвращает таблицу, которую получила, поэтому часто встречается более короткий конструктор: local crop = setmetatable({name = name, days = days, age = 0}, Crop). Он делает то же самое.

Классическая ошибка: забыть Crop.__index = Crop. Без этой строки всё выглядит нормально, пока вы не вызовете метод:

local Crop = {}

function Crop.new(name, days)
    local crop = {name = name, days = days, age = 0}
    setmetatable(crop, Crop)
    return crop
end

function Crop:grow()
    self.age = self.age + 1
end

local wheat = Crop.new("Пшеница", 2)
wheat:grow()

Программа завершается с ошибкой:

main.lua:14: attempt to call a nil value (method 'grow')

Crop — метатаблица пшеницы, но без __index Lua не знает, что отсутствующие ключи нужно искать в ней. Поэтому wheat.grow равно nil, а вызов nil — ошибка. (method 'grow') означает, что метод не найден: проверьте __index и проверьте, нет ли опечатки в имени метода.

Ошибки из прошлых упражнений возможны и здесь. Без return crop функция Crop.new вернёт nil (attempt to index a nil value (local 'wheat')), а wheat.grow() через точку оставит self пустым (attempt to index a nil value (local 'self')).