Architectural Constraints In Java [closed]

Answer 1

Although I am not sure if it is possible to enforce a build failure on layer dependency violation, there is at least a tool that can check and visualize these layers: Sonar. You can integrate it with your maven and jenkins builds as well as with eclipse (and maybe other IDEs).

Sonar features a dependency matrix view which visualized the interdependencies of packages.

EDIT: it seems to be possible to configure sonar to force the build to fail triggered by a violation: the build breaker plugin

Answer 2

Structure101 lets you define your layers visually as cells in Architecture Diagrams which map to the physical code and check conformance. These diagrams are visible in the developers' IDEs and generate edit time warnings if the layering rules are violated. It is also possible to break/report the build during CI. SonarJ and Lattix are other tools for visual dependency control.

Answer 3

This is a very valid question, since lots of projects enforce dependencies through Maven modules, which is a huge waste of productivity and flexibility.

After spending a lot of time researching on this subject I could recommend two tools:

• Macker (http://innig.net/macker/) it has Maven plugin
• Classycle (http://classycle.sourceforge.net/) it has to be plugged-in using Ant

Both tools are not evolving much last years, but are working well. Macker has XML-based syntax, but Classycle has neat DSL. Classycle is more high-level specialized tool and has concept of layers. These tools allow you to enforce strict barriers between packages and certain class types. This tools should be configured in build process to fail upon any constraint immediately.

Check the layering example here (http://innig.net/macker/example/layering/src/macker.xml) and here (http://classycle.sourceforge.net/ddf.html#layer).

There is still a niche for a good open source tool, which would hook into compiler and would give you errors while you are in IDE rather than in build tool. Structure101 is much more feature rich, but also heavy and relies on Eclipse plugin.

Update

These is also JQAssistant, which is very powerful, but can take quite some time to learn and setup.

Answer 4

You can use Checkstyle to implement "customized checks". See it to learn more: http://saturnnetwork.wordpress.com/2012/11/26/ultimate-architecture-enforcement-prevent-code-violations-at-code-commit-time/

I did not try it myself but I think it is not difficult to implement and it's free.

Answer 5

There are several tools that can help you enforce your layered architecture and dependency restrictions in general. These tools are language specific. If you're using Java, I can suggest creating your custom checks using checkstyle.

I authored the text Anton referred to (Ultimate Architecture Enforcement). It's based on our own successful experience. Custom checks can be integrated to the IDE (e.g., Eclipse), can be integrated to your continuous integration tool (e.g., Jenkins), and as the last resort to prevent violations can be executed automatically as a pre-commit verification on Subversion. The custom checks themselves are written in Java using the checkstyle API.

Answer 6

JDepend can analyze your code base and provide you the metrics you are looking for. Three main metrics you are looking for are Afferent Couplings, Efferent Couplings and Package Dependency Cycles.

Architexa is another tool that might of help here.