Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sovanmukherjee/springboot-drools-decision-table
Drools Decision Tables example with Spring Boot
https://github.com/sovanmukherjee/springboot-drools-decision-table
decision-tables drools excel gradle java-21 spring-boot-3
Last synced: about 1 month ago
JSON representation
Drools Decision Tables example with Spring Boot
- Host: GitHub
- URL: https://github.com/sovanmukherjee/springboot-drools-decision-table
- Owner: sovanmukherjee
- Created: 2024-07-20T18:16:53.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-07-26T17:26:09.000Z (5 months ago)
- Last Synced: 2024-10-20T04:53:59.469Z (2 months ago)
- Topics: decision-tables, drools, excel, gradle, java-21, spring-boot-3
- Language: Java
- Homepage: https://sovanmukherjee.github.io/springboot-drools-decision-table/
- Size: 86.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Getting Started 🚀
## [✨ _Spring Boot 3 + Drools + Decision tables_ ✨](https://github.com/sovanmukherjee/springboot-drools-decision-table)
### Overview
Drools is an open-source business rule management system (BRMS) that helps businesses automate decision-making by defining rules that determine what actions to take in various situations. Drools is a java-based rules engine that allows you to separate business logic from the application code, making it more easier to maintain, update and reuse.
#### Drools Basics
There are several ways to define rules in Drools, making it flexible and accessible for different users from developers to business analysts. Here are the few primary methods:
1. [Drools Rule Language (DRL):](https://docs.drools.org/8.39.0.Final/drools-docs/docs-website/drools/language-reference/index.html#:~:text=Using%20spreadsheet%20features-,Drools%20Rule%20Language%20(DRL),defining%20and%20describing%20business%20rules.) A native language for writing rules in Drools, similar to Java syntax.
Structure: Rules are written in plain text files with a .drl extension.
Example:
```sh
package package-name
imports
globals
functions
queries
rule "rule name"
// Attributes
when
LHS // Conditions
then
RHS // Actions
end
rule "rule2 name"
...
```
2. [Decision Tables:](https://docs.jboss.org/drools/release/5.2.0.Final/drools-expert-docs/html/ch06.html) Rules can be defined in spreadsheets, typically Excel.
Advantages: Easier for non-technical users to manage rules in a tabular format. Each row represents a rule with columns for conditions and actions.
Example: [discount.xls](https://github.com/sovanmukherjee/springboot-drools-decision-table/blob/main/src/main/resources/rules/discount.xls)
3. [Domain-Specific Languages (DSLs)](https://docs.jboss.org/drools/release/5.3.0.Final/drools-expert-docs/html/ch05.html#d0e6317): Allows creation of a custom language tailored to specific business domains.
Structure: A DSL file with a .dsl extension is a text file in a line-oriented format. Its entries are used for transforming a DSLR file into a file according to DRL syntax.
Example:
```
[when]There is a customer with age greater than {age}=Customer(age > {age})
[then]Approve the customer's loan=approveLoan($customer)
```
In this example we have used Decision Tables by creating excel file spreadsheet inside the spring boot application.
##### Advantages of Using Decision Tables
1. [Clarity and Readability:](https://github.com/sovanmukherjee/springboot-drools-decision-table/tree/main?tab=readme-ov-file#advantages-of-using-decision-tables) Presents rules in a clear, tabular format that is easy to read and understand.
2. [Visualization:](https://github.com/sovanmukherjee/springboot-drools-decision-table/tree/main?tab=readme-ov-file#advantages-of-using-decision-tables) Provides a visual representation of rules making it easier to identify gaps or overlaps in logic.
3. [Ease of Maintenance:](https://github.com/sovanmukherjee/springboot-drools-decision-table/tree/main?tab=readme-ov-file#advantages-of-using-decision-tables) Simplifies the process of updating rules as changes can be made directly in the table without delving into complex code.
4. [Collaboration:](https://github.com/sovanmukherjee/springboot-drools-decision-table/tree/main?tab=readme-ov-file#advantages-of-using-decision-tables) Facilitates collaboration between business analysts and developers as both can work from the same table format.
5. [Efficiency:](https://github.com/sovanmukherjee/springboot-drools-decision-table/tree/main?tab=readme-ov-file#advantages-of-using-decision-tables) Reduces redundancy by consolidating multiple related rules into a single table.
6. [Consistency:](https://github.com/sovanmukherjee/springboot-drools-decision-table/tree/main?tab=readme-ov-file#advantages-of-using-decision-tables) Ensures consistent application of rules as the table format reduces the likelihood of errors and omissions.
##### When to Avoid Using Decision Tables
1. [Non-Tabular Logic:](https://github.com/sovanmukherjee/springboot-drools-decision-table/tree/main?tab=readme-ov-file#when-to-avoid-using-decision-tables) When the rules do not fit into a tabular structure or involve complex logic that cannot be easily expressed in a table format. Decision tables are not suitable for rules that require intricate conditional logic or multiple interdependencies that are difficult to represent in rows and columns.
2. [Small Number of Rules:](https://github.com/sovanmukherjee/springboot-drools-decision-table/tree/main?tab=readme-ov-file#when-to-avoid-using-decision-tables) When there are only a few rules to manage. The overhead of setting up and maintaining a decision table might not be justified for a small number of rules, which can be more easily managed directly in code or through simple rule definitions.
3. [Unstructured Rules:](https://github.com/sovanmukherjee/springboot-drools-decision-table/tree/main?tab=readme-ov-file#when-to-avoid-using-decision-tables) Decision tables work best for rules that have a uniform structure. If the rules are too diverse or unstructured, it can be challenging to fit them into a decision table format.
4. [Preference Against Spreadsheets:](https://github.com/sovanmukherjee/springboot-drools-decision-table/tree/main?tab=readme-ov-file#when-to-avoid-using-decision-tables) When there is a dislike or organizational policy against using spreadsheet software like Excel or OpenOffice.org.
### Guides
In this example, we have defined the following rules using a decision table and the application will apply the highest possible discount on the purchase amount.
1. If the total purchase amount is greater than or equal to 60,000 then a maximum highest discount rate 12% will be applied.
2. If the total purchase amount is greater than or equal to 40,000 then 6% discount(3rd highest discount rate) will be applied.
3. If the total purchase amount is greater than or equal to 30,000 and if the user is from Arunachal Pradesh, Jammu and Kashmir, Lakshadweep, or Assam then a state-specific discount (2nd highest discount rate ) will be applied.
##### Q1: How can you stop rule execution once the first match is found in a decision table?
Approach: You can add an extra ACTION column and have in it "drools.halt();". Then in the row, put some text (such as "Y" or TRUE or "stop", the specific text doesn't matter as long as there is something present)
##### Technologies used in this example
- Spring boot version: 3.3.1
- Drools
- Java version 21
Step 1: Create a spring boot application and add required dependencies
Step 2: Creating the Excel spreadsheet drools decision table
DRL format of the above drools decision table:
```sh
package rules;
//generated from Decision Table
import org.drools.example.model.RuleDataset;
import java.math.BigDecimal;
import java.math.RoundingMode;
function boolean hasTotalPurchaseAmountReachedThresholdAmount(BigDecimal totalPurchaseAmount, double thresholdAmount) {
return totalPurchaseAmount.compareTo(BigDecimal.valueOf(thresholdAmount)) >= 0;
}
function BigDecimal getPayableAmount( BigDecimal totalPurchaseAmount, int discountRate) {
return totalPurchaseAmount
.subtract(totalPurchaseAmount
.multiply(BigDecimal.valueOf(discountRate))
.divide(BigDecimal.valueOf(100),2, RoundingMode.UP));
}
// rule values at A13, header at A8
rule "Total purchase amount >= 60000"
salience 65535
when
ruleDataset: RuleDataset(hasTotalPurchaseAmountReachedThresholdAmount(ruleDataset.getTotalPurchaseAmount(), 60000))
then
ruleDataset.setDiscountAllowed(true) ;
ruleDataset.setDiscountRate(12);
ruleDataset.setPayableAmount(getPayableAmount(ruleDataset.getTotalPurchaseAmount(), ruleDataset.getDiscountRate()));
drools.halt();
end
// rule values at A20, header at A15
rule "Total purchase amount >= 30000 AND State code is JK"
salience 65534
when
ruleDataset: RuleDataset(hasTotalPurchaseAmountReachedThresholdAmount(ruleDataset.getTotalPurchaseAmount(), 30000), ruleDataset.getStateCode() == "JK")
then
ruleDataset.setDiscountAllowed(true) ;
ruleDataset.setDiscountRate(9);
ruleDataset.setPayableAmount(getPayableAmount(ruleDataset.getTotalPurchaseAmount(), ruleDataset.getDiscountRate()));
drools.halt();
end
// rule values at A21, header at A15
rule "Total purchase amount >= 30000 AND State code LD"
salience 65533
when
ruleDataset: RuleDataset(hasTotalPurchaseAmountReachedThresholdAmount(ruleDataset.getTotalPurchaseAmount(), 30000), ruleDataset.getStateCode() == "LD")
then
ruleDataset.setDiscountAllowed(true) ;
ruleDataset.setDiscountRate(10);
ruleDataset.setPayableAmount(getPayableAmount(ruleDataset.getTotalPurchaseAmount(), ruleDataset.getDiscountRate()));
drools.halt();
end
// rule values at A22, header at A15
rule "Total purchase amount >= 30000 AND State code is AS"
salience 65532
when
ruleDataset: RuleDataset(hasTotalPurchaseAmountReachedThresholdAmount(ruleDataset.getTotalPurchaseAmount(), 30000), ruleDataset.getStateCode() == "AS")
then
ruleDataset.setDiscountAllowed(true) ;
ruleDataset.setDiscountRate(8);
ruleDataset.setPayableAmount(getPayableAmount(ruleDataset.getTotalPurchaseAmount(), ruleDataset.getDiscountRate()));
drools.halt();
end
// rule values at A23, header at A15
rule "Total purchase amount >= 30000 AND State code are AR"
salience 65531
when
ruleDataset: RuleDataset(hasTotalPurchaseAmountReachedThresholdAmount(ruleDataset.getTotalPurchaseAmount(), 30000), ruleDataset.getStateCode() == "AR")
then
ruleDataset.setDiscountAllowed(true) ;
ruleDataset.setDiscountRate(10);
ruleDataset.setPayableAmount(getPayableAmount(ruleDataset.getTotalPurchaseAmount(), ruleDataset.getDiscountRate()));
drools.halt();
end
// rule values at A30, header at A25
rule "Total purchase amount >= 40000"
salience 65530
when
ruleDataset: RuleDataset(hasTotalPurchaseAmountReachedThresholdAmount(ruleDataset.getTotalPurchaseAmount(), 40000))
then
ruleDataset.setDiscountAllowed(true) ;
ruleDataset.setDiscountRate(6);
ruleDataset.setPayableAmount(getPayableAmount(ruleDataset.getTotalPurchaseAmount(), ruleDataset.getDiscountRate()));
drools.halt();
end
```
Step 3: Add the drools configuration in spring boot application
We configured 'StatelessKieSession' as a Spring bean to be used in the service layer.
Step 4: Create a REST endpoint
Step 5: Add service layer
Step 6: Start the Spring Boot application and open the Swagger endpoint.
http://localhost:8080/swagger-ui/index.html
Input-1:
Output:
Input-2:
Output:
Input-3:
Output:
Input-4:
Output:
### Reference Documentation
For further reference, please consider the following sections:
* [Drools Expert User Guide](https://docs.drools.org/6.0.0.Beta2/drools-expert-docs/html_single/)
* [The Rule Engine](https://docs.jboss.org/drools/release/5.2.0.Final/drools-expert-docs/html/ch01.html)
* [Decision Tables](https://docs.jboss.org/drools/release/5.2.0.Final/drools-expert-docs/html/ch06.html)
### Additional Links
These additional references should also help you:
* [Gradle Build Scans – insights for your project's build](https://scans.gradle.com#gradle)
* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/)
* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/)
* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/)