Why do I actually need an interface in Spring Boot?

user_223365 0
Viewed 774

When programming in Spring/Spring Boot, it's a common practice to have every service/component implement an interface, for example:

public interface IAdder {
    int add(int a, int b);
}

@Service
public class Adder implements IAdder {
    public int add(int a, int b) { return a + b; }
}

Why do I actually need to write that interface if I don't plan on having multiple implementations for "Adder" functionality?

One common answer to that question is "you'll need it for mocking in your unit tests". To that, I can answer - not really. I can mock the adder using every possible mocking framework you can think of (Mockito, for example):

@Autowired
IMultiplier multiplier;  // Class under test

@Mock
IAdder adder;

@Test  // Assuming I implement multiplication by multiple additions
public void multiplicationTest() {
    // Arrange
    when(adder).add(3, 3).thenReturn(6);
    
    // Act
    int result = multiplier.multiply(3, 5);
    
    // Assert
    verify(adder, times(4)).add(3, 3);
    assertThat(result).isEqualTo(15);
}

Having said that, what advantage can the IAdder interface provide for me?

spring-boot spring unit-testing java
3 Answers

TBH I hate it when people blindly follow the 'every service needs an interface' rule. It's a maintenance nightmare.

This kind of interfaces only make sense at module boundaries, where the interface itself resides in the consumer module, shouting 'hey, here's the interface I'm gonna need', and the provider module happily obliges.

Within a cohesive module, unless you're planning on multiple implementations of the same functionality, such interfaces make no sense at all. And, since you can easily convert a class into an interface without the clients complaining if you need to, I don't see why you should prematurely clutter your codebase with extra levels of indirection.

user_10928180

I've had this same conversation with coworkers. I feel like this question is a little beyond my Java knowledge, but here's a shot:

I think there are 2 reasons people do it:

1. Java dynamic proxying

The way Spring honors some of the annotations like @Transaction is to create a proxy for the class.

According to the docs, Java dynamic proxying is default proxy-generation method over CGLIB-based proxies. Java dynamic proxying can only work with interfaces, so people got into the habit of creating interfaces for every services. Why is Java dynamic proxying preferred? I don't know, tbh, but these are some points:

  • CGLIB used to be a separate library you had to include. Nowadays it's included with Spring
  • CGLIB is a 3rd-party library to "hack" bytecode, vs the JDK-included dynamic proxying
  • I guess at some point constructors were invoked twice when using CGLIB? Maybe there are other quirks?
  • I have only a tiny bit of experience here, but I know CGLIB can give some opaque error messages sometimes.

I don't have enough experience to recommend going full-CGLIB just for the sake of removing redundant interfaces.

2. "Software engineering reasons", encouraged by the docs

To quote the docs:

Spring AOP can also use CGLIB proxies. This is necessary to proxy classes rather than interfaces. By default, CGLIB is used if a business object does not implement an interface. As it is good practice to program to interfaces rather than classes, business classes normally implement one or more business interfaces.

Here the docs sort of indirectly encourage people to use interfaces. This seems to me to be a little heavy-handed, but it may be part of why it has become common practice. And once it's common practice, it becomes habit.

Conclusion

While I disagree with the idea that all service classes with a single implementation need a redundant interface, I agree that service classes should be treated as a "facade-point" in the code, encapsulating the underlying layers and providing a clean abstraction to the view layer. But I don't see why they need to have literal java interfaces unless the need arises.

That's what I think from a structural point of view. But without more CGLIB vs JDK-proxy info, I'll probably stick with the defaults.

user_3568870

If you do not plan several options for implementing the service, then in theory you can do without the interface.

But, if you use unit tests, things are much more complicated. It is not always possible to use a working implementation in unit tests (for example, if you are using a database connection or interacting with an external application).

Therefore, it is better to use the interface. In your question, you gave the simplest case in which you can do without mock objects. But this is not always possible.

user_90913510
Related