Search code examples
javacoding-styleclass-visibility

Improvement of package-private classes in Java


In my experience, package-private visibility for classes in Java is turning out to be redundant.

Package-private visibility seems to be based on the premise that a class which is almost-privately used by another class is likely to be kept in the same package. Often this is not the case. Is someone exploring an improved access modifier/alternate mechanism?

Problem with trying to use package-private visibility:

  • We are tempted to put functionally unrelated classes in same package to get this benefit

Problem with using public instead:

  • APIs get polluted. Once a library Jar is imported, client sees several other public classes that he has no need to be worried about
  • From a coding-standards perspective, there is no easy way to ensure that short-circuit calls are not done by developers on time crunches (By short-circuit calls I mean method calls that bypass a layer (like from Servlet direct to DAO bypassing the bean/BO)

The current workaround:

  • To dissuade short-circuit calls we usually package different parts of the application into several JARs and ensure only the respective JARs are available in the build environment for each build. (For example server.jar would not be available while compiling swing client classes. Only client classes and common.jar would be available.)

Questions:

  1. Wouldn't it be useful to come up with a new visibility modifer/alternative?
  2. Is something along these lines already in pipeline?
  3. Are frameworks like Spring/Guice sufficient replacements?

Solution

  • Looks like a feature from scala. There is a scope for access modifiers. I've found this tutorial useful.

    Method can be private in scope of some package

    package company.module.domain
    
    class Example {
      private[module] def moduleMethod = ???
      private[domain] def domainMethod = ???
    }
    

    In this example moduleMethod is available everywhere inside package module and its child packages (like domain). Method domainMethod is visible only in domain package and invisible outside.

    Unfortunately this functionality is not compatible with java and those restriction are compiled to byte code with lost of restrictions i.e. to public