This repository contains a reverse engineering library for Context Mapper. It allows to generate Context Maps written in the Context Mapper DSL (CML) language from existing source code. It is extensible and allows to plug-in new Bounded Context or Context Map relationship discovery strategies.
The discovery process starts with searching for Bounded Contexts within your code base first. This is done by applying all configured Bounded Context discovery strategies. After that, the library searches for relationships between these discovered Bounded Contexts by applying the configured relationship discovery strategies.
The strategies are provided by implementing the following two interfaces:
If the relationship discovery strategies identify Bounded Contexts with different names as they were previously discovered by the Bounded Context discovery strategies, you may need a name mapping strategy. They allow to map different Bounded Context names and can be provided by implementing the following interface:
This prototype already provides the following strategies to discover Bounded Contexts and relationships in order to generate a CML model. More strategies may be implemented in the future. Contributions are very welcome as well.
| Strategy | Description |
|---|---|
| SpringBootBoundedContextDiscoveryStrategy | Many Microservice projects implement their services with Spring Boot. This strategy detects all Spring Boot services by searching for it's @SpringBootApplication annotation. This strategy further derives Aggregates from Spring REST endpoints (@RequestMapping annotation on controller classes) and entities from parameters and return types of the methods within the discovered controllers (@RequestMapping, @PutMapping, and @GetMapping on methods). Note: This strategy uses reflection to find all services (Bounded Contexts). To apply it, you have to add all your Spring Boot projects to the classpath. If you work with JAR's, ensure you provide regular JAR's not built with the Spring Boot Maven or Gradle plugins (the classes there are within the BOOT-INF directory and cannot be scanned by the reflections library). |
| AnnotatedTypeBoundedContextDiscoveryStrategy | This strategy works in the same way as the SpringBootBoundedContextDiscoveryStrategy, but you can search for any annotation you want. For each class having the configured annotation, it will create a Bounded Context. |
| Strategy | Description |
|---|---|
| DockerComposeRelationshipDiscoveryStrategy | Microservice projects often use Docker containers to deploy the individual services. Docker Compose allows to start all services with one command. This strategy uses the docker-compose.yml file of your project to discover the dependencies (relationships) between the individual services. |
In case the configured relationship discovery strategies identify Bounded Contexts with different names as previously discovered by the Bounded Context discovery strategies, the following mapping strategies can help to map the different names:
| Strategy | Description |
|---|---|
| DefaultBoundedContextNameMappingStrategy | The DefaultBoundedContextNameMappingStrategy does not map anything and uses the names generated by the RelationshipDiscoveryStrategy to find the previously discovered Bounded Contexts. Hint: You don't need to add this strategy to your configuration, it is always added to the strategies used. |
| SeparatorToCamelCaseBoundedContextNameMappingStrategy | This strategy can be used if the relationship discovery strategy finds names containing separators, while the Bounded Context strategies find the same names but in camel case format instead of using separators. It removes a configurable separator in the names and returns the names in camel case instead. For example: customer-management-context is mapped to CustomerManagementContext, if the separator '-' is configured (customer_management_context to CustomerManagementContext would be another example). |
The following example illustrates how you can discover Context Maps from your code and generate a CML model:
public class ExampleContextMapDiscoverer {
public static void main(String[] args) throws IOException {
// configure discoverer: (you can always add multiple discovery strategies as well)
ContextMapDiscoverer discoverer = new ContextMapDiscoverer()
.usingBoundedContextDiscoveryStrategies(
new SpringBootBoundedContextDiscoveryStrategy("org.your.organisation.root.package"))
.usingRelationshipDiscoveryStrategies(
new DockerComposeRelationshipDiscoveryStrategy(new File("./source-root-directory/")))
.usingBoundedContextNameMappingStrategies(
new SeparatorToCamelCaseBoundedContextNameMappingStrategy("-")
);
// start discovery process creating a Context Map
ContextMap contextmap = discoverer.discoverContextMap();
// store Context Map as Context Mapper DSL (CML) model:
new ContextMapSerializer().serializeContextMap(contextmap, new File("./src-gen/my-context-map.cml"));
}
}To use this library and discover CML models as in the example above, you can add it to your project with Maven or Gradle:
Gradle:
implementation 'org.contextmapper:context-map-discovery:1.4.0'Maven:
<dependency>
<groupId>org.contextmapper</groupId>
<artifactId>context-map-discovery</artifactId>
<version>1.4.0</version>
</dependency>In the folder Examples of this repository you find example microservice projects on which we applied this discovery library to reverse engineer CML Context Maps.
If you want to contribute to this project you can create a fork and a pull request. The project is built with Gradle, so you can import it as Gradle project within Eclipse or IntelliJ IDEA (or any other IDE supporting Gradle).
Contribution is always welcome! Here are some ways how you can contribute:
- Create Github issues if you find bugs or just want to give suggestions for improvements or new discovery strategies.
- This is an open source project: if you want to code, create pull requests from forks of this repository. Please refer to a Github issue if you contribute this way.
- If you want to contribute to our documentation and user guides on our website https://contextmapper.org/, create pull requests from forks of the corresponding page repo https://github.com/ContextMapper/contextmapper.github.io or create issues there.
ContextMapper is released under the Apache License, Version 2.0.