在Java方法中使用标志的最佳实践

Question

在 Java 方法中指定标志的最佳实践是什么？

我见过 SWT 使用 int 作为位域，例如：（

示例部分来自“Effective 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 值）来自不同的类一起，无需任何编译器检查。

在同一本书（“Effective Java”）中，我看到了 EnumSet 的使用，但随后您的用户调用变成：

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

我发现这有点冗长，我更喜欢 SWT 的优雅。

还有其他选择吗？或者这基本上是您必须选择的两种口味？

Answer 1

猜猜你已经碰壁了。我没有看到任何其他选择。 Java 很冗长，这是事实。在这种情况下，我通常添加一个局部变量以使代码更具可读性。你可以这样做，

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

Answer 2

如果您需要位样式标志，Java 将它们包装在 BitSet 中。它已经存在很长时间了，但很少有人费心去使用它（更喜欢在整数中嵌入 C 风格的位处理）。

可以在此处找到 BitSet 的 api。

再加上一些精心挑选的静态整数，它的表现相当不错，直到您开始在一次传递中检查和设置多个位。

Answer 3

我建议您采用 EnumSet 方法。

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

这种方法提供了更好的类型安全性，并且 Style 作为枚举将具有成熟的 OO 功能。

Answer 4

对于遇到此问题的人来说，答案很晚。这是一种减少内存并拥有像 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;
    }
}

method:

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

call 这样的漂亮枚举的方法：

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

Answer 5

如果您只有有限数量的方法将采用一组样式（例如您的示例中的 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..更多），所以你需要一个通用的ticalOr方法将你的数组分割成第一个+其余的块。 留给读者作为练习=）。