addressalign-toparrow-leftarrow-rightbackbellblockcalendarcameraccwcheckchevron-downchevron-leftchevron-rightchevron-small-downchevron-small-leftchevron-small-rightchevron-small-upchevron-upcircle-with-checkcircle-with-crosscircle-with-pluscrossdots-three-verticaleditemptyheartexporteye-with-lineeyefacebookfolderfullheartglobegmailgooglegroupshelp-with-circleimageimagesinstagramlinklocation-pinm-swarmSearchmailmessagesminusmoremuplabelShape 3 + Rectangle 1ShapeoutlookpersonJoin Group on CardStartprice-ribbonShapeShapeShapeShapeImported LayersImported LayersImported Layersshieldstartickettrashtriangle-downtriangle-uptwitteruserwarningyahoo

RFC - Default service implementation structure

From: Wesley H.
Sent on: Saturday, March 2, 2013 10:20 PM
Hello folks,

I have a little issue that I am sure has crossed the minds of a few
folks here and thought I would open it up for comments.

I am currently working on one of my little toy projects. I usually
have at least one of these on the go at any given point as it allows
me to play with new versions of libraries and technologies and also
lets me develop some of my ideas in terms of structure and layout.

Once again, I am finding myself visiting the age old problem of
service interfaces with single implementations. There seems to be
quite a few ideas on how to deal with this. Some say not to use an
interface at all and just have the implementation class, some say to
use an interface, and then there are suggestions for the naming of the
implementation class, <Interface>Imp­l? Default<Interface­>? Try really
hard to come up with a prefix or suffix that is less generic?

Over the years I have flitted back and forward between these options,
never really finding an answer that was all that satisfactory to me.
Not using an interface always seems the tidiest in terms of code
structure, but I find that I run into issues around things like AOP
proxies and having to use cglib proxies rather than JDK ones, which
adds a lot of complexity and seems to outright break some things.

*Impl and Default* seems like a bit of a cop-out, and seem (Impl
especially) as a bit of a tautology.

Coming up with a more specific name seems OK but I sometimes struggle
to do this. My services generally use spring, but 'SpringXyzService',
seems a bit crappy too, other than this there is usually nothing much
to distinguish them. They are simply the pretty bog-standard
implementation of the required interface.

On my new project, I have been trying something a little different,
which I think I quite like but is perhaps a little unconventional.

I have been creating the 'Default' implementation of the interface as
a package scope inner class within the interface definition itself.
Like this...

public interface AccountService {

   Account createAccount(String­ email);

   @Service
   class Default implements AccountService {

       private Collaborator collaborator;

       Default(Collaborator­ collaborator) {
           this.collaborator = collaborator;
       }

       public Account createAccount(String­ email) {
           //Implementation here
       }
   }
}

This kind of thing seems to work functionally, allows for alternative
implementations either by creating another implementation of the
AccountService interface or even by extending the default
implementation and my unit tests have things like this...

AccountService accountService = new AccountService.Defau­lt(mockCollaborator);­

Which actually looks quite pretty to my eyes.

I appreciate that it is all style really, but I am interested if
anyone has any thoughts, do you use a standard that I haven't
mentioned here? Do you have any major objection to my new experimental
approach (either stylistically or because you happen to know it is
going to break some feature of some important library)?

Keen to hear any thoughts that anybody has.

Regards

Wes

Our Sponsors

  • Our Blog

    Read the latest news from the LJC

  • RecWorks Ltd

    Fixing Tech Recruitment using the Power of Community

  • jClarity

    Java/JVM Performance Analysis Tools & mentoring for Java related matters

  • LJC Aggrity

    Our LJC Aggrity site contains blog posts from our members

  • LJC Book Club

    Our Book club with book reviews from our members

  • Devoxx UK

    Java Community Conference in collaboration with the LJC, 8-10th June 16

  • SkillsMatter

    "Host, help organise, promote, film many of our meetings."

  • IBM

    Build Enterprise-grade apps at start-up speed.

  • New Relic

    New Relic makes sense of billions of metrics a day in real time.

  • Hazelcast

    Hazelcast is the leader in operating in-memory computing.

  • Java.Net

    We are an official Java User Group recognised by Oracle's JUG program

  • JRebel

    Free 3 month J-Rebel license.

  • O'Reilly

    40% discount on printed books and 50% on e-books.

People in this
Meetup are also in:

Sign up

Meetup members, Log in

By clicking "Sign up" or "Sign up using Facebook", you confirm that you accept our Terms of Service & Privacy Policy