mindol1004/getting-started
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

example for clean architecture boundaries with Spring Boot

Browse Source
This commit is contained in:
thombergs
2020-03-07 08:26:15 +11:00
committed by akuksin
parent 1f2b333a8a
commit f85a0f36ae
24 changed files with 670 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
spring-boot/boundaries/.gitignore vendored Normal file
View File

@@ -0,0 +1,32 @@
HELP.md
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**
!**/src/test/**
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
out/
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
### VS Code ###
.vscode/

30
spring-boot/boundaries/build.gradle Normal file
View File

@@ -0,0 +1,30 @@
plugins {
id 'org.springframework.boot' version '2.2.5.RELEASE'
id 'io.spring.dependency-management' version '1.0.9.RELEASE'
id 'java'
}
group = 'io.reflectoring'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
compileOnly 'org.projectlombok:lombok'
runtimeOnly 'com.h2database:h2'
annotationProcessor 'org.projectlombok:lombok'
testImplementation('org.springframework.boot:spring-boot-starter-test') {
exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
}
// ArchUnit
testImplementation 'com.tngtech.archunit:archunit-junit5:0.13.1'
testImplementation 'org.reflections:reflections:0.9.10'
}
test {
useJUnitPlatform()
}

172
spring-boot/boundaries/gradlew vendored Normal file
View File

@@ -0,0 +1,172 @@
#!/usr/bin/env sh
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS=""
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn () {
echo "$*"
}
die () {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi
exec "$JAVACMD" "$@"

84
spring-boot/boundaries/gradlew.bat vendored Normal file
View File

@@ -0,0 +1,84 @@
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS=
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

1
spring-boot/boundaries/settings.gradle Normal file
View File

@@ -0,0 +1 @@
rootProject.name = 'boundaries'

13
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/BoundariesApplication.java Normal file
View File

@@ -0,0 +1,13 @@
package io.reflectoring.boundaries;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class BoundariesApplication {
public static void main(String[] args) {
SpringApplication.run(BoundariesApplication.class, args);
}
}

18
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/InternalPackage.java Normal file
View File

@@ -0,0 +1,18 @@
package io.reflectoring.boundaries;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotate a package-info.java file with this annotation to mark it as internal, i.e. no
* classes outside of that package may depend on any classes within that package.
*/
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface InternalPackage {
}

11
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/api/Invoice.java Normal file
View File

@@ -0,0 +1,11 @@
package io.reflectoring.boundaries.billingmodule.api;
import lombok.Value;
@Value
public class Invoice {
private Long userId;
private double amount;
}

9
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/api/InvoiceCalculator.java Normal file
View File

@@ -0,0 +1,9 @@
package io.reflectoring.boundaries.billingmodule.api;
import java.time.LocalDate;
public interface InvoiceCalculator {
Invoice calculateInvoice(Long userId, LocalDate fromDate, LocalDate toDate);
}

27
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/BillingService.java Normal file
View File

@@ -0,0 +1,27 @@
package io.reflectoring.boundaries.billingmodule.internal;
import io.reflectoring.boundaries.billingmodule.api.Invoice;
import io.reflectoring.boundaries.billingmodule.api.InvoiceCalculator;
import io.reflectoring.boundaries.billingmodule.internal.database.api.LineItem;
import io.reflectoring.boundaries.billingmodule.internal.database.api.ReadLineItems;
import java.time.LocalDate;
import java.util.List;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;
@Component
@RequiredArgsConstructor
class BillingService implements InvoiceCalculator {
private final ReadLineItems readLineItems;
@Override
public Invoice calculateInvoice(Long userId, LocalDate fromDate, LocalDate toDate) {
List<LineItem> items = readLineItems.getLineItemsForUser(userId, fromDate, toDate);
double sum = items.stream()
.mapToDouble(LineItem::getAmount)
.sum();
return new Invoice(userId, sum);
}
}

12
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/batchjob/internal/BatchJobConfiguration.java Normal file
View File

@@ -0,0 +1,12 @@
package io.reflectoring.boundaries.billingmodule.internal.batchjob.internal;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;
@Configuration
@EnableScheduling
@ComponentScan
class BatchJobConfiguration {
}

42
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/batchjob/internal/LoadInvoiceDataBatchJob.java Normal file
View File

@@ -0,0 +1,42 @@
package io.reflectoring.boundaries.billingmodule.internal.batchjob.internal;
import io.reflectoring.boundaries.billingmodule.internal.database.api.WriteLineItems;
import io.reflectoring.boundaries.billingmodule.internal.database.api.LineItem;
import java.time.LocalDate;
import java.util.Arrays;
import java.util.List;
import java.util.Random;
import lombok.RequiredArgsConstructor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
@RequiredArgsConstructor
@Component
class LoadInvoiceDataBatchJob {
private static final Logger logger = LoggerFactory.getLogger(LoadInvoiceDataBatchJob.class);
private static final Random random = new Random();
private final WriteLineItems writeLineItems;
@Scheduled(fixedRate = 5000)
void loadDataFromBillingSystem() {
List<LineItem> items = getLineItemsFromBillingSystem();
writeLineItems.saveLineItems(items);
}
private List<LineItem> getLineItemsFromBillingSystem() {
// imagine this list is loaded from a 3rd party system
return Arrays.asList(
lineItem("bread"),
lineItem("butter"),
lineItem("toilet paper")
);
}
private LineItem lineItem(String itemName) {
return new LineItem(42L, itemName, 42.42d, LocalDate.now().minusDays(random.nextInt(10)));
}
}

4
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/batchjob/internal/package-info.java Normal file
View File

@@ -0,0 +1,4 @@
@InternalPackage
package io.reflectoring.boundaries.billingmodule.internal.batchjob.internal;
import io.reflectoring.boundaries.InternalPackage;

14
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/database/api/LineItem.java Normal file
View File

@@ -0,0 +1,14 @@
package io.reflectoring.boundaries.billingmodule.internal.database.api;
import java.time.LocalDate;
import lombok.Value;
@Value
public class LineItem {
private final Long userId;
private final String name;
private final double amount;
private final LocalDate date;
}

10
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/database/api/ReadLineItems.java Normal file
View File

@@ -0,0 +1,10 @@
package io.reflectoring.boundaries.billingmodule.internal.database.api;
import java.time.LocalDate;
import java.util.List;
public interface ReadLineItems {
List<LineItem> getLineItemsForUser(Long userId, LocalDate startDate, LocalDate endDate);
}

9
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/database/api/WriteLineItems.java Normal file
View File

@@ -0,0 +1,9 @@
package io.reflectoring.boundaries.billingmodule.internal.database.api;
import java.util.List;
public interface WriteLineItems {
void saveLineItems(List<LineItem> lineItems);
}

31
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/database/internal/BillingDatabase.java Normal file
View File

@@ -0,0 +1,31 @@
package io.reflectoring.boundaries.billingmodule.internal.database.internal;
import io.reflectoring.boundaries.billingmodule.internal.database.api.LineItem;
import io.reflectoring.boundaries.billingmodule.internal.database.api.ReadLineItems;
import io.reflectoring.boundaries.billingmodule.internal.database.api.WriteLineItems;
import java.time.LocalDate;
import java.util.List;
import java.util.stream.Collectors;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;
@Component
@RequiredArgsConstructor
class BillingDatabase implements WriteLineItems, ReadLineItems {
private final LineItemRepository lineItemRepository;
@Override
public void saveLineItems(List<LineItem> lineItems) {
for (LineItem lineItem : lineItems) {
lineItemRepository.save(LineItemJpaEntity.fromDomainObject(lineItem));
}
}
@Override
public List<LineItem> getLineItemsForUser(Long userId, LocalDate startDate, LocalDate endDate) {
return lineItemRepository.findByUserIdAndDateBetween(userId, startDate, endDate).stream()
.map(LineItemJpaEntity::toDomainObject)
.collect(Collectors.toList());
}
}

12
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/database/internal/BillingDatabaseConfiguration.java Normal file
View File

@@ -0,0 +1,12 @@
package io.reflectoring.boundaries.billingmodule.internal.database.internal;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
@Configuration
@EnableJpaRepositories
@ComponentScan
class BillingDatabaseConfiguration {
}

43
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/database/internal/LineItemJpaEntity.java Normal file
View File

@@ -0,0 +1,43 @@
package io.reflectoring.boundaries.billingmodule.internal.database.internal;
import io.reflectoring.boundaries.billingmodule.internal.database.api.LineItem;
import java.time.LocalDate;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Entity
@Data
@AllArgsConstructor
@NoArgsConstructor
class LineItemJpaEntity {
@Id
@GeneratedValue
private Long userId;
private String name;
private Double amount;
private LocalDate date;
static LineItemJpaEntity fromDomainObject(LineItem lineItem) {
return new LineItemJpaEntity(
lineItem.getUserId(),
lineItem.getName(),
lineItem.getAmount(),
lineItem.getDate()
);
}
LineItem toDomainObject(){
return new LineItem(
this.userId,
this.name,
this.amount,
this.date
);
}
}

11
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/database/internal/LineItemRepository.java Normal file
View File

@@ -0,0 +1,11 @@
package io.reflectoring.boundaries.billingmodule.internal.database.internal;
import java.time.LocalDate;
import java.util.List;
import org.springframework.data.repository.CrudRepository;
interface LineItemRepository extends CrudRepository<LineItemJpaEntity, Long> {
List<LineItemJpaEntity> findByUserIdAndDateBetween(Long userId, LocalDate startDate, LocalDate endDate);
}

4
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/database/internal/package-info.java Normal file
View File

@@ -0,0 +1,4 @@
@InternalPackage
package io.reflectoring.boundaries.billingmodule.internal.database.internal;
import io.reflectoring.boundaries.InternalPackage;

4
spring-boot/boundaries/src/main/java/io/reflectoring/boundaries/billingmodule/internal/package-info.java Normal file
View File

@@ -0,0 +1,4 @@
@InternalPackage
package io.reflectoring.boundaries.billingmodule.internal;
import io.reflectoring.boundaries.InternalPackage;

13
spring-boot/boundaries/src/test/java/io/reflectoring/boundaries/BoundariesApplicationTests.java Normal file
View File

@@ -0,0 +1,13 @@
package io.reflectoring.boundaries;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class BoundariesApplicationTests {
@Test
void contextLoads() {
}
}

64
spring-boot/boundaries/src/test/java/io/reflectoring/boundaries/InternalPackageTests.java Normal file
View File

@@ -0,0 +1,64 @@
package io.reflectoring.boundaries;
import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.noClasses;
import static org.assertj.core.api.Assertions.assertThat;
import com.tngtech.archunit.core.domain.JavaClasses;
import com.tngtech.archunit.core.importer.ClassFileImporter;
import java.io.IOException;
import java.util.List;
import java.util.stream.Collectors;
import org.junit.jupiter.api.Test;
import org.reflections.Reflections;
/**
* Evaluates {@link InternalPackage} annotations and checks that those packages are not accessed from the outside.
*/
class InternalPackageTests {
private static final String BASE_PACKAGE = "io.reflectoring";
private final JavaClasses analyzedClasses = new ClassFileImporter().importPackages(BASE_PACKAGE);
@Test
void internalPackagesAreNotAccessedFromOutside() throws IOException {
// so that the test will break when the base package is re-named
assertPackageExists(BASE_PACKAGE);
List<String> internalPackages = internalPackages(BASE_PACKAGE);
for (String internalPackage : internalPackages) {
assertPackageExists(internalPackage);
assertPackageIsNotAccessedFromOutside(internalPackage);
}
}
/**
* Finds all packages annotated with @{@link InternalPackage}.
*/
private List<String> internalPackages(String basePackage) {
Reflections reflections = new Reflections(basePackage);
return reflections.getTypesAnnotatedWith(InternalPackage.class).stream()
.map(c -> c.getPackage().getName())
.collect(Collectors.toList());
}
void assertPackageIsNotAccessedFromOutside(String internalPackage) {
noClasses().that().resideOutsideOfPackage(packageMatcher(internalPackage))
.should().dependOnClassesThat().resideInAPackage(packageMatcher(internalPackage))
.check(analyzedClasses);
}
void assertPackageExists(String packageName) {
assertThat(analyzedClasses.containPackage(packageName))
.as("package %s exists", packageName)
.isTrue();
}
private String packageMatcher(String fullyQualifiedPackage) {
return fullyQualifiedPackage + "..";
}
}