基于枚举的状态机，状态处理程序的Dagger2注入答案

【问题标题】：Enum-based State Machine, Dagger2 injection of state handler基于枚举的状态机，状态处理程序的Dagger2注入
【发布时间】：2018-07-16 00:48:22
【问题描述】：

我正在尝试创建一个使用枚举来指定状态的状态机。由于有很多状态并且每个状态实现的逻辑都非常复杂，我想将每个状态与将在不同类中定义的状态处理程序相关联。每个状态处理程序都将实现一个公共接口（或扩展一个公共抽象类），但每个状态处理程序都可能有自己的一组注入依赖项，而其他人可能不需要这些依赖项。到目前为止，是这样的......

StateHandler 接口：

public interface StateHandler {
    void onActivation();
    void onDeactivation();
}

StateHandler 示例：

@Singleton
public class DefaultStateHandler implements StateHandler {
    @Inject
    public DefaultStateHandler(SomeDependency someDependency) {...}
    /** implement onActivation, onDeactivation and state specific logic **/
}

@Singleton
public class OtherStateHandler implements StateHandler {
    @Inject
    public OtherStateHandler(SomeOtherDependency someOtherDependency) {...}
    /** implement onActivation, onDeactivation and state specific logic **/
}

StateManager 实现：

@Singleton
public class StateManager {
    private StateType stateType = StateType.DEFAULT;

    @Inject
    public StateManager() { }

    public void changeState(StateType newStateType) {
        if (stateType != newStateType) {
            stateType.getStateHandler().onDeactivation();
            stateType = newStateType;
            stateType.getStateHandler().onActivation();
        }
    }
}

枚举定义：

public enum StateType {
    DEFAULT (/* not sure what to do here */),
    OTHER_STATE (...);

    private StateHandler stateHandlerInstance;
    public getStateHandler { return stateHandlerInstance; }

    StateType(/* not sure what to do here */) {
        /* assign stateHandlerInstance */
    }
}

我想弄清楚的是......在声明关联的枚举时如何注入状态处理程序的特定实例？或者，如果这不可能，是否有另一种方法为每个枚举指定状态处理程序类，然后（在构造函数中或在第一次需要时）获取关联的状态处理程序实例？

【问题讨论】：

你看过@IntoSet和@IntoMap吗？ google.github.io/dagger/multibindings.html
我试过了，但老实说，它超出了我的想象，我什至不确定这是否走在正确的道路上。希望有人能够通过为此用例设计的示例来填补空白。但如果我弄明白了，我会再试一次并发布解决方案！

标签： java enums dagger-2

【解决方案1】：

我最初认为我需要将状态的处理程序实例注入到状态枚举定义中。但是，由于注入需要公共构造函数，而枚举使用私有构造函数，我认为这种方法不可行。

如上面的 cmets 中所述，解决方案是使用 map 多重绑定。

首先简化枚举StateType：

public enum StateType {
    DEFAULT, OTHER_STATE
}

现在我们需要一个特定于这个枚举类型的 Dagger MapKey 接口：

@MapKey
@interface StateTypeKey {
    StateType value();
}

接下来我们需要一个 dagger 模块，该模块将为每个 StateType / StateHandler 组合提供提供者函数：

@Module
public StateTypeHandlersModule {

    // @Provides @IntoMap               // Syntax for dagger >= 2.9
    @Provides(type = Provides.Type.MAP) // Syntax for dagger <= 2.8
    @StateTypeKey(StateType.DEFAULT)
    StateHandler provideDefaultStateHandler(DefaultStateHandler handler) {
        return handler;
    }

    // @Provides @IntoMap               // Syntax for dagger >= 2.9
    @Provides(type = Provides.Type.MAP) // Syntax for dagger <= 2.8
    @StateTypeKey(StateType.OTHER_STATE)
    StateHandler provideOtherStateHandler(OtherStateHandler handler) {
        return handler;
    }

}

不幸的是，它有很多样板代码，这就是为什么我只为处理程序使用单独的模块，并将其包含在更高级别的状态机模块中。请注意，如果您使用相同的 StateTypeKey 声明两个提供程序函数，则第二个处理程序最终在注入的映射中可用。

最后，我们可以将Map<StateType, StateHandler> 注入到 StateManager 中：

@Singleton
public class StateManager {
    private Map<StateType, StateHandler> stateHandlerMap;
    private StateType stateType = StateType.DEFAULT;

    @Inject
    public StateManager(Map<StateType, StateHandler> stateHandlerMap) {
        this.stateHandlerMap = stateHandlerMap;
    }

    public void changeState(StateType newStateType) {
        if (stateType != newStateType) {
            stateHandlerMap.get(stateType).onDeactivation();
            stateType = newStateType;
            stateHandlerMap.get(stateType).onActivation();
        }
    }
}

【讨论】：