Книга: C# 4.0: полное руководство

Методы

Методы

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

Метод состоит из одного или нескольких операторов. В грамотно написанном коде C# каждый метод выполняет только одну функцию. У каждого метода имеется свое имя, по которому он вызывается. В общем, методу в качестве имени можно присвоить любой действительный идентификатор. Следует, однако, иметь в виду, что идентификатор Main() зарезервирован для метода, с которого начинается выполнение программы. Кроме того, в качестве имен методов нельзя использовать ключевые слова С#.

В этой книге методы именуются в соответствии с условными обозначениями, принятыми в литературе по С#. В частности, после имени метода следуют круглые скобки. Так, если методу присвоено имя GetVal, то в тексте книги он упоминается в следующем виде: GetVal(). Такая форма записи помогает отличать имена методов от имен переменных при чтении книги.

Ниже приведена общая форма определения метода:

доступ возращаемый_тип имя(список_параметров) {
// тело метода
}

где доступ — это модификатор доступа, определяющий те части программы, из которых может вызываться метод. Как пояснялось выше, указывать модификатор доступа необязательно. Но если он отсутствует, то метод оказывается закрытым (private) в пределах того класса, в котором он объявляется. Мы будем пока что объявлять методы открытыми (public), чтобы вызывать их из любой другой части кода в программе. Затем возращаемый_тип обозначает тип данных, возвращаемых методом. Этот тип должен быть действительным, в том числе и типом создаваемого класса. Если метод не возвращает значение, то в качестве возвращаемого для него следует указать тип void. Далее имя обозначает конкретное имя, присваиваемое методу. В качестве имени метода может служить любой допустимый идентификатор, не приводящий к конфликтам в текущей области объявлений. И наконец, список_параметров — это последовательность пар, состоящих из типа и идентификатора и разделенных запятыми. Параметры представляют собой переменные, получающие значение аргументов, передаваемых методу при его вызове. Если у метода отсутствуют параметры, то список параметров оказывается пустым.

Как пояснялось выше, методы класса, как правило, манипулируют данными класса и предоставляют доступ к ним. С учетом этого напомним, что в приведенных выше примерах в методе Main() вычислялась площадь на одного человека путем деления общей площади здания на количество жильцов. И хотя такой способ формально считается правильным, на самом деле он оказывается далеко не самым лучшим для организации подобного вычисления. Площадь на одного человека лучше всего вычислять в самом классе Building, просто потому, что так легче понять сам характер вычисления. Ведь площадь на одного человека зависит от значений в полях Area и Occupants, инкапсулированных в классе Building. Следовательно, данное вычисление может быть вполне произведено в самом классе Building. Кроме того, вводя вычисление площади на одного человека в класс Building, мы тем самым избавляем все программы, пользующиеся классом Building, от необходимости выполнять это вычисление самостоятельно. Благодаря этому исключается ненужное дублирование кода. И наконец, добавление в класс Building метода, вычисляющего площадь на одного человека, способствует улучшению его объектно-ориентированной структуры, поскольку величины, непосредственно связанные со зданием, инкапсулируются в классе Building.

Для того чтобы добавить метод в класс Building, достаточно указать его в области объявлений в данном классе. В качестве примера ниже приведен переработанный вариант класса Building, содержащий метод AreaPerPerson(), который выводит площадь, рассчитанную на одного человека в конкретном здании.

// Добавить метод в класс Building.
using System;
class Building {
  public    int    Floors;    //количество этажей
  public    int    Area;    //общая площадь здания
  public    int    Occupants;    //количество жильцов
  // Вывести площадь на одного человека,
  public void AreaPerPerson() {
    Console.WriteLine(" " + Area / Occupants +
             " приходится на одного человека");
  }
}
// Использовать метод AreaPerPerson().
class BuildingDemo {
  static void Main() {
    Building house = new Building();
    Building office = new Building();
    // Присвоить значения полям в объекте house,
    house.Occupants = 4;
    house.Area = 2500;
    house.Floors = 2;
    // Присвоить значения полям в объекте office,
    office.Occupants = 25;
    office.Area = 4200;
    office.Floors = 3;
    Console.WriteLine("Дом имеет:n " +
           house.Floors + " этажаn " +
           house.Occupants + " жильцаn "
                   + house.Area +
           "кв. футов общей площади, из них");
    house.AreaPerPerson() ;
    Console.WriteLine();
    Console.WriteLine("Учреждение имеет:n " +
            office.Floors + " этажаn " +
            office.Occupants + " работниковn " +
            office.Area +
            " кв. футов общей площади, из них");
    office.AreaPerPerson() ;
  }
}

Эта программа дает такой же результат, как и прежде.

Дом имеет:
 2 этажа
 4 жильца
 2500 кв. футов общей площади, из них
 625 приходится на одного человека
Учреждение имеет:
 3 этажа
 25 работников
 4200 кв. футов общей площади, из них
 168 приходится на одного человека

Рассмотрим основные элементы этой программы, начиная с метода AreaPerPerson(). Первая его строка выглядит следующим образом.

public void AreaPerPerson() {

В этой строке объявляется метод, именуемый AreaPerPerson и не имеющий параметров. Для него указывается тип public, а это означает, что его можно вызывать из любой другой части программы. Метод AreaPerPerson() возвращает пустое значение типа void, т.е. он практически ничего не возвращает вызывающей части программы. Анализируемая строка завершается фигурной скобкой, открывающей тело данного метода. Тело метода AreaPerPerson() состоит всего лишь из одного оператора.

Console.WriteLine(" " + Area / Occupants +
     " приходится на одного человека");

Этот оператор осуществляет вывод величины площади на одного человека, которая получается путем деления общей площади здания (переменной Area) на количество жильцов (переменную Occupants). А поскольку у каждого объекта типа Building имеется своя копия переменных Area и Occupants, то при вызове метода AreaPerPerson() в вычислении используются копии этих переменных, принадлежащие вызывающему объекту.

Метод AreaPerPerson() завершается закрывающейся фигурной скобкой. Когда встречается эта скобка, управление передается обратно вызывающей части программы.

Далее проанализируем внимательно следующую строку кода из метода Main().

house.AreaPerPerson() ;

В этой строке вызывается метод AreaPerPerson() для объекта house. Это означает, что метод AreaPerPerson() вызывается относительно объекта, на который ссылается переменная house, и для этой цели служит оператор-точка. Когда метод AreaPerPerson() вызывается, ему передается управление программой. А по его завершении управление передается обратно вызывающей части программы, выполнение которой возобновляется со строки кода, следующей после вызова данного метода.

В данном случае в результате вызова house.AreaPerPerson() выводится площадь на одного человека в здании, определенном в объекте house. Аналогично, в результате вызова office.AreaPerPerson() выводится площадь на одного человека в здании, определенном в объекте office. Таким образом, при каждом вызове метода AreaPerPerson() выводится площадь на одного человека для указанного объекта.

В методе AreaPerPerson() особого внимания заслуживает следующее обстоятельство: обращение к переменным экземпляра Area и Occupants осуществляется непосредственно, т.е. без помощи оператора-точки. Если в методе используется переменная экземпляра, определенная в его классе, то делается это непосредственно, без указания явной ссылки на объект и без помощи оператора-точки. Понять это нетрудно, если хорошенько подумать. Ведь метод всегда вызывается относительно некоторого объекта его класса. Как только вызов произойдет, объект становится известным. Поэтому объект не нужно указывать в методе еще раз. В данном случае это означает, что переменные экземпляра Area и Occupants в методе AreaPerPerson() неявно ссылаются на копии этих же переменных в том объекте, который вызывает метод AreaPerPerson().

-----------------------------------------------

ПРИМЕЧАНИЕ

Попутно следует заметить, что значение переменной Occupants в методе AreaPerPerson() не должно быть равно нулю (это касается всех примеров, приведенных в данной главе). Если бы значение переменной Occupants оказалось равным нулю, то произошла бы ошибка из-за деления на нуль. В главе 13, где рассматриваются исключительные ситуации, будет показано, каким образом в C# отслеживаются и обрабатываются ошибки, которые могут возникнуть во время выполнения программы.

-----------------------------------------------

В целом, возврат из метода может произойти при двух условиях. Во-первых, когда встречается фигурная скобка, закрывающая тело метода, как показывает пример метода AreaPerPerson() из приведенной выше программы. И во-вторых, когда выполняется оператор return. Имеются две формы оператора return: одна — для методов типа void, т.е. тех методов, которые не возвращают значения, а другая — для методов, возвращающих конкретные значения. Первая форма рассматривается в этом разделе, а в следующем разделе будет пояснено, каким образом значения возвращаются из методов.

Для немедленного завершения метода типа void достаточно воспользоваться следующей формой оператора return.

return;

Когда выполняется этот оператор, управление возвращается вызывающей части программы, а оставшийся в методе код пропускается. В качестве примера рассмотрим следующий метод.

public void MyMethO { int i;
  for(i=0; i<10; i++)    {
    if(i == 5) return; // прервать на шаге 5
    Console.WriteLine();
  }
}

В данном примере выполняется лишь 5 полноценных шагов цикла for, поскольку при значении 5 переменной i происходит возврат из метода.

В методе допускается наличие нескольких операторов return, особенно если имеются два или более вариантов возврата из него. Например:

public void MyMethO {
  // ...
  if(done) return;
  // ...
  if (error) return;
}

В данном примере возврат из метода происходит в двух случаях: если метод завершает свою работу или происходит ошибка. Но пользоваться таким приемом программирования следует очень аккуратно. Ведь из-за слишком большого числа точек возврата из метода может нарушиться структура кода.

Итак, напомним еще раз: возврат из метода типа void может произойти при двух условиях: по достижении закрывающей фигурной скобки или при выполнении оператора return.

Методы с возвратом типа void нередко применяются в программировании, тем не менее, большинство методов возвращает конкретное значение. В действительности способность возвращать значение является одним из самых полезных свойств метода. Возврат значения уже демонстрировался в главе 3 на примере метода Math.Sqrt(), использовавшегося для получения квадратного корня.

Возвращаемые значения используются в программировании с самыми разными целями. В одних случаях, как в примере метода Math.Sqrt(), возвращаемое значение содержит результат некоторого вычисления, в других — оно может просто указывать на успешное или неудачное завершение метода, а в третьих — содержать код состояния. Но независимо от преследуемой цели использование возвращаемых значений является неотъемлемой частью программирования на С#.

Для возврата значения из метода в вызывающую часть программы служит следующая форма оператора return:

return значение;

где значение — это конкретное возвращаемое значение.

Используя возвращаемое значение, можно усовершенствовать рассматривавшийся ранее метод AreaPerPerson(). Вместо того чтобы выводить величину площади на одного человека, лучше возвратить ее из этого метода. Среди прочих преимуществ такого подхода следует особо отметить возможность использовать возвращаемое значение для выполнения других вычислений. Приведенный ниже пример представляет собой улучшенный вариант рассматривавшейся ранее программы с усовершенствованным методом AreaPerPerson(), возвращающим величину площади на одного человека вместо того, чтобы выводить ее.

// Возвратить значение из метода AreaPerPerson().
using System;
class Building {
  public int Floors; // количество этажей
  public int Area; // общая площадь здания
  public int Occupants; // количество жильцов
  // Возвратить величину площади на одного человека,
  public int AreaPerPerson() {
    return Area / Occupants;
  }
}
// Использовать значение, возвращаемое методом AreaPerPerson().
class BuildingDemo {
  static void Main() {
    Building house = new Building();
    Building office = new Building();
    int areaPP; // площадь на одного человека
    // Присвоить значения полям в объекте house,
    house.Occupants = 4;
    house.Area = 2500;
    house.Floors = 2;
    // Присвоить значения полям в объекте office,
    office.Occupants = 25;
    office.Area = 4200;
    office.Floors = 3;
    // Получить площадь на одного человека в жилом доме.
    areaPP = house.AreaPerPerson();
    Console.WriteLine("Дом имеет:n " +
           house.Floors + " этажаn " +
           house.Occupants + " жильцаn " +
           house.Area +
           " кв. футов общей площади, из нихn " +
           areaPP + " приходится на одного человека");
    Console.WriteLine();
    // Получить площадь на одного человека в учреждении.
    areaPP = office.AreaPerPerson();
    Console.WriteLine ("Учреждение имеет :n " +
            office.Floors + " этажаn " +
            office.Occupants + " работниковn " +
            office.Area +
            " кв. футов общей площади, из нихn " +
            areaPP + " приходится на одного человека");
  }
}

Эта программа дает такой же результат, как и прежде.

В данной программе обратите внимание на следующее: когда метод AreaPerPerson() вызывается, он указывается в правой части оператора присваивания. А в левой части этого оператора указывается переменная, которой передается значение, возвращаемое методом AreaPerPerson(). Следовательно, после выполнения оператора

areaPP = house.AreaPerPerson();

в переменной areaPP сохраняется величина площади на одного человека в жилом доме (объект house).

Обратите также внимание на то, что теперь метод AreaPerPerson() имеет возвращаемый тип int. Это означает, что он будет возвращать целое значение вызывающей части программы. Тип, возвращаемый методом, имеет очень большое значение, поскольку тип данных, возвращаемых методом, должен быть совместим с возвращаемым типом, указанным в методе. Так, если метод должен возвращать данные типа double, то в нем следует непременно указать возвращаемый тип double.

Несмотря на то что приведенная выше программа верна, она, тем не менее, написана не совсем эффективно. В частности, в ней можно вполне обойтись без переменной areaPP, указав вызов метода AreaPerPerson() непосредственно в операторе, содержащем вызов метода WriteLine(), как показано ниже.

Console.WriteLine("Дом имеет:    "    +
house.Floors + " этажа " + house.Occupants + " жильца " + house.Area +
" кв. футов общей площади, из них " + house.AreaPerPerson() +
" приходится на одного человека");

В данном случае при выполнении оператора, содержащего вызов метода WriteLine(), автоматически вызывается метод house.AreaPerPerson(), а возвращаемое им значение передается методу WriteLine(). Кроме того, вызов метода AreaPerPerson() можно использовать всякий раз, когда требуется получить величину площади на одного человека для конкретного объекта типа Building. Например, в приведенном ниже операторе сравниваются величины площади на одного человека для двух зданий.

if(b1.AreaPerPerson() > b2.AreaPerPerson())
  Console.WriteLine("В здании b1 больше места для каждого человека");

При вызове метода ему можно передать одно или несколько значений. Значение, передаваемое методу, называется аргументом. А переменная, получающая аргумент, называется формальным параметром, или просто параметром. Параметры объявляются в скобках после имени метода. Синтаксис объявления параметров такой же, как и у переменных. А областью действия параметров является тело метода. За исключением особых случаев передачи аргументов методу, параметры действуют так же, как и любые другие переменные.

Ниже приведен пример программы, в котором демонстрируется применение параметра. В классе ChkNum используется метод IsPrime(), который возвращает значение true, если ему передается значение, являющееся простым числом. В противном случае он возвращает значение false. Следовательно, возвращаемым для метода IsPrime() является тип bool.
// Простой пример применения параметра.
using System;
class ChkNum {
  // Возвратить значение true, если значение
  // параметра х окажется простым числом,
  public bool IsPrime(int x) {
    if (x <= 1) return false;
    for (int i=2; i <= x/i; i++)
      if ( (x % i) == 0) return false;
    return true;
  }
}
class ParmDemo {
  static void Main() {
    ChkNum ob = new ChkNum();
    for (int i=2; i < 10; i++)
    if(ob.IsPrime(i))
      Console.WriteLine(i + " простое число.");
    else
      Console.WriteLine(i + " непростое число.");
  }
}

Вот какой результат дает выполнение этой программы.

2    простое число.
3    простое число.
4    непростое число.
5    простое число.
6    непростое число.
7    простое число.
8    непростое число.
9    непростое число.

В данной программе метод IsPrime() вызывается восемь раз, и каждый раз ему передается другое значение. Проанализируем этот процесс более подробно. Прежде всего обратите внимание на то, как вызывается метод IsPrime(). Его аргумент указывается в скобках. Когда метод IsPrime() вызывается в первый раз, ему передается значение 2. Следовательно, когда метод IsPrime() начинает выполняться, его параметр х принимает значение 2. При втором вызове этого метода его параметр х принимает значение 3, при третьем вызове — значение 4 и т.д. Таким образом, значение, передаваемое методу IsPrime() в качестве аргумента при его вызове, представляет собой значение, которое принимает его параметр х.

У метода может быть не только один, но и несколько параметров. Каждый его параметр объявляется, отделяясь от другого запятой. В качестве примера ниже приведен класс ChkNum, который расширен дополнительным методом LeastComFactor(), возвращающим наименьший общий множитель двух его аргументов. Иными словами, этот метод возвращает наименьшее число, на которое оба его аргумента делятся нацело.

// Добавить метод, принимающий два аргумента.
using System;
class ChkNum {
  // Возвратить значение true, если значение
  // параметра х окажется простым числом,
  public bool IsPrime(int x) {
    if (x <= 1) return false;
    for (int i = 2; i <= x / i; i++) if ((x % i) == 0) return false;
    return true;
  }
  // Возвратить наименьший общий множитель,
  public int LeastComFactor(int a, int b) {
    int max;
    if (IsPrime(a) || IsPrime(b)) return 1;
    max = a < b ? a : b;
    for (int i = 2; i <= max / 2; i++)
      if (((a % i) == 0) && ((b % i) == 0)) return i;
    return 1;
  }
}
class ParmDemo {
  static void Main() {
    ChkNum ob = new ChkNum();
    int a, b;
    for (int i = 2; i < 10; i++)
      if (ob.IsPrime(i))
        Console.WriteLine(i + " простое число.");
      else
        Console.WriteLine(i + " непростое число.");
    a = 7;
    b = 8;
    Console.WriteLine("Наименьший общий множитель чисел "
           + a + " и " + b + " равен "
           + ob.LeastComFactor(a, b));
    a = 100;
    b = 8;
    Console.WriteLine("Наименьший общий множитель чисел "
              + a + " и " + b + " равен "
              + ob.LeastComFactor(a, b));
    a = 100;
    b = 75;
    Console.WriteLine("Наименьший общий множитель чисел "
              + a + " и " + b + " равен "
              + ob.LeastComFactor(a, b));
  }
}

Обратите внимание на следующее: когда вызывается метод LeastComFactor(), его аргументы также разделяются запятыми. Ниже приведен результат выполнения данной программы.

2    простое число.
3    простое число.
4    непростое число.
5    простое число.
6    непростое число.
7    простое число.
8    непростое число.
9    непростое число.
Наименьший общий множитель чисел 7 и 8 равен 1
Наименьший общий множитель чисел 100 и 8 равен 2
Наименьший общий множитель чисел 100 и 75 равен 5

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

int MyMeth(int a, double b, float с) {
//...

С помощью параметризированного метода можно дополнить класс Building новым средством, позволяющим вычислять максимальное количество жильцов в здании, исходя из определенной величины минимальной площади на одного человека. Этим новым средством является приведенный ниже метод MaxOccupant().
// Возвратить максимальное количество человек, занимающих здание,
// исходя из заданной минимальной площади на одного человека,
public int MaxOccupant(int minArea) {
  return Area / minArea;

}

Когда вызывается метод MaxOccupant(), его параметр minArea принимает величину необходимой минимальной площади на одного человека. На эту величину делится общая площадь здания при выполнении данного метода, после чего он возвращает результат.

Ниже приведен весь класс Building, включая и метод MaxOccupant().
/*
Добавить параметризированный метод, вычисляющий максимальное количество человек, которые могут занимать здание, исходя из заданной минимальной площади на одного человека.
*/
using System;
class Building {
  public int Floors; // количество этажей
  public int Area; // общая площадь здания
  public int Occupants; // количество жильцов
  // Возвратить площадь    на    одного человека,
  public int AreaPerPerson()    {
    return Area / Occupants;
  }
// Возвратить максимальное количество человек, занимающих здание,
// исходя из заданной минимальной площади на одного человека,
  public int MaxOccupant(int minArea) {
    return Area / minArea;
  }
}
// Использовать метод MaxOccupant().
class BuildingDemo {
  static void Main() {
    Building house = new Building();
    Building office = new Building();
    // Присвоить значения полям в объекте house,
    house.Occupants = 4;
    house.Area = 2500;
    house.Floors = 2;
    // Присвоить значения полям в объекте office,
    office.Occupants = 25;
    office.Area = 4200;
    office.Floors = 3;
    Console.WriteLine("Максимальное количество человек в доме, n" +
           "если на каждого должно приходиться " +
           300 + " кв. футов: " + house.MaxOccupant(300));
    Console.WriteLine("Максимальное количество человек " +
           "в учреждении n" +
           "если на каждого должно приходиться " +
           300 + " кв. футов: " + office.MaxOccupant(300));
  }
}

Выполнение этой программы дает следующий результат.

Максимальное количество человек в доме,
если на каждого должно приходиться 300 кв. футов: 8
Максимальное количество человек в учреждении,
если на каждого должно приходиться 300 кв. футов: 14

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

public void MyMeth() {
  char a, b;
  // . . .
  if(a==b)    {
    Console.WriteLine("равно") ;
    return;
  }
  else {
    Console.WriteLine("не равно") ;
    return;
  }
  Console.WriteLine ("это недоступный код");
}

В данном примере возврат из метода MyMeth() всегда происходит до выполнения последнего оператора, содержащего вызов метода WriteLine(). Если попытаться скомпилировать этот код, то будет выдано предупреждающее сообщение. Вообще говоря, недоступный код считается ошибкой программирования, и поэтому предупреждения о таком коде следует воспринимать всерьез.

Оглавление книги