阿里云-云小站（无限量代金券发放中）
【腾讯云】云服务器、云数据库、COS、CDN、短信等热卖云产品特惠抢购

几种Java 枚举查找且不抛异常的实现及其优劣比较

95次阅读
没有评论

共计 10993 个字符，预计需要花费 28 分钟才能阅读完成。

导读 Java Enum 是一个非常有用的功能，但很多人通常并不能充分利用，这是因为一些库不会优先择用该功能。通常我们也可以正确使用 Java 枚举功能，但在许多代码库中往往存在着这样一个问题，于是有了这篇文章。问题很简单：我们应该如何通过名称或值获取枚举，并忽略不存在的值？
枚举

这是我们将在示例中使用的枚举。挑选更复杂的枚举是为了也可以通过其他字段展示查找枚举。

public enum CardColor {
    RED,
    BLACK,
    ;
}
// Jackson annotation to print the enum as an Object instead of the default name.
@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum CardSuit {
    // Unicode suits - https://en.wikipedia.org/wiki/Playing_cards_in_Unicode
    SPADE("Spade", String.valueOf((char) 0x2660), CardColor.BLACK),
    HEART("Heart", String.valueOf((char) 0x2665), CardColor.RED),
    DIAMOND("Diamond", String.valueOf((char) 0x2666), CardColor.RED),
    CLUB("Club", String.valueOf((char) 0x2663), CardColor.BLACK),
    ;
    private String displayName;
    private String symbol;
    private CardColor color;
    private CardSuit(String displayName, String symbol, CardColor color) {
        this.displayName = displayName;
        this.symbol =  symbol;
        this.color = color;
    }
    public String getDisplayName() {return displayName;}
    public void setDisplayName(String displayName) {this.displayName = displayName;}
    public String getSymbol() {return symbol;}
    public void setSymbol(String symbol) {this.symbol = symbol;}
    public CardColor getColor() {return color;}
    public void setColor(CardColor color) {this.color = color;}

在 GitHub 上查看。

问题

在你知道输入有效的时候，使用 Enum.valueOf 非常棒。但是，如果传入无效的名称，那么将抛出异常。在某些情况下，这很好。不过，在通常情况下，我们宁愿忽略异常并返回 null。

log.debug("Running valueOf");
for (String name : names) {
    try {log.debug("looking up {} found {}", name, Json.serializer().toString(CardSuit.valueOf(name)));
    } catch (Exception ex) {log.warn("Exception Thrown", ex);
    }
}

 

2017-02-22 14:46:38.556 [main] DEBUG c.s.examples.common.EnumLookup - Running valueOf
2017-02-22 14:46:38.804 [main] DEBUG c.s.examples.common.EnumLookup - looking up SPADE found {"displayName":"Spade","symbol":"♠","color":"BLACK"}
2017-02-22 14:46:38.806 [main] DEBUG c.s.examples.common.EnumLookup - looking up HEART found {"displayName":"Heart","symbol":"♥","color":"RED"}
2017-02-22 14:46:38.806 [main] DEBUG c.s.examples.common.EnumLookup - looking up DIAMOND found {"displayName":"Diamond","symbol":"♦","color":"RED"}
2017-02-22 14:46:38.806 [main] DEBUG c.s.examples.common.EnumLookup - looking up CLUB found {"displayName":"Club","symbol":"♣","color":"BLACK"}
2017-02-22 14:46:38.808 [main] WARN  c.s.examples.common.EnumLookup - Exception Thrown
java.lang.IllegalArgumentException: No enum constant com.stubbornjava.examples.common.EnumLookup.CardSuit.Missing
  at java.lang.Enum.valueOf(Enum.java:238)
  at com.stubbornjava.examples.common.EnumLookup$CardSuit.valueOf(EnumLookup.java:1)
  at com.stubbornjava.examples.common.EnumLookup.main(EnumLookup.java:154)
拙劣的实现

很不幸的是，以下两种方法在代码库中出现得是这么的频繁。反面例子，勿学。

Enum.valueOf With Try Catch（劣）

这种拙劣的做法最常见于初学者。异常不应该用于控制流，并且这样可能会有一些性能影响。不要偷懒。你必须用正确的方式去做。

/*
 * Please don't do this! Using try / catch for
 * control flow is a bad practice.
 */
public static CardSuit trycatchValueOf(String name) {
    try {return CardSuit.valueOf(name);
    } catch (Exception ex) {log.warn("Exception Thrown", ex);
        return null;
    }
}

 

log.debug("Running trycatchValueOf");
for (String name : names) {log.debug("looking up {} found {}", name, Json.serializer().toString(CardSuit.trycatchValueOf(name)));
}

 

2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - Running trycatchValueOf
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - looking up SPADE found {"displayName":"Spade","symbol":"♠","color":"BLACK"}
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - looking up HEART found {"displayName":"Heart","symbol":"♥","color":"RED"}
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - looking up DIAMOND found {"displayName":"Diamond","symbol":"♦","color":"RED"}
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - looking up CLUB found {"displayName":"Club","symbol":"♣","color":"BLACK"}
2017-02-22 14:46:38.809 [main] WARN  c.s.examples.common.EnumLookup - Exception Thrown
java.lang.IllegalArgumentException: No enum constant com.stubbornjava.examples.common.EnumLookup.CardSuit.Missing
  at java.lang.Enum.valueOf(Enum.java:238)
  at com.stubbornjava.examples.common.EnumLookup$CardSuit.valueOf(EnumLookup.java:1)
  at com.stubbornjava.examples.common.EnumLookup$CardSuit.trycatchValueOf(EnumLookup.java:89)
  at com.stubbornjava.examples.common.EnumLookup.main(EnumLookup.java:171)
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - looking up Missing found null
通过迭代查找（劣）

这种方法也很常见（见这里），但至少程序员知道不能用 try/catch 来捕获异常。那么，这种方法有什么问题呢？没错，它会迭代所有枚举，直到找到匹配的枚举或返回 null——最坏的情况下需要 n 次，其中 n 就是枚举值的数量。有些人可能会认为这微不足道，这是过早优化了而已。但是，数据结构和算法是 CS 基础。使用 Map 而不是迭代集合要省力得多。这会大大提高性能吗？不，但它是一个很好的习惯。在面试候选人时，你会对线性复杂度搜索算法感到满意吗？此时，你不应该让这样的代码审查通过。

/*
 * Please don't do this! It is inefficient and it's
 * not very hard to use Guava or a static Map as an index.
 */
public static CardSuit iterationFindByName(String name) {for (CardSuit suit : CardSuit.values()) {if (name.equals(suit.name())) {return suit;}
    }
    return null;
}

 

log.debug("Running iteration");
for (String name : names) {log.debug("looking up {} found {}", name, Json.serializer().toString(CardSuit.iterationFindByName(name)));
}

 

2017-02-22 14:46:38.808 [main] DEBUG c.s.examples.common.EnumLookup - Running iteration
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - looking up SPADE found {"displayName":"Spade","symbol":"♠","color":"BLACK"}
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - looking up HEART found {"displayName":"Heart","symbol":"♥","color":"RED"}
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - looking up DIAMOND found {"displayName":"Diamond","symbol":"♦","color":"RED"}
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - looking up CLUB found {"displayName":"Club","symbol":"♣","color":"BLACK"}
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - looking up Missing found null
较优的实现

以下都可以通过使用 Map 形式的索引起作用。但是，它们之间也有一些细微的差别。

静态 Map 索引（较优）

用于快速查找固定大小的正确数据结构是什么？那就是 HashMap。现在通过一些额外的样板，只要我们有很好的散列函数的话，我们就可以进行更有效的查找。稍微更冗长，但如果有办法减少样板的话，这将是极好的。

private static final Map<String, CardSuit> nameIndex =
        Maps.newHashMapWithExpectedSize(CardSuit.values().length);
static {for (CardSuit suit : CardSuit.values()) {nameIndex.put(suit.name(), suit);
    }
}
public static CardSuit lookupByName(String name) {return nameIndex.get(name);
}
log.debug("Running lookupByName");
for (String name : names) {log.debug("looking up {} found {}", name, Json.serializer().toString(CardSuit.lookupByName(name)));
}
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - Running lookupByName
2017-02-22 14:46:38.809 [main] DEBUG c.s.examples.common.EnumLookup - looking up SPADE found {"displayName":"Spade","symbol":"♠","color":"BLACK"}
2017-02-22 14:46:38.810 [main] DEBUG c.s.examples.common.EnumLookup - looking up HEART found {"displayName":"Heart","symbol":"♥","color":"RED"}
2017-02-22 14:46:38.810 [main] DEBUG c.s.examples.common.EnumLookup - looking up DIAMOND found {"displayName":"Diamond","symbol":"♦","color":"RED"}
2017-02-22 14:46:38.813 [main] DEBUG c.s.examples.common.EnumLookup - looking up CLUB found {"displayName":"Club","symbol":"♣","color":"BLACK"}
2017-02-22 14:46:38.813 [main] DEBUG c.s.examples.common.EnumLookup - looking up Missing found null
Guava Enums.getIfPresent（推荐）

这是一个常见的用例，我们在 Google 的朋友为此提供了一个非常干净且无需样板的解决方案。探其究竟，它甚至使用了 WeakReferences 和 WeakHashMaps。基本说来，这段代码将创建一个全局的静态地图，并以 Enum 的类名称键入，并将其用于查找。

public static CardSuit getIfPresent(String name) {return Enums.getIfPresent(CardSuit.class, name).orNull();}
log.debug("Running Guava getIfPresent");
for (String name : names) {log.debug("looking up {} found {}", name, Json.serializer().toString(CardSuit.getIfPresent(name)));
}
2017-02-22 14:46:38.813 [main] DEBUG c.s.examples.common.EnumLookup - Running Guava getIfPresent
2017-02-22 14:46:38.814 [main] DEBUG c.s.examples.common.EnumLookup - looking up SPADE found {"displayName":"Spade","symbol":"♠","color":"BLACK"}
2017-02-22 14:46:38.814 [main] DEBUG c.s.examples.common.EnumLookup - looking up HEART found {"displayName":"Heart","symbol":"♥","color":"RED"}
2017-02-22 14:46:38.815 [main] DEBUG c.s.examples.common.EnumLookup - looking up DIAMOND found {"displayName":"Diamond","symbol":"♦","color":"RED"}
2017-02-22 14:46:38.815 [main] DEBUG c.s.examples.common.EnumLookup - looking up CLUB found {"displayName":"Club","symbol":"♣","color":"BLACK"}
2017-02-22 14:46:38.815 [main] DEBUG c.s.examples.common.EnumLookup - looking up Missing found null
通过字段的进一步索引

这个完全相同的方法可以用于枚举的其他字段。想要通过其显示的名称或其他属性来查找枚举并不少见。

通过字段索引的静态 Map（较优）

与上述相同的方法，但是在显示名称上而不是枚举名称上进行索引。

private static final Map<String, CardSuit> displayNameIndex =
        Maps.newHashMapWithExpectedSize(CardSuit.values().length);
static {for (CardSuit suit : CardSuit.values()) {displayNameIndex.put(suit.getDisplayName(), suit);
    }
}
public static CardSuit lookupByDisplayName(String name) {return displayNameIndex.get(name);
}
log.debug("Running lookupByDisplayName");
for (String displayName : displayNames) {log.debug("looking up {} found {}", displayName, Json.serializer().toString(CardSuit.lookupByDisplayName(displayName)));
}

 

2017-02-22 14:46:38.815 [main] DEBUG c.s.examples.common.EnumLookup - Running lookupByDisplayName
2017-02-22 14:46:38.815 [main] DEBUG c.s.examples.common.EnumLookup - looking up Spade found {"displayName":"Spade","symbol":"♠","color":"BLACK"}
2017-02-22 14:46:38.815 [main] DEBUG c.s.examples.common.EnumLookup - looking up Heart found {"displayName":"Heart","symbol":"♥","color":"RED"}
2017-02-22 14:46:38.815 [main] DEBUG c.s.examples.common.EnumLookup - looking up Diamond found {"displayName":"Diamond","symbol":"♦","color":"RED"}
2017-02-22 14:46:38.816 [main] DEBUG c.s.examples.common.EnumLookup - looking up Club found {"displayName":"Club","symbol":"♣","color":"BLACK"}
2017-02-22 14:46:38.816 [main] DEBUG c.s.examples.common.EnumLookup - looking up Missing found null
通过字段索引的静态 Map（较优）

我们不能在这里利用 Guava，因为对于静态索引创建唯一的全局密钥将是一件困难的事。但是，这并不意味着我们没有帮手！

public class EnumUtils {public static <T, E extends Enum<E>> Function<T, E> lookupMap(Class<E> clazz, Function<E, T> mapper) {@SuppressWarnings("unchecked")
        E[] emptyArray = (E[]) Array.newInstance(clazz, 0);
        return lookupMap(EnumSet.allOf(clazz).toArray(emptyArray), mapper);
    }
    public static <T, E extends Enum<E>> Function<T, E> lookupMap(E[] values, Function<E, T> mapper) {Map<T, E> index = Maps.newHashMapWithExpectedSize(values.length);
        for (E value : values) {index.put(mapper.apply(value), value);
        }
        return (T key) -> index.get(key);
    }
}

 

现在我们有了一个相与样板没多大关联的通用解决方案。

private static final Function<String, CardSuit> func =
        EnumUtils.lookupMap(CardSuit.class, e -> e.getDisplayName());
public static CardSuit lookupByDisplayNameUtil(String name) {return func.apply(name);
}
log.debug("Running lookupByDisplayNameUtil");
for (String displayName : displayNames) {log.debug("looking up {} found {}", displayName, Json.serializer().toString(CardSuit.lookupByDisplayNameUtil(displayName)));
}
2017-02-22 14:46:38.816 [main] DEBUG c.s.examples.common.EnumLookup - Running lookupByDisplayNameUtil
2017-02-22 14:46:38.816 [main] DEBUG c.s.examples.common.EnumLookup - looking up Spade found {"displayName":"Spade","symbol":"♠","color":"BLACK"}
2017-02-22 14:46:38.816 [main] DEBUG c.s.examples.common.EnumLookup - looking up Heart found {"displayName":"Heart","symbol":"♥","color":"RED"}
2017-02-22 14:46:38.816 [main] DEBUG c.s.examples.common.EnumLookup - looking up Diamond found {"displayName":"Diamond","symbol":"♦","color":"RED"}
2017-02-22 14:46:38.816 [main] DEBUG c.s.examples.common.EnumLookup - looking up Club found {"displayName":"Club","symbol":"♣","color":"BLACK"}
2017-02-22 14:46:38.816 [main] DEBUG c.s.examples.common.EnumLookup - looking up Missing found null
结论

这里有若干方法都可用于解决同一个问题。有些拙劣，有些更优。

英文原文：Java Enum Lookup by Name or Field Without Throwing Exceptions

翻译作者：码农网 – 小峰

阿里云 2 核 2G 服务器 3M 带宽 61 元 1 年，有高配

腾讯云新客低至 82 元 / 年，老客户 99 元 / 年

代金券：在阿里云专用满减优惠券

正文完
星哥玩云-微信公众号
post-qrcode
Linux linux命令 linux命令大全 Linux操作系统 linux教程 linux系统
发表至： linux教程
2024-07-24
 0
星锅
版权声明：本站原创文章，由 星锅 于2024-07-24发表，共计10993字。
转载说明：除特殊说明外本站文章皆由CC-4.0协议发布，转载请注明出处。
【腾讯云】推广者专属福利，新客户无门槛领取总价值高达2860元代金券，每种代金券限量500张，先到先得。
在 Linux 上用 dust 代替 du更直观
Linux运维工程师都在用的运维工具有哪些?
虚拟化与KVM介绍
学习Rust 面向对象
干货：基于nginx的tcp反向代理案例
linux 系统tar文件压缩打包命令
表与表之间关系
简单了解如何自己动手制作RPM包
阿里云-最新活动爆款每日限量供应
评论（没有评论）
验证码
星哥说事
星哥说事
分享互联网知识
阅读量
3983912
评论数
4
文章搜索
热门文章
开源堡垒机JumpServer配置教程：使用步骤与配置

开源堡垒机JumpServer配置教程：使用步骤与配置

开源堡垒机 JumpServer 配置教程：使用步骤与配置 上一篇文章星哥讲了如何安装 JumpServer ...
申请腾讯混元的API Key并且使用LobeChat调用混元AI

申请腾讯混元的API Key并且使用LobeChat调用混元AI

申请腾讯混元的 API Key 并且使用 LobeChat 调用混元 AI 之前星哥写了一篇文章《手把手教拥有...
系统加固-Linux不允许用户使用密码登录，只能使用密钥登录

系统加固-Linux不允许用户使用密码登录，只能使用密钥登录

一、密码登录的安全隐患 传统的密码登录方式，尽管简单直接，却存在诸多安全隐患。首先，密码本身容易被猜测或通过暴...
【开源安全保护】如何安装JumpServer堡垒机

【开源安全保护】如何安装JumpServer堡垒机

【开源安全保护】如何安装 JumpServer 堡垒机 什么是堡垒机 大家好，我是星哥，今天我以前来认识堡垒机...
基于Docker快速搭建一个开源的IT人员在线工具箱-it-tools

基于Docker快速搭建一个开源的IT人员在线工具箱-it-tools

基于 Docker 快速搭建一个开源的 IT 人员在线工具箱 -it-tools 在日常的开发工作中，我们经常...
CDN
阿里云CDN-提高用户访问的响应速度和成功率
随机文章
shell字符串比较、判断是否为数字入门案例

shell字符串比较、判断是否为数字入门案例

二元比较操作符, 比较变量或者比较数字. 注意数字与字符串的区别。 整数比较 -eq 等于, 如:if ["$...
路由器改装git服务器之路

路由器改装git服务器之路

导读 在单位中，通常都标配了 git 服务器用来管理代码。对于家庭或者小办公室，这种方式有点不经济。当然如果是...
腾讯云服务器购买价格查询系统（CPU内存配置一键报价入口）

腾讯云服务器购买价格查询系统（CPU内存配置一键报价入口）

腾讯云服务器购买价格查询系统入口 https://curl.qcloud.com/PPrF9NFe 优惠全站搜...
几种负载均衡的算法原理及代码实现

几种负载均衡的算法原理及代码实现

导读 轮询算法：将接收到的请求依次转发到后端服务器上，它均衡对待（一视同仁）所有服务器，而不关心当前服务器实际...
别再说人工智能、deepseek不好用了，那是你不会这样用，赶紧收藏起来！

别再说人工智能、deepseek不好用了，那是你不会这样用，赶紧收藏起来！

别再说人工智能、deepseek 不好用了，那是你不会这样用，赶紧收藏起来！ 近年来，人工智能（AI）和 De...
一言一句话
-「」
【腾讯云】云服务器、云数据库、COS、CDN、短信等云产品特惠热卖中