Compare commits
2 Commits
vuepress
...
all-contri
Author | SHA1 | Date | |
---|---|---|---|
cdcf348fd3 | |||
08659d8c43 |
@ -1559,78 +1559,6 @@
|
||||
"contributions": [
|
||||
"translation"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "AndriyPyzh",
|
||||
"name": "AndriyPyzh",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/u/57706635?v=4",
|
||||
"profile": "https://github.com/AndriyPyzh",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "karthikbhat13",
|
||||
"name": "karthikbhat13",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/u/22431014?v=4",
|
||||
"profile": "https://github.com/karthikbhat13",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "mortezaadi",
|
||||
"name": "Morteza Adigozalpour",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/u/1329687?v=4",
|
||||
"profile": "https://github.com/mortezaadi",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "tan31989",
|
||||
"name": "Nagaraj Tantri",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/u/3784194?v=4",
|
||||
"profile": "https://stackoverflow.com/users/308565/nagaraj-tantri",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "frascu",
|
||||
"name": "Francesco Scuccimarri",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/u/7107651?v=4",
|
||||
"profile": "http://scuccimarri.it",
|
||||
"contributions": [
|
||||
"code"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "Conhan93",
|
||||
"name": "Conny Hansson",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/u/71334757?v=4",
|
||||
"profile": "https://github.com/Conhan93",
|
||||
"contributions": [
|
||||
"doc"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "muklasr",
|
||||
"name": "Muklas Rahmanto",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/u/43443753?v=4",
|
||||
"profile": "http://muklasr.medium.com",
|
||||
"contributions": [
|
||||
"translation"
|
||||
]
|
||||
},
|
||||
{
|
||||
"login": "VxDxK",
|
||||
"name": "Vadim",
|
||||
"avatar_url": "https://avatars.githubusercontent.com/u/38704817?v=4",
|
||||
"profile": "https://github.com/VxDxK",
|
||||
"contributions": [
|
||||
"translation"
|
||||
]
|
||||
}
|
||||
],
|
||||
"contributorsPerLine": 4,
|
||||
|
16
README.md
16
README.md
@ -10,12 +10,12 @@
|
||||
[](https://sonarcloud.io/dashboard?id=iluwatar_java-design-patterns)
|
||||
[](https://gitter.im/iluwatar/java-design-patterns?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
[](#contributors-)
|
||||
[](#contributors-)
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
|
||||
<br/>
|
||||
|
||||
Read in different language : [**zh**](localization/zh/README.md), [**ko**](localization/ko/README.md), [**fr**](localization/fr/README.md), [**tr**](localization/tr/README.md), [**ar**](localization/ar/README.md), [**es**](localization/es/README.md), [**pt**](localization/pt/README.md), [**id**](localization/id/README.md), [**ru**](localization/ru/README.md)
|
||||
Read in different language : [**zh**](/localization/zh/README.md), [**ko**](/localization/ko/README.md), [**fr**](/localization/fr/README.md), [**tr**](/localization/tr/README.md), [**ar**](/localization/ar/README.md), [**es**](/localization/es/README.md), [**pt**](/localization/pt/README.md)
|
||||
|
||||
<br/>
|
||||
|
||||
@ -331,18 +331,6 @@ This project is licensed under the terms of the MIT license.
|
||||
<td align="center"><a href="https://github.com/Xenilo137"><img src="https://avatars.githubusercontent.com/u/24865069?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Xenilo137</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=Xenilo137" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://www.linkedin.com/in/souzasamuel/"><img src="https://avatars.githubusercontent.com/u/17254162?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Samuel Souza</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=samuelpsouza" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/marlo2222"><img src="https://avatars.githubusercontent.com/u/40809563?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Marlo Henrique</b></sub></a><br /><a href="#translation-marlo2222" title="Translation">🌍</a></td>
|
||||
<td align="center"><a href="https://github.com/AndriyPyzh"><img src="https://avatars.githubusercontent.com/u/57706635?v=4?s=100" width="100px;" alt=""/><br /><sub><b>AndriyPyzh</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=AndriyPyzh" title="Code">💻</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><a href="https://github.com/karthikbhat13"><img src="https://avatars.githubusercontent.com/u/22431014?v=4?s=100" width="100px;" alt=""/><br /><sub><b>karthikbhat13</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=karthikbhat13" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://github.com/mortezaadi"><img src="https://avatars.githubusercontent.com/u/1329687?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Morteza Adigozalpour</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=mortezaadi" title="Code">💻</a></td>
|
||||
<td align="center"><a href="https://stackoverflow.com/users/308565/nagaraj-tantri"><img src="https://avatars.githubusercontent.com/u/3784194?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nagaraj Tantri</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=tan31989" title="Code">💻</a></td>
|
||||
<td align="center"><a href="http://scuccimarri.it"><img src="https://avatars.githubusercontent.com/u/7107651?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Francesco Scuccimarri</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=frascu" title="Code">💻</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><a href="https://github.com/Conhan93"><img src="https://avatars.githubusercontent.com/u/71334757?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Conny Hansson</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=Conhan93" title="Documentation">📖</a></td>
|
||||
<td align="center"><a href="http://muklasr.medium.com"><img src="https://avatars.githubusercontent.com/u/43443753?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Muklas Rahmanto</b></sub></a><br /><a href="#translation-muklasr" title="Translation">🌍</a></td>
|
||||
<td align="center"><a href="https://github.com/VxDxK"><img src="https://avatars.githubusercontent.com/u/38704817?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vadim</b></sub></a><br /><a href="#translation-VxDxK" title="Translation">🌍</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Abstract Document
|
||||
category: Structural
|
||||
folder: abstract-document
|
||||
permalink: /patterns/abstract-document/
|
||||
categories: Structural
|
||||
language: en
|
||||
tags:
|
||||
- Extensibility
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Abstract Factory
|
||||
category: Creational
|
||||
folder: abstract-factory
|
||||
permalink: /patterns/abstract-factory/
|
||||
categories: Creational
|
||||
language: en
|
||||
tags:
|
||||
- Gang of Four
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Active Object
|
||||
category: Concurrency
|
||||
folder: active-object
|
||||
permalink: /patterns/active-object/
|
||||
categories: Concurrency
|
||||
language: en
|
||||
tags:
|
||||
- Performance
|
||||
@ -8,7 +11,7 @@ tags:
|
||||
|
||||
|
||||
## Intent
|
||||
The active object design pattern decouples method execution from method invocation for objects that each reside in their thread of control. The goal is to introduce concurrency, by using asynchronous method invocation, and a scheduler for handling requests.
|
||||
The active object design pattern decouples method execution from method invocation for objects that each reside in their thread of control. The goal is to introduce concurrency, by using asynchronous method invocation and a scheduler for handling requests.
|
||||
|
||||
## Explanation
|
||||
|
||||
@ -67,7 +70,7 @@ public abstract class ActiveCreature{
|
||||
requests.put(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
logger.info("{} has started to roam the wastelands.",name());
|
||||
logger.info("{} has started to roam and the wastelands.",name());
|
||||
}
|
||||
}
|
||||
);
|
||||
@ -79,7 +82,7 @@ public abstract class ActiveCreature{
|
||||
}
|
||||
```
|
||||
|
||||
We can see that any class that will extend the ActiveCreature class will have its own thread of control to invoke and execute methods.
|
||||
We can see that any class that will extend the ActiveCreature class will have its own thread of control to execute and invocate methods.
|
||||
|
||||
For example, the Orc class:
|
||||
|
||||
@ -93,7 +96,7 @@ public class Orc extends ActiveCreature {
|
||||
}
|
||||
```
|
||||
|
||||
Now, we can create multiple creatures such as Orcs, tell them to eat and roam, and they will execute it on their own thread of control:
|
||||
Now, we can create multiple creatures such as Orcs, tell them to eat and roam and they will execute it on their own thread of control:
|
||||
|
||||
```java
|
||||
public static void main(String[] args) {
|
||||
@ -120,4 +123,4 @@ Now, we can create multiple creatures such as Orcs, tell them to eat and roam, a
|
||||
|
||||
## Class diagram
|
||||
|
||||

|
||||

|
||||
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
@ -82,7 +82,7 @@ public abstract class ActiveCreature {
|
||||
}
|
||||
|
||||
/**
|
||||
* Roam the wastelands.
|
||||
* Roam in the wastelands.
|
||||
* @throws InterruptedException due to firing a new Runnable.
|
||||
*/
|
||||
public void roam() throws InterruptedException {
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Acyclic Visitor
|
||||
category: Behavioral
|
||||
folder: acyclic-visitor
|
||||
permalink: /patterns/acyclic-visitor/
|
||||
categories: Behavioral
|
||||
language: en
|
||||
tags:
|
||||
- Extensibility
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Adapter
|
||||
category: Structural
|
||||
folder: adapter
|
||||
permalink: /patterns/adapter/
|
||||
categories: Structural
|
||||
language: en
|
||||
tags:
|
||||
- Gang of Four
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Aggregator Microservices
|
||||
category: Architectural
|
||||
folder: aggregator-microservices
|
||||
permalink: /patterns/aggregator-microservices/
|
||||
categories: Architectural
|
||||
language: en
|
||||
tags:
|
||||
- Cloud distributed
|
||||
|
@ -48,7 +48,7 @@ class AggregatorTest {
|
||||
|
||||
@BeforeEach
|
||||
public void setup() {
|
||||
MockitoAnnotations.openMocks(this);
|
||||
MockitoAnnotations.initMocks(this);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Ambassador
|
||||
category: Structural
|
||||
folder: ambassador
|
||||
permalink: /patterns/ambassador/
|
||||
categories: Structural
|
||||
language: en
|
||||
tags:
|
||||
- Decoupling
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: API Gateway
|
||||
category: Architectural
|
||||
folder: api-gateway
|
||||
permalink: /patterns/api-gateway/
|
||||
categories: Architectural
|
||||
language: en
|
||||
tags:
|
||||
- Cloud distributed
|
||||
|
@ -48,7 +48,7 @@ class ApiGatewayTest {
|
||||
|
||||
@BeforeEach
|
||||
public void setup() {
|
||||
MockitoAnnotations.openMocks(this);
|
||||
MockitoAnnotations.initMocks(this);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Arrange/Act/Assert
|
||||
category: Idiom
|
||||
folder: arrange-act-assert
|
||||
permalink: /patterns/arrange-act-assert/
|
||||
categories: Idiom
|
||||
language: en
|
||||
tags:
|
||||
- Testing
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Async Method Invocation
|
||||
category: Concurrency
|
||||
folder: async-method-invocation
|
||||
permalink: /patterns/async-method-invocation/
|
||||
categories: Concurrency
|
||||
language: en
|
||||
tags:
|
||||
- Reactive
|
||||
|
@ -68,7 +68,7 @@ class ThreadAsyncExecutorTest {
|
||||
|
||||
@BeforeEach
|
||||
void setUp() {
|
||||
MockitoAnnotations.openMocks(this);
|
||||
MockitoAnnotations.initMocks(this);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Balking
|
||||
category: Concurrency
|
||||
folder: balking
|
||||
permalink: /patterns/balking/
|
||||
categories: Concurrency
|
||||
language: en
|
||||
tags:
|
||||
- Decoupling
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Bridge
|
||||
category: Structural
|
||||
folder: bridge
|
||||
permalink: /patterns/bridge/
|
||||
categories: Structural
|
||||
language: en
|
||||
tags:
|
||||
- Gang of Four
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Builder
|
||||
category: Creational
|
||||
folder: builder
|
||||
permalink: /patterns/builder/
|
||||
categories: Creational
|
||||
language: en
|
||||
tags:
|
||||
- Gang of Four
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Business Delegate
|
||||
category: Structural
|
||||
folder: business-delegate
|
||||
permalink: /patterns/business-delegate/
|
||||
categories: Structural
|
||||
language: en
|
||||
tags:
|
||||
- Decoupling
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Bytecode
|
||||
category: Behavioral
|
||||
folder: bytecode
|
||||
permalink: /patterns/bytecode/
|
||||
categories: Behavioral
|
||||
language: en
|
||||
tags:
|
||||
- Game programming
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Caching
|
||||
category: Behavioral
|
||||
folder: caching
|
||||
permalink: /patterns/caching/
|
||||
categories: Behavioral
|
||||
language: en
|
||||
tags:
|
||||
- Performance
|
||||
@ -40,29 +43,39 @@ Wikipedia says:
|
||||
**Programmatic Example**
|
||||
|
||||
Let's first look at the data layer of our application. The interesting classes are `UserAccount`
|
||||
which is a simple Java object containing the user account details, and `DbManager` interface which handles
|
||||
reading and writing of these objects to/from database.
|
||||
which is a simple Java object containing the user account details, and `DbManager` which handles
|
||||
reading and writing of these objects to/from MongoDB database.
|
||||
|
||||
```java
|
||||
@Data
|
||||
@Setter
|
||||
@Getter
|
||||
@AllArgsConstructor
|
||||
@ToString
|
||||
@EqualsAndHashCode
|
||||
public class UserAccount {
|
||||
private String userId;
|
||||
private String userName;
|
||||
private String additionalInfo;
|
||||
}
|
||||
|
||||
public interface DbManager {
|
||||
@Slf4j
|
||||
public final class DbManager {
|
||||
|
||||
void connect();
|
||||
void disconnect();
|
||||
|
||||
UserAccount readFromDb(String userId);
|
||||
UserAccount writeToDb(UserAccount userAccount);
|
||||
UserAccount updateDb(UserAccount userAccount);
|
||||
UserAccount upsertDb(UserAccount userAccount);
|
||||
private static MongoClient mongoClient;
|
||||
private static MongoDatabase db;
|
||||
|
||||
private DbManager() { /*...*/ }
|
||||
|
||||
public static void createVirtualDb() { /*...*/ }
|
||||
|
||||
public static void connect() throws ParseException { /*...*/ }
|
||||
|
||||
public static UserAccount readFromDb(String userId) { /*...*/ }
|
||||
|
||||
public static void writeToDb(UserAccount userAccount) { /*...*/ }
|
||||
|
||||
public static void updateDb(UserAccount userAccount) { /*...*/ }
|
||||
|
||||
public static void upsertDb(UserAccount userAccount) { /*...*/ }
|
||||
}
|
||||
```
|
||||
|
||||
@ -158,43 +171,30 @@ strategies.
|
||||
@Slf4j
|
||||
public class CacheStore {
|
||||
|
||||
private static final int CAPACITY = 3;
|
||||
private static LruCache cache;
|
||||
private final DbManager dbManager;
|
||||
|
||||
/* ... details omitted ... */
|
||||
|
||||
public UserAccount readThrough(final String userId) {
|
||||
public static UserAccount readThrough(String userId) {
|
||||
if (cache.contains(userId)) {
|
||||
LOGGER.info("# Found in Cache!");
|
||||
LOGGER.info("# Cache Hit!");
|
||||
return cache.get(userId);
|
||||
}
|
||||
LOGGER.info("# Not found in cache! Go to DB!!");
|
||||
UserAccount userAccount = dbManager.readFromDb(userId);
|
||||
LOGGER.info("# Cache Miss!");
|
||||
UserAccount userAccount = DbManager.readFromDb(userId);
|
||||
cache.set(userId, userAccount);
|
||||
return userAccount;
|
||||
}
|
||||
|
||||
public void writeThrough(final UserAccount userAccount) {
|
||||
public static void writeThrough(UserAccount userAccount) {
|
||||
if (cache.contains(userAccount.getUserId())) {
|
||||
dbManager.updateDb(userAccount);
|
||||
DbManager.updateDb(userAccount);
|
||||
} else {
|
||||
dbManager.writeToDb(userAccount);
|
||||
DbManager.writeToDb(userAccount);
|
||||
}
|
||||
cache.set(userAccount.getUserId(), userAccount);
|
||||
}
|
||||
|
||||
public void writeAround(final UserAccount userAccount) {
|
||||
if (cache.contains(userAccount.getUserId())) {
|
||||
dbManager.updateDb(userAccount);
|
||||
// Cache data has been updated -- remove older
|
||||
cache.invalidate(userAccount.getUserId());
|
||||
// version from cache.
|
||||
} else {
|
||||
dbManager.writeToDb(userAccount);
|
||||
}
|
||||
}
|
||||
|
||||
public static void clearCache() {
|
||||
if (cache != null) {
|
||||
cache.clear();
|
||||
@ -225,39 +225,34 @@ class.
|
||||
public final class AppManager {
|
||||
|
||||
private static CachingPolicy cachingPolicy;
|
||||
private final DbManager dbManager;
|
||||
private final CacheStore cacheStore;
|
||||
|
||||
private AppManager() {
|
||||
}
|
||||
|
||||
public void initDb() { /* ... */ }
|
||||
public static void initDb(boolean useMongoDb) { /* ... */ }
|
||||
|
||||
public static void initCachingPolicy(CachingPolicy policy) { /* ... */ }
|
||||
|
||||
public static void initCacheCapacity(int capacity) { /* ... */ }
|
||||
|
||||
public UserAccount find(final String userId) {
|
||||
LOGGER.info("Trying to find {} in cache", userId);
|
||||
if (cachingPolicy == CachingPolicy.THROUGH
|
||||
|| cachingPolicy == CachingPolicy.AROUND) {
|
||||
return cacheStore.readThrough(userId);
|
||||
public static UserAccount find(String userId) {
|
||||
if (cachingPolicy == CachingPolicy.THROUGH || cachingPolicy == CachingPolicy.AROUND) {
|
||||
return CacheStore.readThrough(userId);
|
||||
} else if (cachingPolicy == CachingPolicy.BEHIND) {
|
||||
return cacheStore.readThroughWithWriteBackPolicy(userId);
|
||||
return CacheStore.readThroughWithWriteBackPolicy(userId);
|
||||
} else if (cachingPolicy == CachingPolicy.ASIDE) {
|
||||
return findAside(userId);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
public void save(final UserAccount userAccount) {
|
||||
LOGGER.info("Save record!");
|
||||
public static void save(UserAccount userAccount) {
|
||||
if (cachingPolicy == CachingPolicy.THROUGH) {
|
||||
cacheStore.writeThrough(userAccount);
|
||||
CacheStore.writeThrough(userAccount);
|
||||
} else if (cachingPolicy == CachingPolicy.AROUND) {
|
||||
cacheStore.writeAround(userAccount);
|
||||
CacheStore.writeAround(userAccount);
|
||||
} else if (cachingPolicy == CachingPolicy.BEHIND) {
|
||||
cacheStore.writeBehind(userAccount);
|
||||
CacheStore.writeBehind(userAccount);
|
||||
} else if (cachingPolicy == CachingPolicy.ASIDE) {
|
||||
saveAside(userAccount);
|
||||
}
|
||||
@ -277,35 +272,24 @@ Here is what we do in the main class of the application.
|
||||
@Slf4j
|
||||
public class App {
|
||||
|
||||
public static void main(final String[] args) {
|
||||
boolean isDbMongo = isDbMongo(args);
|
||||
if(isDbMongo){
|
||||
LOGGER.info("Using the Mongo database engine to run the application.");
|
||||
} else {
|
||||
LOGGER.info("Using the 'in Memory' database to run the application.");
|
||||
}
|
||||
App app = new App(isDbMongo);
|
||||
public static void main(String[] args) {
|
||||
AppManager.initDb(false);
|
||||
AppManager.initCacheCapacity(3);
|
||||
var app = new App();
|
||||
app.useReadAndWriteThroughStrategy();
|
||||
String splitLine = "==============================================";
|
||||
LOGGER.info(splitLine);
|
||||
app.useReadThroughAndWriteAroundStrategy();
|
||||
LOGGER.info(splitLine);
|
||||
app.useReadThroughAndWriteBehindStrategy();
|
||||
LOGGER.info(splitLine);
|
||||
app.useCacheAsideStategy();
|
||||
LOGGER.info(splitLine);
|
||||
}
|
||||
|
||||
public void useReadAndWriteThroughStrategy() {
|
||||
LOGGER.info("# CachingPolicy.THROUGH");
|
||||
appManager.initCachingPolicy(CachingPolicy.THROUGH);
|
||||
|
||||
AppManager.initCachingPolicy(CachingPolicy.THROUGH);
|
||||
var userAccount1 = new UserAccount("001", "John", "He is a boy.");
|
||||
|
||||
appManager.save(userAccount1);
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
appManager.find("001");
|
||||
appManager.find("001");
|
||||
AppManager.save(userAccount1);
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
AppManager.find("001");
|
||||
AppManager.find("001");
|
||||
}
|
||||
|
||||
public void useReadThroughAndWriteAroundStrategy() { /* ... */ }
|
||||
@ -316,6 +300,16 @@ public class App {
|
||||
}
|
||||
```
|
||||
|
||||
Finally, here is some of the console output from the program.
|
||||
|
||||
```
|
||||
12:32:53.845 [main] INFO com.iluwatar.caching.App - # CachingPolicy.THROUGH
|
||||
12:32:53.900 [main] INFO com.iluwatar.caching.App -
|
||||
--CACHE CONTENT--
|
||||
UserAccount(userId=001, userName=John, additionalInfo=He is a boy.)
|
||||
----
|
||||
```
|
||||
|
||||
## Class diagram
|
||||
|
||||

|
||||
|
@ -1,11 +0,0 @@
|
||||
version: '3.7'
|
||||
services:
|
||||
mongodb_container:
|
||||
image: mongo:latest
|
||||
environment:
|
||||
MONGO_INITDB_ROOT_USERNAME: root
|
||||
MONGO_INITDB_ROOT_PASSWORD: rootpassword
|
||||
ports:
|
||||
- 27017:27017
|
||||
volumes:
|
||||
- ./mongo-data/:/data/db
|
@ -39,21 +39,19 @@
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.mockito</groupId>
|
||||
<artifactId>mockito-junit-jupiter</artifactId>
|
||||
<version>3.12.4</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.mockito</groupId>
|
||||
<artifactId>mockito-all</artifactId>
|
||||
<version>1.10.19</version>
|
||||
<scope>test</scope>
|
||||
<groupId>org.mongodb</groupId>
|
||||
<artifactId>mongodb-driver</artifactId>
|
||||
<version>3.12.1</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.mongodb</groupId>
|
||||
<artifactId>mongo-java-driver</artifactId>
|
||||
<version>3.4.1</version>
|
||||
<artifactId>mongodb-driver-core</artifactId>
|
||||
<version>3.0.4</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.mongodb</groupId>
|
||||
<artifactId>bson</artifactId>
|
||||
<version>3.0.4</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<!--
|
||||
|
@ -1,62 +1,58 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.caching;
|
||||
|
||||
import com.iluwatar.caching.database.DbManager;
|
||||
import com.iluwatar.caching.database.DbManagerFactory;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
|
||||
/**
|
||||
* The Caching pattern describes how to avoid expensive re-acquisition of
|
||||
* resources by not releasing the resources immediately after their use.
|
||||
* The resources retain their identity, are kept in some fast-access storage,
|
||||
* and are re-used to avoid having to acquire them again. There are four main
|
||||
* caching strategies/techniques in this pattern; each with their own pros and
|
||||
* cons. They are <code>write-through</code> which writes data to the cache and
|
||||
* DB in a single transaction, <code>write-around</code> which writes data
|
||||
* immediately into the DB instead of the cache, <code>write-behind</code>
|
||||
* which writes data into the cache initially whilst the data is only
|
||||
* written into the DB when the cache is full, and <code>cache-aside</code>
|
||||
* which pushes the responsibility of keeping the data synchronized in both
|
||||
* data sources to the application itself. The <code>read-through</code>
|
||||
* strategy is also included in the mentioned four strategies --
|
||||
* returns data from the cache to the caller <b>if</b> it exists <b>else</b>
|
||||
* queries from DB and stores it into the cache for future use. These strategies
|
||||
* determine when the data in the cache should be written back to the backing
|
||||
* store (i.e. Database) and help keep both data sources
|
||||
* synchronized/up-to-date. This pattern can improve performance and also helps
|
||||
* to maintainconsistency between data held in the cache and the data in
|
||||
* the underlying data store.
|
||||
* The Caching pattern describes how to avoid expensive re-acquisition of resources by not releasing
|
||||
* the resources immediately after their use. The resources retain their identity, are kept in some
|
||||
* fast-access storage, and are re-used to avoid having to acquire them again. There are four main
|
||||
* caching strategies/techniques in this pattern; each with their own pros and cons. They are;
|
||||
* <code>write-through</code> which writes data to the cache and DB in a single transaction,
|
||||
* <code>write-around</code> which writes data immediately into the DB instead of the cache,
|
||||
* <code>write-behind</code> which writes data into the cache initially whilst the data is only
|
||||
* written into the DB when the cache is full, and <code>cache-aside</code> which pushes the
|
||||
* responsibility of keeping the data synchronized in both data sources to the application itself.
|
||||
* The <code>read-through</code> strategy is also included in the mentioned four strategies --
|
||||
* returns data from the cache to the caller <b>if</b> it exists <b>else</b> queries from DB and
|
||||
* stores it into the cache for future use. These strategies determine when the data in the cache
|
||||
* should be written back to the backing store (i.e. Database) and help keep both data sources
|
||||
* synchronized/up-to-date. This pattern can improve performance and also helps to maintain
|
||||
* consistency between data held in the cache and the data in the underlying data store.
|
||||
*
|
||||
* <p>In this example, the user account ({@link UserAccount}) entity is used
|
||||
* as the underlying application data. The cache itself is implemented as an
|
||||
* internal (Java) data structure. It adopts a Least-Recently-Used (LRU)
|
||||
* strategy for evicting data from itself when its full. The four
|
||||
* strategies are individually tested. The testing of the cache is restricted
|
||||
* towards saving and querying of user accounts from the
|
||||
* underlying data store( {@link DbManager}). The main class ( {@link App}
|
||||
* is not aware of the underlying mechanics of the application
|
||||
* (i.e. save and query) and whether the data is coming from the cache or the
|
||||
* DB (i.e. separation of concern). The AppManager ({@link AppManager}) handles
|
||||
* the transaction of data to-and-from the underlying data store (depending on
|
||||
* the preferred caching policy/strategy).
|
||||
* <p>In this example, the user account ({@link UserAccount}) entity is used as the underlying
|
||||
* application data. The cache itself is implemented as an internal (Java) data structure. It adopts
|
||||
* a Least-Recently-Used (LRU) strategy for evicting data from itself when its full. The four
|
||||
* strategies are individually tested. The testing of the cache is restricted towards saving and
|
||||
* querying of user accounts from the underlying data store ( {@link DbManager}). The main class (
|
||||
* {@link App} is not aware of the underlying mechanics of the application (i.e. save and query) and
|
||||
* whether the data is coming from the cache or the DB (i.e. separation of concern). The AppManager
|
||||
* ({@link AppManager}) handles the transaction of data to-and-from the underlying data store
|
||||
* (depending on the preferred caching policy/strategy).
|
||||
* <p>
|
||||
* <i>{@literal App --> AppManager --> CacheStore/LRUCache/CachingPolicy -->
|
||||
* DBManager} </i>
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* There are 2 ways to launch the application.
|
||||
* - to use "in Memory" database.
|
||||
* - to use the MongoDb as a database
|
||||
*
|
||||
* To run the application with "in Memory" database, just launch it without parameters
|
||||
* Example: 'java -jar app.jar'
|
||||
*
|
||||
* To run the application with MongoDb you need to be installed the MongoDb
|
||||
* in your system, or to launch it in the docker container.
|
||||
* You may launch docker container from the root of current module with command:
|
||||
* 'docker-compose up'
|
||||
* Then you can start the application with parameter --mongo
|
||||
* Example: 'java -jar app.jar --mongo'
|
||||
* <i>{@literal App --> AppManager --> CacheStore/LRUCache/CachingPolicy --> DBManager} </i>
|
||||
* </p>
|
||||
*
|
||||
* @see CacheStore
|
||||
@ -65,67 +61,23 @@ import lombok.extern.slf4j.Slf4j;
|
||||
*/
|
||||
@Slf4j
|
||||
public class App {
|
||||
/**
|
||||
* Constant parameter name to use mongoDB.
|
||||
*/
|
||||
private static final String USE_MONGO_DB = "--mongo";
|
||||
/**
|
||||
* Application manager.
|
||||
*/
|
||||
private final AppManager appManager;
|
||||
|
||||
/**
|
||||
* Constructor of current App.
|
||||
*
|
||||
* @param isMongo boolean
|
||||
*/
|
||||
public App(final boolean isMongo) {
|
||||
DbManager dbManager = DbManagerFactory.initDb(isMongo);
|
||||
appManager = new AppManager(dbManager);
|
||||
appManager.initDb();
|
||||
}
|
||||
|
||||
/**
|
||||
* Program entry point.
|
||||
*
|
||||
* @param args command line args
|
||||
*/
|
||||
public static void main(final String[] args) {
|
||||
// VirtualDB (instead of MongoDB) was used in running the JUnit tests
|
||||
public static void main(String[] args) {
|
||||
AppManager.initDb(false); // VirtualDB (instead of MongoDB) was used in running the JUnit tests
|
||||
// and the App class to avoid Maven compilation errors. Set flag to
|
||||
// true to run the tests with MongoDB (provided that MongoDB is
|
||||
// installed and socket connection is open).
|
||||
boolean isDbMongo = isDbMongo(args);
|
||||
if (isDbMongo) {
|
||||
LOGGER.info("Using the Mongo database engine to run the application.");
|
||||
} else {
|
||||
LOGGER.info("Using the 'in Memory' database to run the application.");
|
||||
}
|
||||
App app = new App(isDbMongo);
|
||||
AppManager.initCacheCapacity(3);
|
||||
var app = new App();
|
||||
app.useReadAndWriteThroughStrategy();
|
||||
String splitLine = "==============================================";
|
||||
LOGGER.info(splitLine);
|
||||
app.useReadThroughAndWriteAroundStrategy();
|
||||
LOGGER.info(splitLine);
|
||||
app.useReadThroughAndWriteBehindStrategy();
|
||||
LOGGER.info(splitLine);
|
||||
app.useCacheAsideStategy();
|
||||
LOGGER.info(splitLine);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check the input parameters. if
|
||||
*
|
||||
* @param args input params
|
||||
* @return true if there is "--mongo" parameter in arguments
|
||||
*/
|
||||
private static boolean isDbMongo(final String[] args) {
|
||||
for (String arg : args) {
|
||||
if (arg.equals(USE_MONGO_DB)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -133,14 +85,14 @@ public class App {
|
||||
*/
|
||||
public void useReadAndWriteThroughStrategy() {
|
||||
LOGGER.info("# CachingPolicy.THROUGH");
|
||||
appManager.initCachingPolicy(CachingPolicy.THROUGH);
|
||||
AppManager.initCachingPolicy(CachingPolicy.THROUGH);
|
||||
|
||||
var userAccount1 = new UserAccount("001", "John", "He is a boy.");
|
||||
|
||||
appManager.save(userAccount1);
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
appManager.find("001");
|
||||
appManager.find("001");
|
||||
AppManager.save(userAccount1);
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
AppManager.find("001");
|
||||
AppManager.find("001");
|
||||
}
|
||||
|
||||
/**
|
||||
@ -148,21 +100,21 @@ public class App {
|
||||
*/
|
||||
public void useReadThroughAndWriteAroundStrategy() {
|
||||
LOGGER.info("# CachingPolicy.AROUND");
|
||||
appManager.initCachingPolicy(CachingPolicy.AROUND);
|
||||
AppManager.initCachingPolicy(CachingPolicy.AROUND);
|
||||
|
||||
var userAccount2 = new UserAccount("002", "Jane", "She is a girl.");
|
||||
|
||||
appManager.save(userAccount2);
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
appManager.find("002");
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
userAccount2 = appManager.find("002");
|
||||
AppManager.save(userAccount2);
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
AppManager.find("002");
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
userAccount2 = AppManager.find("002");
|
||||
userAccount2.setUserName("Jane G.");
|
||||
appManager.save(userAccount2);
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
appManager.find("002");
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
appManager.find("002");
|
||||
AppManager.save(userAccount2);
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
AppManager.find("002");
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
AppManager.find("002");
|
||||
}
|
||||
|
||||
/**
|
||||
@ -170,31 +122,23 @@ public class App {
|
||||
*/
|
||||
public void useReadThroughAndWriteBehindStrategy() {
|
||||
LOGGER.info("# CachingPolicy.BEHIND");
|
||||
appManager.initCachingPolicy(CachingPolicy.BEHIND);
|
||||
AppManager.initCachingPolicy(CachingPolicy.BEHIND);
|
||||
|
||||
var userAccount3 = new UserAccount("003",
|
||||
"Adam",
|
||||
"He likes food.");
|
||||
var userAccount4 = new UserAccount("004",
|
||||
"Rita",
|
||||
"She hates cats.");
|
||||
var userAccount5 = new UserAccount("005",
|
||||
"Isaac",
|
||||
"He is allergic to mustard.");
|
||||
var userAccount3 = new UserAccount("003", "Adam", "He likes food.");
|
||||
var userAccount4 = new UserAccount("004", "Rita", "She hates cats.");
|
||||
var userAccount5 = new UserAccount("005", "Isaac", "He is allergic to mustard.");
|
||||
|
||||
appManager.save(userAccount3);
|
||||
appManager.save(userAccount4);
|
||||
appManager.save(userAccount5);
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
appManager.find("003");
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
UserAccount userAccount6 = new UserAccount("006",
|
||||
"Yasha",
|
||||
"She is an only child.");
|
||||
appManager.save(userAccount6);
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
appManager.find("004");
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
AppManager.save(userAccount3);
|
||||
AppManager.save(userAccount4);
|
||||
AppManager.save(userAccount5);
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
AppManager.find("003");
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
UserAccount userAccount6 = new UserAccount("006", "Yasha", "She is an only child.");
|
||||
AppManager.save(userAccount6);
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
AppManager.find("004");
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
}
|
||||
|
||||
/**
|
||||
@ -202,26 +146,20 @@ public class App {
|
||||
*/
|
||||
public void useCacheAsideStategy() {
|
||||
LOGGER.info("# CachingPolicy.ASIDE");
|
||||
appManager.initCachingPolicy(CachingPolicy.ASIDE);
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
AppManager.initCachingPolicy(CachingPolicy.ASIDE);
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
|
||||
var userAccount3 = new UserAccount("003",
|
||||
"Adam",
|
||||
"He likes food.");
|
||||
var userAccount4 = new UserAccount("004",
|
||||
"Rita",
|
||||
"She hates cats.");
|
||||
var userAccount5 = new UserAccount("005",
|
||||
"Isaac",
|
||||
"He is allergic to mustard.");
|
||||
appManager.save(userAccount3);
|
||||
appManager.save(userAccount4);
|
||||
appManager.save(userAccount5);
|
||||
var userAccount3 = new UserAccount("003", "Adam", "He likes food.");
|
||||
var userAccount4 = new UserAccount("004", "Rita", "She hates cats.");
|
||||
var userAccount5 = new UserAccount("005", "Isaac", "He is allergic to mustard.");
|
||||
AppManager.save(userAccount3);
|
||||
AppManager.save(userAccount4);
|
||||
AppManager.save(userAccount5);
|
||||
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
appManager.find("003");
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
appManager.find("004");
|
||||
LOGGER.info(appManager.printCacheContent());
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
AppManager.find("003");
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
AppManager.find("004");
|
||||
LOGGER.info(AppManager.printCacheContent());
|
||||
}
|
||||
}
|
||||
|
@ -23,80 +23,65 @@
|
||||
|
||||
package com.iluwatar.caching;
|
||||
|
||||
import com.iluwatar.caching.database.DbManager;
|
||||
|
||||
import java.text.ParseException;
|
||||
import java.util.Optional;
|
||||
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
|
||||
/**
|
||||
* AppManager helps to bridge the gap in communication between the main class
|
||||
* and the application's back-end. DB connection is initialized through this
|
||||
* class. The chosen caching strategy/policy is also initialized here.
|
||||
* Before the cache can be used, the size of the cache has to be set.
|
||||
* Depending on the chosen caching policy, AppManager will call the
|
||||
* appropriate function in the CacheStore class.
|
||||
* AppManager helps to bridge the gap in communication between the main class and the application's
|
||||
* back-end. DB connection is initialized through this class. The chosen caching strategy/policy is
|
||||
* also initialized here. Before the cache can be used, the size of the cache has to be set.
|
||||
* Depending on the chosen caching policy, AppManager will call the appropriate function in the
|
||||
* CacheStore class.
|
||||
*/
|
||||
@Slf4j
|
||||
public class AppManager {
|
||||
/**
|
||||
* Caching Policy.
|
||||
*/
|
||||
private CachingPolicy cachingPolicy;
|
||||
/**
|
||||
* Database Manager.
|
||||
*/
|
||||
private final DbManager dbManager;
|
||||
/**
|
||||
* Cache Store.
|
||||
*/
|
||||
private final CacheStore cacheStore;
|
||||
public final class AppManager {
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param newDbManager database manager
|
||||
*/
|
||||
public AppManager(final DbManager newDbManager) {
|
||||
this.dbManager = newDbManager;
|
||||
this.cacheStore = new CacheStore(newDbManager);
|
||||
private static CachingPolicy cachingPolicy;
|
||||
|
||||
private AppManager() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Developer/Tester is able to choose whether the application should use
|
||||
* MongoDB as its underlying data storage or a simple Java data structure
|
||||
* to (temporarily) store the data/objects during runtime.
|
||||
* Developer/Tester is able to choose whether the application should use MongoDB as its underlying
|
||||
* data storage or a simple Java data structure to (temporarily) store the data/objects during
|
||||
* runtime.
|
||||
*/
|
||||
public void initDb() {
|
||||
dbManager.connect();
|
||||
public static void initDb(boolean useMongoDb) {
|
||||
if (useMongoDb) {
|
||||
try {
|
||||
DbManager.connect();
|
||||
} catch (ParseException e) {
|
||||
LOGGER.error("Error connecting to MongoDB", e);
|
||||
}
|
||||
} else {
|
||||
DbManager.createVirtualDb();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize caching policy.
|
||||
*
|
||||
* @param policy is a {@link CachingPolicy}
|
||||
*/
|
||||
public void initCachingPolicy(final CachingPolicy policy) {
|
||||
public static void initCachingPolicy(CachingPolicy policy) {
|
||||
cachingPolicy = policy;
|
||||
if (cachingPolicy == CachingPolicy.BEHIND) {
|
||||
Runtime.getRuntime().addShutdownHook(new Thread(cacheStore::flushCache));
|
||||
Runtime.getRuntime().addShutdownHook(new Thread(CacheStore::flushCache));
|
||||
}
|
||||
cacheStore.clearCache();
|
||||
CacheStore.clearCache();
|
||||
}
|
||||
|
||||
public static void initCacheCapacity(int capacity) {
|
||||
CacheStore.initCapacity(capacity);
|
||||
}
|
||||
|
||||
/**
|
||||
* Find user account.
|
||||
*
|
||||
* @param userId String
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
public UserAccount find(final String userId) {
|
||||
LOGGER.info("Trying to find {} in cache", userId);
|
||||
if (cachingPolicy == CachingPolicy.THROUGH
|
||||
|| cachingPolicy == CachingPolicy.AROUND) {
|
||||
return cacheStore.readThrough(userId);
|
||||
public static UserAccount find(String userId) {
|
||||
if (cachingPolicy == CachingPolicy.THROUGH || cachingPolicy == CachingPolicy.AROUND) {
|
||||
return CacheStore.readThrough(userId);
|
||||
} else if (cachingPolicy == CachingPolicy.BEHIND) {
|
||||
return cacheStore.readThroughWithWriteBackPolicy(userId);
|
||||
return CacheStore.readThroughWithWriteBackPolicy(userId);
|
||||
} else if (cachingPolicy == CachingPolicy.ASIDE) {
|
||||
return findAside(userId);
|
||||
}
|
||||
@ -105,55 +90,41 @@ public class AppManager {
|
||||
|
||||
/**
|
||||
* Save user account.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
*/
|
||||
public void save(final UserAccount userAccount) {
|
||||
LOGGER.info("Save record!");
|
||||
public static void save(UserAccount userAccount) {
|
||||
if (cachingPolicy == CachingPolicy.THROUGH) {
|
||||
cacheStore.writeThrough(userAccount);
|
||||
CacheStore.writeThrough(userAccount);
|
||||
} else if (cachingPolicy == CachingPolicy.AROUND) {
|
||||
cacheStore.writeAround(userAccount);
|
||||
CacheStore.writeAround(userAccount);
|
||||
} else if (cachingPolicy == CachingPolicy.BEHIND) {
|
||||
cacheStore.writeBehind(userAccount);
|
||||
CacheStore.writeBehind(userAccount);
|
||||
} else if (cachingPolicy == CachingPolicy.ASIDE) {
|
||||
saveAside(userAccount);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns String.
|
||||
*
|
||||
* @return String
|
||||
*/
|
||||
public String printCacheContent() {
|
||||
return cacheStore.print();
|
||||
public static String printCacheContent() {
|
||||
return CacheStore.print();
|
||||
}
|
||||
|
||||
/**
|
||||
* Cache-Aside save user account helper.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
*/
|
||||
private void saveAside(final UserAccount userAccount) {
|
||||
dbManager.updateDb(userAccount);
|
||||
cacheStore.invalidate(userAccount.getUserId());
|
||||
private static void saveAside(UserAccount userAccount) {
|
||||
DbManager.updateDb(userAccount);
|
||||
CacheStore.invalidate(userAccount.getUserId());
|
||||
}
|
||||
|
||||
/**
|
||||
* Cache-Aside find user account helper.
|
||||
*
|
||||
* @param userId String
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
private UserAccount findAside(final String userId) {
|
||||
return Optional.ofNullable(cacheStore.get(userId))
|
||||
.or(() -> {
|
||||
Optional<UserAccount> userAccount =
|
||||
Optional.ofNullable(dbManager.readFromDb(userId));
|
||||
userAccount.ifPresent(account -> cacheStore.set(userId, account));
|
||||
return userAccount;
|
||||
})
|
||||
.orElse(null);
|
||||
private static UserAccount findAside(String userId) {
|
||||
return Optional.ofNullable(CacheStore.get(userId))
|
||||
.or(() -> {
|
||||
Optional<UserAccount> userAccount = Optional.ofNullable(DbManager.readFromDb(userId));
|
||||
userAccount.ifPresent(account -> CacheStore.set(userId, account));
|
||||
return userAccount;
|
||||
})
|
||||
.orElse(null);
|
||||
}
|
||||
}
|
||||
|
@ -23,11 +23,9 @@
|
||||
|
||||
package com.iluwatar.caching;
|
||||
|
||||
import com.iluwatar.caching.database.DbManager;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
|
||||
/**
|
||||
@ -35,34 +33,16 @@ import lombok.extern.slf4j.Slf4j;
|
||||
*/
|
||||
@Slf4j
|
||||
public class CacheStore {
|
||||
/**
|
||||
* Cache capacity.
|
||||
*/
|
||||
private static final int CAPACITY = 3;
|
||||
|
||||
/**
|
||||
* Lru cache see {@link LruCache}.
|
||||
*/
|
||||
private LruCache cache;
|
||||
/**
|
||||
* DbManager.
|
||||
*/
|
||||
private final DbManager dbManager;
|
||||
private static LruCache cache;
|
||||
|
||||
/**
|
||||
* Cache Store.
|
||||
* @param dataBaseManager {@link DbManager}
|
||||
*/
|
||||
public CacheStore(final DbManager dataBaseManager) {
|
||||
this.dbManager = dataBaseManager;
|
||||
initCapacity(CAPACITY);
|
||||
private CacheStore() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Init cache capacity.
|
||||
* @param capacity int
|
||||
*/
|
||||
public void initCapacity(final int capacity) {
|
||||
public static void initCapacity(int capacity) {
|
||||
if (cache == null) {
|
||||
cache = new LruCache(capacity);
|
||||
} else {
|
||||
@ -72,64 +52,57 @@ public class CacheStore {
|
||||
|
||||
/**
|
||||
* Get user account using read-through cache.
|
||||
* @param userId {@link String}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
public UserAccount readThrough(final String userId) {
|
||||
public static UserAccount readThrough(String userId) {
|
||||
if (cache.contains(userId)) {
|
||||
LOGGER.info("# Found in Cache!");
|
||||
LOGGER.info("# Cache Hit!");
|
||||
return cache.get(userId);
|
||||
}
|
||||
LOGGER.info("# Not found in cache! Go to DB!!");
|
||||
UserAccount userAccount = dbManager.readFromDb(userId);
|
||||
LOGGER.info("# Cache Miss!");
|
||||
UserAccount userAccount = DbManager.readFromDb(userId);
|
||||
cache.set(userId, userAccount);
|
||||
return userAccount;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get user account using write-through cache.
|
||||
* @param userAccount {@link UserAccount}
|
||||
*/
|
||||
public void writeThrough(final UserAccount userAccount) {
|
||||
public static void writeThrough(UserAccount userAccount) {
|
||||
if (cache.contains(userAccount.getUserId())) {
|
||||
dbManager.updateDb(userAccount);
|
||||
DbManager.updateDb(userAccount);
|
||||
} else {
|
||||
dbManager.writeToDb(userAccount);
|
||||
DbManager.writeToDb(userAccount);
|
||||
}
|
||||
cache.set(userAccount.getUserId(), userAccount);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get user account using write-around cache.
|
||||
* @param userAccount {@link UserAccount}
|
||||
*/
|
||||
public void writeAround(final UserAccount userAccount) {
|
||||
public static void writeAround(UserAccount userAccount) {
|
||||
if (cache.contains(userAccount.getUserId())) {
|
||||
dbManager.updateDb(userAccount);
|
||||
// Cache data has been updated -- remove older
|
||||
cache.invalidate(userAccount.getUserId());
|
||||
DbManager.updateDb(userAccount);
|
||||
cache.invalidate(userAccount.getUserId()); // Cache data has been updated -- remove older
|
||||
// version from cache.
|
||||
} else {
|
||||
dbManager.writeToDb(userAccount);
|
||||
DbManager.writeToDb(userAccount);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get user account using read-through cache with write-back policy.
|
||||
* @param userId {@link String}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
public UserAccount readThroughWithWriteBackPolicy(final String userId) {
|
||||
public static UserAccount readThroughWithWriteBackPolicy(String userId) {
|
||||
if (cache.contains(userId)) {
|
||||
LOGGER.info("# Found in cache!");
|
||||
LOGGER.info("# Cache Hit!");
|
||||
return cache.get(userId);
|
||||
}
|
||||
LOGGER.info("# Not found in Cache!");
|
||||
UserAccount userAccount = dbManager.readFromDb(userId);
|
||||
LOGGER.info("# Cache Miss!");
|
||||
UserAccount userAccount = DbManager.readFromDb(userId);
|
||||
if (cache.isFull()) {
|
||||
LOGGER.info("# Cache is FULL! Writing LRU data to DB...");
|
||||
UserAccount toBeWrittenToDb = cache.getLruData();
|
||||
dbManager.upsertDb(toBeWrittenToDb);
|
||||
DbManager.upsertDb(toBeWrittenToDb);
|
||||
}
|
||||
cache.set(userId, userAccount);
|
||||
return userAccount;
|
||||
@ -137,13 +110,12 @@ public class CacheStore {
|
||||
|
||||
/**
|
||||
* Set user account.
|
||||
* @param userAccount {@link UserAccount}
|
||||
*/
|
||||
public void writeBehind(final UserAccount userAccount) {
|
||||
public static void writeBehind(UserAccount userAccount) {
|
||||
if (cache.isFull() && !cache.contains(userAccount.getUserId())) {
|
||||
LOGGER.info("# Cache is FULL! Writing LRU data to DB...");
|
||||
UserAccount toBeWrittenToDb = cache.getLruData();
|
||||
dbManager.upsertDb(toBeWrittenToDb);
|
||||
DbManager.upsertDb(toBeWrittenToDb);
|
||||
}
|
||||
cache.set(userAccount.getUserId(), userAccount);
|
||||
}
|
||||
@ -151,7 +123,7 @@ public class CacheStore {
|
||||
/**
|
||||
* Clears cache.
|
||||
*/
|
||||
public void clearCache() {
|
||||
public static void clearCache() {
|
||||
if (cache != null) {
|
||||
cache.clear();
|
||||
}
|
||||
@ -160,51 +132,44 @@ public class CacheStore {
|
||||
/**
|
||||
* Writes remaining content in the cache into the DB.
|
||||
*/
|
||||
public void flushCache() {
|
||||
public static void flushCache() {
|
||||
LOGGER.info("# flushCache...");
|
||||
Optional.ofNullable(cache)
|
||||
.map(LruCache::getCacheDataInListForm)
|
||||
.orElse(List.of())
|
||||
.forEach(dbManager::updateDb);
|
||||
dbManager.disconnect();
|
||||
.forEach(DbManager::updateDb);
|
||||
}
|
||||
|
||||
/**
|
||||
* Print user accounts.
|
||||
* @return {@link String}
|
||||
*/
|
||||
public String print() {
|
||||
public static String print() {
|
||||
return Optional.ofNullable(cache)
|
||||
.map(LruCache::getCacheDataInListForm)
|
||||
.orElse(List.of())
|
||||
.stream()
|
||||
.map(userAccount -> userAccount.toString() + "\n")
|
||||
.collect(Collectors.joining("", "\n--CACHE CONTENT--\n", "----"));
|
||||
.collect(Collectors.joining("", "\n--CACHE CONTENT--\n", "----\n"));
|
||||
}
|
||||
|
||||
/**
|
||||
* Delegate to backing cache store.
|
||||
* @param userId {@link String}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
public UserAccount get(final String userId) {
|
||||
public static UserAccount get(String userId) {
|
||||
return cache.get(userId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delegate to backing cache store.
|
||||
* @param userId {@link String}
|
||||
* @param userAccount {@link UserAccount}
|
||||
*/
|
||||
public void set(final String userId, final UserAccount userAccount) {
|
||||
public static void set(String userId, UserAccount userAccount) {
|
||||
cache.set(userId, userAccount);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delegate to backing cache store.
|
||||
* @param userId {@link String}
|
||||
*/
|
||||
public void invalidate(final String userId) {
|
||||
public static void invalidate(String userId) {
|
||||
cache.invalidate(userId);
|
||||
}
|
||||
}
|
||||
|
@ -32,25 +32,10 @@ import lombok.Getter;
|
||||
@AllArgsConstructor
|
||||
@Getter
|
||||
public enum CachingPolicy {
|
||||
/**
|
||||
* Through.
|
||||
*/
|
||||
THROUGH("through"),
|
||||
/**
|
||||
* AROUND.
|
||||
*/
|
||||
AROUND("around"),
|
||||
/**
|
||||
* BEHIND.
|
||||
*/
|
||||
BEHIND("behind"),
|
||||
/**
|
||||
* ASIDE.
|
||||
*/
|
||||
ASIDE("aside");
|
||||
|
||||
/**
|
||||
* Policy value.
|
||||
*/
|
||||
private final String policy;
|
||||
}
|
||||
|
171
caching/src/main/java/com/iluwatar/caching/DbManager.java
Normal file
171
caching/src/main/java/com/iluwatar/caching/DbManager.java
Normal file
@ -0,0 +1,171 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.caching;
|
||||
|
||||
import com.iluwatar.caching.constants.CachingConstants;
|
||||
import com.mongodb.MongoClient;
|
||||
import com.mongodb.client.MongoDatabase;
|
||||
import com.mongodb.client.model.UpdateOptions;
|
||||
import java.text.ParseException;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.bson.Document;
|
||||
|
||||
/**
|
||||
* <p>DBManager handles the communication with the underlying data store i.e. Database. It contains
|
||||
* the implemented methods for querying, inserting, and updating data. MongoDB was used as the
|
||||
* database for the application.</p>
|
||||
*
|
||||
* <p>Developer/Tester is able to choose whether the application should use MongoDB as its
|
||||
* underlying data storage (connect()) or a simple Java data structure to (temporarily) store the
|
||||
* data/objects during runtime (createVirtualDB()).</p>
|
||||
*/
|
||||
@Slf4j
|
||||
public final class DbManager {
|
||||
|
||||
private static MongoClient mongoClient;
|
||||
private static MongoDatabase db;
|
||||
private static boolean useMongoDB;
|
||||
|
||||
private static Map<String, UserAccount> virtualDB;
|
||||
|
||||
private DbManager() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Create DB.
|
||||
*/
|
||||
public static void createVirtualDb() {
|
||||
useMongoDB = false;
|
||||
virtualDB = new HashMap<>();
|
||||
}
|
||||
|
||||
/**
|
||||
* Connect to DB.
|
||||
*/
|
||||
public static void connect() throws ParseException {
|
||||
useMongoDB = true;
|
||||
mongoClient = new MongoClient();
|
||||
db = mongoClient.getDatabase("test");
|
||||
}
|
||||
|
||||
/**
|
||||
* Read user account from DB.
|
||||
*/
|
||||
public static UserAccount readFromDb(String userId) {
|
||||
if (!useMongoDB) {
|
||||
if (virtualDB.containsKey(userId)) {
|
||||
return virtualDB.get(userId);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
if (db == null) {
|
||||
try {
|
||||
connect();
|
||||
} catch (ParseException e) {
|
||||
LOGGER.error("Error connecting to MongoDB", e);
|
||||
}
|
||||
}
|
||||
var iterable = db
|
||||
.getCollection(CachingConstants.USER_ACCOUNT)
|
||||
.find(new Document(CachingConstants.USER_ID, userId));
|
||||
if (iterable == null) {
|
||||
return null;
|
||||
}
|
||||
Document doc = iterable.first();
|
||||
String userName = doc.getString(CachingConstants.USER_NAME);
|
||||
String appInfo = doc.getString(CachingConstants.ADD_INFO);
|
||||
return new UserAccount(userId, userName, appInfo);
|
||||
}
|
||||
|
||||
/**
|
||||
* Write user account to DB.
|
||||
*/
|
||||
public static void writeToDb(UserAccount userAccount) {
|
||||
if (!useMongoDB) {
|
||||
virtualDB.put(userAccount.getUserId(), userAccount);
|
||||
return;
|
||||
}
|
||||
if (db == null) {
|
||||
try {
|
||||
connect();
|
||||
} catch (ParseException e) {
|
||||
LOGGER.error("Error connecting to MongoDB", e);
|
||||
}
|
||||
}
|
||||
db.getCollection(CachingConstants.USER_ACCOUNT).insertOne(
|
||||
new Document(CachingConstants.USER_ID, userAccount.getUserId())
|
||||
.append(CachingConstants.USER_NAME, userAccount.getUserName())
|
||||
.append(CachingConstants.ADD_INFO, userAccount.getAdditionalInfo())
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update DB.
|
||||
*/
|
||||
public static void updateDb(UserAccount userAccount) {
|
||||
if (!useMongoDB) {
|
||||
virtualDB.put(userAccount.getUserId(), userAccount);
|
||||
return;
|
||||
}
|
||||
if (db == null) {
|
||||
try {
|
||||
connect();
|
||||
} catch (ParseException e) {
|
||||
LOGGER.error("Error connecting to MongoDB", e);
|
||||
}
|
||||
}
|
||||
db.getCollection(CachingConstants.USER_ACCOUNT).updateOne(
|
||||
new Document(CachingConstants.USER_ID, userAccount.getUserId()),
|
||||
new Document("$set", new Document(CachingConstants.USER_NAME, userAccount.getUserName())
|
||||
.append(CachingConstants.ADD_INFO, userAccount.getAdditionalInfo())));
|
||||
}
|
||||
|
||||
/**
|
||||
* Insert data into DB if it does not exist. Else, update it.
|
||||
*/
|
||||
public static void upsertDb(UserAccount userAccount) {
|
||||
if (!useMongoDB) {
|
||||
virtualDB.put(userAccount.getUserId(), userAccount);
|
||||
return;
|
||||
}
|
||||
if (db == null) {
|
||||
try {
|
||||
connect();
|
||||
} catch (ParseException e) {
|
||||
LOGGER.error("Error connecting to MongoDB", e);
|
||||
}
|
||||
}
|
||||
db.getCollection(CachingConstants.USER_ACCOUNT).updateOne(
|
||||
new Document(CachingConstants.USER_ID, userAccount.getUserId()),
|
||||
new Document("$set",
|
||||
new Document(CachingConstants.USER_ID, userAccount.getUserId())
|
||||
.append(CachingConstants.USER_NAME, userAccount.getUserName())
|
||||
.append(CachingConstants.ADD_INFO, userAccount.getAdditionalInfo())
|
||||
),
|
||||
new UpdateOptions().upsert(true)
|
||||
);
|
||||
}
|
||||
}
|
@ -29,83 +29,41 @@ import java.util.List;
|
||||
import java.util.Map;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
|
||||
|
||||
/**
|
||||
* Data structure/implementation of the application's cache. The data structure
|
||||
* consists of a hash table attached with a doubly linked-list. The linked-list
|
||||
* helps in capturing and maintaining the LRU data in the cache. When a data is
|
||||
* queried (from the cache), added (to the cache), or updated, the data is
|
||||
* moved to the front of the list to depict itself as the most-recently-used
|
||||
* data. The LRU data is always at the end of the list.
|
||||
* Data structure/implementation of the application's cache. The data structure consists of a hash
|
||||
* table attached with a doubly linked-list. The linked-list helps in capturing and maintaining the
|
||||
* LRU data in the cache. When a data is queried (from the cache), added (to the cache), or updated,
|
||||
* the data is moved to the front of the list to depict itself as the most-recently-used data. The
|
||||
* LRU data is always at the end of the list.
|
||||
*/
|
||||
@Slf4j
|
||||
public class LruCache {
|
||||
/**
|
||||
* Static class Node.
|
||||
*/
|
||||
static class Node {
|
||||
/**
|
||||
* user id.
|
||||
*/
|
||||
private final String userId;
|
||||
/**
|
||||
* User Account.
|
||||
*/
|
||||
private UserAccount userAccount;
|
||||
/**
|
||||
* previous.
|
||||
*/
|
||||
private Node previous;
|
||||
/**
|
||||
* next.
|
||||
*/
|
||||
private Node next;
|
||||
|
||||
/**
|
||||
* Node definition.
|
||||
*
|
||||
* @param id String
|
||||
* @param account {@link UserAccount}
|
||||
*/
|
||||
Node(final String id, final UserAccount account) {
|
||||
this.userId = id;
|
||||
this.userAccount = account;
|
||||
static class Node {
|
||||
String userId;
|
||||
UserAccount userAccount;
|
||||
Node previous;
|
||||
Node next;
|
||||
|
||||
public Node(String userId, UserAccount userAccount) {
|
||||
this.userId = userId;
|
||||
this.userAccount = userAccount;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Capacity of Cache.
|
||||
*/
|
||||
private int capacity;
|
||||
/**
|
||||
* Cache {@link HashMap}.
|
||||
*/
|
||||
private Map<String, Node> cache = new HashMap<>();
|
||||
/**
|
||||
* Head.
|
||||
*/
|
||||
private Node head;
|
||||
/**
|
||||
* End.
|
||||
*/
|
||||
private Node end;
|
||||
int capacity;
|
||||
Map<String, Node> cache = new HashMap<>();
|
||||
Node head;
|
||||
Node end;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param cap Integer.
|
||||
*/
|
||||
public LruCache(final int cap) {
|
||||
this.capacity = cap;
|
||||
public LruCache(int capacity) {
|
||||
this.capacity = capacity;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get user account.
|
||||
*
|
||||
* @param userId String
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
public UserAccount get(final String userId) {
|
||||
public UserAccount get(String userId) {
|
||||
if (cache.containsKey(userId)) {
|
||||
var node = cache.get(userId);
|
||||
remove(node);
|
||||
@ -117,10 +75,8 @@ public class LruCache {
|
||||
|
||||
/**
|
||||
* Remove node from linked list.
|
||||
*
|
||||
* @param node {@link Node}
|
||||
*/
|
||||
public void remove(final Node node) {
|
||||
public void remove(Node node) {
|
||||
if (node.previous != null) {
|
||||
node.previous.next = node.next;
|
||||
} else {
|
||||
@ -135,10 +91,8 @@ public class LruCache {
|
||||
|
||||
/**
|
||||
* Move node to the front of the list.
|
||||
*
|
||||
* @param node {@link Node}
|
||||
*/
|
||||
public void setHead(final Node node) {
|
||||
public void setHead(Node node) {
|
||||
node.next = head;
|
||||
node.previous = null;
|
||||
if (head != null) {
|
||||
@ -152,11 +106,8 @@ public class LruCache {
|
||||
|
||||
/**
|
||||
* Set user account.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
* @param userId {@link String}
|
||||
*/
|
||||
public void set(final String userId, final UserAccount userAccount) {
|
||||
public void set(String userId, UserAccount userAccount) {
|
||||
if (cache.containsKey(userId)) {
|
||||
var old = cache.get(userId);
|
||||
old.userAccount = userAccount;
|
||||
@ -176,43 +127,25 @@ public class LruCache {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if Cache contains the userId.
|
||||
*
|
||||
* @param userId {@link String}
|
||||
* @return boolean
|
||||
*/
|
||||
public boolean contains(final String userId) {
|
||||
public boolean contains(String userId) {
|
||||
return cache.containsKey(userId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Invalidate cache for user.
|
||||
*
|
||||
* @param userId {@link String}
|
||||
*/
|
||||
public void invalidate(final String userId) {
|
||||
public void invalidate(String userId) {
|
||||
var toBeRemoved = cache.remove(userId);
|
||||
if (toBeRemoved != null) {
|
||||
LOGGER.info("# {} has been updated! "
|
||||
+ "Removing older version from cache...", userId);
|
||||
LOGGER.info("# {} has been updated! Removing older version from cache...", userId);
|
||||
remove(toBeRemoved);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the cache is full.
|
||||
* @return boolean
|
||||
*/
|
||||
public boolean isFull() {
|
||||
return cache.size() >= capacity;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get LRU data.
|
||||
*
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
public UserAccount getLruData() {
|
||||
return end.userAccount;
|
||||
}
|
||||
@ -228,8 +161,6 @@ public class LruCache {
|
||||
|
||||
/**
|
||||
* Returns cache data in list form.
|
||||
*
|
||||
* @return {@link List}
|
||||
*/
|
||||
public List<UserAccount> getCacheDataInListForm() {
|
||||
var listOfCacheData = new ArrayList<UserAccount>();
|
||||
@ -243,14 +174,10 @@ public class LruCache {
|
||||
|
||||
/**
|
||||
* Set cache capacity.
|
||||
*
|
||||
* @param newCapacity int
|
||||
*/
|
||||
public void setCapacity(final int newCapacity) {
|
||||
public void setCapacity(int newCapacity) {
|
||||
if (capacity > newCapacity) {
|
||||
// Behavior can be modified to accommodate
|
||||
// for decrease in cache size. For now, we'll
|
||||
clear();
|
||||
clear(); // Behavior can be modified to accommodate for decrease in cache size. For now, we'll
|
||||
// just clear the cache.
|
||||
} else {
|
||||
this.capacity = newCapacity;
|
||||
|
@ -24,28 +24,19 @@
|
||||
package com.iluwatar.caching;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Data;
|
||||
import lombok.EqualsAndHashCode;
|
||||
import lombok.Getter;
|
||||
import lombok.Setter;
|
||||
import lombok.ToString;
|
||||
|
||||
/**
|
||||
* Entity class (stored in cache and DB) used in the application.
|
||||
*/
|
||||
@Data
|
||||
@Setter
|
||||
@Getter
|
||||
@AllArgsConstructor
|
||||
@ToString
|
||||
@EqualsAndHashCode
|
||||
public class UserAccount {
|
||||
/**
|
||||
* User Id.
|
||||
*/
|
||||
private String userId;
|
||||
/**
|
||||
* User Name.
|
||||
*/
|
||||
private String userName;
|
||||
/**
|
||||
* Additional Info.
|
||||
*/
|
||||
private String additionalInfo;
|
||||
}
|
||||
|
@ -26,27 +26,11 @@ package com.iluwatar.caching.constants;
|
||||
/**
|
||||
* Constant class for defining constants.
|
||||
*/
|
||||
public final class CachingConstants {
|
||||
/**
|
||||
* User Account.
|
||||
*/
|
||||
public class CachingConstants {
|
||||
|
||||
public static final String USER_ACCOUNT = "user_accounts";
|
||||
/**
|
||||
* User ID.
|
||||
*/
|
||||
public static final String USER_ID = "userID";
|
||||
/**
|
||||
* User Name.
|
||||
*/
|
||||
public static final String USER_NAME = "userName";
|
||||
/**
|
||||
* Additional Info.
|
||||
*/
|
||||
public static final String ADD_INFO = "additionalInfo";
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
private CachingConstants() {
|
||||
}
|
||||
}
|
||||
|
@ -1,4 +0,0 @@
|
||||
/**
|
||||
* Constants.
|
||||
*/
|
||||
package com.iluwatar.caching.constants;
|
@ -1,52 +0,0 @@
|
||||
package com.iluwatar.caching.database;
|
||||
|
||||
import com.iluwatar.caching.UserAccount;
|
||||
|
||||
/**
|
||||
* <p>DBManager handles the communication with the underlying data store i.e.
|
||||
* Database. It contains the implemented methods for querying, inserting,
|
||||
* and updating data. MongoDB was used as the database for the application.</p>
|
||||
*/
|
||||
public interface DbManager {
|
||||
/**
|
||||
* Connect to DB.
|
||||
*/
|
||||
void connect();
|
||||
|
||||
/**
|
||||
* Disconnect from DB.
|
||||
*/
|
||||
void disconnect();
|
||||
|
||||
/**
|
||||
* Read from DB.
|
||||
*
|
||||
* @param userId {@link String}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
UserAccount readFromDb(String userId);
|
||||
|
||||
/**
|
||||
* Write to DB.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
UserAccount writeToDb(UserAccount userAccount);
|
||||
|
||||
/**
|
||||
* Update record.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
UserAccount updateDb(UserAccount userAccount);
|
||||
|
||||
/**
|
||||
* Update record or Insert if not exists.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
UserAccount upsertDb(UserAccount userAccount);
|
||||
}
|
@ -1,25 +0,0 @@
|
||||
package com.iluwatar.caching.database;
|
||||
|
||||
/**
|
||||
* Creates the database connection accroding the input parameter.
|
||||
*/
|
||||
public final class DbManagerFactory {
|
||||
/**
|
||||
* Private constructor.
|
||||
*/
|
||||
private DbManagerFactory() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Init database.
|
||||
*
|
||||
* @param isMongo boolean
|
||||
* @return {@link DbManager}
|
||||
*/
|
||||
public static DbManager initDb(final boolean isMongo) {
|
||||
if (isMongo) {
|
||||
return new MongoDb();
|
||||
}
|
||||
return new VirtualDb();
|
||||
}
|
||||
}
|
@ -1,128 +0,0 @@
|
||||
package com.iluwatar.caching.database;
|
||||
|
||||
import static com.iluwatar.caching.constants.CachingConstants.ADD_INFO;
|
||||
import static com.iluwatar.caching.constants.CachingConstants.USER_ACCOUNT;
|
||||
import static com.iluwatar.caching.constants.CachingConstants.USER_ID;
|
||||
import static com.iluwatar.caching.constants.CachingConstants.USER_NAME;
|
||||
|
||||
import com.iluwatar.caching.UserAccount;
|
||||
import com.iluwatar.caching.constants.CachingConstants;
|
||||
import com.mongodb.MongoClient;
|
||||
import com.mongodb.MongoClientOptions;
|
||||
import com.mongodb.MongoCredential;
|
||||
import com.mongodb.ServerAddress;
|
||||
import com.mongodb.client.MongoDatabase;
|
||||
import com.mongodb.client.model.UpdateOptions;
|
||||
import java.util.List;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.bson.Document;
|
||||
|
||||
/**
|
||||
* Implementation of DatabaseManager.
|
||||
* implements base methods to work with MongoDb.
|
||||
*/
|
||||
@Slf4j
|
||||
public class MongoDb implements DbManager {
|
||||
private static final String DATABASE_NAME = "admin";
|
||||
private static final String MONGO_USER = "root";
|
||||
private static final String MONGO_PASSWORD = "rootpassword";
|
||||
private MongoClient client;
|
||||
private MongoDatabase db;
|
||||
|
||||
/**
|
||||
* Connect to Db. Check th connection
|
||||
*/
|
||||
@Override
|
||||
public void connect() {
|
||||
MongoCredential mongoCredential = MongoCredential.createCredential(MONGO_USER,
|
||||
DATABASE_NAME,
|
||||
MONGO_PASSWORD.toCharArray());
|
||||
MongoClientOptions options = MongoClientOptions.builder().build();
|
||||
client = new MongoClient(new ServerAddress(), List.of(mongoCredential), options);
|
||||
db = client.getDatabase(DATABASE_NAME);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void disconnect() {
|
||||
client.close();
|
||||
}
|
||||
|
||||
/**
|
||||
* Read data from DB.
|
||||
*
|
||||
* @param userId {@link String}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
@Override
|
||||
public UserAccount readFromDb(final String userId) {
|
||||
var iterable = db
|
||||
.getCollection(CachingConstants.USER_ACCOUNT)
|
||||
.find(new Document(USER_ID, userId));
|
||||
if (iterable.first() == null) {
|
||||
return null;
|
||||
}
|
||||
Document doc = iterable.first();
|
||||
if (doc != null) {
|
||||
String userName = doc.getString(USER_NAME);
|
||||
String appInfo = doc.getString(ADD_INFO);
|
||||
return new UserAccount(userId, userName, appInfo);
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Write data to DB.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
@Override
|
||||
public UserAccount writeToDb(final UserAccount userAccount) {
|
||||
db.getCollection(USER_ACCOUNT).insertOne(
|
||||
new Document(USER_ID, userAccount.getUserId())
|
||||
.append(USER_NAME, userAccount.getUserName())
|
||||
.append(ADD_INFO, userAccount.getAdditionalInfo())
|
||||
);
|
||||
return userAccount;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update DB.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
@Override
|
||||
public UserAccount updateDb(final UserAccount userAccount) {
|
||||
Document id = new Document(USER_ID, userAccount.getUserId());
|
||||
Document dataSet = new Document(USER_NAME, userAccount.getUserName())
|
||||
.append(ADD_INFO, userAccount.getAdditionalInfo());
|
||||
db.getCollection(CachingConstants.USER_ACCOUNT)
|
||||
.updateOne(id, new Document("$set", dataSet));
|
||||
return userAccount;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update data if exists.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
@Override
|
||||
public UserAccount upsertDb(final UserAccount userAccount) {
|
||||
String userId = userAccount.getUserId();
|
||||
String userName = userAccount.getUserName();
|
||||
String additionalInfo = userAccount.getAdditionalInfo();
|
||||
db.getCollection(CachingConstants.USER_ACCOUNT).updateOne(
|
||||
new Document(USER_ID, userId),
|
||||
new Document("$set",
|
||||
new Document(USER_ID, userId)
|
||||
.append(USER_NAME, userName)
|
||||
.append(ADD_INFO, additionalInfo)
|
||||
),
|
||||
new UpdateOptions().upsert(true)
|
||||
);
|
||||
return userAccount;
|
||||
}
|
||||
}
|
@ -1,78 +0,0 @@
|
||||
package com.iluwatar.caching.database;
|
||||
|
||||
import com.iluwatar.caching.UserAccount;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* Implementation of DatabaseManager.
|
||||
* implements base methods to work with hashMap as database.
|
||||
*/
|
||||
public class VirtualDb implements DbManager {
|
||||
/**
|
||||
* Virtual DataBase.
|
||||
*/
|
||||
private Map<String, UserAccount> db;
|
||||
|
||||
/**
|
||||
* Creates new HashMap.
|
||||
*/
|
||||
@Override
|
||||
public void connect() {
|
||||
db = new HashMap<>();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void disconnect() {
|
||||
db = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Read from Db.
|
||||
*
|
||||
* @param userId {@link String}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
@Override
|
||||
public UserAccount readFromDb(final String userId) {
|
||||
if (db.containsKey(userId)) {
|
||||
return db.get(userId);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Write to DB.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
@Override
|
||||
public UserAccount writeToDb(final UserAccount userAccount) {
|
||||
db.put(userAccount.getUserId(), userAccount);
|
||||
return userAccount;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update reecord in DB.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
@Override
|
||||
public UserAccount updateDb(final UserAccount userAccount) {
|
||||
return writeToDb(userAccount);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update.
|
||||
*
|
||||
* @param userAccount {@link UserAccount}
|
||||
* @return {@link UserAccount}
|
||||
*/
|
||||
@Override
|
||||
public UserAccount upsertDb(final UserAccount userAccount) {
|
||||
return updateDb(userAccount);
|
||||
}
|
||||
}
|
@ -1,4 +0,0 @@
|
||||
/**
|
||||
* Database classes.
|
||||
*/
|
||||
package com.iluwatar.caching.database;
|
@ -1,20 +0,0 @@
|
||||
/**
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
package com.iluwatar.caching;
|
@ -25,21 +25,25 @@ package com.iluwatar.caching;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
|
||||
|
||||
/**
|
||||
* Tests that Caching example runs without errors.
|
||||
*/
|
||||
class AppTest {
|
||||
|
||||
/**
|
||||
* Issue: Add at least one assertion to this test case.
|
||||
* <p>
|
||||
*
|
||||
* Solution: Inserted assertion to check whether the execution of the main method in {@link App}
|
||||
* throws an exception.
|
||||
*/
|
||||
|
||||
@Test
|
||||
void shouldExecuteApplicationWithoutException() {
|
||||
|
||||
assertDoesNotThrow(() -> App.main(new String[]{}));
|
||||
}
|
||||
}
|
||||
|
@ -23,11 +23,11 @@
|
||||
|
||||
package com.iluwatar.caching;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
|
||||
/**
|
||||
* Application test
|
||||
*/
|
||||
@ -43,30 +43,32 @@ class CachingTest {
|
||||
// to avoid Maven compilation errors. Set flag to true to run the
|
||||
// tests with MongoDB (provided that MongoDB is installed and socket
|
||||
// connection is open).
|
||||
app = new App(false);
|
||||
AppManager.initDb(false);
|
||||
AppManager.initCacheCapacity(3);
|
||||
app = new App();
|
||||
}
|
||||
|
||||
@Test
|
||||
void testReadAndWriteThroughStrategy() {
|
||||
assertNotNull(app);
|
||||
assertNotNull(app);
|
||||
app.useReadAndWriteThroughStrategy();
|
||||
}
|
||||
|
||||
@Test
|
||||
void testReadThroughAndWriteAroundStrategy() {
|
||||
assertNotNull(app);
|
||||
assertNotNull(app);
|
||||
app.useReadThroughAndWriteAroundStrategy();
|
||||
}
|
||||
|
||||
@Test
|
||||
void testReadThroughAndWriteBehindStrategy() {
|
||||
assertNotNull(app);
|
||||
assertNotNull(app);
|
||||
app.useReadThroughAndWriteBehindStrategy();
|
||||
}
|
||||
|
||||
@Test
|
||||
void testCacheAsideStrategy() {
|
||||
assertNotNull(app);
|
||||
assertNotNull(app);
|
||||
app.useCacheAsideStategy();
|
||||
}
|
||||
}
|
||||
|
@ -1,84 +0,0 @@
|
||||
package com.iluwatar.caching.database;
|
||||
|
||||
import com.iluwatar.caching.UserAccount;
|
||||
import com.iluwatar.caching.constants.CachingConstants;
|
||||
import com.mongodb.client.FindIterable;
|
||||
import com.mongodb.client.MongoCollection;
|
||||
import com.mongodb.client.MongoDatabase;
|
||||
import org.bson.Document;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.internal.util.reflection.Whitebox;
|
||||
|
||||
import static com.iluwatar.caching.constants.CachingConstants.ADD_INFO;
|
||||
import static com.iluwatar.caching.constants.CachingConstants.USER_ID;
|
||||
import static com.iluwatar.caching.constants.CachingConstants.USER_NAME;
|
||||
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.Mockito.*;
|
||||
|
||||
class MongoDbTest {
|
||||
private static final String ID = "123";
|
||||
private static final String NAME = "Some user";
|
||||
private static final String ADDITIONAL_INFO = "Some app Info";
|
||||
|
||||
@Mock
|
||||
MongoDatabase db;
|
||||
private MongoDb mongoDb = new MongoDb();
|
||||
|
||||
private UserAccount userAccount;
|
||||
|
||||
@BeforeEach
|
||||
void init() {
|
||||
db = mock(MongoDatabase.class);
|
||||
Whitebox.setInternalState(mongoDb, "db", db);
|
||||
userAccount = new UserAccount(ID, NAME, ADDITIONAL_INFO);
|
||||
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
void connect() {
|
||||
assertDoesNotThrow(() -> mongoDb.connect());
|
||||
}
|
||||
|
||||
@Test
|
||||
void readFromDb() {
|
||||
Document document = new Document(USER_ID, ID)
|
||||
.append(USER_NAME, NAME)
|
||||
.append(ADD_INFO, ADDITIONAL_INFO);
|
||||
MongoCollection<Document> mongoCollection = mock(MongoCollection.class);
|
||||
when(db.getCollection(CachingConstants.USER_ACCOUNT)).thenReturn(mongoCollection);
|
||||
|
||||
FindIterable<Document> findIterable = mock(FindIterable.class);
|
||||
when(mongoCollection.find(any(Document.class))).thenReturn(findIterable);
|
||||
|
||||
when(findIterable.first()).thenReturn(document);
|
||||
|
||||
assertEquals(mongoDb.readFromDb(ID),userAccount);
|
||||
}
|
||||
|
||||
@Test
|
||||
void writeToDb() {
|
||||
MongoCollection<Document> mongoCollection = mock(MongoCollection.class);
|
||||
when(db.getCollection(CachingConstants.USER_ACCOUNT)).thenReturn(mongoCollection);
|
||||
doNothing().when(mongoCollection).insertOne(any(Document.class));
|
||||
assertDoesNotThrow(()-> {mongoDb.writeToDb(userAccount);});
|
||||
}
|
||||
|
||||
@Test
|
||||
void updateDb() {
|
||||
MongoCollection<Document> mongoCollection = mock(MongoCollection.class);
|
||||
when(db.getCollection(CachingConstants.USER_ACCOUNT)).thenReturn(mongoCollection);
|
||||
assertDoesNotThrow(()-> {mongoDb.updateDb(userAccount);});
|
||||
}
|
||||
|
||||
@Test
|
||||
void upsertDb() {
|
||||
MongoCollection<Document> mongoCollection = mock(MongoCollection.class);
|
||||
when(db.getCollection(CachingConstants.USER_ACCOUNT)).thenReturn(mongoCollection);
|
||||
assertDoesNotThrow(()-> {mongoDb.upsertDb(userAccount);});
|
||||
}
|
||||
}
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Callback
|
||||
category: Idiom
|
||||
folder: callback
|
||||
permalink: /patterns/callback/
|
||||
categories: Idiom
|
||||
language: en
|
||||
tags:
|
||||
- Reactive
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Chain of responsibility
|
||||
category: Behavioral
|
||||
folder: chain-of-responsibility
|
||||
permalink: /patterns/chain-of-responsibility/
|
||||
categories: Behavioral
|
||||
language: en
|
||||
tags:
|
||||
- Gang of Four
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Circuit Breaker
|
||||
category: Behavioral
|
||||
folder: circuit-breaker
|
||||
permalink: /patterns/circuit-breaker/
|
||||
categories: Behavioral
|
||||
language: en
|
||||
tags:
|
||||
- Performance
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Static Content Hosting
|
||||
category: Cloud
|
||||
folder: cloud-static-content-hosting
|
||||
permalink: /patterns/cloud-static-content-hosting/
|
||||
categories: Cloud
|
||||
language: en
|
||||
tags:
|
||||
- Cloud distributed
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Collection Pipeline
|
||||
category: Functional
|
||||
folder: collection-pipeline
|
||||
permalink: /patterns/collection-pipeline/
|
||||
categories: Functional
|
||||
language: en
|
||||
tags:
|
||||
- Reactive
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Combinator
|
||||
category: Idiom
|
||||
folder: combinator
|
||||
permalink: /patterns/combinator/
|
||||
categories: Idiom
|
||||
language: en
|
||||
tags:
|
||||
- Reactive
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
---
|
||||
layout: pattern
|
||||
title: Command
|
||||
category: Behavioral
|
||||
folder: command
|
||||
permalink: /patterns/command/
|
||||
categories: Behavioral
|
||||
language: en
|
||||
tags:
|
||||
- Gang of Four
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Commander
|
||||
category: Concurrency
|
||||
folder: commander
|
||||
permalink: /patterns/commander/
|
||||
categories: Concurrency
|
||||
language: en
|
||||
tags:
|
||||
- Cloud distributed
|
||||
@ -22,4 +25,4 @@ We need a mechanism in place which can handle these kinds of situations. We have
|
||||
|
||||
## Credits
|
||||
|
||||
* [Distributed Transactions: The Icebergs of Microservices](https://www.grahamlea.com/2016/08/distributed-transactions-microservices-icebergs/)
|
||||
* [https://www.grahamlea.com/2016/08/distributed-transactions-microservices-icebergs/]
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Composite Entity
|
||||
category: Structural
|
||||
folder: composite-entity
|
||||
permalink: /patterns/composite-entity/
|
||||
categories: Structural
|
||||
language: en
|
||||
tags:
|
||||
- Enterprise Integration Pattern
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Composite
|
||||
category: Structural
|
||||
folder: composite
|
||||
permalink: /patterns/composite/
|
||||
categories: Structural
|
||||
language: en
|
||||
tags:
|
||||
- Gang of Four
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Converter
|
||||
category: Creational
|
||||
folder: converter
|
||||
permalink: /patterns/converter/
|
||||
categories: Creational
|
||||
language: en
|
||||
tags:
|
||||
- Decoupling
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: CQRS
|
||||
category: Architectural
|
||||
folder: cqrs
|
||||
permalink: /patterns/cqrs/
|
||||
categories: Architectural
|
||||
language: en
|
||||
tags:
|
||||
- Performance
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Data Access Object
|
||||
category: Architectural
|
||||
folder: dao
|
||||
permalink: /patterns/dao/
|
||||
categories: Architectural
|
||||
language: en
|
||||
tags:
|
||||
- Data access
|
||||
|
@ -1,6 +1,10 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Data Bus
|
||||
category: Architectural
|
||||
folder: data-bus
|
||||
permalink: /patterns/data-bus/
|
||||
|
||||
categories: Architectural
|
||||
language: en
|
||||
tags:
|
||||
- Decoupling
|
||||
|
@ -46,7 +46,7 @@ class DataBusTest {
|
||||
|
||||
@BeforeEach
|
||||
void setUp() {
|
||||
MockitoAnnotations.openMocks(this);
|
||||
MockitoAnnotations.initMocks(this);
|
||||
}
|
||||
|
||||
@Test
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Data Locality
|
||||
category: Behavioral
|
||||
folder: data-locality
|
||||
permalink: /patterns/data-locality/
|
||||
categories: Behavioral
|
||||
language: en
|
||||
tags:
|
||||
- Game programming
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Data Mapper
|
||||
category: Architectural
|
||||
folder: data-mapper
|
||||
permalink: /patterns/data-mapper/
|
||||
categories: Architectural
|
||||
language: en
|
||||
tags:
|
||||
- Decoupling
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Data Transfer Object
|
||||
category: Architectural
|
||||
folder: data-transfer-object
|
||||
permalink: /patterns/data-transfer-object/
|
||||
categories: Architectural
|
||||
language: en
|
||||
tags:
|
||||
- Performance
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Decorator
|
||||
category: Structural
|
||||
folder: decorator
|
||||
permalink: /patterns/decorator/
|
||||
categories: Structural
|
||||
language: en
|
||||
tags:
|
||||
- Gang of Four
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Delegation
|
||||
category: Structural
|
||||
folder: delegation
|
||||
permalink: /patterns/delegation/
|
||||
categories: Structural
|
||||
language: en
|
||||
tags:
|
||||
- Decoupling
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Dependency Injection
|
||||
category: Creational
|
||||
folder: dependency-injection
|
||||
permalink: /patterns/dependency-injection/
|
||||
categories: Creational
|
||||
language: en
|
||||
tags:
|
||||
- Decoupling
|
||||
@ -100,4 +103,4 @@ Use the Dependency Injection pattern when:
|
||||
* [Dependency Injection Principles, Practices, and Patterns](https://www.amazon.com/gp/product/161729473X/ref=as_li_qf_asin_il_tl?ie=UTF8&tag=javadesignpat-20&creative=9325&linkCode=as2&creativeASIN=161729473X&linkId=57079257a5c7d33755493802f3b884bd)
|
||||
* [Clean Code: A Handbook of Agile Software Craftsmanship](https://www.amazon.com/gp/product/0132350882/ref=as_li_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0132350882&linkCode=as2&tag=javadesignpat-20&linkId=2c390d89cc9e61c01b9e7005c7842871)
|
||||
* [Java 9 Dependency Injection: Write loosely coupled code with Spring 5 and Guice](https://www.amazon.com/gp/product/1788296257/ref=as_li_tl?ie=UTF8&tag=javadesignpat-20&camp=1789&creative=9325&linkCode=as2&creativeASIN=1788296257&linkId=4e9137a3bf722a8b5b156cce1eec0fc1)
|
||||
* [Google Guice: Agile Lightweight Dependency Injection Framework](https://www.amazon.com/gp/product/1590599977/ref=as_li_qf_asin_il_tl?ie=UTF8&tag=javadesignpat-20&creative=9325&linkCode=as2&creativeASIN=1590599977&linkId=3b10c90b7ba480a1b7777ff38000f956)
|
||||
* [Google Guice Tutorial: Open source Java based dependency injection framework](https://www.amazon.com/gp/product/B083P7DZ8M/ref=as_li_tl?ie=UTF8&tag=javadesignpat-20&camp=1789&creative=9325&linkCode=as2&creativeASIN=B083P7DZ8M&linkId=04f0f902c877921e45215b624a124bfe)
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Dirty Flag
|
||||
category: Behavioral
|
||||
folder: dirty-flag
|
||||
permalink: /patterns/dirty-flag/
|
||||
categories: Behavioral
|
||||
language: en
|
||||
tags:
|
||||
- Game programming
|
||||
|
@ -1,323 +0,0 @@
|
||||
---
|
||||
title: Domain Model
|
||||
category: Architectural
|
||||
language: en
|
||||
tags:
|
||||
- Domain
|
||||
---
|
||||
|
||||
## Intent
|
||||
|
||||
Domain model pattern provides an object-oriented way of dealing with complicated logic. Instead of having one procedure that handles all business logic for a user action there are multiple objects and each of them handles a slice of domain logic that is relevant to it.
|
||||
|
||||
## Explanation
|
||||
|
||||
Real world example
|
||||
|
||||
> Let's assume that we need to build an e-commerce web application. While analyzing requirements you will notice that there are few nouns you talk about repeatedly. It’s your Customer, and a Product the customer looks for. These two are your domain-specific classes and each of that classes will include some business logic specific to its domain.
|
||||
|
||||
In plain words
|
||||
|
||||
> The Domain Model is an object model of the domain that incorporates both behavior and data.
|
||||
|
||||
Programmatic Example
|
||||
|
||||
In the example of the e-commerce app, we need to deal with the domain logic of customers who want to buy products and return them if they want. We can use the domain model pattern and create classes `Customer` and `Product` where every single instance of that class incorporates both behavior and data and represents only one record in the underlying table.
|
||||
|
||||
Here is the `Product` domain class with fields `name`, `price`, `expirationDate` which is specific for each product, `productDao` for working with DB, `save` method for saving product and `getSalePrice` method which return price for this product with discount.
|
||||
|
||||
```java
|
||||
@Slf4j
|
||||
@Getter
|
||||
@Setter
|
||||
@Builder
|
||||
@AllArgsConstructor
|
||||
public class Product {
|
||||
|
||||
private static final int DAYS_UNTIL_EXPIRATION_WHEN_DISCOUNT_ACTIVE = 4;
|
||||
private static final double DISCOUNT_RATE = 0.2;
|
||||
|
||||
@NonNull private final ProductDao productDao;
|
||||
@NonNull private String name;
|
||||
@NonNull private Money price;
|
||||
@NonNull private LocalDate expirationDate;
|
||||
|
||||
/**
|
||||
* Save product or update if product already exist.
|
||||
*/
|
||||
public void save() {
|
||||
try {
|
||||
Optional<Product> product = productDao.findByName(name);
|
||||
if (product.isPresent()) {
|
||||
productDao.update(this);
|
||||
} else {
|
||||
productDao.save(this);
|
||||
}
|
||||
} catch (SQLException ex) {
|
||||
LOGGER.error(ex.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate sale price of product with discount.
|
||||
*/
|
||||
public Money getSalePrice() {
|
||||
return price.minus(calculateDiscount());
|
||||
}
|
||||
|
||||
private Money calculateDiscount() {
|
||||
if (ChronoUnit.DAYS.between(LocalDate.now(), expirationDate)
|
||||
< DAYS_UNTIL_EXPIRATION_WHEN_DISCOUNT_ACTIVE) {
|
||||
|
||||
return price.multipliedBy(DISCOUNT_RATE, RoundingMode.DOWN);
|
||||
}
|
||||
|
||||
return Money.zero(USD);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Here is the `Customer` domain class with fields `name`, `money` which is specific for each customer, `customerDao` for working with DB, `save` for saving customer, `buyProduct` which add a product to purchases and withdraw money, `returnProduct` which remove product from purchases and return money, `showPurchases` and `showBalance` methods for printing customer's purchases and money balance.
|
||||
|
||||
```java
|
||||
@Slf4j
|
||||
@Getter
|
||||
@Setter
|
||||
@Builder
|
||||
public class Customer {
|
||||
|
||||
@NonNull private final CustomerDao customerDao;
|
||||
@Builder.Default private List<Product> purchases = new ArrayList<>();
|
||||
@NonNull private String name;
|
||||
@NonNull private Money money;
|
||||
|
||||
/**
|
||||
* Save customer or update if customer already exist.
|
||||
*/
|
||||
public void save() {
|
||||
try {
|
||||
Optional<Customer> customer = customerDao.findByName(name);
|
||||
if (customer.isPresent()) {
|
||||
customerDao.update(this);
|
||||
} else {
|
||||
customerDao.save(this);
|
||||
}
|
||||
} catch (SQLException ex) {
|
||||
LOGGER.error(ex.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add product to purchases, save to db and withdraw money.
|
||||
*
|
||||
* @param product to buy.
|
||||
*/
|
||||
public void buyProduct(Product product) {
|
||||
LOGGER.info(
|
||||
String.format(
|
||||
"%s want to buy %s($%.2f)...",
|
||||
name, product.getName(), product.getSalePrice().getAmount()));
|
||||
try {
|
||||
withdraw(product.getSalePrice());
|
||||
} catch (IllegalArgumentException ex) {
|
||||
LOGGER.error(ex.getMessage());
|
||||
return;
|
||||
}
|
||||
try {
|
||||
customerDao.addProduct(product, this);
|
||||
purchases.add(product);
|
||||
LOGGER.info(String.format("%s bought %s!", name, product.getName()));
|
||||
} catch (SQLException exception) {
|
||||
receiveMoney(product.getSalePrice());
|
||||
LOGGER.error(exception.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove product from purchases, delete from db and return money.
|
||||
*
|
||||
* @param product to return.
|
||||
*/
|
||||
public void returnProduct(Product product) {
|
||||
LOGGER.info(
|
||||
String.format(
|
||||
"%s want to return %s($%.2f)...",
|
||||
name, product.getName(), product.getSalePrice().getAmount()));
|
||||
if (purchases.contains(product)) {
|
||||
try {
|
||||
customerDao.deleteProduct(product, this);
|
||||
purchases.remove(product);
|
||||
receiveMoney(product.getSalePrice());
|
||||
LOGGER.info(String.format("%s returned %s!", name, product.getName()));
|
||||
} catch (SQLException ex) {
|
||||
LOGGER.error(ex.getMessage());
|
||||
}
|
||||
} else {
|
||||
LOGGER.error(String.format("%s didn't buy %s...", name, product.getName()));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Print customer's purchases.
|
||||
*/
|
||||
public void showPurchases() {
|
||||
Optional<String> purchasesToShow =
|
||||
purchases.stream()
|
||||
.map(p -> p.getName() + " - $" + p.getSalePrice().getAmount())
|
||||
.reduce((p1, p2) -> p1 + ", " + p2);
|
||||
|
||||
if (purchasesToShow.isPresent()) {
|
||||
LOGGER.info(name + " bought: " + purchasesToShow.get());
|
||||
} else {
|
||||
LOGGER.info(name + " didn't bought anything");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Print customer's money balance.
|
||||
*/
|
||||
public void showBalance() {
|
||||
LOGGER.info(name + " balance: " + money);
|
||||
}
|
||||
|
||||
private void withdraw(Money amount) throws IllegalArgumentException {
|
||||
if (money.compareTo(amount) < 0) {
|
||||
throw new IllegalArgumentException("Not enough money!");
|
||||
}
|
||||
money = money.minus(amount);
|
||||
}
|
||||
|
||||
private void receiveMoney(Money amount) {
|
||||
money = money.plus(amount);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
In the class `App`, we create a new instance of class Customer which represents customer Tom and handle data and actions of that customer and creating three products that Tom wants to buy.
|
||||
|
||||
|
||||
```java
|
||||
// Create data source and create the customers, products and purchases tables
|
||||
final var dataSource = createDataSource();
|
||||
deleteSchema(dataSource);
|
||||
createSchema(dataSource);
|
||||
|
||||
// create customer
|
||||
var customerDao = new CustomerDaoImpl(dataSource);
|
||||
|
||||
var tom =
|
||||
Customer.builder()
|
||||
.name("Tom")
|
||||
.money(Money.of(USD, 30))
|
||||
.customerDao(customerDao)
|
||||
.build();
|
||||
|
||||
tom.save();
|
||||
|
||||
// create products
|
||||
var productDao = new ProductDaoImpl(dataSource);
|
||||
|
||||
var eggs =
|
||||
Product.builder()
|
||||
.name("Eggs")
|
||||
.price(Money.of(USD, 10.0))
|
||||
.expirationDate(LocalDate.now().plusDays(7))
|
||||
.productDao(productDao)
|
||||
.build();
|
||||
|
||||
var butter =
|
||||
Product.builder()
|
||||
.name("Butter")
|
||||
.price(Money.of(USD, 20.00))
|
||||
.expirationDate(LocalDate.now().plusDays(9))
|
||||
.productDao(productDao)
|
||||
.build();
|
||||
|
||||
var cheese =
|
||||
Product.builder()
|
||||
.name("Cheese")
|
||||
.price(Money.of(USD, 25.0))
|
||||
.expirationDate(LocalDate.now().plusDays(2))
|
||||
.productDao(productDao)
|
||||
.build();
|
||||
|
||||
eggs.save();
|
||||
butter.save();
|
||||
cheese.save();
|
||||
|
||||
// show money balance of customer after each purchase
|
||||
tom.showBalance();
|
||||
tom.showPurchases();
|
||||
|
||||
// buy eggs
|
||||
tom.buyProduct(eggs);
|
||||
tom.showBalance();
|
||||
|
||||
// buy butter
|
||||
tom.buyProduct(butter);
|
||||
tom.showBalance();
|
||||
|
||||
// trying to buy cheese, but receive a refusal
|
||||
// because he didn't have enough money
|
||||
tom.buyProduct(cheese);
|
||||
tom.showBalance();
|
||||
|
||||
// return butter and get money back
|
||||
tom.returnProduct(butter);
|
||||
tom.showBalance();
|
||||
|
||||
// Tom can buy cheese now because he has enough money
|
||||
// and there is a discount on cheese because it expires in 2 days
|
||||
tom.buyProduct(cheese);
|
||||
|
||||
tom.save();
|
||||
|
||||
// show money balance and purchases after shopping
|
||||
tom.showBalance();
|
||||
tom.showPurchases();
|
||||
```
|
||||
|
||||
The program output:
|
||||
|
||||
```java
|
||||
17:52:28.690 [main] INFO com.iluwatar.domainmodel.Customer - Tom balance: USD 30.00
|
||||
17:52:28.695 [main] INFO com.iluwatar.domainmodel.Customer - Tom didn't bought anything
|
||||
17:52:28.699 [main] INFO com.iluwatar.domainmodel.Customer - Tom want to buy Eggs($10.00)...
|
||||
17:52:28.705 [main] INFO com.iluwatar.domainmodel.Customer - Tom bought Eggs!
|
||||
17:52:28.705 [main] INFO com.iluwatar.domainmodel.Customer - Tom balance: USD 20.00
|
||||
17:52:28.705 [main] INFO com.iluwatar.domainmodel.Customer - Tom want to buy Butter($20.00)...
|
||||
17:52:28.712 [main] INFO com.iluwatar.domainmodel.Customer - Tom bought Butter!
|
||||
17:52:28.712 [main] INFO com.iluwatar.domainmodel.Customer - Tom balance: USD 0.00
|
||||
17:52:28.712 [main] INFO com.iluwatar.domainmodel.Customer - Tom want to buy Cheese($20.00)...
|
||||
17:52:28.712 [main] ERROR com.iluwatar.domainmodel.Customer - Not enough money!
|
||||
17:52:28.712 [main] INFO com.iluwatar.domainmodel.Customer - Tom balance: USD 0.00
|
||||
17:52:28.712 [main] INFO com.iluwatar.domainmodel.Customer - Tom want to return Butter($20.00)...
|
||||
17:52:28.721 [main] INFO com.iluwatar.domainmodel.Customer - Tom returned Butter!
|
||||
17:52:28.721 [main] INFO com.iluwatar.domainmodel.Customer - Tom balance: USD 20.00
|
||||
17:52:28.721 [main] INFO com.iluwatar.domainmodel.Customer - Tom want to buy Cheese($20.00)...
|
||||
17:52:28.726 [main] INFO com.iluwatar.domainmodel.Customer - Tom bought Cheese!
|
||||
17:52:28.737 [main] INFO com.iluwatar.domainmodel.Customer - Tom balance: USD 0.00
|
||||
17:52:28.738 [main] INFO com.iluwatar.domainmodel.Customer - Tom bought: Eggs - $10.00, Cheese - $20.00
|
||||
```
|
||||
|
||||
## Class diagram
|
||||
|
||||

|
||||
|
||||
## Applicability
|
||||
|
||||
Use a Domain model pattern when your domain logic is complex and that complexity can rapidly grow because this pattern handles increasing complexity very well. Otherwise, it's a more complex solution for organizing domain logic, so shouldn't use Domain Model pattern for systems with simple domain logic, because the cost of understanding it and complexity of data source exceeds the benefit of this pattern.
|
||||
|
||||
## Related patterns
|
||||
|
||||
- [Transaction Script](https://java-design-patterns.com/patterns/transaction-script/)
|
||||
|
||||
- [Table Module](https://java-design-patterns.com/patterns/table-module/)
|
||||
|
||||
- [Service Layer](https://java-design-patterns.com/patterns/service-layer/)
|
||||
|
||||
## Credits
|
||||
|
||||
* [Domain Model Pattern](https://martinfowler.com/eaaCatalog/domainModel.html)
|
||||
* [Patterns of Enterprise Application Architecture](https://www.amazon.com/gp/product/0321127420/ref=as_li_qf_asin_il_tl?ie=UTF8&tag=javadesignpat-20&creative=9325&linkCode=as2&creativeASIN=0321127420&linkId=18acc13ba60d66690009505577c45c04)
|
||||
* [Architecture patterns: domain model and friends](https://inviqa.com/blog/architecture-patterns-domain-model-and-friends)
|
Binary file not shown.
Before Width: | Height: | Size: 314 KiB |
@ -1,87 +0,0 @@
|
||||
@startuml
|
||||
package com.iluwatar.domainmodel {
|
||||
class App {
|
||||
+ CREATE_SCHEMA_SQL : String {static}
|
||||
+ DELETE_SCHEMA_SQL : String {static}
|
||||
+ H2_DB_URL : String {static}
|
||||
+ App()
|
||||
- createDataSource() : DataSource {static}
|
||||
- createSchema(dataSource : DataSource) {static}
|
||||
- deleteSchema(dataSource : DataSource) {static}
|
||||
+ main(args : String[]) {static}
|
||||
}
|
||||
class Customer {
|
||||
- customerDao : CustomerDao
|
||||
- money : Money
|
||||
- name : String
|
||||
- purchases : List<Product>
|
||||
~ Customer(customerDao : CustomerDao, purchases : List<Product>, name : String, money : Money)
|
||||
+ builder() : CustomerBuilder {static}
|
||||
+ buyProduct(product : Product)
|
||||
+ getCustomerDao() : CustomerDao
|
||||
+ getMoney() : Money
|
||||
+ getName() : String
|
||||
+ getPurchases() : List<Product>
|
||||
- receiveMoney(amount : Money)
|
||||
+ returnProduct(product : Product)
|
||||
+ save()
|
||||
+ setMoney(money : Money)
|
||||
+ setName(name : String)
|
||||
+ setPurchases(purchases : List<Product>)
|
||||
+ showBalance()
|
||||
+ showPurchases()
|
||||
- withdraw(amount : Money)
|
||||
}
|
||||
interface CustomerDao {
|
||||
+ addProduct(Product, Customer) {abstract}
|
||||
+ deleteProduct(Product, Customer) {abstract}
|
||||
+ findByName(String) : Optional<Customer> {abstract}
|
||||
+ save(Customer) {abstract}
|
||||
+ update(Customer) {abstract}
|
||||
}
|
||||
class CustomerDaoImpl {
|
||||
- dataSource : DataSource
|
||||
+ CustomerDaoImpl(userDataSource : DataSource)
|
||||
+ addProduct(product : Product, customer : Customer)
|
||||
+ deleteProduct(product : Product, customer : Customer)
|
||||
+ findByName(name : String) : Optional<Customer>
|
||||
+ save(customer : Customer)
|
||||
+ update(customer : Customer)
|
||||
}
|
||||
class Product {
|
||||
- expirationDate : LocalDate
|
||||
- name : String
|
||||
- price : Money
|
||||
- productDao : ProductDao
|
||||
+ Product(productDao : ProductDao, name : String, price : Money, expirationDate : LocalDate)
|
||||
+ builder() : ProductBuilder {static}
|
||||
- calculateDiscount() : Money
|
||||
+ getExpirationDate() : LocalDate
|
||||
+ getName() : String
|
||||
+ getPrice() : Money
|
||||
+ getProductDao() : ProductDao
|
||||
+ getSalePrice() : Money
|
||||
+ save()
|
||||
+ setExpirationDate(expirationDate : LocalDate)
|
||||
+ setName(name : String)
|
||||
+ setPrice(price : Money)
|
||||
}
|
||||
interface ProductDao {
|
||||
+ findByName(String) : Optional<Product> {abstract}
|
||||
+ save(Product) {abstract}
|
||||
+ update(Product) {abstract}
|
||||
}
|
||||
class ProductDaoImpl {
|
||||
- dataSource : DataSource
|
||||
+ ProductDaoImpl(userDataSource : DataSource)
|
||||
+ findByName(name : String) : Optional<Product>
|
||||
+ save(product : Product)
|
||||
+ update(product : Product)
|
||||
}
|
||||
}
|
||||
Product --> ProductDao
|
||||
Customer --> CustomerDao
|
||||
Customer --> Product
|
||||
CustomerDaoImpl ..|> CustomerDao
|
||||
ProductDaoImpl ..|> ProductDao
|
||||
@enduml
|
@ -1,78 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
|
||||
The MIT License
|
||||
Copyright © 2014-2021 Ilkka Seppälä
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
-->
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<parent>
|
||||
<artifactId>java-design-patterns</artifactId>
|
||||
<groupId>com.iluwatar</groupId>
|
||||
<version>1.25.0-SNAPSHOT</version>
|
||||
</parent>
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<artifactId>domain-model</artifactId>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.h2database</groupId>
|
||||
<artifactId>h2</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.junit.jupiter</groupId>
|
||||
<artifactId>junit-jupiter-engine</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.mockito</groupId>
|
||||
<artifactId>mockito-core</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.joda</groupId>
|
||||
<artifactId>joda-money</artifactId>
|
||||
<version>1.0.1</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-assembly-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<configuration>
|
||||
<archive>
|
||||
<manifest>
|
||||
<mainClass>com.iluwatar.domainmodel.App</mainClass>
|
||||
</manifest>
|
||||
</archive>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
</project>
|
@ -1,173 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import static org.joda.money.CurrencyUnit.USD;
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.time.LocalDate;
|
||||
import javax.sql.DataSource;
|
||||
|
||||
import org.h2.jdbcx.JdbcDataSource;
|
||||
import org.joda.money.Money;
|
||||
|
||||
|
||||
/**
|
||||
* Domain Model pattern is a more complex solution for organizing domain logic than Transaction
|
||||
* Script and Table Module. It provides an object-oriented way of dealing with complicated logic.
|
||||
* Instead of having one procedure that handles all business logic for a user action like
|
||||
* Transaction Script there are multiple objects and each of them handles a slice of domain logic
|
||||
* that is relevant to it. The significant difference between Domain Model and Table Module pattern
|
||||
* is that in Table Module a single class encapsulates all the domain logic for all records stored
|
||||
* in table when in Domain Model every single class represents only one record in underlying table.
|
||||
*
|
||||
* <p>In this example, we will use the Domain Model pattern to implement buying of products
|
||||
* by customers in a Shop. The main method will create a customer and a few products.
|
||||
* Customer will do a few purchases, try to buy product which are too expensive for him,
|
||||
* return product which he bought to return money.</p>
|
||||
*/
|
||||
public class App {
|
||||
|
||||
public static final String H2_DB_URL = "jdbc:h2:~/test";
|
||||
|
||||
public static final String CREATE_SCHEMA_SQL =
|
||||
"CREATE TABLE CUSTOMERS (name varchar primary key, money decimal);"
|
||||
+ "CREATE TABLE PRODUCTS (name varchar primary key, price decimal, expiration_date date);"
|
||||
+ "CREATE TABLE PURCHASES ("
|
||||
+ "product_name varchar references PRODUCTS(name),"
|
||||
+ "customer_name varchar references CUSTOMERS(name));";
|
||||
|
||||
public static final String DELETE_SCHEMA_SQL =
|
||||
"DROP TABLE CUSTOMERS IF EXISTS;"
|
||||
+ "DROP TABLE PURCHASES IF EXISTS;"
|
||||
+ "DROP TABLE PRODUCTS IF EXISTS;";
|
||||
|
||||
/**
|
||||
* Program entry point.
|
||||
*
|
||||
* @param args command line arguments
|
||||
* @throws Exception if any error occurs
|
||||
*/
|
||||
public static void main(String[] args) throws Exception {
|
||||
|
||||
// Create data source and create the customers, products and purchases tables
|
||||
final var dataSource = createDataSource();
|
||||
deleteSchema(dataSource);
|
||||
createSchema(dataSource);
|
||||
|
||||
// create customer
|
||||
var customerDao = new CustomerDaoImpl(dataSource);
|
||||
|
||||
var tom =
|
||||
Customer.builder()
|
||||
.name("Tom")
|
||||
.money(Money.of(USD, 30))
|
||||
.customerDao(customerDao)
|
||||
.build();
|
||||
|
||||
tom.save();
|
||||
|
||||
// create products
|
||||
var productDao = new ProductDaoImpl(dataSource);
|
||||
|
||||
var eggs =
|
||||
Product.builder()
|
||||
.name("Eggs")
|
||||
.price(Money.of(USD, 10.0))
|
||||
.expirationDate(LocalDate.now().plusDays(7))
|
||||
.productDao(productDao)
|
||||
.build();
|
||||
|
||||
var butter =
|
||||
Product.builder()
|
||||
.name("Butter")
|
||||
.price(Money.of(USD, 20.00))
|
||||
.expirationDate(LocalDate.now().plusDays(9))
|
||||
.productDao(productDao)
|
||||
.build();
|
||||
|
||||
var cheese =
|
||||
Product.builder()
|
||||
.name("Cheese")
|
||||
.price(Money.of(USD, 25.0))
|
||||
.expirationDate(LocalDate.now().plusDays(2))
|
||||
.productDao(productDao)
|
||||
.build();
|
||||
|
||||
eggs.save();
|
||||
butter.save();
|
||||
cheese.save();
|
||||
|
||||
// show money balance of customer after each purchase
|
||||
tom.showBalance();
|
||||
tom.showPurchases();
|
||||
|
||||
// buy eggs
|
||||
tom.buyProduct(eggs);
|
||||
tom.showBalance();
|
||||
|
||||
// buy butter
|
||||
tom.buyProduct(butter);
|
||||
tom.showBalance();
|
||||
|
||||
// trying to buy cheese, but receive a refusal
|
||||
// because he didn't have enough money
|
||||
tom.buyProduct(cheese);
|
||||
tom.showBalance();
|
||||
|
||||
// return butter and get money back
|
||||
tom.returnProduct(butter);
|
||||
tom.showBalance();
|
||||
|
||||
// Tom can buy cheese now because he has enough money
|
||||
// and there is a discount on cheese because it expires in 2 days
|
||||
tom.buyProduct(cheese);
|
||||
|
||||
tom.save();
|
||||
|
||||
// show money balance and purchases after shopping
|
||||
tom.showBalance();
|
||||
tom.showPurchases();
|
||||
}
|
||||
|
||||
private static DataSource createDataSource() {
|
||||
var dataSource = new JdbcDataSource();
|
||||
dataSource.setUrl(H2_DB_URL);
|
||||
return dataSource;
|
||||
}
|
||||
|
||||
private static void deleteSchema(DataSource dataSource) throws SQLException {
|
||||
try (var connection = dataSource.getConnection();
|
||||
var statement = connection.createStatement()) {
|
||||
statement.execute(DELETE_SCHEMA_SQL);
|
||||
}
|
||||
}
|
||||
|
||||
private static void createSchema(DataSource dataSource) throws SQLException {
|
||||
try (var connection = dataSource.getConnection();
|
||||
var statement = connection.createStatement()) {
|
||||
statement.execute(CREATE_SCHEMA_SQL);
|
||||
}
|
||||
}
|
||||
}
|
@ -1,153 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
|
||||
import lombok.Builder;
|
||||
import lombok.Getter;
|
||||
import lombok.NonNull;
|
||||
import lombok.Setter;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.joda.money.Money;
|
||||
|
||||
/**
|
||||
* This class organizes domain logic of customer.
|
||||
* A single instance of this class
|
||||
* contains both the data and behavior of a single customer.
|
||||
*/
|
||||
@Slf4j
|
||||
@Getter
|
||||
@Setter
|
||||
@Builder
|
||||
public class Customer {
|
||||
|
||||
@NonNull private final CustomerDao customerDao;
|
||||
@Builder.Default private List<Product> purchases = new ArrayList<>();
|
||||
@NonNull private String name;
|
||||
@NonNull private Money money;
|
||||
|
||||
/**
|
||||
* Save customer or update if customer already exist.
|
||||
*/
|
||||
public void save() {
|
||||
try {
|
||||
Optional<Customer> customer = customerDao.findByName(name);
|
||||
if (customer.isPresent()) {
|
||||
customerDao.update(this);
|
||||
} else {
|
||||
customerDao.save(this);
|
||||
}
|
||||
} catch (SQLException ex) {
|
||||
LOGGER.error(ex.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add product to purchases, save to db and withdraw money.
|
||||
*
|
||||
* @param product to buy.
|
||||
*/
|
||||
public void buyProduct(Product product) {
|
||||
LOGGER.info(
|
||||
String.format(
|
||||
"%s want to buy %s($%.2f)...",
|
||||
name, product.getName(), product.getSalePrice().getAmount()));
|
||||
try {
|
||||
withdraw(product.getSalePrice());
|
||||
} catch (IllegalArgumentException ex) {
|
||||
LOGGER.error(ex.getMessage());
|
||||
return;
|
||||
}
|
||||
try {
|
||||
customerDao.addProduct(product, this);
|
||||
purchases.add(product);
|
||||
LOGGER.info(String.format("%s bought %s!", name, product.getName()));
|
||||
} catch (SQLException exception) {
|
||||
receiveMoney(product.getSalePrice());
|
||||
LOGGER.error(exception.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove product from purchases, delete from db and return money.
|
||||
*
|
||||
* @param product to return.
|
||||
*/
|
||||
public void returnProduct(Product product) {
|
||||
LOGGER.info(
|
||||
String.format(
|
||||
"%s want to return %s($%.2f)...",
|
||||
name, product.getName(), product.getSalePrice().getAmount()));
|
||||
if (purchases.contains(product)) {
|
||||
try {
|
||||
customerDao.deleteProduct(product, this);
|
||||
purchases.remove(product);
|
||||
receiveMoney(product.getSalePrice());
|
||||
LOGGER.info(String.format("%s returned %s!", name, product.getName()));
|
||||
} catch (SQLException ex) {
|
||||
LOGGER.error(ex.getMessage());
|
||||
}
|
||||
} else {
|
||||
LOGGER.error(String.format("%s didn't buy %s...", name, product.getName()));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Print customer's purchases.
|
||||
*/
|
||||
public void showPurchases() {
|
||||
Optional<String> purchasesToShow =
|
||||
purchases.stream()
|
||||
.map(p -> p.getName() + " - $" + p.getSalePrice().getAmount())
|
||||
.reduce((p1, p2) -> p1 + ", " + p2);
|
||||
|
||||
if (purchasesToShow.isPresent()) {
|
||||
LOGGER.info(name + " bought: " + purchasesToShow.get());
|
||||
} else {
|
||||
LOGGER.info(name + " didn't bought anything");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Print customer's money balance.
|
||||
*/
|
||||
public void showBalance() {
|
||||
LOGGER.info(name + " balance: " + money);
|
||||
}
|
||||
|
||||
private void withdraw(Money amount) throws IllegalArgumentException {
|
||||
if (money.compareTo(amount) < 0) {
|
||||
throw new IllegalArgumentException("Not enough money!");
|
||||
}
|
||||
money = money.minus(amount);
|
||||
}
|
||||
|
||||
private void receiveMoney(Money amount) {
|
||||
money = money.plus(amount);
|
||||
}
|
||||
}
|
@ -1,40 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.util.Optional;
|
||||
|
||||
public interface CustomerDao {
|
||||
|
||||
Optional<Customer> findByName(String name) throws SQLException;
|
||||
|
||||
void update(Customer customer) throws SQLException;
|
||||
|
||||
void save(Customer customer) throws SQLException;
|
||||
|
||||
void addProduct(Product product, Customer customer) throws SQLException;
|
||||
|
||||
void deleteProduct(Product product, Customer customer) throws SQLException;
|
||||
}
|
@ -1,109 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import static org.joda.money.CurrencyUnit.USD;
|
||||
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.SQLException;
|
||||
import java.util.Optional;
|
||||
import javax.sql.DataSource;
|
||||
|
||||
import org.joda.money.Money;
|
||||
|
||||
public class CustomerDaoImpl implements CustomerDao {
|
||||
|
||||
private final DataSource dataSource;
|
||||
|
||||
public CustomerDaoImpl(final DataSource userDataSource) {
|
||||
this.dataSource = userDataSource;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Optional<Customer> findByName(String name) throws SQLException {
|
||||
var sql = "select * from CUSTOMERS where name = ?;";
|
||||
|
||||
try (var connection = dataSource.getConnection();
|
||||
var preparedStatement = connection.prepareStatement(sql)) {
|
||||
preparedStatement.setString(1, name);
|
||||
|
||||
ResultSet rs = preparedStatement.executeQuery();
|
||||
|
||||
if (rs.next()) {
|
||||
return Optional.of(
|
||||
Customer.builder()
|
||||
.name(rs.getString("name"))
|
||||
.money(Money.of(USD, rs.getBigDecimal("money")))
|
||||
.customerDao(this)
|
||||
.build());
|
||||
} else {
|
||||
return Optional.empty();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void update(Customer customer) throws SQLException {
|
||||
var sql = "update CUSTOMERS set money = ? where name = ?;";
|
||||
try (var connection = dataSource.getConnection();
|
||||
var preparedStatement = connection.prepareStatement(sql)) {
|
||||
preparedStatement.setBigDecimal(1, customer.getMoney().getAmount());
|
||||
preparedStatement.setString(2, customer.getName());
|
||||
preparedStatement.executeUpdate();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void save(Customer customer) throws SQLException {
|
||||
var sql = "insert into CUSTOMERS (name, money) values (?, ?)";
|
||||
try (var connection = dataSource.getConnection();
|
||||
var preparedStatement = connection.prepareStatement(sql)) {
|
||||
preparedStatement.setString(1, customer.getName());
|
||||
preparedStatement.setBigDecimal(2, customer.getMoney().getAmount());
|
||||
preparedStatement.executeUpdate();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void addProduct(Product product, Customer customer) throws SQLException {
|
||||
var sql = "insert into PURCHASES (product_name, customer_name) values (?,?)";
|
||||
try (var connection = dataSource.getConnection();
|
||||
var preparedStatement = connection.prepareStatement(sql)) {
|
||||
preparedStatement.setString(1, product.getName());
|
||||
preparedStatement.setString(2, customer.getName());
|
||||
preparedStatement.executeUpdate();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void deleteProduct(Product product, Customer customer) throws SQLException {
|
||||
var sql = "delete from PURCHASES where product_name = ? and customer_name = ?";
|
||||
try (var connection = dataSource.getConnection();
|
||||
var preparedStatement = connection.prepareStatement(sql)) {
|
||||
preparedStatement.setString(1, product.getName());
|
||||
preparedStatement.setString(2, customer.getName());
|
||||
preparedStatement.executeUpdate();
|
||||
}
|
||||
}
|
||||
}
|
@ -1,94 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import static org.joda.money.CurrencyUnit.USD;
|
||||
|
||||
import java.math.RoundingMode;
|
||||
import java.sql.SQLException;
|
||||
import java.time.LocalDate;
|
||||
import java.time.temporal.ChronoUnit;
|
||||
import java.util.Optional;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Builder;
|
||||
import lombok.Getter;
|
||||
import lombok.NonNull;
|
||||
import lombok.Setter;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.joda.money.Money;
|
||||
|
||||
/**
|
||||
* This class organizes domain logic of product.
|
||||
* A single instance of this class
|
||||
* contains both the data and behavior of a single product.
|
||||
*/
|
||||
@Slf4j
|
||||
@Getter
|
||||
@Setter
|
||||
@Builder
|
||||
@AllArgsConstructor
|
||||
public class Product {
|
||||
|
||||
private static final int DAYS_UNTIL_EXPIRATION_WHEN_DISCOUNT_ACTIVE = 4;
|
||||
private static final double DISCOUNT_RATE = 0.2;
|
||||
|
||||
@NonNull private final ProductDao productDao;
|
||||
@NonNull private String name;
|
||||
@NonNull private Money price;
|
||||
@NonNull private LocalDate expirationDate;
|
||||
|
||||
/**
|
||||
* Save product or update if product already exist.
|
||||
*/
|
||||
public void save() {
|
||||
try {
|
||||
Optional<Product> product = productDao.findByName(name);
|
||||
if (product.isPresent()) {
|
||||
productDao.update(this);
|
||||
} else {
|
||||
productDao.save(this);
|
||||
}
|
||||
} catch (SQLException ex) {
|
||||
LOGGER.error(ex.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate sale price of product with discount.
|
||||
*/
|
||||
public Money getSalePrice() {
|
||||
return price.minus(calculateDiscount());
|
||||
}
|
||||
|
||||
private Money calculateDiscount() {
|
||||
if (ChronoUnit.DAYS.between(LocalDate.now(), expirationDate)
|
||||
< DAYS_UNTIL_EXPIRATION_WHEN_DISCOUNT_ACTIVE) {
|
||||
|
||||
return price.multipliedBy(DISCOUNT_RATE, RoundingMode.DOWN);
|
||||
}
|
||||
|
||||
return Money.zero(USD);
|
||||
}
|
||||
}
|
@ -1,36 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.util.Optional;
|
||||
|
||||
public interface ProductDao {
|
||||
|
||||
Optional<Product> findByName(String name) throws SQLException;
|
||||
|
||||
void save(Product product) throws SQLException;
|
||||
|
||||
void update(Product product) throws SQLException;
|
||||
}
|
@ -1,92 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import static org.joda.money.CurrencyUnit.USD;
|
||||
|
||||
import java.sql.Date;
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.SQLException;
|
||||
import java.util.Optional;
|
||||
import javax.sql.DataSource;
|
||||
|
||||
import org.joda.money.Money;
|
||||
|
||||
|
||||
public class ProductDaoImpl implements ProductDao {
|
||||
|
||||
private final DataSource dataSource;
|
||||
|
||||
public ProductDaoImpl(final DataSource userDataSource) {
|
||||
this.dataSource = userDataSource;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Optional<Product> findByName(String name) throws SQLException {
|
||||
var sql = "select * from PRODUCTS where name = ?;";
|
||||
|
||||
try (var connection = dataSource.getConnection();
|
||||
var preparedStatement = connection.prepareStatement(sql)) {
|
||||
preparedStatement.setString(1, name);
|
||||
|
||||
ResultSet rs = preparedStatement.executeQuery();
|
||||
|
||||
if (rs.next()) {
|
||||
return Optional.of(
|
||||
Product.builder()
|
||||
.name(rs.getString("name"))
|
||||
.price(Money.of(USD, rs.getBigDecimal("price")))
|
||||
.expirationDate(rs.getDate("expiration_date").toLocalDate())
|
||||
.productDao(this)
|
||||
.build());
|
||||
} else {
|
||||
return Optional.empty();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void save(Product product) throws SQLException {
|
||||
var sql = "insert into PRODUCTS (name, price, expiration_date) values (?, ?, ?)";
|
||||
try (var connection = dataSource.getConnection();
|
||||
var preparedStatement = connection.prepareStatement(sql)) {
|
||||
preparedStatement.setString(1, product.getName());
|
||||
preparedStatement.setBigDecimal(2, product.getPrice().getAmount());
|
||||
preparedStatement.setDate(3, Date.valueOf(product.getExpirationDate()));
|
||||
preparedStatement.executeUpdate();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void update(Product product) throws SQLException {
|
||||
var sql = "update PRODUCTS set price = ?, expiration_date = ? where name = ?;";
|
||||
try (var connection = dataSource.getConnection();
|
||||
var preparedStatement = connection.prepareStatement(sql)) {
|
||||
preparedStatement.setBigDecimal(1, product.getPrice().getAmount());
|
||||
preparedStatement.setDate(2, Date.valueOf(product.getExpirationDate()));
|
||||
preparedStatement.setString(3, product.getName());
|
||||
preparedStatement.executeUpdate();
|
||||
}
|
||||
}
|
||||
}
|
@ -1,38 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
|
||||
|
||||
/** Tests that Domain Model example runs without errors. */
|
||||
final class AppTest {
|
||||
|
||||
@Test
|
||||
void shouldExecuteApplicationWithoutException() {
|
||||
assertDoesNotThrow(() -> App.main(new String[] {}));
|
||||
}
|
||||
|
||||
}
|
@ -1,164 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import org.joda.money.CurrencyUnit;
|
||||
import org.joda.money.Money;
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.SQLException;
|
||||
import java.time.LocalDate;
|
||||
|
||||
import static org.joda.money.CurrencyUnit.USD;
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
class CustomerDaoImplTest {
|
||||
|
||||
public static final String INSERT_CUSTOMER_SQL = "insert into CUSTOMERS values('customer', 100)";
|
||||
public static final String SELECT_CUSTOMERS_SQL = "select name, money from CUSTOMERS";
|
||||
public static final String INSERT_PURCHASES_SQL =
|
||||
"insert into PURCHASES values('product', 'customer')";
|
||||
public static final String SELECT_PURCHASES_SQL =
|
||||
"select product_name, customer_name from PURCHASES";
|
||||
|
||||
private DataSource dataSource;
|
||||
private Product product;
|
||||
private Customer customer;
|
||||
private CustomerDao customerDao;
|
||||
|
||||
@BeforeEach
|
||||
void setUp() throws SQLException {
|
||||
// create db schema
|
||||
dataSource = TestUtils.createDataSource();
|
||||
|
||||
TestUtils.deleteSchema(dataSource);
|
||||
TestUtils.createSchema(dataSource);
|
||||
|
||||
// setup objects
|
||||
customerDao = new CustomerDaoImpl(dataSource);
|
||||
|
||||
customer = Customer.builder().name("customer").money(Money.of(CurrencyUnit.USD,100.0)).customerDao(customerDao).build();
|
||||
|
||||
product =
|
||||
Product.builder()
|
||||
.name("product")
|
||||
.price(Money.of(USD, 100.0))
|
||||
.expirationDate(LocalDate.parse("2021-06-27"))
|
||||
.productDao(new ProductDaoImpl(dataSource))
|
||||
.build();
|
||||
}
|
||||
|
||||
@AfterEach
|
||||
void tearDown() throws SQLException {
|
||||
TestUtils.deleteSchema(dataSource);
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldFindCustomerByName() throws SQLException {
|
||||
var customer = customerDao.findByName("customer");
|
||||
|
||||
assertTrue(customer.isEmpty());
|
||||
|
||||
TestUtils.executeSQL(INSERT_CUSTOMER_SQL, dataSource);
|
||||
|
||||
customer = customerDao.findByName("customer");
|
||||
|
||||
assertTrue(customer.isPresent());
|
||||
assertEquals("customer", customer.get().getName());
|
||||
assertEquals(Money.of(USD, 100), customer.get().getMoney());
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldSaveCustomer() throws SQLException {
|
||||
customerDao.save(customer);
|
||||
|
||||
try (var connection = dataSource.getConnection();
|
||||
var statement = connection.createStatement();
|
||||
ResultSet rs = statement.executeQuery(SELECT_CUSTOMERS_SQL)) {
|
||||
|
||||
assertTrue(rs.next());
|
||||
assertEquals(customer.getName(), rs.getString("name"));
|
||||
assertEquals(customer.getMoney(), Money.of(USD, rs.getBigDecimal("money")));
|
||||
}
|
||||
|
||||
assertThrows(SQLException.class, () -> customerDao.save(customer));
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldUpdateCustomer() throws SQLException {
|
||||
TestUtils.executeSQL(INSERT_CUSTOMER_SQL, dataSource);
|
||||
|
||||
customer.setMoney(Money.of(CurrencyUnit.USD, 99));
|
||||
|
||||
customerDao.update(customer);
|
||||
|
||||
try (var connection = dataSource.getConnection();
|
||||
var statement = connection.createStatement();
|
||||
ResultSet rs = statement.executeQuery(SELECT_CUSTOMERS_SQL)) {
|
||||
|
||||
assertTrue(rs.next());
|
||||
assertEquals(customer.getName(), rs.getString("name"));
|
||||
assertEquals(customer.getMoney(), Money.of(USD, rs.getBigDecimal("money")));
|
||||
assertFalse(rs.next());
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldAddProductToPurchases() throws SQLException {
|
||||
TestUtils.executeSQL(INSERT_CUSTOMER_SQL, dataSource);
|
||||
TestUtils.executeSQL(ProductDaoImplTest.INSERT_PRODUCT_SQL, dataSource);
|
||||
|
||||
customerDao.addProduct(product, customer);
|
||||
|
||||
try (var connection = dataSource.getConnection();
|
||||
var statement = connection.createStatement();
|
||||
ResultSet rs = statement.executeQuery(SELECT_PURCHASES_SQL)) {
|
||||
|
||||
assertTrue(rs.next());
|
||||
assertEquals(product.getName(), rs.getString("product_name"));
|
||||
assertEquals(customer.getName(), rs.getString("customer_name"));
|
||||
assertFalse(rs.next());
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldDeleteProductFromPurchases() throws SQLException {
|
||||
TestUtils.executeSQL(INSERT_CUSTOMER_SQL, dataSource);
|
||||
TestUtils.executeSQL(ProductDaoImplTest.INSERT_PRODUCT_SQL, dataSource);
|
||||
TestUtils.executeSQL(INSERT_PURCHASES_SQL, dataSource);
|
||||
|
||||
customerDao.deleteProduct(product, customer);
|
||||
|
||||
try (var connection = dataSource.getConnection();
|
||||
var statement = connection.createStatement();
|
||||
ResultSet rs = statement.executeQuery(SELECT_PURCHASES_SQL)) {
|
||||
|
||||
assertFalse(rs.next());
|
||||
}
|
||||
}
|
||||
}
|
@ -1,112 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import org.joda.money.CurrencyUnit;
|
||||
import org.joda.money.Money;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.time.LocalDate;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.Optional;
|
||||
|
||||
import static org.joda.money.CurrencyUnit.USD;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.mockito.Mockito.*;
|
||||
|
||||
class CustomerTest {
|
||||
|
||||
private CustomerDao customerDao;
|
||||
private Customer customer;
|
||||
private Product product;
|
||||
|
||||
@BeforeEach
|
||||
void setUp() {
|
||||
customerDao = mock(CustomerDao.class);
|
||||
|
||||
customer = Customer.builder()
|
||||
.name("customer")
|
||||
.money(Money.of(CurrencyUnit.USD, 100.0))
|
||||
.customerDao(customerDao)
|
||||
.build();
|
||||
|
||||
product = Product.builder()
|
||||
.name("product")
|
||||
.price(Money.of(USD, 100.0))
|
||||
.expirationDate(LocalDate.now().plusDays(10))
|
||||
.productDao(mock(ProductDao.class))
|
||||
.build();
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldSaveCustomer() throws SQLException {
|
||||
when(customerDao.findByName("customer")).thenReturn(Optional.empty());
|
||||
|
||||
customer.save();
|
||||
|
||||
verify(customerDao, times(1)).save(customer);
|
||||
|
||||
when(customerDao.findByName("customer")).thenReturn(Optional.of(customer));
|
||||
|
||||
customer.save();
|
||||
|
||||
verify(customerDao, times(1)).update(customer);
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldAddProductToPurchases() {
|
||||
product.setPrice(Money.of(USD, 200.0));
|
||||
|
||||
customer.buyProduct(product);
|
||||
|
||||
assertEquals(customer.getPurchases(), new ArrayList<>());
|
||||
assertEquals(customer.getMoney(), Money.of(USD,100));
|
||||
|
||||
product.setPrice(Money.of(USD, 100.0));
|
||||
|
||||
customer.buyProduct(product);
|
||||
|
||||
assertEquals(new ArrayList<>(Arrays.asList(product)), customer.getPurchases());
|
||||
assertEquals(Money.zero(USD), customer.getMoney());
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldRemoveProductFromPurchases() {
|
||||
customer.setPurchases(new ArrayList<>(Arrays.asList(product)));
|
||||
|
||||
customer.returnProduct(product);
|
||||
|
||||
assertEquals(new ArrayList<>(), customer.getPurchases());
|
||||
assertEquals(Money.of(USD, 200), customer.getMoney());
|
||||
|
||||
customer.returnProduct(product);
|
||||
|
||||
assertEquals(new ArrayList<>(), customer.getPurchases());
|
||||
assertEquals(Money.of(USD, 200), customer.getMoney());
|
||||
}
|
||||
}
|
||||
|
@ -1,127 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import org.joda.money.Money;
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.SQLException;
|
||||
import java.time.LocalDate;
|
||||
|
||||
import static org.joda.money.CurrencyUnit.USD;
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
|
||||
class ProductDaoImplTest {
|
||||
|
||||
public static final String INSERT_PRODUCT_SQL =
|
||||
"insert into PRODUCTS values('product', 100, DATE '2021-06-27')";
|
||||
public static final String SELECT_PRODUCTS_SQL =
|
||||
"select name, price, expiration_date from PRODUCTS";
|
||||
|
||||
private DataSource dataSource;
|
||||
private ProductDao productDao;
|
||||
private Product product;
|
||||
|
||||
@BeforeEach
|
||||
void setUp() throws SQLException {
|
||||
// create schema
|
||||
dataSource = TestUtils.createDataSource();
|
||||
|
||||
TestUtils.deleteSchema(dataSource);
|
||||
TestUtils.createSchema(dataSource);
|
||||
|
||||
// setup objects
|
||||
productDao = new ProductDaoImpl(dataSource);
|
||||
|
||||
product =
|
||||
Product.builder()
|
||||
.name("product")
|
||||
.price(Money.of(USD, 100.0))
|
||||
.expirationDate(LocalDate.parse("2021-06-27"))
|
||||
.productDao(productDao)
|
||||
.build();
|
||||
}
|
||||
|
||||
@AfterEach
|
||||
void tearDown() throws SQLException {
|
||||
TestUtils.deleteSchema(dataSource);
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldFindProductByName() throws SQLException {
|
||||
var product = productDao.findByName("product");
|
||||
|
||||
assertTrue(product.isEmpty());
|
||||
|
||||
TestUtils.executeSQL(INSERT_PRODUCT_SQL, dataSource);
|
||||
|
||||
product = productDao.findByName("product");
|
||||
|
||||
assertTrue(product.isPresent());
|
||||
assertEquals("product", product.get().getName());
|
||||
assertEquals(Money.of(USD, 100), product.get().getPrice());
|
||||
assertEquals(LocalDate.parse("2021-06-27"), product.get().getExpirationDate());
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldSaveProduct() throws SQLException {
|
||||
|
||||
productDao.save(product);
|
||||
|
||||
try (var connection = dataSource.getConnection();
|
||||
var statement = connection.createStatement();
|
||||
ResultSet rs = statement.executeQuery(SELECT_PRODUCTS_SQL)) {
|
||||
|
||||
assertTrue(rs.next());
|
||||
assertEquals(product.getName(), rs.getString("name"));
|
||||
assertEquals(product.getPrice(), Money.of(USD, rs.getBigDecimal("price")));
|
||||
assertEquals(product.getExpirationDate(), rs.getDate("expiration_date").toLocalDate());
|
||||
}
|
||||
|
||||
assertThrows(SQLException.class, () -> productDao.save(product));
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldUpdateProduct() throws SQLException {
|
||||
TestUtils.executeSQL(INSERT_PRODUCT_SQL, dataSource);
|
||||
|
||||
product.setPrice(Money.of(USD, 99.0));
|
||||
|
||||
productDao.update(product);
|
||||
|
||||
try (var connection = dataSource.getConnection();
|
||||
var statement = connection.createStatement();
|
||||
ResultSet rs = statement.executeQuery(SELECT_PRODUCTS_SQL)) {
|
||||
|
||||
assertTrue(rs.next());
|
||||
assertEquals(product.getName(), rs.getString("name"));
|
||||
assertEquals(product.getPrice(), Money.of(USD, rs.getBigDecimal("price")));
|
||||
assertEquals(product.getExpirationDate(), rs.getDate("expiration_date").toLocalDate());
|
||||
}
|
||||
}
|
||||
}
|
@ -1,78 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import org.joda.money.Money;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.time.LocalDate;
|
||||
import java.util.Optional;
|
||||
|
||||
import static org.joda.money.CurrencyUnit.USD;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.mockito.Mockito.*;
|
||||
|
||||
class ProductTest {
|
||||
|
||||
private ProductDao productDao;
|
||||
private Product product;
|
||||
|
||||
@BeforeEach
|
||||
void setUp() {
|
||||
productDao = mock(ProductDaoImpl.class);
|
||||
|
||||
product = Product.builder()
|
||||
.name("product")
|
||||
.price(Money.of(USD, 100.0))
|
||||
.expirationDate(LocalDate.now().plusDays(10))
|
||||
.productDao(productDao)
|
||||
.build();
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldSaveProduct() throws SQLException {
|
||||
when(productDao.findByName("product")).thenReturn(Optional.empty());
|
||||
|
||||
product.save();
|
||||
|
||||
verify(productDao, times(1)).save(product);
|
||||
|
||||
when(productDao.findByName("product")).thenReturn(Optional.of(product));
|
||||
|
||||
product.save();
|
||||
|
||||
verify(productDao, times(1)).update(product);
|
||||
}
|
||||
|
||||
@Test
|
||||
void shouldGetSalePriceOfProduct() {
|
||||
assertEquals(Money.of(USD, 100), product.getSalePrice());
|
||||
|
||||
product.setExpirationDate(LocalDate.now().plusDays(2));
|
||||
|
||||
assertEquals(Money.of(USD, 80), product.getSalePrice());
|
||||
}
|
||||
}
|
@ -1,53 +0,0 @@
|
||||
/*
|
||||
* The MIT License
|
||||
* Copyright © 2014-2021 Ilkka Seppälä
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package com.iluwatar.domainmodel;
|
||||
|
||||
import org.h2.jdbcx.JdbcDataSource;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
import java.sql.SQLException;
|
||||
|
||||
public class TestUtils {
|
||||
|
||||
public static void executeSQL( String sql, DataSource dataSource) throws SQLException {
|
||||
try (var connection = dataSource.getConnection();
|
||||
var statement = connection.createStatement()) {
|
||||
statement.executeUpdate(sql);
|
||||
}
|
||||
}
|
||||
|
||||
public static void createSchema(DataSource dataSource) throws SQLException {
|
||||
TestUtils.executeSQL(App.CREATE_SCHEMA_SQL, dataSource);
|
||||
}
|
||||
|
||||
public static void deleteSchema(DataSource dataSource) throws SQLException {
|
||||
TestUtils.executeSQL(App.DELETE_SCHEMA_SQL, dataSource);
|
||||
}
|
||||
|
||||
public static DataSource createDataSource() {
|
||||
var dataSource = new JdbcDataSource();
|
||||
dataSource.setURL(App.H2_DB_URL);
|
||||
return dataSource;
|
||||
}
|
||||
}
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Double Buffer
|
||||
category: Behavioral
|
||||
folder: double-buffer
|
||||
permalink: /patterns/double-buffer/
|
||||
categories: Behavioral
|
||||
language: en
|
||||
tags:
|
||||
- Performance
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Double Checked Locking
|
||||
category: Idiom
|
||||
folder: double-checked-locking
|
||||
permalink: /patterns/double-checked-locking/
|
||||
categories: Idiom
|
||||
language: en
|
||||
tags:
|
||||
- Performance
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Double Dispatch
|
||||
category: Idiom
|
||||
folder: double-dispatch
|
||||
permalink: /patterns/double-dispatch/
|
||||
categories: Idiom
|
||||
language: en
|
||||
tags:
|
||||
- Extensibility
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: EIP Aggregator
|
||||
category: Integration
|
||||
folder: eip-aggregator
|
||||
permalink: /patterns/eip-aggregator/
|
||||
categories: Integration
|
||||
language: en
|
||||
tags:
|
||||
- Enterprise Integration Pattern
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: EIP Message Channel
|
||||
category: Integration
|
||||
folder: eip-message-channel
|
||||
permalink: /patterns/eip-message-channel/
|
||||
categories: Integration
|
||||
language: en
|
||||
tags:
|
||||
- Enterprise Integration Pattern
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: EIP Publish Subscribe
|
||||
category: Integration
|
||||
folder: eip-publish-subscribe
|
||||
permalink: /patterns/eip-publish-subscribe/
|
||||
categories: Integration
|
||||
language: en
|
||||
tags:
|
||||
- Enterprise Integration Pattern
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: EIP Splitter
|
||||
category: Integration
|
||||
folder: eip-splitter
|
||||
permalink: /patterns/eip-splitter/
|
||||
categories: Integration
|
||||
language: en
|
||||
tags:
|
||||
- Enterprise Integration Pattern
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: EIP Wire Tap
|
||||
category: Integration
|
||||
folder: eip-wire-tap
|
||||
permalink: /patterns/eip-wire-tap/
|
||||
categories: Integration
|
||||
language: en
|
||||
tags:
|
||||
- Enterprise Integration Pattern
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Event Aggregator
|
||||
category: Structural
|
||||
folder: event-aggregator
|
||||
permalink: /patterns/event-aggregator/
|
||||
categories: Structural
|
||||
language: en
|
||||
tags:
|
||||
- Reactive
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Event-based Asynchronous
|
||||
category: Concurrency
|
||||
folder: event-asynchronous
|
||||
permalink: /patterns/event-asynchronous/
|
||||
categories: Concurrency
|
||||
language: en
|
||||
tags:
|
||||
- Reactive
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Event Driven Architecture
|
||||
category: Architectural
|
||||
folder: event-driven-architecture
|
||||
permalink: /patterns/event-driven-architecture/
|
||||
categories: Architectural
|
||||
language: en
|
||||
tags:
|
||||
- Reactive
|
||||
@ -21,6 +24,7 @@ Use an Event-driven architecture when
|
||||
|
||||
## Real world examples
|
||||
|
||||
* SendGrid, an email API, sends events whenever an email is processed, delivered, opened etc... (https://sendgrid.com/docs/API_Reference/Webhooks/event.html)
|
||||
* Chargify, a billing API, exposes payment activity through various events (https://docs.chargify.com/api-events)
|
||||
* Amazon's AWS Lambda, lets you execute code in response to events such as changes to Amazon S3 buckets, updates to an Amazon DynamoDB table, or custom events generated by your applications or devices. (https://aws.amazon.com/lambda)
|
||||
* MySQL runs triggers based on events such as inserts and update events happening on database tables.
|
||||
@ -28,6 +32,6 @@ Use an Event-driven architecture when
|
||||
## Credits
|
||||
|
||||
* [Event-driven architecture - Wikipedia](https://en.wikipedia.org/wiki/Event-driven_architecture)
|
||||
* [What is an Event-Driven Architecture](https://aws.amazon.com/event-driven-architecture/)
|
||||
* [Fundamental Components of an Event-Driven Architecture](http://giocc.com/fundamental-components-of-an-event-driven-architecture.html)
|
||||
* [Real World Applications/Event Driven Applications](https://wiki.haskell.org/Real_World_Applications/Event_Driven_Applications)
|
||||
* [Event-driven architecture definition](http://searchsoa.techtarget.com/definition/event-driven-architecture)
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Event Queue
|
||||
category: Concurrency
|
||||
folder: event-queue
|
||||
permalink: /patterns/event-queue/
|
||||
categories: Concurrency
|
||||
language: en
|
||||
tags:
|
||||
- Game programming
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Event Sourcing
|
||||
category: Architectural
|
||||
folder: event-sourcing
|
||||
permalink: /patterns/event-sourcing/
|
||||
categories: Architectural
|
||||
language: en
|
||||
tags:
|
||||
- Performance
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Execute Around
|
||||
category: Idiom
|
||||
folder: execute-around
|
||||
permalink: /patterns/execute-around/
|
||||
categories: Idiom
|
||||
language: en
|
||||
tags:
|
||||
- Extensibility
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Extension objects
|
||||
category: Behavioral
|
||||
folder: extension-objects
|
||||
permalink: /patterns/extension-objects/
|
||||
categories: Behavioral
|
||||
language: en
|
||||
tags:
|
||||
- Extensibility
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Facade
|
||||
category: Structural
|
||||
folder: facade
|
||||
permalink: /patterns/facade/
|
||||
categories: Structural
|
||||
language: en
|
||||
tags:
|
||||
- Gang Of Four
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Factory Kit
|
||||
category: Creational
|
||||
folder: factory-kit
|
||||
permalink: /patterns/factory-kit/
|
||||
categories: Creational
|
||||
language: en
|
||||
tags:
|
||||
- Extensibility
|
||||
|
@ -1,6 +1,9 @@
|
||||
---
|
||||
layout: pattern
|
||||
title: Factory Method
|
||||
category: Creational
|
||||
folder: factory-method
|
||||
permalink: /patterns/factory-method/
|
||||
categories: Creational
|
||||
language: en
|
||||
tags:
|
||||
- Extensibility
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user