Рефакторинг. Зачем? - DarkGoodWIN

Часто путают понятия класс и объект, так вот, в нашем случае объект — это Line, а класс — TLine.

Объединение данных и кода

В прошлой главе мы создали новый класс, научились создавать экземпляры классов и на этом закончили. Давайте эту главу начнём с примера использования данной конструкции:

function CalculateLineLength(Line: TLine): Double;

begin

Result:= Sqrt(Sqr(Line. X2 — Line. X1) + Sqr(Line. Y2 — Line. Y1));

end;

var

Line: TLine;

LineLenght: Double;

begin

Line:= TLine. Create;

Line. X1:= 10;

Line. Y1:= 10;

Line. X2:= 20;

Line. Y2:= 20;

LineLenght:= CalculateLineLength(Line);

end;

Тут мы создаём новую линию и рассчитываем её длину. Для этого мы завели вспомогательную функцию CalculateLineLength.

Если приглядется, то в нашей новой функции слишком часто упоминается название переменной Line. Возможно есть способ сделать код несколько проще и наглядней? К счастью да. Дело в том, что функцию можно перенести непосредственно в класс:

type

TLine = class(TObject)

public

X1: Integer;

Y1: Integer;

X2: Integer;

Y2: Integer;

function CalculateLineLength: Double;

end;

function TLine. CalculateLineLength: Double;

begin

Result:= Sqrt(Sqr(X2 — X1) + Sqr(Y2 — Y1));

end;

В месте использования код также становтся наглядней. Строка LineLenght:= CalculateLineLength(Line); заменится на строку: LineLenght:= Line. CalculateLineLength;, что несколько короче и куда лучше подчёркивает тот факт, что функция относится именно к линии, а не к чему–то ещё.

Отмечу, что на практике, глядя на исходный код, часто возникает потребность понять, что можно сделать с тем или иным классом. Так вот, значительно проще, удобнее и быстрее пройтись по членам класса, чем найти все функции, принимающие класс в качестве параметра.

И немного из терминологии. Функцию член класса принято называть методом. В нашем случае, мы имеем класс с одним методом CalculateLineLength.

Приватные члены класса

В прошлой главе мы создали первый метод. Он вычисляет длину отрезка. На современных машинах это вычисление занимает совсем немного времени, однако, предположим, что действие это не такое быстрое и для каждой линии выполняется многократно.

Есть много способов решения подобной проблемы, но один из самых простых и универсальных — это кэширование.

Действительно, зачем считать длину каждый раз, если это можно сделать единожды, запомнить посчитанное значение и потом, в качестве результата функции, возвращать его.

Вот как это могло бы выглядеть:

type

TLine = class(TObject)

public

X1: Integer;

Y1: Integer;

X2: Integer;

Y2: Integer;

LengthCalculated: Boolean;

LineLength: Double;

function CalculateLineLength: Double;

end;

function TLine. CalculateLineLength: Double;

begin

if not LengthCalculated then

begin

LineLength:= Sqrt(Sqr(X2 — X1) + Sqr(Y2 — Y1));

LengthCalculated:= True;

end;

Result:= LineLength;

end;

При всей иллюзии работоспособности, в данном коде присутствует целый спектр проблем. Во–первых, тому, кто будет использовать класс снаружи, будет неочевидно, что необходимо вызывать функцию CalculateLineLength и не корректно напрямую использовать поле LineLength. Ну а во–вторых — нет механизма пересчёта длины при изменении координат точек.

Первую проблему мы решим в этой главе, а вторую оставим для следующей, так как для её решения потребуется познакомиться с ещё одним термином.

Мы уже упоминали, да и не раз сталкивались с ключевым словом public, теперь пришло время рассказать, что оно означает. Члены класса, объявленные как public доступны как внутри класса, так и за его пределами.

Кроме public, есть ещё и ключевое слово private, которое означает, что члены класса доступны только из методов данного класса и не доступны за его пределами. В Object Pascal реализации, используемой в компиляторе Delphi, у данной функциональности есть особенность. Видимость private распространяется не только на членов класса, но и на весь модуль, в котором объявлен класс, что является неким отклонением от общих принципов, но уж так сложилось исторически, ничего не попишешь.

Так или иначе, private члены классов — это некие служебные поля и методы (переменные и функции), не предназначенные для использования за пределами класса.

Давайте посмотрим, как будет выглядеть декларация нашего класса, если мы унесём в private секцию всё лишнее:

type

TLine = class(TObject)

private

LengthCalculated: Boolean;

LineLength: Double;

public

X1: Integer;

Y1: Integer;

X2: Integer;

Y2: Integer;

function CalculateLineLength: Double;

end;

Данная реализация вполне себе красноречиво говорит, что поля LengthCalculated и LineLength трогать не надо. По крайней мере, если вы не планируете менять внутренней логики класса.

Свойства

Для того, чтобы можно было каким–то образом реагировать на изменения значений полей классов, были придуманы свойства (property). Они так же могут перекликаться с понятиями getter и setter.

Сначала я приведу пример кода, а потом поясню что происходит. Думаю так будет понятнее:

type

TLine = class(TObject)

private

LengthCalculated: Boolean;

LineLength: Double;

FX2: Integer;

FY2: Integer;

FX1: Integer;

FY1: Integer;

procedure SetX1(const Value: Integer);

procedure SetX2(const Value: Integer);

procedure SetY1(const Value: Integer);

procedure SetY2(const Value: Integer);

public

property X1: Integer read FX1 write SetX1;

property Y1: Integer read FY1 write SetY1;

property X2: Integer read FX2 write SetX2;

property Y2: Integer read FY2 write SetY2;

function CalculateLineLength: Double;

end;

function TLine. CalculateLineLength: Double;

begin

if not LengthCalculated then

begin

LineLength:= Sqrt(Sqr(X2 — X1) + Sqr(Y2 — Y1));

LengthCalculated:= True;

end;

Result:= LineLength;

end;

procedure TLine. SetX1(const Value: Integer);

begin

LengthCalculated:= False;

FX1:= Value;

end;

procedure TLine. SetX2(const Value: Integer);

begin

LengthCalculated:= False;

FX2:= Value;

end;

procedure TLine. SetY1(const Value: Integer);

begin

LengthCalculated:= False;

FY1:= Value;

end;

procedure TLine. SetY2(const Value: Integer);

begin

LengthCalculated:= False;

FY2:= Value;

end;

И так, что мы сделали. Мы добавили полям X1, Y1, X2, Y2 префик «F» и перенесли в private секцию. Префикс «F» — это стандартный, исторически сложившийся префикс для обозначения приватного поля (сокращение от Field, поле). После этого напрямую менять значения координат снаружи класса стало невозможно.

Параллельно, также в private секции мы создали набор функций SetX1, SetY1, SetX2, SetY2 для корректной установки соответствующих значений. Помимо своих непосредственных обязанностей, они также сбрасывают флаг LengthCalculated, чтобы при последующем обращении некорректная уже длина пересчиталась заново.

Для доступа к приватным полям снаружи — предусмотрены свойства. Строка «property X1: Integer read FX1 write SetX1;” означает, что мы свойство X1, при чтении которого будет возвращаться значение FX1 (то, что после ключевого слова read), а при записи — будет вызываться функция SetX1 (то, что после ключевого слова write).

Таким образом, запись: «X:= Line. X1» эквивалентна записи «X:= Line. FX1», а запись «Line. X1:= X» эквивалентна записи «Line. SetX1(X)».

Наследование

Долго решался, прежде чем начать эту тему, обычно она достаточно сложна для понимания. Не уверен, что мне удасться уложиться в одну главу, но не беда. Главное быть последовательным. Давайте не уходить далеко от геометрических примитивов. Создадим два класса. Класс, описывающий круг и класс, описывающий прямоугольник:

type

TCircle = class(TObject)

public

X: Integer;

Y: Integer;

D: Integer;

end;

TRectangle = class(TObject)

public

X1: Integer;

Y1: Integer;

X2: Integer;

Y2: Integer;

end;

Круг вполне описывается координатами центра (X, Y) и диаметром (D), а прямоугольник — двумя точками (X1, Y1 и X2, Y2).

Допустим у нас есть программа для рисования кругов и прямоугольников. Каждый раз, когда мы рисуем новый круг, он кладётся в массив Circles: array of TCircle, а когда рисуем новый прямоугольник, он кладётся в массив Rectangles: array of TRectangle.