Question

There are several different ways I can initialize complex objects (with injected dependencies and required set-up of injected members), are all seem reasonable, but have various advantages and disadvantages. I’ll give a concrete example:

final class MyClass {
  private final Dependency dependency;
  @Inject public MyClass(Dependency dependency) {
    this.dependency = dependency;
    dependency.addHandler(new Handler() {
      @Override void handle(int foo) { MyClass.this.doSomething(foo); }
    });
    doSomething(0);
  }
  private void doSomething(int foo) { dependency.doSomethingElse(foo+1); }
}

As you can see, the constructor does 3 things, including calling an instance method. I’ve been told that calling instance methods from a constructor is unsafe because it circumvents the compiler’s checks for uninitialized members. I.e. I could have called doSomething(0) before setting this.dependency, which would have compiled but not worked. What is the best way to refactor this?

1. Make doSomething static and pass in the dependency explicitly? In my actual case I have three instance methods and three member fields that all depend on one another, so this seems like a lot of extra boilerplate to make all three of these static.

2. Move the addHandler and doSomething into an @Inject public void init() method. While use with Guice will be transparent, it requires any manual construction to be sure to call init() or else the object won’t be fully-functional if someone forgets. Also, this exposes more of the API, both of which seem like bad ideas.

3. Wrap a nested class to keep the dependency to make sure it behaves properly without exposing additional API:

   class DependencyManager {
     private final Dependency dependency;
     public DependecyManager(Dependency dependency) { ... }
     public doSomething(int foo) { ... }
   }
   @Inject public MyClass(Dependency dependency) {
     DependencyManager manager = new DependencyManager(dependency);
     manager.doSomething(0);
   }

   This pulls instance methods out of all constructors, but generates an extra layer of classes, and when I already had inner and anonymous classes (e.g. that handler) it can become confusing – when I tried this I was told to move the DependencyManager to a separate file, which is also distasteful because it’s now multiple files to do a single thing.

So what is the preferred way to deal with this sort of situation?

Answer 1

Josh Bloch in Effective Java recommends using a static factory method, although I can’t find any argument for cases like this. There is, however, a similar case in Java Concurrency in Practice, specifically meant to prevent leaking out a reference to this from the constructor. Applied to this case, it would look like:

final class MyClass {
  private final Dependency dependency;

  private MyClass(Dependency dependency) {
    this.dependency = dependency;
  }

  public static createInstance(Dependency dependency) {
    MyClass instance = new MyClass(dependency);
    dependency.addHandler(new Handler() {
      @Override void handle(int foo) { instance.doSomething(foo); }
    });
    instance.doSomething(0);
    return instance;
  }
  ...
}

However, this may not work well with the DI annotation you use.