Ayende @ Rahien

Hi!
My name is Ayende Rahien
Founder of Hibernating Rhinos LTD and RavenDB.
You can reach me by phone or email:

ayende@ayende.com

+972 52-548-6969

@

Posts: 5,947 | Comments: 44,540

filter by tags archive

Ayende's Design Guidelines: Rule #1


When creating a generic method, strongly prefer to supply an overload that is not generic, can accept the types manually, and is externally visible.

Reasoning: The generic version often looks significantly better than the non generic version, but it comes with a cost. It assumes that you know, up front, what the types are. When you are writing any type of generic code, this is almost always not the case and your generic method is useless in that scenario.

Example: myContainer.RegisterComponent<IService, ServiceImpl>(); is a good syntax to have, but the problem with that is that it cannot be used with this code:

foreach(Type type in GetComponentTypes())
{
    myContainer.RegisterComponent<type.GetInterfaces()[0], type>();
}

Since we cannot use the generic overload, we need to resort to trickery such as MakeGenericMethod and friends. This is costly at runtime, obscure and generally make life harder all around.


Comments

Symon Rottem

I completely agree - this is something I've run into a few times and providing an API without non-generic alternatives just generates friction for the consumer.

Christopher Bennage

I guess the context here is when you are publishing an API?

In a project where I control and consume the code base, it's YAGNI.

Ayende Rahien

Yes, this is for published API.

If you control the code, it doesn't really matter, since you can always change that.

Nevertheless, you need to carefully consider what you believe a published API is

Andrey Shchekin

Exactly. http://api.castleproject.org/html/MCastleMicroKernelDefaultKernelResolveServices1.htm immediatelly comes to mind.

Andrey Shchekin

Exactly. http://api.castleproject.org/html/MCastleMicroKernelDefaultKernelResolveServices1.htm immediatelly comes to mind.

Francois Tanguay

That's why I wished there was a way to promote a type object into a generic scope:

foreach(Type type in GetComponentTypes())

{

// New using scope keyword!

using<TInterface with type.GetInterfaces()[0], T with type>()

{ 

  myContainer.RegisterComponent<TInterface, T>(); 

}

}

Comment preview

Comments have been closed on this topic.

FUTURE POSTS

No future posts left, oh my!

RECENT SERIES

  1. RavenDB Sharding (2):
    21 May 2015 - Adding a new shard to an existing cluster, the easy way
  2. The RavenDB Comic Strip (2):
    20 May 2015 - Part II – a team in trouble!
  3. Challenge (45):
    28 Apr 2015 - What is the meaning of this change?
  4. Interview question (2):
    30 Mar 2015 - fix the index
  5. Excerpts from the RavenDB Performance team report (20):
    20 Feb 2015 - Optimizing Compare – The circle of life (a post-mortem)
View all series

RECENT COMMENTS

Syndication

Main feed Feed Stats
Comments feed   Comments Feed Stats