Създайте изброени константи в Java

Набор от „изброими константи“ е подредена колекция от константи, които могат да бъдат преброени, като числа. Това свойство ви позволява да ги използвате като числа за индексиране на масив или можете да ги използвате като променлива на индекса в цикъл for. В Java такива обекти са най-често известни като „изброени константи“.

Използването на изброени константи може да направи кода по-четлив. Например може да искате да дефинирате нов тип данни с име Цвят с константи ЧЕРВЕНО, ЗЕЛЕНО и СИНЕ като възможните му стойности. Идеята е да имате Color като атрибут на други обекти, които създавате, като например обектите Car:

клас Автомобил {Цветен цвят; ...}

След това можете да напишете ясен, четим код, като този:

 myCar.color = ЧЕРВЕНО; 

вместо нещо като:

 myCar.color = 3; 

Още по-важен атрибут на изброените константи в езици като Pascal е, че те са безопасни за типа. С други думи, не е възможно да присвоите невалиден цвят на атрибута цвят - той винаги трябва да бъде ЧЕРВЕН, ЗЕЛЕН или СИН. За разлика от това, ако цветната променлива е int, тогава можете да й присвоите всяко валидно цяло число, дори ако това число не представлява валиден цвят.

Тази статия ви дава шаблон за създаване на изброени константи, които са:

  • Тип безопасно
  • Печат
  • Подредени, за използване като индекс
  • Свързани, за циклично напред или назад
  • Изброими

В бъдеща статия ще научите как да разширите изброените константи, за да приложите зависимо от държавата поведение.

Защо да не използваме статични финали?

Често срещан механизъм за изброените константи използва статични окончателни променливи int, като този:

статичен финал int ЧЕРВЕН = 0; статичен финал int GREEN = 1; статичен финал int BLUE = 2; ...

Статичните финали са полезни

Тъй като те са окончателни, стойностите са постоянни и неизменни. Тъй като са статични, те се създават само веднъж за класа или интерфейса, в който са дефинирани, вместо веднъж за всеки обект. И тъй като те са целочислени променливи, те могат да бъдат изброени и използвани като индекс.

Например можете да напишете цикъл, за да създадете списък с любимите цветове на клиента:

за (int i = 0; ...) {if (customerLikesColor (i)) {favoriteColors.add (i); }}

Можете също да индексирате в масив или вектор, като използвате променливите, за да получите стойност, свързана с цвета. Да предположим например, че имате настолна игра, която има различни цветни фигури за всеки играч. Да предположим, че имате растерно изображение за всяка цветна част и метод, наречен, display()който копира това растерно изображение към текущото местоположение. Един от начините да поставите фигура на дъската може да бъде нещо подобно:

PiecePicture redPiece = нов PiecePicture (ЧЕРВЕН); PiecePicture greenPiece = нов PiecePicture (ЗЕЛЕН); PiecePicture bluePiece = нов PiecePicture (СИН);

void placePiece (int location, int color) {setPosition (местоположение); ако (цвят == ЧЕРВЕН) {дисплей (redPiece); } иначе ако (цвят == ЗЕЛЕН) {дисплей (greenPiece); } else {дисплей (bluePiece); }}

Но като използвате целочислените стойности за индексиране в масив парчета, можете да опростите кода до:

PiecePicture [] парче = {нов PiecePicture (ЧЕРВЕН), нов PiecePicture (ЗЕЛЕН), нов PiecePicture (СИН)); void placePiece (int location, int color) {setPosition (местоположение); дисплей (парче [цвят]); }

Възможността да завъртате диапазон от константи и да индексирате в масив или вектор са основните предимства на статичните крайни цели числа. И когато броят на възможностите за избор нараства, ефектът от опростяването е още по-голям.

Но статичните финали са рисковани

Все пак има няколко недостатъка при използването на статични крайни цели числа. Основният недостатък е липсата на безопасност на типа. Всяко цяло число, което се изчислява или чете, може да се използва като „цвят“, независимо дали има смисъл да се прави. Можете да преминете през края на дефинираните константи или да спрете да ги покриете всички, което лесно може да се случи, ако добавите или премахнете константа от списъка, но забравите да коригирате индекса на цикъла.

Например вашият цикъл за предпочитание на цветовете може да се чете по следния начин:

for (int i = 0; i <= BLUE; i ++) {if (customerLikesColor (i)) {favoriteColors.add (i); }}

По-късно можете да добавите нов цвят:

статичен финал int ЧЕРВЕН = 0; статичен финал int GREEN = 1; статичен финал int BLUE = 2; статичен финал int MAGENTA = 3;

Или можете да премахнете един:

статичен финал int ЧЕРВЕН = 0; статичен финал int BLUE = 1;

И в двата случая програмата няма да работи правилно. Ако премахнете цвят, ще получите грешка при изпълнение, която насочва вниманието към проблема. Ако добавите цвят, изобщо няма да получите грешка - програмата просто няма да покрие всички цветови избори.

Друг недостатък е липсата на четим идентификатор. Ако използвате кутия за съобщения или конзола за показване на текущия избор на цвят, получавате номер. Това прави отстраняването на грешки доста трудно.

Проблемите със създаването на четим идентификатор понякога се решават с помощта на статични финални константи на низа, като това:

статичен краен низ ЧЕРВЕН = "червен" .intern (); ...

Използването на intern()метода гарантира, че във вътрешния пул от низове има само един низ с това съдържание. Но за intern()да бъдат ефективни, всеки низ или променлива на низ, който някога е сравняван с ЧЕРВЕНО, трябва да го използва. Дори тогава статичните финални низове не позволяват цикли или индексиране в масив и все още не разглеждат въпроса за безопасността на типа.

Тип безопасност

Проблемът със статичните крайни цели числа е, че променливите, които ги използват, по своята същност са неограничени. Те са int променливи, което означава, че могат да държат всяко цяло число, а не само константите, които са били предназначени да държат. Целта е да се дефинира променлива от тип Color, така че да получите грешка при компилация, а не грешка по време на изпълнение, когато на тази променлива е присвоена невалидна стойност.

An elegant solution was provided in Philip Bishop's article in JavaWorld, "Typesafe constants in C++ and Java."

The idea is really simple (once you see it!):

public final class Color { // final class!! private Color() {} // private constructor!!

public static final Color RED = new Color(); public static final Color GREEN = new Color(); public static final Color BLUE = new Color(); }

Because the class is defined as final, it can't be subclassed. No other classes will be created from it. Because the constructor is private, other methods can't use the class to create new objects. The only objects that will ever be created with this class are the static objects the class creates for itself the first time the class is referenced! This implementation is a variation of the Singleton pattern that limits the class to a predefined number of instances. You can use this pattern to create exactly one class any time you need a Singleton, or use it as shown here to create a fixed number of instances. (The Singleton pattern is defined in the book Design Patterns: Elements of Reusable Object-Oriented Software by Gamma, Helm, Johnson, and Vlissides, Addison-Wesley, 1995. See the Resources section for a link to this book.)

The mind-boggling part of this class definition is that the class uses itself to create new objects. The first time you reference RED, it doesn't exist. But the act of accessing the class that RED is defined in causes it to be created, along with the other constants. Admittedly, that kind of recursive reference is rather difficult to visualize. But the advantage is total type safety. A variable of type Color can never be assigned anything other than the RED, GREEN, or BLUE objects that the Color class creates.

Identifiers

The first enhancement to the typesafe enumerated constant class is to create a string representation of the constants. You want to be able to produce a readable version of the value with a line like this:

 System.out.println(myColor); 

Whenever you output an object to a character output stream like System.out, and whenever you concatenate an object to a string, Java automatically invokes the toString() method for that object. That's a good reason to define a toString() method for any new class you create.

If the class does not have a toString() method, the inheritance hierarchy is inspected until one is found. At the top of the hierarchy, the toString() method in the Object class returns the class name. So the toString() method always has some meaning, but most of the time the default method will not be very useful.

Here is a modification to the Color class that provides a useful toString() method:

public final class Color { private String id; private Color(String anID) {this.id = anID; } public String toString() {return this.id; }

public static final Color RED = new Color(

"Red"

); public static final Color GREEN = new Color(

"Green"

); public static final Color BLUE = new Color(

"Blue"

); }

This version adds a private String variable (id). The constructor has been modified to take a String argument and store it as the object's ID. The toString() method then returns the object's ID.

One trick you can use to invoke the toString() method takes advantage of the fact that it is automatically invoked when an object is concatenated to a string. That means you could put the object's name in a dialog by concatenating it to a null string using a line like the following:

 textField1.setText("" + myColor); 

Unless you happen to love all the parentheses in Lisp, you will find that a bit more readable than the alternative:

 textField1.setText(myColor.toString()); 

It's also easier to make sure you put in the right number of closing parentheses!

Ordering and indexing

The next question is how to index into a vector or an array using members of the

Color

class. The mechanism will be to assign an ordinal number to each class constant and reference it using the attribute

.ord

, like this:

 void placePiece(int location, int color) { setPosition(location); display(piece[color.ord]); } 

Although tacking on .ord to convert the reference to color into a number is not particularly pretty, it is not terribly obtrusive either. It seems like a fairly reasonable tradeoff for typesafe constants.

Here is how the ordinal numbers are assigned:

public final class Color { private String id; public final int ord;private static int upperBound = 0; private Color(String anID) { this.id = anID; this.ord = upperBound++; } public String toString() {return this.id; } public static int size() { return upperBound; }

public static final Color RED = new Color("Red"); public static final Color GREEN = new Color("Green"); public static final Color BLUE = new Color("Blue"); }

This code uses the new JDK version 1.1 definition of a "blank final" variable -- a variable that is assigned a value once and once only. This mechanism allows each object to have its own non-static final variable, ord, which will be assigned once during object creation and which will thereafter remain immutable. The static variable upperBound keeps track of the next unused index in the collection. That value becomes the ord attribute when the object is created, after which the upper bound is incremented.

For compatibility with the Vector class, the method size() is defined to return the number of constants that have been defined in this class (which is the same as the upper bound).

A purist might decide that the variable ord should be private, and the method named ord() should return it -- if not, a method named getOrd(). I lean toward accessing the attribute directly, though, for two reasons. The first is that the concept of an ordinal is unequivocally that of an int. There is little likelihood, if any, that the implementation would ever change. The second reason is that what you really want is the ability to use the object as though it were an int, as you could in a language like Pascal. For example, you might want to use the attribute color to index an array. But you cannot use a Java object to do that directly. What you would really like to say is:

 display(piece[color]); // desirable, but does not work 

But you can't do that. The minimum change necessary to get what you want is to access an attribute, instead, like this:

 display(piece[color.ord]); // closest to desirable 

instead of the lengthy alternative:

 display(piece[color.ord()]); // extra parentheses 

or the even lengthier:

 display(piece[color.getOrd()]); // extra parentheses and text 

The Eiffel language uses the same syntax for accessing attributes and invoking methods. That would be the ideal. Given the necessity of choosing one or the other, however, I've gone with accessing ord as an attribute. With any luck, the identifier ord will become so familiar as a result of repetition that using it will seem as natural as writing int. (As natural as that may be.)

Looping

Следващата стъпка е възможността за итерация над константите на класа. Искате да можете да циклирате от началото до края:

 за (Цвят c = Color.first (); c! = null; c = c.next ()) {...} 

или от края обратно към началото:

 за (Цвят c = Color.last (); c! = null; c = c.prev ()) {...} 

Тези модификации използват статични променливи, за да проследят последния създаден обект и да го свържат със следващия обект: