检查Java中是否存在枚举

时间:2009-07-22 20:16:45

标签: java string enums compare

无论如何通过将枚举与给定字符串进行比较来检查枚举是否存在?我似乎找不到任何这样的功能。我可以尝试使用valueOf方法并捕获异常但我被教导过捕获运行时异常并不是一种好的做法。有人有什么想法吗?

9 个答案:

答案 0 :(得分:61)

如果我需要这样做,我有时会建立一个Set<String>名称,甚至是我自己的Map<String,MyEnum> - 那么你可以检查一下。

值得注意的几点:

  • 在静态初始值设定项中填充任何此类静态集合。 不要使用变量初始化程序,然后依赖它在枚举构造函数运行时执行 - 它不会! (在静态初始化程序之前,枚举构造函数是第一个要执行的东西。)
  • 尽量避免经常使用values() - 每次都必须创建并填充新数组。要迭代所有元素,请使用EnumSet.allOf,这对于没有大量元素的枚举更有效。

示例代码:

import java.util.*;

enum SampleEnum {
    Foo,
    Bar;

    private static final Map<String, SampleEnum> nameToValueMap =
        new HashMap<String, SampleEnum>();

    static {
        for (SampleEnum value : EnumSet.allOf(SampleEnum.class)) {
            nameToValueMap.put(value.name(), value);
        }
    }

    public static SampleEnum forName(String name) {
        return nameToValueMap.get(name);
    }
}

public class Test {
    public static void main(String [] args)
        throws Exception { // Just for simplicity!
        System.out.println(SampleEnum.forName("Foo"));
        System.out.println(SampleEnum.forName("Bar"));
        System.out.println(SampleEnum.forName("Baz"));
    }
}

当然,如果你只有几个名字,这可能有点过分 - 当n足够小时,O(n)解决方案通常胜过O(1)解决方案。这是另一种方法:

import java.util.*;

enum SampleEnum {
    Foo,
    Bar;

    // We know we'll never mutate this, so we can keep
    // a local copy.
    private static final SampleEnum[] copyOfValues = values();

    public static SampleEnum forName(String name) {
        for (SampleEnum value : copyOfValues) {
            if (value.name().equals(name)) {
                return value;
            }
        }
        return null;
    }
}

public class Test {
    public static void main(String [] args)
        throws Exception { // Just for simplicity!
        System.out.println(SampleEnum.forName("Foo"));
        System.out.println(SampleEnum.forName("Bar"));
        System.out.println(SampleEnum.forName("Baz"));
    }
}

答案 1 :(得分:46)

我认为没有内置的方法可以在不捕获异常的情况下执行此操作。你可以改用这样的东西:

public static MyEnum asMyEnum(String str) {
    for (MyEnum me : MyEnum.values()) {
        if (me.name().equalsIgnoreCase(str))
            return me;
    }
    return null;
}

编辑:正如Jon Skeet所说,values()每次调用时都会克隆一个私有后备数组。如果性能至关重要,您可能只需要调用values()一次,缓存数组并迭代它。

此外,如果您的枚举值具有大量值,则Jon Skeet的地图替代方案可能比任何数组迭代都更好。

答案 2 :(得分:34)

我最喜欢的lib之一:Apache Commons。

EnumUtils可以很容易地做到这一点。

以下示例验证具有该库的Enum:

public enum MyEnum {
    DIV("div"), DEPT("dept"), CLASS("class");

    private final String val;

    MyEnum(String val) {
    this.val = val;
    }

    public String getVal() {
    return val;
    }
}


MyEnum strTypeEnum = null;

// test if String str is compatible with the enum 
// e.g. if you pass str = "div", it will return false. If you pass "DIV", it will return true.
if( EnumUtils.isValidEnum(MyEnum.class, str) ){
    strTypeEnum = MyEnum.valueOf(str);
}

答案 3 :(得分:6)

我不知道为什么有人告诉你捕捉运行时异常是坏事。

使用valueOf并抓取IllegalArgumentException可以将字符串转换/检查为枚举。

答案 4 :(得分:5)

根据Jon Skeet的回答,我做了一个允许在工作中轻松完成的课程:

import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;

import java.util.EnumSet;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

/**
 * <p>
 * This permits to easily implement a failsafe implementation of the enums's valueOf
 * Better use it inside the enum so that only one of this object instance exist for each enum...
 * (a cache could solve this if needed)
 * </p>
 *
 * <p>
 * Basic usage exemple on an enum class called MyEnum:
 *
 *   private static final FailSafeValueOf<MyEnum> FAIL_SAFE = FailSafeValueOf.create(MyEnum.class);
 *   public static MyEnum failSafeValueOf(String enumName) {
 *       return FAIL_SAFE.valueOf(enumName);
 *   }
 *
 * </p>
 *
 * <p>
 * You can also use it outside of the enum this way:
 *   FailSafeValueOf.create(MyEnum.class).valueOf("EnumName");
 * </p>
 *
 * @author Sebastien Lorber <i>(lorber.sebastien@gmail.com)</i>
 */
public class FailSafeValueOf<T extends Enum<T>> {

    private final Map<String,T> nameToEnumMap;

    private FailSafeValueOf(Class<T> enumClass) {
        Map<String,T> map = Maps.newHashMap();
        for ( T value : EnumSet.allOf(enumClass)) {
            map.put( value.name() , value);
        }
        nameToEnumMap = ImmutableMap.copyOf(map);
    }

    /**
     * Returns the value of the given enum element
     * If the 
     * @param enumName
     * @return
     */
    public T valueOf(String enumName) {
        return nameToEnumMap.get(enumName);
    }

    public static <U extends Enum<U>> FailSafeValueOf<U> create(Class<U> enumClass) {
        return new FailSafeValueOf<U>(enumClass);
    }

}

单元测试:

import org.testng.annotations.Test;

import static org.testng.Assert.*;


/**
 * @author Sebastien Lorber <i>(lorber.sebastien@gmail.com)</i>
 */
public class FailSafeValueOfTest {

    private enum MyEnum {
        TOTO,
        TATA,
        ;

        private static final FailSafeValueOf<MyEnum> FAIL_SAFE = FailSafeValueOf.create(MyEnum.class);
        public static MyEnum failSafeValueOf(String enumName) {
            return FAIL_SAFE.valueOf(enumName);
        }
    }

    @Test
    public void testInEnum() {
        assertNotNull( MyEnum.failSafeValueOf("TOTO") );
        assertNotNull( MyEnum.failSafeValueOf("TATA") );
        assertNull( MyEnum.failSafeValueOf("TITI") );
    }

    @Test
    public void testInApp() {
        assertNotNull( FailSafeValueOf.create(MyEnum.class).valueOf("TOTO") );
        assertNotNull( FailSafeValueOf.create(MyEnum.class).valueOf("TATA") );
        assertNull( FailSafeValueOf.create(MyEnum.class).valueOf("TITI") );
    }

}

请注意,我使用Guava制作了一个ImmutableMap,但实际上你可以使用一个普通的地图我认为因为地图永远不会被返回...

答案 5 :(得分:3)

大多数答案都建议使用带有等于的循环来检查枚举是否存在,或者使用带有enum.valueOf()的try / catch。我想知道哪种方法更快并尝试了。我不擅长基准测试,所以如果我犯了任何错误,请纠正我。

这是我主要课程的代码:

    package enumtest;

public class TestMain {

    static long timeCatch, timeIterate;
    static String checkFor;
    static int corrects;

    public static void main(String[] args) {
        timeCatch = 0;
        timeIterate = 0;
        TestingEnum[] enumVals = TestingEnum.values();
        String[] testingStrings = new String[enumVals.length * 5];
        for (int j = 0; j < 10000; j++) {
            for (int i = 0; i < testingStrings.length; i++) {
                if (i % 5 == 0) {
                    testingStrings[i] = enumVals[i / 5].toString();
                } else {
                    testingStrings[i] = "DOES_NOT_EXIST" + i;
                }
            }

            for (String s : testingStrings) {
                checkFor = s;
                if (tryCatch()) {
                    ++corrects;
                }
                if (iterate()) {
                    ++corrects;
                }
            }
        }

        System.out.println(timeCatch / 1000 + "us for try catch");
        System.out.println(timeIterate / 1000 + "us for iterate");
        System.out.println(corrects);
    }

    static boolean tryCatch() {
        long timeStart, timeEnd;
        timeStart = System.nanoTime();
        try {
            TestingEnum.valueOf(checkFor);
            return true;
        } catch (IllegalArgumentException e) {
            return false;
        } finally {
            timeEnd = System.nanoTime();
            timeCatch += timeEnd - timeStart;
        }

    }

    static boolean iterate() {
        long timeStart, timeEnd;
        timeStart = System.nanoTime();
        TestingEnum[] values = TestingEnum.values();
        for (TestingEnum v : values) {
            if (v.toString().equals(checkFor)) {
                timeEnd = System.nanoTime();
                timeIterate += timeEnd - timeStart;
                return true;
            }
        }
        timeEnd = System.nanoTime();
        timeIterate += timeEnd - timeStart;
        return false;
    }
}

这意味着,每个方法运行的枚举长度是50000倍 我多次运行此测试,使用10,20,50和100枚枚举常量。 结果如下:

  • 10:尝试/捕获:760ms |迭代:62ms
  • 20:try / catch:1671ms |迭代:177ms
  • 50:尝试/捕获:3113ms |迭代:488ms
  • 100:try / catch:6834ms |迭代:1760ms

这些结果并不准确。再次执行时,结果差异高达10%,但它们足以表明try / catch方法效率低得多,尤其是对于小枚举。

答案 6 :(得分:2)

从Java 8开始,我们可以使用streams而不是for循环。此外,如果枚举没有具有此类名称的实例,则返回Optional可能是合适的。

关于如何查找枚举,我提出了以下三种选择:

private enum Test {
    TEST1, TEST2;

    public Test fromNameOrThrowException(String name) {
        return Arrays.stream(values())
                .filter(e -> e.name().equals(name))
                .findFirst()
                .orElseThrow(() -> new IllegalArgumentException("No enum with name " + name));
    }

    public Test fromNameOrNull(String name) {
        return Arrays.stream(values()).filter(e -> e.name().equals(name)).findFirst().orElse(null);
    }

    public Optional<Test> fromName(String name) {
        return Arrays.stream(values()).filter(e -> e.name().equals(name)).findFirst();
    }
}

答案 7 :(得分:1)

您也可以使用Guava并执行以下操作:

// This method returns enum for a given string if it exists, otherwise it returns default enum.
private MyEnum getMyEnum(String enumName) {
  // It is better to return default instance of enum instead of null
  return hasMyEnum(enumName) ? MyEnum.valueOf(enumName) : MyEnum.DEFAULT;
}

// This method checks that enum for a given string exists.
private boolean hasMyEnum(String enumName) {
  return Iterables.any(Arrays.asList(MyEnum.values()), new Predicate<MyEnum>() {
    public boolean apply(MyEnum myEnum) {
      return myEnum.name().equals(enumName);
    }
  }); 
}

在第二种方法中,我使用guava(Google Guava)库,它提供了非常有用的 Iterables 类。使用 Iterables.any()方法,我们可以检查列表对象中是否存在给定值。此方法需要两个参数:列表和谓词对象。首先,我使用 Arrays.asList()方法创建包含所有枚举的列表。之后我创建了新的 Predicate 对象,用于检查给定元素(在我们的例子中是枚举)是否满足 apply 方法中的条件。如果发生这种情况,方法 Iterables.any()将返回true值。

答案 8 :(得分:1)

只需使用valueOf()方法。如果该值不存在,它将引发IllegalArgumentException,您可以像这样捕获它:

      boolean isSettingCodeValid = true;

       try {
            SettingCode.valueOf(settingCode.toUpperCase());
        } catch (IllegalArgumentException e) {
            // throw custom exception or change the isSettingCodeValid value
            isSettingCodeValid = false;
        }