Where should @Service annotation be kept? Interface or Implementation?

spring service
TheKojuEffect picture TheKojuEffect · May 3, 2013 · Viewed 72.7k times · Source

I'm developing an application using Spring. I'm required to use the @Service annotation. I have ServiceI and ServiceImpl such that ServiceImpl implements ServiceI. I'm confused here as to where should I keep the @Service annotation.

Should I annotate the interface or the implementation with @Service? What are the differences between these two approaches?

Answer

Ralph picture Ralph · Nov 4, 2015

I never put @Component (or @Service, ...) at an interface, because this make the interface useless. Let me explain why.

claim 1: If you have an interface then you want to use that interface for the injection point type.

claim 2: The purpose of an interface is that it define a contract that can been implemented by several implementations. On the other side you have your injection point (@Autowired). Having just one interface and only one class that implement it, is (IMHO) useless, and violates YAGNI.

fact: When you put:

  • @Component (or @Service, ...) at an interface,
  • have multiple classes that implements it,
  • at least two classes become Spring Beans, and
  • have an injection point that use the interface for type based injection,

then you will get and NoUniqueBeanDefinitionException (or you have a very special configurations setup, with Environment, Profiles or Qualifiers ...)

Conclusion: If you use @Component (or @Service, ...) at an interface then you must violate at least one of the two clains. Therefore I think it is not useful (except some rare scenarios) to put @Component at interface level.

Spring-Data-JPA Repository interfaces are something complete different

Related questions

Is Spring annotation @Controller same as @Service?

Is Spring annotation @Controller same as @Service? I have idea about @Controller which can be used for URL mapping and invoking business logic. while @Service used to annotate service class which contains business logic. Can I use @Controller instead of @…

Read More
What is DAO and Service layer exactly in Spring framework?

What is DAO and Service layer exactly in Spring framework? I am looking for theoretical answer.

Read More
Spring DTO validation in Service or Controller?

I'm building a straight forward AJAX / JSON web service with Spring. The common data flow is: some DTO from browser v Spring @Controller method v Spring @Service method I'm looking for the most easy way to handle data validation. I …

Read More