java - 为什么 Guava Enums.ifPresent 在后台使用同步？

Question

Guava 的 Enums.ifPresent(Class, String) 在后台调用 Enums.getEnumConstants:

@GwtIncompatible // java.lang.ref.WeakReference
static <T extends Enum<T>> Map<String, WeakReference<? extends Enum<?>>> getEnumConstants(
Class<T> enumClass) {
    synchronized (enumConstantCache) {
        Map<String, WeakReference<? extends Enum<?>>> constants = enumConstantCache.get(enumClass);
        if (constants == null) {
            constants = populateCache(enumClass);
        }
        return constants;
    }
}

为什么需要同步块(synchronized block)？这不会导致严重性能损失吗？ Java 的 Enum.valueOf(Class, String) 似乎不需要一个。更进一步，如果确实需要同步，为什么这样做效率如此低下？人们希望如果枚举存在于缓存中，则可以在不锁定的情况下检索它。只有在需要填充缓存时才锁定。

供引用:Maven 依赖

<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>23.2-jre</version>
</dependency>

编辑:通过锁定，我指的是双重检查锁。

Answer 1

我已经接受了@maaartinus 的回答，但想写一个单独的“答案”来说明问题背后的情况以及它把我带到的有趣的兔子洞。

tl;dr - Use Java's Enum.valueOf which is thread safe and does not sync unlike Guava's Enums.ifPresent. Also in majority of cases it probably doesn't matter.

长话短说:

我正在开发一个利用轻量级 Java 线程的代码库 Quasar Fibers .为了利用纤程的力量，它们运行的​​代码应该主要是异步和非阻塞的，因为纤程被多路复用到 Java/OS 线程。单个纤程不会“阻塞”底层线程变得非常重要。如果底层线程被阻塞，它将阻塞在其上运行的所有纤程，并且性能会大大降低。 Guava 的 Enums.ifPresent 就是其中之一，我确信它是可以避免的。

最初，我开始使用 Guava 的 Enums.ifPresent，因为它在无效的枚举值上返回 null。与抛出 IllegalArgumentException 的 Java Enum.valueOf 不同(在我看来，这不如 null 值可取)。

这是一个比较各种转换为枚举的方法的粗略基准:

1. Java 的 Enum.valueOf 捕获 IllegalArgumentException 以返回 null
2. Guava 的 Enums.ifPresent
3. Apache Commons Lang EnumUtils.getEnum
4. Apache Commons Lang 3 EnumUtils.getEnum
5. 我自己的自定义不可变 map 查找

注意事项:

• Apache Common Lang 3 在底层使用 Java 的 Enum.valueOf，因此是相同的
• 早期版本的 Apache Common Lang 使用与 Guava 非常相似的 WeakHashMap 解决方案，但不使用同步。他们喜欢廉价的读取和更昂贵的写入(我的下意识 react 说这就是 Guava 应该做的)
• Java 抛出 IllegalArgumentException 的决定在处理无效枚举值时可能会产生很小的相关成本。抛出/捕获异常不是免费的。
• Guava 是这里唯一使用同步的方法

基准设置:

• 使用具有 10 个线程的固定线程池的 ExecutorService
• 提交 100K Runnable 任务来转换枚举
• 每个 Runnable 任务转换 100 个枚举
• 每个转换枚举的方法将转换 1000 万个字符串 (100K x 100)

运行的基准结果:

Convert valid enum string value:
    JAVA -> 222 ms
    GUAVA -> 964 ms
    APACHE_COMMONS_LANG -> 138 ms
    APACHE_COMMONS_LANG3 -> 149 ms
    MY_OWN_CUSTOM_LOOKUP -> 160 ms

Try to convert INVALID enum string value:
    JAVA -> 6009 ms
    GUAVA -> 734 ms
    APACHE_COMMONS_LANG -> 65 ms
    APACHE_COMMONS_LANG3 -> 5558 ms
    MY_OWN_CUSTOM_LOOKUP -> 92 ms

这些数字应该与大量盐一起使用，并且会根据其他因素而改变。但它们足以让我决定采用 Java 的代码库解决方案，使用 Fibers。

基准代码:

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

import com.google.common.base.Enums;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableMap.Builder;

public class BenchmarkEnumValueOf {

    enum Strategy {
        JAVA,
        GUAVA,
        APACHE_COMMONS_LANG,
        APACHE_COMMONS_LANG3,
        MY_OWN_CUSTOM_LOOKUP;

        private final static ImmutableMap<String, Strategy> lookup;

        static {
            Builder<String, Strategy> immutableMapBuilder = ImmutableMap.builder();
            for (Strategy strategy : Strategy.values()) {
                immutableMapBuilder.put(strategy.name(), strategy);
            }

            lookup = immutableMapBuilder.build();
        }

        static Strategy toEnum(String name) {
            return name != null ? lookup.get(name) : null;
        }
    }

    public static void main(String[] args) {
        final int BENCHMARKS_TO_RUN = 1;

        System.out.println("Convert valid enum string value:");
        for (int i = 0; i < BENCHMARKS_TO_RUN; i++) {
            for (Strategy strategy : Strategy.values()) {
                runBenchmark(strategy, "JAVA", 100_000);
            }
        }

        System.out.println("\nTry to convert INVALID enum string value:");
        for (int i = 0; i < BENCHMARKS_TO_RUN; i++) {
            for (Strategy strategy : Strategy.values()) {
                runBenchmark(strategy, "INVALID_ENUM", 100_000);
            }
        }
    }

    static void runBenchmark(Strategy strategy, String enumStringValue, int iterations) {
        ExecutorService executorService = Executors.newFixedThreadPool(10);

        long timeStart = System.currentTimeMillis();

        for (int i = 0; i < iterations; i++) {
            executorService.submit(new EnumValueOfRunnable(strategy, enumStringValue));
        }

        executorService.shutdown();

        try {
            executorService.awaitTermination(1000, TimeUnit.SECONDS);
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }

        long timeDuration = System.currentTimeMillis() - timeStart;

        System.out.println("\t" + strategy.name() + " -> " + timeDuration + " ms");
    }

    static class EnumValueOfRunnable implements Runnable {

        Strategy strategy;
        String enumStringValue;

        EnumValueOfRunnable(Strategy strategy, String enumStringValue) {
            this.strategy = strategy;
            this.enumStringValue = enumStringValue;
        }

        @Override
        public void run() {
            for (int i = 0; i < 100; i++) {
                switch (strategy) {
                    case JAVA:
                        try {
                            Enum.valueOf(Strategy.class, enumStringValue);
                        } catch (IllegalArgumentException e) {}
                        break;
                    case GUAVA:
                        Enums.getIfPresent(Strategy.class, enumStringValue);
                        break;
                    case APACHE_COMMONS_LANG:
                        org.apache.commons.lang.enums.EnumUtils.getEnum(Strategy.class, enumStringValue);
                        break;
                    case APACHE_COMMONS_LANG3:
                        org.apache.commons.lang3.EnumUtils.getEnum(Strategy.class, enumStringValue);
                        break;
                    case MY_OWN_CUSTOM_LOOKUP:
                        Strategy.toEnum(enumStringValue);
                        break;
                }
            }
        }
    }

}