Главная » Java, Советы » Подумайте над реализацией интерфейса ComparabIe

0

 

в отличие от других обсуждавшихся в этой главе методов, метод соmрагеТо в классе Object не декларируется. Пожалуй, это единственный такой метод в интерфейсе java.lang.СоmрагаЫе. По своим свойствам он похож на метод equals из класса Object, за исключением того, что, помимо простой проверки равенства, он позволяет выполнять упорядочивающее сравнение. Реализуя интерфейс СоmрагаЫе, класс показывает, что его экземпляры обладают естественным своиством упорядочения (natиra! ordering). Сортировка массива объектов, реализующих интерфейс СоmрагаЫе, выполняется просто:

 

Arrays.sort(a);

 

Для объектов СоmрагаЫе так же просто выполняется поиск, вычисляются предельные значения и обеспечивается поддержка автоматически сортируемых коллекций. Например, следующая программа, использующая тот факт, что класс String реализует I1нтерфейс СоmрагаЫе, печатает в алфавитном порядке список аргументов, указанных в командной строке, удаляя при этом дубликаты:

 

public class WordList {

public static void main(String[] args) {

Set 5 = new TreeSet();

s,addAll(Arrays.asList(args));

 System.out.println(s);

}

}51

 

Реализуя интерфейс СотрагаЫе, вы разрешаете вашему классу взаимодействовать со всем обширным набором общих алгоритмов и реализаций коллекций, которые связаны с этим интерфейсом. Приложив немного усилий, вы получаете огромные возможности. Практически все классы значений в библиотеках платформы Java реализуют интерфейс СотрагаЫе. И если вы пишите класс значений с очевидным свойством естественного упорядочения – алфавитным, числовым либо хронологическим,- вы должны хорошо продумать реализацию этого интерфейса. В этой статье рассказывается о том, как к этому приступить.

Общее соглашение для метода соmрагеТо имеет тот же характер, что и соглашение

Для метода equals. Приведем его текст по спецификации интерфейса СотрагаЫе:

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

В следующем описании запись sgп(выражение) обозначает математическую функцию signuт, которая, по определению, возвращает -1, О или 1 в зависимости от того, является ли

значение выражения отрицательным, равным нулю или положительным.

·       Разработчик должен гарантировать тождество sgn(x.compareTo(y)) == -sgп(у.соmрагеТо(х)) для всех х и у. (Это подразумевает, что выражение х. сотрагеТо(у) должно инициировать исключительную ситуацию тогда и только тогда, когда у. сотрагеТо(х) инициирует исключение.)

·      Разработчик должен также гарантировать транзитивность отношения (х.сотрагеТо(у»О && y.compareTo(z»O) подразумевает x.compareTo(z»O.

·      Наконец, разработчик должен гарантировать,

что из тождества х. соmрагеТо(у) == О вытекает тождество sgn(x.compareTo(z)) == sgn(y.compareTo(z)) для всех z.

·      Настоятельно рекомендуется выполнять условие

(х. сотрагеТо(у) == О) == (х. equalS(y)). Вообще говоря, для любого класса, который реализует интерфейс СотрагаЫе,  но нарушает это условие, сей факт должен быть четко оговорен (в сопроводительной документации). Рекомендуется использовать следующую формулировку: "Примечание: данный класс имеет естественное упорядочение, не согласующееся с условием равенства".

 

 

Как и соглашения для метода equals (статья 7), соглашения для соmрагеТо не так сложны, как это кажется. Для одного класса любое разумное отношение упорядочения будет соответствовать соглашениям для соmрагеТо. Для сравнения разных классов метод соmрагеТо, в отличие от метода equals, использоваться не должен: если сравниваются две ссылки на объекты различных классов, можно инициировать исключительную ситуацию ClassCastException. Метод compareTo обычно так и делает. И хотя представленное соглашение не исключает сравнения между классами, в библиотеках для платформы Java, в частности в версии 1.4, нет классов, которые поддерживали бы такую возможность.

Точно так же, как класс, нарушающий соглашения для метода ‘hashCode, может испортить другие классы, работа которых зависит от хэширования, класс, не соблюдающий соглашений для метода соmрагеТо, способен нарушить работу других классов, использующих сравнение. К классам, связанным со сравнением, относятся упорядоченные коллекции, TreeSet и ТгееМар, а также вспомогательные классы Collections и Arrays, содержащие алгоритмы поиска и сортировки.

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

Из этих трех условий следует, что проверка равенства, осуществляемая с помощью метода соmрагеТо, должна подчиняться тем же самым ограничениям, которые продиктованы соглашениями для метода equals: рефлективность, симметрия, транзитивность и отличие от null. Следовательно, здесь справедливо то же самое предупреждение: невозможно расширить порождающий экземпляры класс, вводя новый аспект и не нарушая при этом соглашения для метода сотрагеТо (статья 7). Возможен обходной Путь. Если вы хотите добавить важное свойство к классу, реализующему интерфейс СотрагаЫе, не расширяйте его, а напишите новый независимый класс, в котором для исходного класса выделено отдельное поле. Затем добавьте метод представления, возвращающий значение этого поля. Это позволит вам реализовать во втором классе любой метод сотрагеТо, который вам нравится. При необходимости клиент может рассматривать экземпляр второго класса как экземпляр первого класса.

Последний пункт соглашений для соmрагеТо, являющийся скорее предположением, чем настоящим условием, постулирует, что проверка равенства, осуществляемая с помощью метода соmрагеТо, обычно должна давать те же самые результаты, что и метод equals. Если это условие выполняется, считается, что упорядочение, задаваемое методом соmрагеТо, согласуется с проверкой равенства (consistent with equals). Если же оно нарушается, то упорядочение называется несогласующимся с проверкой равенства (inconsistent with eqиals).

 

Класс, чей метод соmрагеТо устанавливает порядок, несогласующийся с условием равенства, будет работоспособен, однако отсортированные коллекции, содержащие элементы этого класса, могут не соответствовать общим соглашениям для соответствующих интерфейсов коллекций (Collection, Set или Мар). Дело в том, что общие соглашения для этих интерфейсов определяются в терминах метода equals, тогда как в отсортированных коллекциях ИСПОЛl>зуется проверка равенства, которая реализуется методом соmрагеТо, а не equals. Если это произойдет, катастрофы не будет, но иногда это следует учитывать.

Например, рассмотрим класс BigDecimal, чей метод соmрагеТо не согласуется с проверкой равенства. Если вы создадите HashSet и добавите в него новую запись BigDecimal("1.0"), а затем BigDecimal("1.00"), этот набор будет содержать два элемента, поскольку два добавленных в него экземпляра класса BigDecimal не будут равны, если их сравнивать с помощью’ метода equals. Однако если вы выполняете ту же самую процедуру с TreeSet, а не HashSet, полученный набор будет содержать только один элемент, поскольку два представленных экземпляра BigDecimal оказываются равны при их сравнении с помощью метода соmаргеТо. (См. документацию на BigDecimal.)

Процедура написания метода соmрагеТо похожа на процедуру для метода equals, но есть несколько ключевых различий. Перед преобразованием типа нет необходимости проверять тип аргумента. Если аргумент имеет неправильный тип, метод соmрагеТо обязан инициировать исключительную ситуацию ClassCastException. Если аргумент имеет значение null, метод compare Т о должен инициировать исключительную ситуацию NullPointerException. Т о же самое вы получите, если приведете аргумент к правильному типу, а затем попытаетесь обратиться к его членам.

Сравнение полей само по себе является упорядочивающим сравнением, а не сравнением с проверкой равенства. Сравнение полей, имеющих ссылки на объекты, осуществляйте путем рекурсивного вызова метода сотрагеТо. Если поле не реализует интерфейс Сотра rable или вам необходимо не стандартное упорядочение, вы можете использовать явную реализацию интерфейса Comparator. Либо напишите ваш собственный метод, либо воспользуйтесь уже имеющимся, как это было в случае с методом сотра геТо в классе CaselnsensitiveString (статья 7):

public int compareTo(Object о) {

CaselnsensitiveString cis = (CaselnsensitiveString)o;

return String.CASE_INSENSITIVE_ORDER.compare(s, cis.s);

}

 

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

возвратить этот результат. Если самые значимые поля равны, продолжайте сравнивать следующие по значимости поля и т. д. Если все поля равны, равны и объекты, поэтому возвращайте нуль. Такой прием демонстрирует метод соmрагеТо для класса PhoneNumber из статьи 8:

 

public int compareTo(Object о) {

PhoneNumber рn = (PhoneNumber)o;

// Сравниваем коды зон

if (areaCode < pn.areaCode)

 return -1;

if (areaCode > pn.areaCode)

return 1;

// Коды зон равны, сравниваем номера АТС

 if (exchange < pn.exchange)

 retuгn -1;

if (exchange > pn.exchange)

retuгn 1;

// Коды зон и номера АТС равны, сравниваем номера абонентов

 if (extension < pn.extension)

return -1;

if (extension > pn.extension)

 return 1;

return о; // Все поля равны

}

Этот метод работает прекрасно, но его можно улучшить. Напомним, что в соглашениях для метода соmрагеТо величина возвращаемого значения не конкретизируется, только знак. Вы можете извлечь из этого пользу, упростив программу и, возможно, заставив ее работать немного быстрее:

public int compareTo(Object о) {

PhoneNumber рп = (PhoneNumber)o;

// Сравниваем коды зон

int areaCodeDiff = areaCode – pn.areaCode;

if (areaCodeDiff 1= О)

return areaCodeDiff;

// Коды зон равны, сравниваем номера АТС

int exchangeDiff = exchange – pn.exchange;

if (exchangeDiff != 0)

return exchangeDiff;

// Коды зон и номера АТС равны, сравниваем номера абонентов

return extension – pn.extension;

}

Такая уловка работает прекрасно, но применять ее следует крайне осторожно.

Не пользуйтесь ею, если у вас нет уверенности в том, что рассматриваемое поле не может иметь отрицательное значение или, что бывает чаще, разность между наименьшим и наибольшим возможными значениями поля меньше или равна значению INTEGER. MAX_VALUE (231 -1). Причина, по которой этот прием не работает, обычно заключается в том, что 32-битовое целое число со знаком является недостаточно большим, чтобы показать разность двух 32-битовых целых чисел с произвольным знаком. Если i – большое положительное целое число, а j – большое отрицательное целое число, то при вычислении разности (i-j) произойдет переполнение и будет возвращено отрицательное значение. Следовательно, полученный нами метод соmрагеТо работать не будет: для некоторых аргументов будет выдаваться бессмысленный результат, тем самым будут нарушены первое и второе условия соглашения для метода соmрагеТо. И эта проблема не является чисто теоретической, она уже вызывала сбои в реальных системах. Выявить причину подобных отказов бывает крайне трудно, поскольку не· правильный метод соmрагеТо работает правильно со многими входными значениями.

Источник: Джошуа Блох, Java TM Эффективное программирование, Издательство «Лори»

По теме:

  • Комментарии