What does it mean to "program to an interface"?
Asked Answered
J

33

922

I have seen this mentioned a few times and I am not clear on what it means. When and why would you do this?

I know what interfaces do, but the fact I am not clear on this makes me think I am missing out on using them correctly.

Is it just so if you were to do:

IInterface classRef = new ObjectWhatever()

You could use any class that implements IInterface? When would you need to do that? The only thing I can think of is if you have a method and you are unsure of what object will be passed except for it implementing IInterface. I cannot think how often you would need to do that.

Also, how could you write a method that takes in an object that implements an interface? Is that possible?

Jonette answered 21/12, 2008 at 0:48 Comment(14)
If you can remember and your program needs to be optimal, just before compilation you may wish to swap the Interface declaration for the actual implementation. As using an interface adds a level of indirection which gives a performance hit. Distribute your code programmed to interfaces though...Solarize
@Ande Turner: that's poor advice. 1). "your program needs to be optimal" is not a good reason for swapping out interfaces! Then you say "Distribute your code programmed to interfaces though..." so you are advising that given requirement (1) you then release sub-optimal code?!?Linker
Most of the answers here aren't quite right. It doesn't mean or even imply "use the interface keyword" at all. An interface is a spec of how to use something--synonymous with the contract (look it up). Separate from that is the implementation, which is how that contract is fulfilled. Program against only the guarantees of the method / type so that, when the method / type is changed in a way that still obeys the contract, it does not break the code using it.Gabrielson
@apollodude217 that is actually the best answer on the entire page. At least for the question in the title, since there are at least 3 quite different questions here...Tarrance
The fundemental problem with questions like this is that it assumes that "programming to an interface" means "wrap everything in an abstract interface", which is silly if you consider the term predates the concept of Java style abstract interfaces.Toneme
This is mostly done with COM. Where you handle an object without knowing the class but only what interface it's supports.Sparker
It's just a fancy word for callback. That's all it is. All it means is that you do something (say .. "get some info from the net" or "do a calculation"). That other thing will eventually call a function of yours, to tell you the result. Right? So you have to somehow state the name of that function (the callback function). The "interface!" just states the name of that function. That's all it is, nothing more to it.Agnail
The classic List lst = new ArrayList(); just means you are restricting what functions on the created object are available to you, which is completely dumb. This weird construct keeps getting propagated by Java teachers and books for no conceivable reason.Dismount
@Jonette you shouldn't conflate this question with additional questions. SO is a 1 question per topic site. It's better to ask separate questions and reference this one if it's relevant.Interscholastic
@Dismount Holy moly, not at all! A piece of code should use the most narrow type possible as it is self-documenting code. By restricting your type in this way, a programmer automatically knows more about how it might be used. Consider code that uses ArrayList. It might actually require something particular to that implementation in the use of it. Then consider you used Iterable - now, you know 100% that the code will be used only in a for each loop. Way more information is conveyed in that way more understandable code.Marty
@Marty It also means your function is restricted to only using it for a loop. Which might bite you in the ass on later updates, three functions deeper into the project.Dismount
@Dismount A similar problem can happen if you request a needlessly specific type. You can never change the implementation to a related type implemented differently. It's an improper short circuit in logic to characterize generality in a code as "completely dumb". Each types of generality / specificity has its purpose, but in general, using the least specific type provides you with the most ability to change code. Asking for an ArrayList, for example, might only make sense if part of your API is a speed guarantee that relies on contiguous memory. Most code will specify only a List.Marty
@Marty Isn't ArrayList literally the only implementation of List on java anyway?Dismount
@Dismount Just for the default implementations baked into Java, take a look at "implemented by" here: docs.oracle.com/javase/8/docs/api/java/util/List.html. There's AbstractList, AbstractSequentialList, ArrayList, AttributeList, CopyOnWriteArrayList, LinkedList, RoleList, RoleUnresolvedList, Stack, and Vector. You can also make custom classes that implement the List interface or use other people's code that implements it.Marty
H
1830

There are some wonderful answers on here to this questions that get into all sorts of great detail about interfaces and loosely coupling code, inversion of control and so on. There are some fairly heady discussions, so I'd like to take the opportunity to break things down a bit for understanding why an interface is useful.

When I first started getting exposed to interfaces, I too was confused about their relevance. I didn't understand why you needed them. If we're using a language like Java or C#, we already have inheritance and I viewed interfaces as a weaker form of inheritance and thought, "why bother?" In a sense I was right, you can think of interfaces as sort of a weak form of inheritance, but beyond that I finally understood their use as a language construct by thinking of them as a means of classifying common traits or behaviors that were exhibited by potentially many non-related classes of objects.

For example -- say you have a SIM game and have the following classes:

class HouseFly inherits Insect {
    void FlyAroundYourHead(){}
    void LandOnThings(){}
}

class Telemarketer inherits Person {
    void CallDuringDinner(){}
    void ContinueTalkingWhenYouSayNo(){}
}

Clearly, these two objects have nothing in common in terms of direct inheritance. But, you could say they are both annoying.

Let's say our game needs to have some sort of random thing that annoys the game player when they eat dinner. This could be a HouseFly or a Telemarketer or both -- but how do you allow for both with a single function? And how do you ask each different type of object to "do their annoying thing" in the same way?

The key to realize is that both a Telemarketer and HouseFly share a common loosely interpreted behavior even though they are nothing alike in terms of modeling them. So, let's make an interface that both can implement:

interface IPest {
    void BeAnnoying();
}

class HouseFly inherits Insect implements IPest {
    void FlyAroundYourHead(){}
    void LandOnThings(){}

    void BeAnnoying() {
        FlyAroundYourHead();
        LandOnThings();
    }
}

class Telemarketer inherits Person implements IPest {
    void CallDuringDinner(){}
    void ContinueTalkingWhenYouSayNo(){}

    void BeAnnoying() {
        CallDuringDinner();
        ContinueTalkingWhenYouSayNo();
    }
}

We now have two classes that can each be annoying in their own way. And they do not need to derive from the same base class and share common inherent characteristics -- they simply need to satisfy the contract of IPest -- that contract is simple. You just have to BeAnnoying. In this regard, we can model the following:

class DiningRoom {

    DiningRoom(Person[] diningPeople, IPest[] pests) { ... }

    void ServeDinner() {
        when diningPeople are eating,

        foreach pest in pests
        pest.BeAnnoying();
    }
}

Here we have a dining room that accepts a number of diners and a number of pests -- note the use of the interface. This means that in our little world, a member of the pests array could actually be a Telemarketer object or a HouseFly object.

The ServeDinner method is called when dinner is served and our people in the dining room are supposed to eat. In our little game, that's when our pests do their work -- each pest is instructed to be annoying by way of the IPest interface. In this way, we can easily have both Telemarketers and HouseFlys be annoying in each of their own ways -- we care only that we have something in the DiningRoom object that is a pest, we don't really care what it is and they could have nothing in common with other.

This very contrived pseudo-code example (that dragged on a lot longer than I anticipated) is simply meant to illustrate the kind of thing that finally turned the light on for me in terms of when we might use an interface. I apologize in advance for the silliness of the example, but hope that it helps in your understanding. And, to be sure, the other posted answers you've received here really cover the gamut of the use of interfaces today in design patterns and development methodologies.

Haematin answered 21/12, 2008 at 3:43 Comment(21)
Another thing to consider is that in some cases it might be useful to have an interface for things that "might" be annoying, and have a varierty of objects implement BeAnnoying as a no-op; this interface may exist in place of, or in addition to, the interface for things that are annoying (if both interfaces exist, the "things that are annoying" interface should inherit from the "things that might be annoying" interface). The disadvantage of using such interfaces is that implementations may get burdened with implementing an "annoying" number of stub methods. The advantage is that...Katar
...it's often faster to invoke a stub method needlessly than to determine whether the method should be called. This is part of the reason IEnumerator<T> inherits IDisposable. In the vast majority of cases, it will be cheaper for the consumer of an enumerator to unconditionally call Dispose on it, than for the consumer to check whether a Dispose call is necessary. It's too bad that neither .net nor Java allows one to specify default implementations for interface methods, since there are many situations where interfaces could benefit from 'optional' methods, where there would be...Katar
...a clear reasonable "default" behavior (sometimes do nothing, sometimes throw exception, and often call some static method or some other interface member in a fixed manner); such a feature would make it much more practical to have more types implement "maybe" interfaces, reducing the need for type-checking and type-casting at runtime.Katar
Why the HouseFly class still has some abstract methods?Castellano
The methods are not intended to represent abstract methods -- their implementation is irrelevant to the question which focused on interfaces.Haematin
Encapsulating behaviors, such as IPest is known as the strategy pattern just in case anyone is interested on following up with more material on that subject...Drayman
Interestingly, you don't point out that because the objects in the IPest[] are IPest references, you can call BeAnnoying() because they have that method, while you can't call other methods without a cast. However, each objects individual BeAnnoying() method will be called.Calculator
Does it mean that when executing the code in foreach loop, both the Be.Annoying() method would be called?Semiology
Only the BeAnnoying() method of the class that is "realizing" or "implementing" the interface will be called.Haematin
Very good explanation... I just need to say it here: I never heard of interfaces being some kind of loose inheritance mechanism, but instead I know of inheritance being used as a poor mechanism for defining interfaces (for example, in regular Python you do it all the time).Rebekahrebekkah
I am not so sure if TeleMarketer and HouseFly being unrelated is the key here to make use of interfaces. Even if they were related the situation still warrants interfaces given the restrictions around base classes. The key here is behaviours. There is a conceptual difference between interface and abstract class where former is used when you want to convey has a behaviour of (as opposed to latter which is strictly is a).Judsen
wish there is more about "Program not to an implementation" -- what about this part? Is FlyAroundYourHead() too specific and is for the implemented item? The same with .bark() and .meow(), which is program to an implementation -- because it tied up too much to Dog and Cat. If programming to an interface, it should be .giveSound() That is, general enough so that it is not specific to a particular implementation (or to a particular subclass)Agretha
Another design for situation:"Events" are annoying here, and each person should have it's own annoying events which when occur at the dinner time, makes him mad.Gonzales
This answer's example looks more like dependency inversion (which also programs to interfaces) than it does an example of programming to interfaces. I would like to see a useful example of programming to interfaces that does not also involve dependency inversion.Conquer
Of course, it is an excellent way of explaining why interfaces are useful, however, this is really not the answer to the main question (this answer https://mcmap.net/q/15827/-what-does-it-mean-to-quot-program-to-an-interface-quot is much better in that regard)Quasi
Plus one for the relation between telemarketeer and houseflyPacemaker
a means of classifying common traits or behaviors that were exhibited by potentially many non-related classes of objects this hits the spot completely! In that sometimes it's not obvious two classes (or more) have a common connection. Nice answer :)Giguere
This is the single best answer I've ever seen on stack overflowIridescence
You could add that this design couples loosely enough between DiningRoom and the various Pests that you can introduce new pests (think class Covid19 implements IPest {...};!) that didn't even exist when the DiningRoom class was written! Not only don't you need to change Diningroom, you don't even have to recompile it! Comes in handy for tests and large projects.Chromatic
This is by far the best explanation to interface I have seen. Vehicle as an interface might be too hard for beginners. Teachers should use this instead.Marlenemarler
Probably best explanation Ive seen on this subject. CheersScourge
S
333

The specific example I used to give to students is that they should write

List myList = new ArrayList(); // programming to the List interface

instead of

ArrayList myList = new ArrayList(); // this is bad

These look exactly the same in a short program, but if you go on to use myList 100 times in your program you can start to see a difference. The first declaration ensures that you only call methods on myList that are defined by the List interface (so no ArrayList specific methods). If you've programmed to the interface this way, later on you can decide that you really need

List myList = new TreeList();

and you only have to change your code in that one spot. You already know that the rest of your code doesn't do anything that will be broken by changing the implementation because you programmed to the interface.

The benefits are even more obvious (I think) when you're talking about method parameters and return values. Take this for example:

public ArrayList doSomething(HashMap map);

That method declaration ties you to two concrete implementations (ArrayList and HashMap). As soon as that method is called from other code, any changes to those types probably mean you're going to have to change the calling code as well. It would be better to program to the interfaces.

public List doSomething(Map map);

Now it doesn't matter what kind of List you return, or what kind of Map is passed in as a parameter. Changes that you make inside the doSomething method won't force you to change the calling code.

Selfish answered 21/12, 2008 at 1:35 Comment(3)
Comments are not for extended discussion; this conversation has been moved to chat.Navada
I have a question on the reason you mentioned "The first declaration ensures that you only call methods on myList that are defined by the List interface (so no ArrayList specific methods). If you've programmed to the interface this way, later on you can decide that you really need List myList = new TreeList(); and you only have to change your code in that one spot." Maybe I have misunderstood, I wonder why you need to change ArrayList to TreeList if you want to "ensures that you only call methods on myList "?Butterbur
@Butterbur There are any number of reasons you might want to change the type of list you're using. One might have better lookup performance, for example. The point is, that if you program to the List interface, it makes it easier to change your code to a different implementation later.Selfish
C
95

Programming to an interface is saying, "I need this functionality and I don't care where it comes from."

Consider (in Java), the List interface versus the ArrayList and LinkedList concrete classes. If all I care about is that I have a data structure containing multiple data items that I should access via iteration, I'd pick a List (and that's 99% of the time). If I know that I need constant-time insert/delete from either end of the list, I might pick the LinkedList concrete implementation (or more likely, use the Queue interface). If I know I need random access by index, I'd pick the ArrayList concrete class.

Chester answered 21/12, 2008 at 0:59 Comment(1)
totally agree i.e. the independence between what is done vs. how it is done. By partitioning a system along independent components, you end up with a system that it is simple and reusable (see Simple Made Easy by the guy who created Clojure)Thermostat
T
50

Programming to an interface has absolutely nothing to do with abstract interfaces like we see in Java or .NET. It isn't even an OOP concept.

What it means is don't go messing around with the internals of an object or data structure. Use the Abstract Program Interface, or API, to interact with your data. In Java or C# that means using public properties and methods instead of raw field access. For C that means using functions instead of raw pointers.

EDIT: And with databases it means using views and stored procedures instead of direct table access.

Toneme answered 19/7, 2012 at 19:34 Comment(1)
Best answer. Gamma give a similar explanation here : artima.com/lejava/articles/designprinciples.html (see page 2). He is refering to the OO concept but you are right: it is larger then that.Orangy
U
40

Using interfaces is a key factor in making your code easily testable in addition to removing unnecessary couplings between your classes. By creating an interface that defines the operations on your class, you allow classes that want to use that functionality the ability to use it without depending on your implementing class directly. If later on you decide to change and use a different implementation, you need only change the part of the code where the implementation is instantiated. The rest of the code need not change because it depends on the interface, not the implementing class.

This is very useful in creating unit tests. In the class under test you have it depend on the interface and inject an instance of the interface into the class (or a factory that allows it to build instances of the interface as needed) via the constructor or a property settor. The class uses the provided (or created) interface in its methods. When you go to write your tests, you can mock or fake the interface and provide an interface that responds with data configured in your unit test. You can do this because your class under test deals only with the interface, not your concrete implementation. Any class implementing the interface, including your mock or fake class, will do.

EDIT: Below is a link to an article where Erich Gamma discusses his quote, "Program to an interface, not an implementation."

http://www.artima.com/lejava/articles/designprinciples.html

Ulmer answered 21/12, 2008 at 1:20 Comment(2)
Please, read again this interview : Gamma was of course talking about the OO concept of interface, not the JAVA or the C# special kind of class (ISomething). The problem is, most people though he was talking about the keyword, so we now have a lot of uneeded interfaces (ISomething).Orangy
Very good interview. Please, be careful for future readers, there are four pages in the interview. I would almost close the browser before seeing it.Leeanneleeboard
S
38

You should look into Inversion of Control:

In such a scenario, you wouldn't write this:

IInterface classRef = new ObjectWhatever();

You would write something like this:

IInterface classRef = container.Resolve<IInterface>();

This would go into a rule-based setup in the container object, and construct the actual object for you, which could be ObjectWhatever. The important thing is that you could replace this rule with something that used another type of object altogether, and your code would still work.

If we leave IoC off the table, you can write code that knows that it can talk to an object that does something specific, but not which type of object or how it does it.

This would come in handy when passing parameters.

As for your parenthesized question "Also, how could you write a method that takes in an object that implements an Interface? Is that possible?", in C# you would simply use the interface type for the parameter type, like this:

public void DoSomethingToAnObject(IInterface whatever) { ... }

This plugs right into the "talk to an object that does something specific." The method defined above knows what to expect from the object, that it implements everything in IInterface, but it doesn't care which type of object it is, only that it adheres to the contract, which is what an interface is.

For instance, you're probably familiar with calculators and have probably used quite a few in your days, but most of the time they're all different. You, on the other hand, knows how a standard calculator should work, so you're able to use them all, even if you can't use the specific features that each calculator has that none of the other has.

This is the beauty of interfaces. You can write a piece of code, that knows that it will get objects passed to it that it can expect certain behavior from. It doesn't care one hoot what kind of object it is, only that it supports the behavior needed.

Let me give you a concrete example.

We have a custom-built translation system for windows forms. This system loops through controls on a form and translate text in each. The system knows how to handle basic controls, like the-type-of-control-that-has-a-Text-property, and similar basic stuff, but for anything basic, it falls short.

Now, since controls inherit from pre-defined classes that we have no control over, we could do one of three things:

  1. Build support for our translation system to detect specifically which type of control it is working with, and translate the correct bits (maintenance nightmare)
  2. Build support into base classes (impossible, since all the controls inherit from different pre-defined classes)
  3. Add interface support

So we did nr. 3. All our controls implement ILocalizable, which is an interface that gives us one method, the ability to translate "itself" into a container of translation text/rules. As such, the form doesn't need to know which kind of control it has found, only that it implements the specific interface, and knows that there is a method where it can call to localize the control.

Scrivens answered 21/12, 2008 at 0:58 Comment(2)
Why mentioning IoC in the very beginning as this would only add more confusion.Greenbelt
Agree, I would say programming against interfaces is just a technique to make IoC easier and reliable.Cate
P
37

Code to the Interface Not the Implementation has NOTHING to do with Java, nor its Interface construct.

This concept was brought to prominence in the Patterns / Gang of Four books but was most probably around well before that. The concept certainly existed well before Java ever existed.

The Java Interface construct was created to aid in this idea (among other things), and people have become too focused on the construct as the centre of the meaning rather than the original intent. However, it is the reason we have public and private methods and attributes in Java, C++, C#, etc.

It means just interact with an object or system's public interface. Don't worry or even anticipate how it does what it does internally. Don't worry about how it is implemented. In object-oriented code, it is why we have public vs. private methods/attributes. We are intended to use the public methods because the private methods are there only for use internally, within the class. They make up the implementation of the class and can be changed as required without changing the public interface. Assume that regarding functionality, a method on a class will perform the same operation with the same expected result every time you call it with the same parameters. It allows the author to change how the class works, its implementation, without breaking how people interact with it.

And you can program to the interface, not the implementation without ever using an Interface construct. You can program to the interface not the implementation in C++, which does not have an Interface construct. You can integrate two massive enterprise systems much more robustly as long as they interact through public interfaces (contracts) rather than calling methods on objects internal to the systems. The interfaces are expected to always react the same expected way given the same input parameters; if implemented to the interface and not the implementation. The concept works in many places.

Shake the thought that Java Interfaces have anything what-so-ever to do with the concept of 'Program to the Interface, Not the Implementation'. They can help apply the concept, but they are not the concept.

Pawsner answered 14/4, 2016 at 19:36 Comment(1)
The first sentence says it all. This should be the accepted answer.Apocarpous
F
15

It sounds like you understand how interfaces work but are unsure of when to use them and what advantages they offer. Here are a few examples of when an interface would make sense:

// if I want to add search capabilities to my application and support multiple search
// engines such as Google, Yahoo, Live, etc.

interface ISearchProvider
{
    string Search(string keywords);
}

then I could create GoogleSearchProvider, YahooSearchProvider, LiveSearchProvider, etc.

// if I want to support multiple downloads using different protocols
// HTTP, HTTPS, FTP, FTPS, etc.
interface IUrlDownload
{
    void Download(string url)
}

// how about an image loader for different kinds of images JPG, GIF, PNG, etc.
interface IImageLoader
{
    Bitmap LoadImage(string filename)
}

then create JpegImageLoader, GifImageLoader, PngImageLoader, etc.

Most add-ins and plugin systems work off interfaces.

Another popular use is for the Repository pattern. Say I want to load a list of zip codes from different sources

interface IZipCodeRepository
{
    IList<ZipCode> GetZipCodes(string state);
}

then I could create an XMLZipCodeRepository, SQLZipCodeRepository, CSVZipCodeRepository, etc. For my web applications, I often create XML repositories early on so I can get something up and running before the SQL Database is ready. Once the database is ready I write an SQLRepository to replace the XML version. The rest of my code remains unchanged since it runs solely off of interfaces.

Methods can accept interfaces such as:

PrintZipCodes(IZipCodeRepository zipCodeRepository, string state)
{
    foreach (ZipCode zipCode in zipCodeRepository.GetZipCodes(state))
    {
        Console.WriteLine(zipCode.ToString());
    }
}
Feodore answered 21/12, 2008 at 4:45 Comment(0)
C
13

A lot of explanation out there, but to make it even more simpler. Take for instance a List. One can implement a list with as:

  1. An internal array
  2. A linked list
  3. Other implementations

By building to an interface, say a List. You only code as to definition of List or what List means in reality.

You could use any type of implementation internally say an array implementation. But suppose you wish to change the implementation for some reason say a bug or performance. Then you just have to change the declaration List<String> ls = new ArrayList<String>() to List<String> ls = new LinkedList<String>().

Nowhere else in code, will you have to change anything else; Because everything else was built on the definition of List.

Ceaseless answered 15/4, 2013 at 13:5 Comment(0)
B
12

It makes your code a lot more extensible and easier to maintain when you have sets of similar classes. I am a junior programmer, so I am no expert, but I just finished a project that required something similar.

I work on client side software that talks to a server running a medical device. We are developing a new version of this device that has some new components that the customer must configure at times. There are two types of new components, and they are different, but they are also very similar. Basically, I had to create two config forms, two lists classes, two of everything.

I decided that it would be best to create an abstract base class for each control type that would hold almost all of the real logic, and then derived types to take care of the differences between the two components. However, the base classes would not have been able to perform operations on these components if I had to worry about types all of the time (well, they could have, but there would have been an "if" statement or switch in every method).

I defined a simple interface for these components and all of the base classes talk to this interface. Now when I change something, it pretty much 'just works' everywhere and I have no code duplication.

Brightwork answered 21/12, 2008 at 1:7 Comment(0)
G
10

If you program in Java, JDBC is a good example. JDBC defines a set of interfaces but says nothing about the implementation. Your applications can be written against this set of interfaces. In theory, you pick some JDBC driver and your application would just work. If you discover there's a faster or "better" or cheaper JDBC driver or for whatever reason, you can again in theory re-configure your property file, and without having to make any change in your application, your application would still work.

Greenbelt answered 21/12, 2008 at 1:20 Comment(3)
It's not just useful in case a better driver becomes available, it makes it possible to change database vendors completely.Limitless
JDBC is so bad that it needs replacing. Find another example.Hellkite
JDBC is bad but not for any reason to do with interface vs implementation or levels of abstraction. And so in order to illustrate the concept in question, it is just perfect.Espadrille
M
8

Programming to Interfaces is awesome, it promotes loose coupling. As @lassevk mentioned, Inversion of Control is a great use of this.

In addition, look into SOLID principals. here is a video series

It goes through a hard coded (strongly coupled example) then looks at interfaces, finally progressing to a IoC/DI tool (NInject)

Mysia answered 21/12, 2008 at 1:52 Comment(0)
A
8

I am a late comer to this question, but I want to mention here that the line "Program to an interface, not an implementation" had some good discussion in the GoF (Gang of Four) Design Patterns book.

It stated, on p. 18:

Program to an interface, not an implementation

Don't declare variables to be instances of particular concrete classes. Instead, commit only to an interface defined by an abstract class. You will find this to be a common theme of the design patterns in this book.

and above that, it began with:

There are two benefits to manipulating objects solely in terms of the interface defined by abstract classes:

  1. Clients remain unaware of the specific types of objects they use, as long as the objects adhere to the interface that clients expect.
  2. Clients remain unaware of the classes that implement these objects. Clients only know about the abstract class(es) defining the interface.

So in other words, don't write it your classes so that it has a quack() method for ducks, and then a bark() method for dogs, because they are too specific for a particular implementation of a class (or subclass). Instead, write the method using names that are general enough to be used in the base class, such as giveSound() or move(), so that they can be used for ducks, dogs, or even cars, and then the client of your classes can just say .giveSound() rather than thinking about whether to use quack() or bark() or even determine the type before issuing the correct message to be sent to the object.

Agretha answered 1/1, 2016 at 16:0 Comment(0)
S
6

To add to the existing posts, sometimes coding to interfaces helps on large projects when developers work on separate components simultaneously. All you need is to define interfaces upfront and write code to them while other developers write code to the interface you are implementing.

Sunday answered 21/12, 2008 at 1:8 Comment(0)
F
5

If I'm writing a new class Swimmer to add the functionality swim() and need to use an object of class say Dog, and this Dog class implements interface Animal which declares swim().

At the top of the hierarchy (Animal), it's very abstract while at the bottom (Dog) it's very concrete. The way I think about "programming to interfaces" is that, as I write Swimmer class, I want to write my code against the interface that's as far up that hierarchy which in this case is an Animal object. An interface is free from implementation details and thus makes your code loosely-coupled.

The implementation details can be changed with time, however, it would not affect the remaining code since all you are interacting with is with the interface and not the implementation. You don't care what the implementation is like... all you know is that there will be a class that would implement the interface.

Felicio answered 28/4, 2010 at 16:44 Comment(0)
C
5

It can be advantageous to program to interfaces, even when we are not depending on abstractions.

Programming to interfaces forces us to use a contextually appropriate subset of an object. That helps because it:

  1. prevents us from doing contextually inappropriate things, and
  2. lets us safely change the implementation in the future.

For example, consider a Person class that implements the Friend and the Employee interface.

class Person implements AbstractEmployee, AbstractFriend {
}

In the context of the person's birthday, we program to the Friend interface, to prevent treating the person like an Employee.

function party() {
    const friend: Friend = new Person("Kathryn");
    friend.HaveFun();
}

In the context of the person's work, we program to the Employee interface, to prevent blurring workplace boundaries.

function workplace() {
    const employee: Employee = new Person("Kathryn");
    employee.DoWork();
}

Great. We have behaved appropriately in different contexts, and our software is working well.

Far into the future, if our business changes to work with dogs, we can change the software fairly easily. First, we create a Dog class that implements both Friend and Employee. Then, we safely change new Person() to new Dog(). Even if both functions have thousands of lines of code, that simple edit will work because we know the following are true:

  1. Function party uses only the Friend subset of Person.
  2. Function workplace uses only the Employee subset of Person.
  3. Class Dog implements both the Friend and Employee interfaces.

On the other hand, if either party or workplace were to have programmed against Person, there would be a risk of both having Person-specific code. Changing from Person to Dog would require us to comb through the code to extirpate any Person-specific code that Dog does not support.

The moral: programming to interfaces helps our code to behave appropriately and to be ready for change. It also prepares our code to depend on abstractions, which brings even more advantages.

Conquer answered 3/7, 2017 at 19:36 Comment(1)
Assuming you don't have excessively broad interfaces, that is.Rivi
M
4

It is also good for Unit Testing, you can inject your own classes (that meet the requirements of the interface) into a class that depends on it

Maragretmarala answered 8/1, 2009 at 21:12 Comment(0)
M
4

Short story: A postman is asked to go home after home and receive the covers contains (letters, documents, cheques, gift cards, application, love letter) with the address written on it to deliver.

Suppose there is no cover and ask the postman to go home after home and receive all the things and deliver to other people, the postman can get confused.

So better wrap it with cover (in our story it is the interface) then he will do his job fine.

Now the postman's job is to receive and deliver the covers only (he wouldn't bothered what is inside in the cover).

Create a type of interface not actual type, but implement it with actual type.

To create to interface means your components get Fit into the rest of code easily

I give you an example.

you have the AirPlane interface as below.

interface Airplane{
    parkPlane();
    servicePlane();
}

Suppose you have methods in your Controller class of Planes like

parkPlane(Airplane plane)

and

servicePlane(Airplane plane)

implemented in your program. It will not BREAK your code. I mean, it need not to change as long as it accepts arguments as AirPlane.

Because it will accept any Airplane despite actual type, flyer, highflyr, fighter, etc.

Also, in a collection:

List<Airplane> plane; // Will take all your planes.

The following example will clear your understanding.


You have a fighter plane that implements it, so

public class Fighter implements Airplane {

    public void  parkPlane(){
        // Specific implementations for fighter plane to park
    }
    public void  servicePlane(){
        // Specific implementatoins for fighter plane to service.
    }
}

The same thing for HighFlyer and other clasess:

public class HighFlyer implements Airplane {

    public void  parkPlane(){
        // Specific implementations for HighFlyer plane to park
    }

    public void  servicePlane(){
        // specific implementatoins for HighFlyer plane to service.
    }
}

Now think your controller classes using AirPlane several times,

Suppose your Controller class is ControlPlane like below,

public Class ControlPlane{ 
 AirPlane plane;
 // so much method with AirPlane reference are used here...
}

Here magic comes as you may make your new AirPlane type instances as many as you want and you are not changing the code of ControlPlane class.

You can add an instance...

JumboJetPlane // implementing AirPlane interface.
AirBus        // implementing AirPlane interface.

You may remove instances of previously created types too.

Moonrise answered 8/8, 2014 at 10:25 Comment(0)
V
4

Previous answers focus on programming to an abstraction for the sake of extensibility and loose coupling. While these are very important points, readability is equally important. Readability allows others (and your future self) to understand the code with minimal effort. This is why readability leverages abstractions.

An abstraction is, by definition, simpler than its implementation. An abstraction omits detail in order to convey the essence or purpose of a thing, but nothing more. Because abstractions are simpler, I can fit a lot more of them in my head at one time, compared to implementations.

As a programmer (in any language) I walk around with a general idea of a List in my head at all times. In particular, a List allows random access, duplicate elements, and maintains order. When I see a declaration like this: List myList = new ArrayList() I think, cool, this is a List that's being used in the (basic) way that I understand; and I don't have to think any more about it.

On the other hand, I do not carry around the specific implementation details of ArrayList in my head. So when I see, ArrayList myList = new ArrayList(). I think, uh-oh, this ArrayList must be used in a way that isn't covered by the List interface. Now I have to track down all the usages of this ArrayList to understand why, because otherwise I won't be able to fully understand this code. It gets even more confusing when I discover that 100% of the usages of this ArrayList do conform to the List interface. Then I'm left wondering... was there some code relying on ArrayList implementation details that got deleted? Was the programmer who instantiated it just incompetent? Is this application locked into that specific implementation in some way at runtime? A way that I don't understand?

I'm now confused and uncertain about this application, and all we're talking about is a simple List. What if this was a complex business object ignoring its interface? Then my knowledge of the business domain is insufficient to understand the purpose of the code.

So even when I need a List strictly within a private method (nothing that would break other applications if it changed, and I could easily find/replace every usage in my IDE) it still benefits readability to program to an abstraction. Because abstractions are simpler than implementation details. You could say that programming to abstractions is one way of adhering to the KISS principle.

Vestry answered 2/8, 2021 at 18:29 Comment(1)
Very good explanation. This argument is really valuable.Misplay
M
3

Imagine you have a product called 'Zebra' that can be extended by plugins. It finds the plugins by searching for DLLs in some directory. It loads all those DLLs and uses reflection to find any classes that implement IZebraPlugin, and then calls the methods of that interface to communicate with the plugins.

This makes it completely independent of any specific plugin class - it doesn't care what the classes are. It only cares that they fulfill the interface specification.

Interfaces are a way of defining points of extensibility like this. Code that talks to an interface is more loosely coupled - in fact it is not coupled at all to any other specific code. It can inter-operate with plugins written years later by people who have never met the original developer.

You could instead use a base class with virtual functions - all plugins would be derived from the base class. But this is much more limiting because a class can only have one base class, whereas it can implement any number of interfaces.

Majordomo answered 21/12, 2008 at 1:46 Comment(0)
A
3

In Java these concrete classes all implement the CharSequence interface:

CharBuffer, String, StringBuffer, StringBuilder

These concrete classes do not have a common parent class other than Object, so there is nothing that relates them, other than the fact they each have something to do with arrays of characters, representing such, or manipulating such. For instance, the characters of String cannot be changed once a String object is instantiated, whereas the characters of StringBuffer or StringBuilder can be edited.

Yet each one of these classes is capable of suitably implementing the CharSequence interface methods:

char charAt(int index)
int length()
CharSequence subSequence(int start, int end)
String toString()

In some cases, Java class library classes that used to accept String have been revised to now accept the CharSequence interface. So if you have an instance of StringBuilder, instead of extracting a String object (which means instantiating a new object instance), it can instead just pass the StringBuilder itself as it implements the CharSequence interface.

The Appendable interface that some classes implement has much the same kind of benefit for any situation where characters can be appended to an instance of the underlying concrete class object instance. All of these concrete classes implement the Appendable interface:

BufferedWriter, CharArrayWriter, CharBuffer, FileWriter, FilterWriter, LogStream, OutputStreamWriter, PipedWriter, PrintStream, PrintWriter, StringBuffer, StringBuilder, StringWriter, Writer

Akers answered 21/12, 2008 at 4:17 Comment(2)
It's too bad interfaces like CharSequence are so anemic. I wish Java and .NET had allowed interfaces to have default implementation, so that people wouldn't pare down interfaces purely for the purpose of minimizing boilerplate code. Given any legitimate CharSequence implementation one could emulate most of the functions of String using only the above four methods, but many implementations could perform those functions much more efficiently in other ways. Unfortunately, even if a particular implementation of CharSequence holds everything in a single char[] and could perform many...Katar
...operations like indexOf quickly, there's no way that a caller who isn't familiar with a particular implementation of CharSequence could ask it to do so rather than having to use charAt to examine each individual character.Katar
J
3

So, just to get this right, the advantage of a interface is that I can separate the calling of a method from any particular class. Instead creating a instance of the interface, where the implementation is given from whichever class I choose that implements that interface. Thus allowing me to have many classes, which have similar but slightly different functionality and in some cases (the cases related to the intention of the interface) not care which object it is.

For example, I could have a movement interface. A method which makes something 'move' and any object (Person, Car, Cat) that implements the movement interface could be passed in and told to move. Without the method every knowing the type of class it is.

Jonette answered 21/12, 2008 at 22:5 Comment(0)
B
3

C++ explanation.

Think of an interface as your classes public methods.

You then could create a template that 'depends' on these public methods in order to carry out it's own function (it makes function calls defined in the classes public interface). Lets say this template is a container, like a Vector class, and the interface it depends on is a search algorithm.

Any algorithm class that defines the functions/interface Vector makes calls to will satisfy the 'contract' (as someone explained in the original reply). The algorithms don't even need to be of the same base class; the only requirement is that the functions/methods that the Vector depends on (interface) is defined in your algorithm.

The point of all of this is that you could supply any different search algorithm/class just as long as it supplied the interface that Vector depends on (bubble search, sequential search, quick search).

You might also want to design other containers (lists, queues) that would harness the same search algorithm as Vector by having them fulfill the interface/contract that your search algorithms depends on.

This saves time (OOP principle 'code reuse') as you are able to write an algorithm once instead of again and again and again specific to every new object you create without over-complicating the issue with an overgrown inheritance tree.

As for 'missing out' on how things operate; big-time (at least in C++), as this is how most of the Standard TEMPLATE Library's framework operates.

Of course when using inheritance and abstract classes the methodology of programming to an interface changes; but the principle is the same, your public functions/methods are your classes interface.

This is a huge topic and one of the the cornerstone principles of Design Patterns.

Boman answered 18/12, 2012 at 22:35 Comment(0)
M
2

Q: - ... "Could you use any class that implements an interface?"
A: - Yes.

Q: - ... "When would you need to do that?"
A: - Each time you need a class(es) that implements interface(s).

Note: We couldn't instantiate an interface not implemented by a class - True.

  • Why?
  • Because the interface has only method prototypes, not definitions (just functions names, not their logic)

AnIntf anInst = new Aclass();
// we could do this only if Aclass implements AnIntf.
// anInst will have Aclass reference.


Note: Now we could understand what happened if Bclass and Cclass implemented same Dintf.

Dintf bInst = new Bclass();  
// now we could call all Dintf functions implemented (defined) in Bclass.

Dintf cInst = new Cclass();  
// now we could call all Dintf functions implemented (defined) in Cclass.

What we have: Same interface prototypes (functions names in interface), and call different implementations.

Bibliography: Prototypes - wikipedia

Moralist answered 9/3, 2014 at 6:17 Comment(0)
O
2

An interface is like a contract, where you want your implementation class to implement methods written in the contract (interface). Since Java does not provide multiple inheritance, "programming to interface" is a good way to achieve multiple inheritance.

If you have a class A that is already extending some other class B, but you want that class A to also follow certain guidelines or implement a certain contract, then you can do so by the "programming to interface" strategy.

Oliva answered 27/5, 2016 at 10:44 Comment(0)
W
2

program to an interface is a term from the GOF book. i would not directly say it has to do with java interface but rather real interfaces. to achieve clean layer separation, you need to create some separation between systems for example: Let's say you had a concrete database you want to use, you would never "program to the database" , instead you would "program to the storage interface". Likewise you would never "program to a Web Service" but rather you would program to a "client interface". this is so you can easily swap things out.

i find these rules help me:

1. we use a java interface when we have multiple types of an object. if i just have single object, i dont see the point. if there are at least two concrete implementations of some idea, then i would use a java interface.

2. if as i stated above, you want to bring decoupling from an external system (storage system) to your own system (local DB) then also use a interface.

notice how there are two ways to consider when to use them.

Wescott answered 2/2, 2020 at 8:7 Comment(0)
S
2

Coding to an interface is a philosophy, rather than specific language constructs or design patterns - it instructs you what is the correct order of steps to follow in order to create better software systems (e.g. more resilient, more testable, more scalable, more extendible, and other nice traits).

What it actually means is:

===

Before jumping to implementations and coding (the HOW) - think of the WHAT:

  • What black boxes should make up your system,
  • What is each box' responsibility,
  • What are the ways each "client" (that is, one of those other boxes, 3rd party "boxes", or even humans) should communicate with it (the API of each box).

After you figure the above, go ahead and implement those boxes (the HOW).

Thinking first of what a box' is and what its API, leads the developer to distil the box' responsibility, and to mark for himself and future developers the difference between what is its exposed details ("API") and it's hidden details ("implementation details"), which is a very important differentiation to have.

One immediate and easily noticeable gain is the team can then change and improve implementations without affecting the general architecture. It also makes the system MUCH more testable (it goes well with the TDD approach).

===
Beyond the traits I've mentioned above, you also save A LOT OF TIME going this direction.

Micro Services and DDD, when done right, are great examples of "Coding to an interface", however the concept wins in every pattern from monoliths to "serverless", from BE to FE, from OOP to functional, etc....

I strongly recommend this approach for Software Engineering (and I basically believe it makes total sense in other fields as well).

Snowberry answered 23/5, 2022 at 12:27 Comment(0)
K
1

Program to an interface allows to change implementation of contract defined by interface seamlessly. It allows loose coupling between contract and specific implementations.

IInterface classRef = new ObjectWhatever()

You could use any class that implements IInterface? When would you need to do that?

Have a look at this SE question for good example.

Why should the interface for a Java class be preferred?

does using an Interface hit performance?

if so how much?

Yes. It will have slight performance overhead in sub-seconds. But if your application has requirement to change the implementation of interface dynamically, don't worry about performance impact.

how can you avoid it without having to maintain two bits of code?

Don't try to avoid multiple implementations of interface if your application need them. In absence of tight coupling of interface with one specific implementation, you may have to deploy the patch to change one implementation to other implementation.

One good use case: Implementation of Strategy pattern:

Real World Example of the Strategy Pattern

Khan answered 27/12, 2016 at 16:29 Comment(0)
L
1

"Program to interface" means don't provide hard code right the way, meaning your code should be extended without breaking the previous functionality. Just extensions, not editing the previous code.

Lerner answered 30/7, 2018 at 15:55 Comment(0)
B
0

Also I see a lot of good and explanatory answers here, so I want to give my point of view here, including some extra information what I noticed when using this method.

Unit testing

For the last two years, I have written a hobby project and I did not write unit tests for it. After writing about 50K lines I found out it would be really necessary to write unit tests. I did not use interfaces (or very sparingly) ... and when I made my first unit test, I found out it was complicated. Why?

Because I had to make a lot of class instances, used for input as class variables and/or parameters. So the tests look more like integration tests (having to make a complete 'framework' of classes since all was tied together).

Fear of interfaces So I decided to use interfaces. My fear was that I had to implement all functionality everywhere (in all used classes) multiple times. In some way this is true, however, by using inheritance it can be reduced a lot.

Combination of interfaces and inheritance I found out the combination is very good to be used. I give a very simple example.

public interface IPricable
{
    int Price { get; }
}

public interface ICar : IPricable

public abstract class Article
{
    public int Price { get { return ... } }
}

public class Car : Article, ICar
{
    // Price does not need to be defined here
}

This way copying code is not necessary, while still having the benefit of using a car as interface (ICar).

Basel answered 18/12, 2014 at 13:23 Comment(0)
R
0

Let's start out with some definitions first:

Interface n. The set of all signatures defined by an object's operations is called the interface to the object

Type n. A particular interface

A simple example of an interface as defined above would be all the PDO object methods such as query(), commit(), close() etc., as a whole, not separately. These methods, i.e. its interface define the complete set of messages, requests that can be sent to the object.

A type as defined above is a particular interface. I will use the made-up shape interface to demonstrate: draw(), getArea(), getPerimeter() etc..

If an object is of the Database type we mean that it accepts messages/requests of the database interface, query(), commit() etc.. Objects can be of many types. You can have a database object be of the shape type as long as it implements its interface, in which case this would be sub-typing.

Many objects can be of many different interfaces/types and implement that interface differently. This allows us to substitute objects, letting us choose which one to use. Also known as polymorphism.

The client will only be aware of the interface and not the implementation.

So in essence programming to an interface would involve making some type of abstract class such as Shape with the interface only specified i.e. draw(), getCoordinates(), getArea() etc.. And then have different concrete classes implement those interfaces such as a Circle class, Square class, Triangle class. Hence program to an interface not an implementation.

Rask answered 5/8, 2015 at 23:48 Comment(0)
B
0

I strongly believe hard questions should be explained with easy real-world answers. And in the realm of software design, it's very important.

Look at any door in your house, school, church... any building.

Imagine some doors got the perils right-bottom (so you have to bow to interact with the door, which is open or close it),

Or others got just in the top-left (So, some dwarfs, people with disabilities, or Kevin Hart will not find very amusing and usable such doors ).

So design is the keyword, create programs to others humans can develop/use it.

What Interfaces does is to make things easy for other junior/senior developers across colossus projects[1], so everybody knows what are they doing with little help from others so you can work as smooth as possible (in Theory).


[1]: How? By exposing the shape of value. So, you don't need documentation, cause the code itself is self-explanatory (Awesome).


This answer was not meant to be for language-specific instead of concept-driven (After all, humans are creating tools by writing code).

Bertha answered 26/3, 2019 at 18:11 Comment(1)
Very good and (abstract) explanation of usage of interfaces in general.Misplay
K
-1

Here is a simple example to illustrate when you program a flight booking system.

//This interface is very flexible and abstract
    addPassenger(Plane seat, Ticket ticket); 

//Boeing is implementation of Plane
    addPassenger(Boeing747 seat, EconomyTicket ticket); 
    addPassenger(Cessna, BusinessClass ticket);


    addPassenger(J15, E87687); 
Kayser answered 19/12, 2014 at 13:15 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.