xmolecules / Jmolecules

= jMolecules – Architectural abstractions for Java

A set of libraries to help developers work with architectural concepts in Java. Goals:

• Express that a piece of code (package, class, method...) implements an architectural concept.
• Make it easy for the human reader to determine what kind of architectural concepts a given piece of code is.
• Allow tool integration (to do interesting stuff like generating persistence or static architecture analysis to check for validations of the architectural rules.)

== Expressing DDD concepts Example:

[source,java]

import org.jmolecules.ddd.annotation.*;

@Entity public class BankAccount { /* ... */ }

@ValueObject public class Currency { /* ... */ }

@Repository public class Accounts { /* ... */ }

When we take Ubiquitous Language serious, we want names (for classes, methods, etc.) that only contain words from the domain language. That means the titles of the building blocks should not be part of the names. So in a banking domain we don't want BankAccountEntity, CurrencyVO or even AccountRepository as types. Instead, we want BankAccount, Currency and Accounts – like in the example above.

Still, we want to express that a given class (or other architectural element) is a special building block; i.e. uses a design pattern. jMolecules provide a set of standard annotations for the building blocks known from DDD.

=== Using a type based model

As an alternative to the above mentioned annotations, jMolecules also provides a set of interfaces, largely based on the ideas presented in John Sullivan's series https://scabl.blogspot.com/p/advancing-enterprise-ddd.html["Advancing Enterprise DDD"]. They allow expressing relationships between the building blocks right within the type system, so that the compiler can help to verify model correctness and the information can also be processed by Java reflection more easily.

• Identifier -- A type to represent types that are supposed to act as identifiers.
• Identifiable<ID> -- Anything that's exposing an identifier.
• Entity<T extends AggregateRoot<T, ?>, ID> extends Identifiable<ID> -- An entity, declaring to which AggregateRoot it belongs and which identifier it exposes.
• AggregateRoot<T extends AggregateRoot<T, ID>, ID extends Identifier> extends Entity<T, ID> -- an aggregate root being an Entity belonging to itself exposing a dedicated Identifier
• Association<T extends AggregateRoot<T, ID>, ID extends Identifier> extends Identifiable<ID> -- an explicit association to a target AggregateRoot.

This arrangement gives guidance to modeling and allows to easily verify the following rules, potentially via reflection:

• Enforced, dedicated identifier types per aggregate to avoid identifiers for different aggregates mixed up.
• AggregateRoot must only refer to Entity instances that were declared to belong to it.
• AggregateRoots and Entitys must only refer to other AggregateRoots via Association instances.

For automated verification and runtime technology integration see https://github.com/xmolecules/jmolecules-integrations#jmoleculestechnology-integrations[jMolecules Integrations].

=== Libraries

• link:jmolecules-ddd[jmolecules-ddd] -- annotations and interfaces to express DDD building blocks (value objects, entities, aggregate roots etc.) in code.
• link:jmolecules-events[jmolecules-events] -- annotations and interfaces to express the concept of events in code.

== Expressing architecture jMolecules provides annotations to mark a package as a layer (or ring):

[source,java]

import org.jmolecules.architecture.layered.*;

@DomainLayer package org.acmebank.domain;

@ApplicationLayer package org.acmebank.application;

That way, all classes in the respective package are considered to be part of the annotated layer.

Alternatively, classes can be annotated directly:

[source,java]

import org.jmolecules.architecture.layered.*;

@DomainLayer @Entity public class BankAccount { /* ... */ }

@ApplicationLayer @Service public class TransferMoney { /* ... */ }

Currently, annotations for Layered and Onion Architecture exist.

=== Libraries

• link:jmolecules-architecture[jmolecules-architecture] -- annotations to express architectural styles in code. ** link:jmolecules-architecture/jmolecules-cqrs-architecture[jmolecules-cqrs-architecture] -- CQRS architecture *** @Command *** @CommandDispatcher *** @CommandHandler *** @QueryModel ** link:jmolecules-architecture/jmolecules-layered-architecture[jmolecules-layered-architecture] -- Layered architecture *** @DomainLayer *** @ApplicationLayer *** @InfrastructureLayer *** @InterfaceLayer ** link:jmolecules-architecture/jmolecules-onion-architecture[jmolecules-onion-architecture] -- Onion architecture *** Classic **** @DomainModelRing **** @DomainServiceRing **** @ApplicationServiceRing **** @InfrastructureRing *** Simplified (does not separate domain model and services) **** @DomainRing **** @ApplicationRing **** @InfrastructureRing

== Installation To use jMolecules in your project just install it from the Maven central repository.

=== Maven

[source,xml]

=== Gradle

[source,groovy]

compile("org.jmolecules:jmolecules-ddd:1.2.0")

== Release instructions

• mvn release:prepare -DscmReleaseCommitComment="$ticketId - Release version $version." -DscmDevelopmentCommitComment="$ticketId - Prepare next development iteration."
• mvn release:perform -Dgpg.keyname=$keyname