大数据、Java EE 学习资料请关注 B 站:https://space.bilibili.com/204792350

你真的了解 enum 类型吗?看懂这篇文章,相信在 Java 又进一小步......

  • 普通应用,直接定义枚举,无需任何额外的方法等
  • 自定义枚举方法,可以和对象一样,实现逻辑操作
  • 使用 == 比较类型,可提供编译时和运行时的安全性。
  • 在 switch 中使用枚举类型
  • 枚举类型属性、方法、构造函数
  • 枚举类型的 EnumSet 和 EnumMap 数据结构
  • 实现设计模式:单例和策略
  • 使用 Lambda 表达式,可以更加简洁
  • 格式化 Enum 类型为 JSON
  • 作为 Message 或者异常信息枚举

普通应用

public enum OrderStatus {
    APPROED, ORDERED, DELIVERED, RECEIPTED, DELETED, SINGED;
}

自定义枚举方法

public class Order {
    private OrderStatus status;
    public enum OrderStatus {
	    APPROED, ORDERED, DELIVERED, RECEIPTED, DELETED, SINGED;
    }
 
    public boolean isDeliverable() {
        return getStatus() == OrderStatus.READY;
    }
}

使用 == 比较类型

由于枚举类型确保JVM中仅存在一个常量实例,因此可以安全地使用 == 运算符比较两个变量.

此外,== 运算符可提供编译时和运行时的安全性。

首先,看一下以下代码段中的运行时安全性,其中 == 运算符用于比较状态,并且如果两个值均为null 都不会引发 NullPointerException。相反,如果使用equals方法,将抛出 NullPointerException:

if(testPz.getStatus().equals(Pizza.PizzaStatus.DELIVERED)); 
if(testPz.getStatus() == Pizza.PizzaStatus.DELIVERED); 

对于编译时安全性,另一个示例,两个不同枚举类型进行比较,使用equal方法比较结果确定为true,因为getStatus方法的枚举值与另一个类型枚举值一致,但逻辑上应该为false。这个问题可以使用==操作符避免。因为编译器会表示类型不兼容错误:

if(testPz.getStatus().equals(TestColor.GREEN));
if(testPz.getStatus() == TestColor.GREEN);

在 switch 中使用枚举类型

public int getDeliveryTimeInDays() {
    switch (status) {
        case ORDERED:
            return 5;
        case READY:
            return 2;
        case DELIVERED:
            return 0;
    }
    return 0;
}

枚举类型属性、方法、构造函数

摆脱多个 if 和 switch 结构:

public class Order {
 
    private OrderStatus status;
    public enum OrderStatus {
        ORDERED (5){
            @Override
            public boolean isOrdered() {
                return true;
            }
        },
        READY (2){
            @Override
            public boolean isReady() {
                return true;
            }
        },
        DELIVERED (0){
            @Override
            public boolean isDelivered() {
                return true;
            }
        };
 
        private int timeToDelivery;
 
        public boolean isOrdered() {return false;}
 
        public boolean isReady() {return false;}
 
        public boolean isDelivered(){return false;}
 
        public int getTimeToDelivery() {
            return timeToDelivery;
        }
 
        OrderStatus (int timeToDelivery) {
            this.timeToDelivery = timeToDelivery;
        }
    }
 
    public boolean isDeliverable() {
        return this.status.isReady();
    }
 
    public void printTimeToDeliver() {
        System.out.println("Time to delivery is " + 
          this.getStatus().getTimeToDelivery());
    }
     
    // Methods that set and get the status variable.
}

如何工作:

@Test
public void test01() {
    Order order = new Order();
    order.setStatus(Order.OrderStatus.READY);
    assertTrue(order.isDeliverable());
}

枚举类型的 EnumSet 和 EnumMap 数据结构

EnumSet

EnumSet 是一种专门为枚举类型所设计的 Set 类型。

HashSet相比,由于使用了内部位向量表示,因此它是特定 Enum 常量集的非常有效且紧凑的表示形式。

它提供了类型安全的替代方法,以替代传统的基于int的“位标志”,使我们能够编写更易读和易于维护的简洁代码。

EnumSet 是抽象类,其有两个实现:RegularEnumSetJumboEnumSet,选择哪一个取决于实例化时枚举中常量的数量。

在很多场景中的枚举常量集合操作(如:取子集、增加、删除、containsAllremoveAll批操作)使用EnumSet非常合适;如果需要迭代所

public class Order {
 
    private static EnumSet<OrderStatus> undeliveredOrderStatuses =
      EnumSet.of(OrderStatus.ORDERED, OrderStatus.READY);
 
    private OrderStatus status;
 
    public enum OrderStatus {
        ...
    }
 
    public boolean isDeliverable() {
        return this.status.isReady();
    }
 
    public void printTimeToDeliver() {
        System.out.println("Time to delivery is " + 
          this.getStatus().getTimeToDelivery() + " days");
    }
 
    public static List<Pizza> getAllUndeliveredOrders(List<Pizza> input) {
        return input.stream().filter(
          (s) -> undeliveredOrderStatuses.contains(s.getStatus()))
            .collect(Collectors.toList());
    }
 
    public void deliver() { 
        if (isDeliverable()) { 
            OrderDeliverySystemConfiguration.getInstance().getDeliveryStrategy()
              .deliver(this); 
            this.setStatus(OrderStatus.DELIVERED); 
        } 
    }
     
    // Methods that set and get the status variable.
}

如何使用:

@Test
public void test03() {
    List<Order> orderList = new ArrayList<>();
    Order order1 = new Order();
    order1.setStatus(Order.OrderStatus.DELIVERED);
 
    Order order2 = new Order();
    order2.setStatus(Order.OrderStatus.ORDERED);
 
    Order order3 = new Order();
    order3.setStatus(Order.OrderStatus.ORDERED);
 
    Order order4 = new Order();
    order4.setStatus(Order.OrderStatus.READY);
 
    orderList.add(order1);
    orderList.add(order2);
    orderList.add(order3);
    orderList.add(order4);
 
    List<Pizza> undeliveredOrders = Order.getAllUndeliveredOrders(orderList); 
    assertTrue(undeliveredOrders.size() == 3); 
}

EnumMap

EnumMap是一个专门化的映射实现,用于将枚举常量用作键。与对应的 HashMap 相比,它是一个高效紧凑的实现,并且在内部表示为一个数组:

Iterator<Order> iterator = orderList.iterator();
while (iterator.hasNext()) {
    Order order = iterator.next();
    OrderStatus status = order.getStatus();
    if (orderByStatus.containsKey(status)) {
      pzByStatus.get(status).add(order);
    } else {
      List<Order> newOrderList = new ArrayList<>();
      newOrderList.add(order);
      orderByStatus.put(status, newOrderList);
    }
}

如何使用:

@Test
public void test01() {
    List<Order> pzList = new ArrayList<>();
    Order order1 = new Order();
    order1.setStatus(Order.OrderStatus.DELIVERED);
 
    Order order2 = new Order();
    order2.setStatus(Order.OrderStatus.ORDERED);
 
    Order order3 = new Order();
    order3.setStatus(Order.OrderStatus.ORDERED);
 
    Order order4 = new Order();
    order4.setStatus(Order.OrderStatus.READY);
 
    orderList.add(order1);
    orderList.add(order2);
    orderList.add(order3);
    orderList.add(order4);
 
    EnumMap<Order.OrderStatus,List<Order>> map = Order.groupOrderByStatus(orderList);
    assertTrue(map.get(Order.OrderStatus.DELIVERED).size() == 1);
    assertTrue(map.get(Order.OrderStatus.ORDERED).size() == 2);
    assertTrue(map.get(Order.OrderStatus.READY).size() == 1);
}

实现设计模式:单例和策略

单例

下面的代码段显示了如何使用枚举实现单例模式:

public enum OrderDeliverySystemConfiguration {
    INSTANCE;
    OrderDeliverySystemConfiguration() {
        // Initialization configuration which involves
        // overriding defaults like delivery strategy
    }
 
    private OrderDeliveryStrategy deliveryStrategy = OrderDeliveryStrategy.NORMAL;
 
    public static OrderDeliverySystemConfiguration getInstance() {
        return INSTANCE;
    }
 
    public OrderDeliveryStrategy getDeliveryStrategy() {
        return deliveryStrategy;
    }
}

如何使用:

PizzaDeliveryStrategy deliveryStrategy = PizzaDeliverySystemConfiguration.getInstance().getDeliveryStrategy();

通过 PizzaDeliverySystemConfiguration.getInstance() 获取的就是单例的 PizzaDeliverySystemConfiguration

策略模式

通常,策略模式由不同类实现同一个接口来实现的。

这也就意味着添加新策略意味着添加新的实现类。使用枚举,可以轻松完成此任务,添加新的实现意味着只定义具有某个实现的另一个实例。

下面的代码段显示了如何使用枚举实现策略模式:

public enum PizzaDeliveryStrategy {
    EXPRESS {
        @Override
        public void deliver(Pizza pz) {
            System.out.println("Pizza will be delivered in express mode");
        }
    },
    NORMAL {
        @Override
        public void deliver(Pizza pz) {
            System.out.println("Pizza will be delivered in normal mode");
        }
    };
 
    public abstract void deliver(Pizza pz);
}

给 Order 增加以下方法:

public void deliver() {
    if (isDeliverable()) {
        OrderDeliverySystemConfiguration.getInstance().getDeliveryStrategy()
          .deliver(this);
        this.setStatus(OrderStatus.DELIVERED);
    }
}

如何使用:

@Test
public void test04() {
    Order order = new Order();
    order.setStatus(Order.OrderStatus.READY);
    order.deliver();
    assertTrue(order.getStatus() == Order.OrderStatus.DELIVERED);
}

这里的话 Order.OrderStatus.READY 是一个枚举,重写了其中的默认方法,所以实现了类似多个实现类,实现同一个接口的策略模式;

使用 Lambda 表达式

Order 类可以用Java 8重写,您可以看到方法 lambda 和Stream API如何使 getAllUndeliveredOrders()groupOrderByStatus()方法变得如此简洁:

getAllUndeliveredOrders()

public static List<Order> getAllUndeliveredPizzas(List<Order> input) {
    return input.stream().filter(
      (s) -> !deliveredOrderStatuses.contains(s.getStatus()))
        .collect(Collectors.toList());
}

groupOrderByStatus()

public static EnumMap<OrderStatus, List<Order>> 
  groupOrderByStatus(List<Order> orderList) {
    EnumMap<OrderStatus, List<Order>> map = orderList.stream().collect(
      Collectors.groupingBy(Order::getStatus,
      () -> new EnumMap<>(OrderStatus.class), Collectors.toList()));
    return map;
}

格式化 Enum 类型为 JSON

使用Jackson库,可以将枚举类型的JSON表示为POJO。下面的代码段显示了可以用于同一目的的Jackson批注:

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum OrderStatus {
    ORDERED (5){
        @Override
        public boolean isOrdered() {
            return true;
        }
    },
    READY (2){
        @Override
        public boolean isReady() {
            return true;
        }
    },
    DELIVERED (0){
        @Override
        public boolean isDelivered() {
            return true;
        }
    };
 
    private int timeToDelivery;
 
    public boolean isOrdered() {return false;}
 
    public boolean isReady() {return false;}
 
    public boolean isDelivered(){return false;}
 
    @JsonProperty("timeToDelivery")
    public int getTimeToDelivery() {
        return timeToDelivery;
    }
 
    private OrderStatus (int timeToDelivery) {
        this.timeToDelivery = timeToDelivery;
    }
}

如何使用:

Order order = new Order();
order.setStatus(Order.OrderStatus.APPROED);
System.out.println(new ObjectMapper().writeValueAsString(order));

生成类似下面这种结构:

{
  "status" : {
    "timeToDelivery" : 2,
    "ready" : true,
    "ordered" : false,
    "delivered" : false
  },
  "deliverable" : true
}

作为 Message 或者异常信息枚举

public enum SignType {

    REGISTER(100000, "注册使用"),
    FORGET_PASSWORD(100001, "忘记密码使用"),
    UPDATE_PHONE_NUMBER(100002, "更新手机号码使用");

    private final int code;
    private final String message;

    SignType(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }

    @Override
    public String toString() {
        return "SignType{" +
                "code=" + code +
                ", message='" + message + '\'' +
                '}';
    }
}

如何使用:

System.out.println(SignType.FORGET_PASSWORD.getCode());
System.out.println(SignType.FORGET_PASSWORD.getMessage());
System.out.println(SignType.FORGET_PASSWORD.toString());

输出:

100001
忘记密码使用
PinType{code=100001, message='忘记密码使用'}

相关连接

评论

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×