Object Mentor Blog: Injecting Those Dependencies

Injecting Those Dependencies

Brett Schuchert — Mon, 22 Mar 2010 16:00:00 -0500

Last week I was teaching a class with a good group of C++ developers in Chicago. They were up on C++, current standardization efforts, virtual machines, performance analysis and tuning. At one point I mentioned a metric for virtual method dispatch on the JVM and one of the students used my numbers to work backwards to determine the number of instructions on different processors.

I was teaching our Working Effectively with Legacy Code class. Michael Feathers usually teaches this class, but he was busy (probably working with legacy code somewhere, which, ironically, is why he wrote the book – to solve the problem once and for all and to stop working with legacy code).

In an early project we have some problem code (the class was in Java, but we discussed C++ quite a bit):

    public void addEvent(Event event) {
        event.added();
        events.add(event);
        mailService.sendMail("jacques@spg1.com", "Event Notification", event
                .toString());
        display.showEvent(event);
    }

The problem with this code, however, comes from what happens in the constructor:

    public Scheduler(String owner, SchedulerDisplay display) {
        this.owner = owner;

        mailService = MailService.getInstance();
        this.display = new SchedulerDisplay();
    }

The display object is associated with a real device (OK, not in our simulation, but you get the point). We need to fix that dependency.

So we traditionally talk about a few ways to address that:

Create an interface and then have a concrete and test-double implementation
Create a test subclass

Those are a few typical ways to handle this problem, but given that the students also worked in C++ and were very concerned with performance (and dynamic binding), so we discussed more alternatives: 1. Link seam – build the system using the original SchedulerDispaly header file but link in a different version of the class. 2. Template parameter (compiler seam) – introduce a template parameter and compile in the dependency rather than link it in.

#pragma once

template<class D> class Scheduler
{
public:
  Scheduler(D &display);
  ~Scheduler();
  void handleEvent();

private:
  D &display;
};

So here are 4 ways to remove the dependency (working bottom up in a sense):

Link seam: link in a different version of SchedulerDisplay
Compiler seam: use a template parameter
Dynamic seam: create a test subclass that removes external dependency
Dynamic seam: extract an interface from existing concrete class, and make Scheduler depend on the new interface.

For C++, the first option might be a good option if it allows a very quick build/test cycle. Imagine using a class that brings in several unwanted dependencies. By making a test version replacement and linking to it, you might be able to get up and running quickly. On the other hand, you have to have a custom build target, which is really outside of the language.

The second option is good for C++ and maybe C#, but not Java. Java’s implementation of generics is so bad, that it requires an interface for this particular case, so you end up with the final option anyway. Using templates puts the seam into the language rather than the build system. It will affect clients because either:

They will have to provide a template parameter
Or, by providing a default value for the template parameter, clients will be aware of a class they were not previously aware of. Still, a viable option, but it will increase build time at least a little.

The third option may not work in any language without changing the original problem code. Imagine a no argument constructor that performs some static initialization. Without changing the constructor, you cannot guarantee that this approach will work. In any case, the problem as presented requires a change since the constructor was doing the initialization of the display; it did not allow for dependency injection.

The final option requires a bit more change, but is pretty flexible if you can afford the virtual method overhead. In Java this isn’t much of an issue (for a number of reasons, mostly related to effective JIT optimization). The cost is a bit more of a problem in C++ because introducing a first virtual method is a big deal. Personally, I don’t work on embedded systems, so I can generally ignore that problem. But this is not something to simply ignore, context does matter.

So which option is the best?

None of the above.

As a developer, you should probably be aware of all of these options (or maybe not the template option of you’re strictly a Java developer). Then, when you are faced with a legacy coding problem, you’ll have more tools from which to choose.

"Injecting Those Dependencies" by Gold Price

Wed, 30 Nov 2011 12:49:28 -0600

With the help of golden prices we can buy all things which we have desire. Gold Price

"Injecting Those Dependencies" by Brokerage firms

Fri, 25 Nov 2011 06:13:56 -0600

I am happy when reading your blog with updated information! thanks alot and hope that you will post more site that are related to this site.

"Injecting Those Dependencies" by Rubel

Thu, 17 Nov 2011 10:40:41 -0600

Reading through this your publish I’ve known many something totally new relating to this new great version from the ” new world ” that we haven’t known before. No Hype iPhone 4S Features

"Injecting Those Dependencies" by Wood Floor Dallas

Fri, 11 Nov 2011 01:43:07 -0600

Remodeling floors will go a long way in setting the ambiance of the room. Materials are available in a variety of textures and styles such as hardwood flooring, laminate, and ceramics. Materials must be durable and skid resistant to withstand high traffic while still remaining comfortable underfoot. Choice Flooring and Remodelling Brings you the best services yet pocket friendly! info@choiceflooringandremodeling.com

"Injecting Those Dependencies" by Nascar Racing

Sun, 06 Nov 2011 23:37:17 -0600

Please email me with any hints & tips about how you made your website look this good, I would appreciate it.

"Injecting Those Dependencies" by No Hype iPhone 4S Features

Sat, 05 Nov 2011 12:41:13 -0500

I think the article very interesting and above all true and applicabile.Il blog is well done and nice, congratulations. No Hype iPhone 4S Features

"Injecting Those Dependencies" by No Hype iPhone 4S Features

Sat, 05 Nov 2011 12:38:09 -0500

I’m happy for I found this blog, explaining everything in detail regarding the topic. We can benefit from these articles and I wish we do not have a language barrier.I Will probably be back to get more.

No Hype iPhone 4S Features

"Injecting Those Dependencies" by ysbearing/yisong@1stbearing.com

Wed, 19 Oct 2011 01:24:39 -0500

Slewing ring is also called slewing bearing, some people called: rotary support, swing support. English Name: slewing bearing or slewing ring bearing or turn table bearing, slewing ring in the real industrial applications is very wide. http://www.1stbearing.com

"Injecting Those Dependencies" by Ashley Bowling

Sat, 15 Oct 2011 14:19:50 -0500

No matter what the problem is, it’s always a people problem.

Jerry Weinberg

"Injecting Those Dependencies" by bakiretr

Tue, 11 Oct 2011 09:33:08 -0500

Thank you for taking the time to publish this information very useful!I’m still waiting for some interesting thoughts from your side in your next post

"Injecting Those Dependencies" by sex

Tue, 11 Oct 2011 09:31:58 -0500

Do all these people just need to vent? Well that’s my two cents! Have a great day!

"Injecting Those Dependencies" by ????? ??????

Tue, 11 Oct 2011 06:44:23 -0500

ely. Parkour was disciplined anterior to Freerunning by David Belle. It consists of hurdles and bounds. The big philosophical system

"Injecting Those Dependencies" by ????? ??????

Tue, 11 Oct 2011 06:44:07 -0500

Parkour and Freerunning are different but not entirely. Parkour was disciplined anterior to Freerunning by David Belle. It consists of hurdles and bounds. The big philosophical system

"Injecting Those Dependencies" by Louboutins

Mon, 10 Oct 2011 22:45:46 -0500

asda s d60f4as5+d6 sss

"Injecting Those Dependencies" by moncler

Mon, 10 Oct 2011 22:41:50 -0500

asdfa sd0+fa+0s d9sdss

"Injecting Those Dependencies" by Christian

Mon, 10 Oct 2011 22:38:25 -0500

as vbcn+0v b+vcb n+v

"Injecting Those Dependencies" by UGG Montclair

Thu, 29 Sep 2011 20:01:26 -0500

The article in UGG Montclair Boots Saleyour blog reminds me some old memory .That is good .It gives me happy .I think we will haMontclair UGG Boots Saleous talk.Do you agree?

"Injecting Those Dependencies" by http://www.ghalay.com

Tue, 27 Sep 2011 17:10:25 -0500

I need to read more on this topic…I admiring time and effort you put in your blog, because it is obviously one great place where I can find lot of useful info.. http://www.ghalay.com

"Injecting Those Dependencies" by Latest Movie Poster

Thu, 15 Sep 2011 03:27:49 -0500

I really enjoyed reading this post. I congte you for the terrific job that you’re doing. Great stuff, just simply amazing!

"Injecting Those Dependencies" by coupon for baby

Thu, 15 Sep 2011 03:26:13 -0500

So informative this are provided here,I really happy to read this post,I was just imagine about it and you provided me the correct informg,So thanks for sharing the information.

"Injecting Those Dependencies" by Omaha Foreclosure Central

Wed, 07 Sep 2011 14:20:37 -0500

I want to say that this article is awesome, nice written and include almost all vital infos. I would like to see more posts like this .

"Injecting Those Dependencies" by Rent To Own Omaha

Tue, 06 Sep 2011 14:28:51 -0500

I just wanted to say hi and tell you how wonderful I think your blog is. I am a latecomer, unfortunately-but I will keep a close eye on it,now that I have found it. Take care!!!

"Injecting Those Dependencies" by Nebraska Foreclosures Central

Sun, 04 Sep 2011 11:24:19 -0500

"Injecting Those Dependencies" by bagsupplyer

Sat, 03 Sep 2011 04:10:07 -0500

Thank you for posting. Waiting for updating. Discount designer men DSQ t shirt from China at on line store

"Injecting Those Dependencies" by bagsupplyer

Sat, 03 Sep 2011 04:09:14 -0500

Nice Article.Thank you for sharing. Waiting for updating. Cheap brand men Diesel t shirt from China for wholesale at on line store