Лучшая практика использования флагов в методе Java

Как лучше всего указывать флаги в методе Java?

Я видел SWT, использующий int в качестве битовых полей, например:

(пример частично из "Эффективной Java, 2-е изд.", стр. 159):

public class Text {
  public static final int STYLE_BOLD = 1 << 0; // 1
  public static final int STYLE_ITALIC = 1 << 1; // 2

  void printText(String text, int flags) {

  }
}

и ваш клиентский звонок выглядит так:

printText("hello", Text.STYLE_BOLD | Text.STYLE_ITALIC);

... но это не рекомендуется, так как вы можете смешивать флаги (значения int) из разных классов вместе без каких-либо проверок компилятором.

В той же книге ("Эффективная Java") я вижу использование EnumSet, но тогда ваш пользовательский вызов становится:

printText("hello", EnumSet.of(Style.Bold, Style.ITALIC));

Я нахожу это немного многословным, и я предпочитаю элегантность SWT.

Есть ли другая альтернатива или это два вкуса, которые вы должны выбрать?

5 ответов

Решение

Думаю, ты ударил стену. Я не вижу другого варианта. Ява многословна, это факт. В подобных ситуациях я обычно добавляю локальную переменную, чтобы сделать код более читабельным. Вы можете сделать это,

EnumSet<Style> styles = EnumSet.of(Style.Bold, Style.ITALIC);
printText("hello", styles);

Я советую вам пойти с EnumSet подход.

EnumSet<Style> styles = EnumSet.of(Style.Bold, Style.Italic);

Такой подход обеспечивает лучшую безопасность типов и Style будучи enum будет иметь полноценные возможности OO.

Если вы хотите флаги в битовом стиле, Java оборачивает их в BitSet, Это было вокруг целую вечность, но мало кто удосужился использовать его (предпочитая встраивать обработку битов в стиле C в целые).

API для BitSet можно найти здесь.

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

Поздний ответ для всех, кто сталкивался с этим. Вот один из способов сделать это, чтобы уменьшить память и получить хороший enum, такой как api:

public static class MyFlag {

    public static final MyFlag A = new MyFlag(1<<0);
    public static final MyFlag B = new MyFlag(1<<1);
    public static final MyFlag C = new MyFlag(1<<2);
    public static final MyFlag ALL = A.and(B).and(C);

    private final int flag;

    private MyFlag(int flag){
        this.flag = flag;
    }

    public MyFlag and(MyFlag limit){
        return new MyFlag(flag & limit.flag);
    }

    public MyFlag not(MyFlag limit){
        return new MyFlag(flag | ~limit.flag);
    }

    public boolean isSet(MyFlag limit){
        if(limit ==null){
            return false;
        }
        return (this.flag & limit.flag) != 0;
    }
}

метод:

public void doFoo(MyFlag flag){
   if(MyFlag.A.isSet(flag)){
   ....
   }
   if(MyFlag.C.isSet(flag)){
   ....
   }
}

вызов:

x.doFoo(MyFlag.A.and(MyFlag.C));

Если у вас есть только ограниченное количество методов, которые будут использовать набор стилей (например, printText(в вашем примере), вы можете настроить их сигнатуру, чтобы получить переменное количество параметров стиля:

void printText(String text, Style... flags) {
  EnumSet<Style> style = logicalOr(flags); // see comment below
  ...
 }

И тогда ваши звонки будут очень близки к нетипизированному (int) маршруту флага:

printText("hello", Style.BOLD, Style.ITALIC);

К сожалению, нет EnumSet.of(E... ) заводская, просто EnumSet.of(E first, E... more)так что вам понадобится общий logicalOr способ разбить ваш массив на первый + остальные куски. Оставил как упражнение читателю =).

Другие вопросы по тегам