-
-
Notifications
You must be signed in to change notification settings - Fork 11
/
architectural-refactorings.md
74 lines (53 loc) · 9.27 KB
/
architectural-refactorings.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
---
title: Architectural Refactorings
permalink: /docs/architectural-refactorings/
image: /img/cm-og-image.png
---
This section provides a documentation of all [architectural refactorings (ARs)](https://www.infoq.com/articles/architectural-refactoring/) available in the Context Mapper tool.
## Motivation: Why Refactoring?
The provided refactorings ensure that the result is always a correct CML model which compiles without errors.
If you perform similar changes manually, you also have to fix errors that occur manually within the [Context Map](/docs/context-map/).
The ARs ensure that corresponding references and dependencies in other parts of the model are respected and adjusted if necessary.
## Architectural Refactoring Categories
The ARs are divided into the following categories:
* **Structural Refactorings**: Change the structure of the decomposition (impact on Bounded Contexts and/or Aggregates).
* **Relationship Refactorings**: Just change the type of a relationship on the Context Map, but do not change the structure of the decomposition.
## Refactoring Overview
The Context Mapper tool offers you a set of architectural refactorings which can be applied to your CML models. The refactorings shall
support you while evolving and improving the architecture of your system.
### Structural Refactorings
We currently provide the following structural ARs:
| Name | Subject | Description | Input | Output |
|---------------------------------------------------------------------------------------------------------|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|-------------------------------------------------------------------|
| [**AR-1: Split Aggregate by Entities**](/docs/ar-split-aggregate-by-entities) | Aggregate | Splits an aggregate which contains multiple entities and produces one aggregate per entity. | 1 Aggregate | n Aggregates |
| [**AR-2: Split Bounded Context by Features**<sup>1</sup>](/docs/ar-split-bounded-context-by-features) | Bounded Context | Splits a bounded context by grouping those aggregates together into one bounded context which are used by the same use case(s) and/or user stories (features). | 1 Bounded Context | n Bounded Contexts |
| [**AR-3: Split Bounded Context by Owner**<sup>1</sup>](/docs/ar-split-bounded-context-by-owners) | Bounded Context | Splits a bounded context by grouping those aggregates together into one bounded context which belong to the same team. | 1 Bounded Context | n Bounded Contexts |
| [**AR-4: Extract Aggregates by Volatility**](/docs/ar-extract-aggregates-by-volatility) | Bounded Context | Extracts all aggregates from a bounded context by a given volatility, or likelihood for change (RARELY, NORMAL or OFTEN), and moves them to a separate context. | 1 Bounded Context | 2 Bounded Contexts |
| [**AR-5: Extract Aggregates by Cohesion**](/docs/ar-extract-aggregates-by-cohesion) | Bounded Context | Extracts a set of aggregates which are chosen by certain cohesion criteria and moves them to a separate bounded context. | 1 Bounded Context | 2 Bounded Contexts |
| [**AR-6: Merge Aggregates**](/docs/ar-merge-aggregates) | Aggregate | Merges two aggregates within a bounded context together to one aggregate. | 2 Aggregates | 1 Aggregate |
| [**AR-7: Merge Bounded Contexts**](/docs/ar-merge-bounded-contexts) | Bounded Context | Merges two bounded contexts together. The result is one bounded context containing all the aggregates of the two input boundedcontexts. | 2 Bounded Contexts | 1 Bounded Context |
| [**AR-8: Extract Shared Kernel**](/docs/ar-extract-shared-kernel) | Shared Kernel relationship | Extracts a new bounded context for the common model parts of the Shared Kernel and establishes two upstream-downstream relationship between the new and the existing Bounded Contexts. | 1 Shared Kernel relationship | 1 New Bounded Context and 2 new upstream-downstream relationships |
| [**AR-9: Suspend Partnership**](/docs/ar-suspend-partnership) | Partnership relationship | Suspends a Partnership relationship and replaces it with another structure how the two Bounded Context can depend on each other. The AR provides three strategies to suspend the partnership. | 1 Partnership relationship | _Depends on the selected mode_ |
<sup>1</sup>: An aggregate in CML can be used by **multiple** features (use cases and/or user stories) and is owned by **one** owner (team).
### Relationship Refactorings
The following ARs to change Context Map relationships are currently implemented:
| Name | Subject | Description | Input | Output |
|------------------------------------------------------------------------------------------------|----------------------------|---------------------------------------------------------------------------------|----------------------------|----------------------------|
| [**AR-10: Change Shared Kernel to Partnership**](/docs/ar-change-shared-kernel-to-partnership) | Shared Kernel relationship | Changes the type of a Shared Kernel relationship to a Partnership relationship. | Shared Kernel relationship | Partnership relationship |
| [**AR-11: Change Partnership to Shared Kernel**](/docs/ar-change-partnership-to-shared-kernel) | Partnership relationship | Changes the type of a Partnership relationship to a Shared Kernel relationship. | Partnership relationship | Shared Kernel relationship |
## Examples
You can find [input and corresponding output examples](https://github.com/ContextMapper/context-mapper-examples/tree/master/src/main/cml/architectural-refactorings) for all ARs listed above in our [examples repository](https://github.com/ContextMapper/context-mapper-examples).
## How to apply Architectural Refactorings
### Visual Studio Code
In VS Code we suggest the application of Architectural Refactorings via code actions. If your cursor is on a CML object on which an AR can be applied, a light bulb shows up:
<a href="/img/architectural-refactoring-handling-in-vscode-1.png"></a>
In the case illustrated above, the _PolicyManagementContext_ contains Aggregates that are maintained by different teams and [Split Bounded Context by Owner (AR-3)](/docs/ar-split-bounded-context-by-owners) can be applied:
<a href="/img/architectural-refactoring-handling-in-vscode-2.png"></a>
By clicking on the light bulb and the AR you want to apply the model will be refactored accordingly.
### Eclipse
Architectural refactorings can be applied within the Context Mapper Eclipse plugin by using the context menu in the DSL editor. With a
right-click on a bounded context or an aggregate the **Context Mapper: Refactor** menu entry appears and lists all refactorings which are applicable to the selected elements:
<a href="/img/architectural-refactorings-context-menu.png"></a>
You can also use the Shift-Alt-T keybinding for quick access to the available refactorings (the cursor must be on the object on which you want to start the refactoring).
*Note*: The context menu only shows ARs for which your selected model element fulfills the preconditions.
The preconditions for all ARs are mentioned on the corresponding detail pages linked above.