Baker is a library that provides a simple and intuitive way to orchestrate microservice-based process flows.
You declare your orchestration logic as a recipe using the Java, Kotlin, or Scala DSL. A recipe consists of
interactions
(system calls), ingredients
(data), and events
.
Bakers ability to visualize recipes provides a powerful communication tool that helps product owners, architects, and engineers to have a common understanding of the business process. This feature allows you to easily share your recipe with others, enabling collaboration and feedback.
Baker allows for the reuse of common interactions across different recipes, promoting consistency and reducing duplication. With Baker, you can quickly assemble complex process flows by reusing pre-existing building blocks that have been built by other teams within your company.
Use the list below to learn more about Baker:
- Documentation
- Concepts: high level concepts and terminology
- Recipe DSL: how to use the recipe DSL
- Visualization: how to visualize a recipe
- Baker Talk @ J-Fall 2021: API orchestration taken to the next level
A recipe is the blueprint of your business process. To create this blueprint you use the Java, Kotlin, or Scala DSL. The examples below demonstrate a recipe for a simple web shop process.
Java DSL
final Recipe recipe=new Recipe("Web shop")
.withSensoryEvents(
CustomerInfoReceived.class,
OrderPlaced.class,
PaymentMade.class
)
.withInteractions(
InteractionDescriptor.of(ValidateOrder.class),
InteractionDescriptor.of(ReserveItems.class)
.withRequiredEvent(PaymentMade.class),
InteractionDescriptor.of(ShipGoods.class),
InteractionDescriptor.of(SendInvoice.class)
.withRequiredEvent(GoodsShipped.class)
)
.withDefaultFailureStrategy(
new RetryWithIncrementalBackoffBuilder()
.withInitialDelay(Duration.ofMillis(100))
.withDeadline(Duration.ofHours(24))
.withMaxTimeBetweenRetries(Duration.ofMinutes(10))
.build());
Kotlin DSL
val recipe = recipe("Web shop") {
sensoryEvents {
event<CustomerInfoReceived>()
event<OrderPlaced>()
event<PaymentMade>()
}
interaction<ValidateOrder>()
interaction<ReserveItems> {
requiredEvents {
event<PaymentMade>()
}
}
interaction<ShipGoods>()
interaction<SendInvoice> {
requiredEvents {
event<GoodsShipped>()
}
}
defaultFailureStrategy = retryWithIncrementalBackoff {
initialDelay = 100.milliseconds
until = deadline(24.hours)
maxTimeBetweenRetries = 10.minutes
}
}
Scala DSL
val recipe: Recipe = Recipe("Web shop")
.withSensoryEvents(
Event[CustomerInfoReceived],
Event[OrderPlaced],
Event[PaymentMade]
)
.withInteractions(
ValidateOrder,
ReserveItems
.withRequiredEvent(Event[PaymentMade])
ShipGoods,
SendInvoice
.withRequiredEvent(goodsShipped)
)
.withDefaultFailureStrategy(
RetryWithIncrementalBackoff
.builder()
.withInitialDelay(100 milliseconds)
.withUntil(Some(UntilDeadline(24 hours)))
.withMaxTimeBetweenRetries(Some(10 minutes))
.build()
)
Baker is released to Maven Central. To use Baker you need three modules.
- recipe-dsl: DSL to describe recipes in a declarative manner
- compiler: Compiles recipes into models the runtime can execute
- runtime: The runtime to manage and execute recipes
Note If you want to use the Kotlin DSL add
baker-recipe-dsl-kotlin_2.13
instead ofbaker-recipe-dsl_2.13
.
<dependency>
<groupId>com.ing.baker</groupId>
<artifactId>baker-recipe-dsl_2.13</artifactId>
<version>3.6.3</version>
</dependency>
<dependency>
<groupId>com.ing.baker</groupId>
<artifactId>baker-compiler_2.13</artifactId>
<version>3.6.3</version>
</dependency>
<dependency>
<groupId>com.ing.baker</groupId>
<artifactId>baker-runtime_2.13</artifactId>
<version>3.6.3</version>
</dependency>
implementation 'com.ing.baker:baker-recipe-dsl_2.13:3.6.3'
implementation 'com.ing.baker:baker-compiler_2.13:3.6.3'
implementation 'com.ing.baker:baker-runtime_2.13:3.6.3'
Baker gets cross compiled and released for both Scala 2.12 and 2.13.
libraryDependencies += "com.ing.baker" % "baker-recipe-dsl_2.13" % "3.6.3"
libraryDependencies += "com.ing.baker" % "baker-compiler_2.13" % "3.6.3"
libraryDependencies += "com.ing.baker" % "baker-runtime_2.13" % "3.6.3"
We welcome your contributions! The simplest way to contribute to Baker is by creating a branch from a fork. You can then create a pull request on GitHub from your branch.
To compile and test all libraries:
sbt
> compile
> test
To cross compile all libraries for Scala 2.12 and 2.13:
sbt
> +compile
> +test
To build a single project (baker-akka-runtime, baker-anotations, etc...):
- Find the name of the project by running:
sbt
> projects
- Open the desired project via
sbt
:
sbt
> project <PROJECT_NAME>
> compile
> test