├── .gitignore ├── .mvn └── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── Dockerfile ├── Makefile ├── README.md ├── mvnw ├── mvnw.cmd ├── pom.xml ├── screenshots ├── diagram.png ├── get_user_fail.png ├── get_user_ok.png ├── spring_boot.png └── swagger_ui.png └── src ├── main ├── java │ └── com │ │ └── yilmazgokhan │ │ └── architecture │ │ ├── ArchitectureApplication.java │ │ ├── client │ │ ├── ClientProcess.java │ │ └── ClientService.java │ │ ├── config │ │ └── SwaggerConfig.java │ │ ├── controller │ │ └── UserController.java │ │ ├── entity │ │ └── User.java │ │ ├── exception │ │ ├── CustomExceptionHandler.java │ │ ├── common │ │ │ └── InvalidParamException.java │ │ ├── core │ │ │ ├── ArchitectureException.java │ │ │ ├── ErrorResponse.java │ │ │ └── Response.java │ │ └── user │ │ │ ├── UserAlreadyExistException.java │ │ │ └── UserNotFoundException.java │ │ ├── facade │ │ └── UserFacade.java │ │ ├── model │ │ ├── common │ │ │ └── ResponseHandler.java │ │ └── user │ │ │ └── UserModel.java │ │ ├── repository │ │ └── UserRepository.java │ │ ├── service │ │ └── UserService.java │ │ └── util │ │ └── Constants.java └── resources │ └── application.properties └── test └── java └── com └── yilmazgokhan └── architecture └── ArchitectureApplicationTests.java /.gitignore: -------------------------------------------------------------------------------- 1 | HELP.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/**/target/ 5 | !**/src/test/**/target/ 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | 22 | ### NetBeans ### 23 | /nbproject/private/ 24 | /nbbuild/ 25 | /dist/ 26 | /nbdist/ 27 | /.nb-gradle/ 28 | build/ 29 | !**/src/main/**/build/ 30 | !**/src/test/**/build/ 31 | 32 | ### VS Code ### 33 | .vscode/ 34 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yilmazgokhan/Spring-Boot-Base-Architecture/bc20b1f2f683d7b542d1aae5a895461945dca430/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip 2 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar 3 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM adoptopenjdk/openjdk11:latest 2 | 3 | COPY ./target/architecture-0.0.1-SNAPSHOT.jar /usr/app/ 4 | 5 | WORKDIR /usr/app 6 | 7 | RUN sh -c 'touch architecture-0.0.1-SNAPSHOT.jar' 8 | 9 | ARG JAR_FILE=target/spring-boot-base-0.0.1-SNAPSHOT.jar 10 | 11 | ENTRYPOINT ["java","-jar","architecture-0.0.1-SNAPSHOT.jar"] -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | IMAGE_NAME:=spring-boot-base 2 | IMAGE_TAG:=latest 3 | 4 | # This command will run the project in docker environment. The project will execute on port 8080 on your computer. 5 | default: 6 | mvn clean install -DskipTests 7 | docker build -t $(IMAGE_NAME):$(IMAGE_TAG) . 8 | docker run -p 8080:8080 $(IMAGE_NAME):$(IMAGE_TAG) 9 | 10 | clean: 11 | mvn clean 12 | 13 | image: 14 | docker build -t $(IMAGE_NAME):$(IMAGE_TAG) . 15 | 16 | run: 17 | docker run -p 8080:8080 $(IMAGE_NAME):$(IMAGE_TAG) 18 | 19 | run-background: 20 | docker run -d -p 8080:8080 $(IMAGE_NAME):$(IMAGE_TAG) 21 | 22 | run-bash: 23 | docker run -i -t $(IMAGE_NAME):$(IMAGE_TAG) /bin/bash 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Spring Boot Architecture 2 | 3 | ![SpringBoot](https://img.shields.io/badge/SpringBoot-blue) 4 | ![JAVA](https://img.shields.io/badge/JAVA-1.8-blue) 5 | ![MySQL](https://img.shields.io/badge/MySQL-yellow) 6 | ![Facade](https://img.shields.io/badge/FACADE-yellow) 7 | ![JPA](https://img.shields.io/badge/JPA-yellow) 8 | ![Project Lombok](https://img.shields.io/badge/ProjectLombok-yellow) 9 | ![Swagger](https://img.shields.io/badge/Swagger-yellow) 10 | ![Retrofit](https://img.shields.io/badge/Retrofit-yellow) 11 | ![ModelMapper](https://img.shields.io/badge/ModelMapper-yellow) 12 | 13 | spring_boot 14 | 15 | > I recommend this structure for basic projects that are not extensive. 16 | 17 | ## Introduction 18 | 19 | This repo is Spring Boot project in which different technologies such as Swagger, Model Mapper are integrated. 20 | Additionally, there are 2 different APIs available for testing. 21 | 22 | ## Technologies 23 | 24 | - **Spring Boot** makes it easy to create stand-alone, production-grade Spring based Applications that you can " 25 | just run". 26 | - **MySQL** is an open-source relational database management system. Its name is a combination of "My", the name of 27 | co-founder Michael Widenius's daughter My, and "SQL", the abbreviation for Structured Query Language. 28 | - **Facade** is a structural design pattern that provides a simplified interface to a library, a framework, or any other 29 | complex set of classes. 30 | - **Java Persistence API (JPA)**, part of the larger Spring Data family, makes it easy to easily implement JPA based 31 | repositories. This module deals with enhanced support for JPA based data access layers. It makes it easier to build 32 | Spring-powered applications that use data access technologies. 33 | - **Project Lombok** is a java library that automatically plugs into your editor and build tools, spicing up your java. 34 | Never write another getter or equals method again, with one annotation your class has a fully featured builder, 35 | Automate your logging variables, and much more. 36 | - Simplify API development for users, teams, and enterprises with the **Swagger** open source and professional toolset. 37 | Find out how Swagger can help you design and document your APIs at scale. 38 | - **Retrofit**: A type-safe HTTP client for Android and Java. 39 | - The goal of **ModelMapper** is to make object mapping easy, by automatically determining how one object model maps to 40 | another, based on conventions, in the same way that a human would - while providing a simple, refactoring-safe API for 41 | handling specific use cases. 42 | 43 | 44 | 45 | ## Preparation of project 46 | 47 | ### SQL Create Query 48 | 49 | First, it needs to create a database named `architecture` in the phpMyAdmin console. 50 | 51 | > You can use [XAMPP](https://www.apachefriends.org/) for work on local server. 52 | > If you do not make any changes in the configuration, you can access phpMyAdmin from the link below. 53 | > 54 | > http://localhost/phpmyadmin/ 55 | 56 | The required table can be created using the following SQL query. 57 | 58 | ``` 59 | CREATE TABLE users ( 60 | userId VARCHAR(30) PRIMARY KEY, 61 | name VARCHAR(40), 62 | username VARCHAR(40)); 63 | ``` 64 | 65 | ### Swagger 66 | 67 | 68 | 69 | > After running Apache and phpMyAdmin correctly in your local, the Swagger UI link will be as follows. 70 | > 71 | > http://localhost:8082/swagger-ui.html 72 | 73 | ## Tests 74 | 75 | API tests with **200 OK** and **404 Not Found** (**_Custom Exception_**) codes are listed below. 76 | 77 | 78 | 79 | 80 | 81 | ## Test For Local 82 | 83 | - Clone or download the application to your computer. 84 | 85 | - Go to the folder where the application is located via terminal. 86 | 87 | - Before testing, please make sure Docker is installed on your local computer. 88 | 89 | - Then run the application with the `make` command. Make sure you have the `make` installed on your computer. If `make` is not installed on your computer, you can find detailed information [here](https://www.gnu.org/software/make/). 90 | 91 | - Now you can test the application on your own computer. 92 | 93 | ### If you want to run the make commands in order, you can run them in the following order. 94 | 95 | ```sh 96 | make clean 97 | ``` 98 | 99 | ```sh 100 | make image 101 | ``` 102 | 103 | ```sh 104 | make run 105 | ``` 106 | 107 | ## References 108 | 109 | - [Spring Boot](https://spring.io/projects/spring-boot) 110 | - [MySQL](https://www.mysql.com/) 111 | - [Facade](https://refactoring.guru/design-patterns/facade) 112 | - [JPA](https://spring.io/projects/spring-data-jpa) 113 | - [Project Lombok](https://projectlombok.org/) 114 | - [Swagger](https://swagger.io/) 115 | - [Retrofit](https://square.github.io/retrofit/) 116 | - [Model Mapper](http://modelmapper.org/getting-started/) 117 | 118 | ### Contributing to Project 119 | 120 | All contributions are welcome! Please fork this repository and contribute back using pull requests. 121 | 122 | > Don't forget to star ⭐ the repo it motivates me to share more open source 123 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /usr/local/etc/mavenrc ] ; then 40 | . /usr/local/etc/mavenrc 41 | fi 42 | 43 | if [ -f /etc/mavenrc ] ; then 44 | . /etc/mavenrc 45 | fi 46 | 47 | if [ -f "$HOME/.mavenrc" ] ; then 48 | . "$HOME/.mavenrc" 49 | fi 50 | 51 | fi 52 | 53 | # OS specific support. $var _must_ be set to either true or false. 54 | cygwin=false; 55 | darwin=false; 56 | mingw=false 57 | case "`uname`" in 58 | CYGWIN*) cygwin=true ;; 59 | MINGW*) mingw=true;; 60 | Darwin*) darwin=true 61 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 62 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 63 | if [ -z "$JAVA_HOME" ]; then 64 | if [ -x "/usr/libexec/java_home" ]; then 65 | export JAVA_HOME="`/usr/libexec/java_home`" 66 | else 67 | export JAVA_HOME="/Library/Java/Home" 68 | fi 69 | fi 70 | ;; 71 | esac 72 | 73 | if [ -z "$JAVA_HOME" ] ; then 74 | if [ -r /etc/gentoo-release ] ; then 75 | JAVA_HOME=`java-config --jre-home` 76 | fi 77 | fi 78 | 79 | if [ -z "$M2_HOME" ] ; then 80 | ## resolve links - $0 may be a link to maven's home 81 | PRG="$0" 82 | 83 | # need this for relative symlinks 84 | while [ -h "$PRG" ] ; do 85 | ls=`ls -ld "$PRG"` 86 | link=`expr "$ls" : '.*-> \(.*\)$'` 87 | if expr "$link" : '/.*' > /dev/null; then 88 | PRG="$link" 89 | else 90 | PRG="`dirname "$PRG"`/$link" 91 | fi 92 | done 93 | 94 | saveddir=`pwd` 95 | 96 | M2_HOME=`dirname "$PRG"`/.. 97 | 98 | # make it fully qualified 99 | M2_HOME=`cd "$M2_HOME" && pwd` 100 | 101 | cd "$saveddir" 102 | # echo Using m2 at $M2_HOME 103 | fi 104 | 105 | # For Cygwin, ensure paths are in UNIX format before anything is touched 106 | if $cygwin ; then 107 | [ -n "$M2_HOME" ] && 108 | M2_HOME=`cygpath --unix "$M2_HOME"` 109 | [ -n "$JAVA_HOME" ] && 110 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 111 | [ -n "$CLASSPATH" ] && 112 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 113 | fi 114 | 115 | # For Mingw, ensure paths are in UNIX format before anything is touched 116 | if $mingw ; then 117 | [ -n "$M2_HOME" ] && 118 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 119 | [ -n "$JAVA_HOME" ] && 120 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 121 | fi 122 | 123 | if [ -z "$JAVA_HOME" ]; then 124 | javaExecutable="`which javac`" 125 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 126 | # readlink(1) is not available as standard on Solaris 10. 127 | readLink=`which readlink` 128 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 129 | if $darwin ; then 130 | javaHome="`dirname \"$javaExecutable\"`" 131 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 132 | else 133 | javaExecutable="`readlink -f \"$javaExecutable\"`" 134 | fi 135 | javaHome="`dirname \"$javaExecutable\"`" 136 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 137 | JAVA_HOME="$javaHome" 138 | export JAVA_HOME 139 | fi 140 | fi 141 | fi 142 | 143 | if [ -z "$JAVACMD" ] ; then 144 | if [ -n "$JAVA_HOME" ] ; then 145 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 146 | # IBM's JDK on AIX uses strange locations for the executables 147 | JAVACMD="$JAVA_HOME/jre/sh/java" 148 | else 149 | JAVACMD="$JAVA_HOME/bin/java" 150 | fi 151 | else 152 | JAVACMD="`\\unset -f command; \\command -v java`" 153 | fi 154 | fi 155 | 156 | if [ ! -x "$JAVACMD" ] ; then 157 | echo "Error: JAVA_HOME is not defined correctly." >&2 158 | echo " We cannot execute $JAVACMD" >&2 159 | exit 1 160 | fi 161 | 162 | if [ -z "$JAVA_HOME" ] ; then 163 | echo "Warning: JAVA_HOME environment variable is not set." 164 | fi 165 | 166 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 167 | 168 | # traverses directory structure from process work directory to filesystem root 169 | # first directory with .mvn subdirectory is considered project base directory 170 | find_maven_basedir() { 171 | 172 | if [ -z "$1" ] 173 | then 174 | echo "Path not specified to find_maven_basedir" 175 | return 1 176 | fi 177 | 178 | basedir="$1" 179 | wdir="$1" 180 | while [ "$wdir" != '/' ] ; do 181 | if [ -d "$wdir"/.mvn ] ; then 182 | basedir=$wdir 183 | break 184 | fi 185 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 186 | if [ -d "${wdir}" ]; then 187 | wdir=`cd "$wdir/.."; pwd` 188 | fi 189 | # end of workaround 190 | done 191 | echo "${basedir}" 192 | } 193 | 194 | # concatenates all lines of a file 195 | concat_lines() { 196 | if [ -f "$1" ]; then 197 | echo "$(tr -s '\n' ' ' < "$1")" 198 | fi 199 | } 200 | 201 | BASE_DIR=`find_maven_basedir "$(pwd)"` 202 | if [ -z "$BASE_DIR" ]; then 203 | exit 1; 204 | fi 205 | 206 | ########################################################################################## 207 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 208 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 209 | ########################################################################################## 210 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 211 | if [ "$MVNW_VERBOSE" = true ]; then 212 | echo "Found .mvn/wrapper/maven-wrapper.jar" 213 | fi 214 | else 215 | if [ "$MVNW_VERBOSE" = true ]; then 216 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 217 | fi 218 | if [ -n "$MVNW_REPOURL" ]; then 219 | jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 220 | else 221 | jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 222 | fi 223 | while IFS="=" read key value; do 224 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 225 | esac 226 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 227 | if [ "$MVNW_VERBOSE" = true ]; then 228 | echo "Downloading from: $jarUrl" 229 | fi 230 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 231 | if $cygwin; then 232 | wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` 233 | fi 234 | 235 | if command -v wget > /dev/null; then 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Found wget ... using wget" 238 | fi 239 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 240 | wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 241 | else 242 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 243 | fi 244 | elif command -v curl > /dev/null; then 245 | if [ "$MVNW_VERBOSE" = true ]; then 246 | echo "Found curl ... using curl" 247 | fi 248 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 249 | curl -o "$wrapperJarPath" "$jarUrl" -f 250 | else 251 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f 252 | fi 253 | 254 | else 255 | if [ "$MVNW_VERBOSE" = true ]; then 256 | echo "Falling back to using Java to download" 257 | fi 258 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 259 | # For Cygwin, switch paths to Windows format before running javac 260 | if $cygwin; then 261 | javaClass=`cygpath --path --windows "$javaClass"` 262 | fi 263 | if [ -e "$javaClass" ]; then 264 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 265 | if [ "$MVNW_VERBOSE" = true ]; then 266 | echo " - Compiling MavenWrapperDownloader.java ..." 267 | fi 268 | # Compiling the Java class 269 | ("$JAVA_HOME/bin/javac" "$javaClass") 270 | fi 271 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 272 | # Running the downloader 273 | if [ "$MVNW_VERBOSE" = true ]; then 274 | echo " - Running MavenWrapperDownloader.java ..." 275 | fi 276 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 277 | fi 278 | fi 279 | fi 280 | fi 281 | ########################################################################################## 282 | # End of extension 283 | ########################################################################################## 284 | 285 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 286 | if [ "$MVNW_VERBOSE" = true ]; then 287 | echo $MAVEN_PROJECTBASEDIR 288 | fi 289 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 290 | 291 | # For Cygwin, switch paths to Windows format before running java 292 | if $cygwin; then 293 | [ -n "$M2_HOME" ] && 294 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 295 | [ -n "$JAVA_HOME" ] && 296 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 297 | [ -n "$CLASSPATH" ] && 298 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 299 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 300 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 301 | fi 302 | 303 | # Provide a "standardized" way to retrieve the CLI args that will 304 | # work with both Windows and non-Windows executions. 305 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" 306 | export MAVEN_CMD_LINE_ARGS 307 | 308 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 309 | 310 | exec "$JAVACMD" \ 311 | $MAVEN_OPTS \ 312 | $MAVEN_DEBUG_OPTS \ 313 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 314 | "-Dmaven.home=${M2_HOME}" \ 315 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 316 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 317 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* 50 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 124 | 125 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 127 | ) 128 | 129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 131 | if exist %WRAPPER_JAR% ( 132 | if "%MVNW_VERBOSE%" == "true" ( 133 | echo Found %WRAPPER_JAR% 134 | ) 135 | ) else ( 136 | if not "%MVNW_REPOURL%" == "" ( 137 | SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 138 | ) 139 | if "%MVNW_VERBOSE%" == "true" ( 140 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 141 | echo Downloading from: %DOWNLOAD_URL% 142 | ) 143 | 144 | powershell -Command "&{"^ 145 | "$webclient = new-object System.Net.WebClient;"^ 146 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 147 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 148 | "}"^ 149 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ 150 | "}" 151 | if "%MVNW_VERBOSE%" == "true" ( 152 | echo Finished downloading %WRAPPER_JAR% 153 | ) 154 | ) 155 | @REM End of extension 156 | 157 | @REM Provide a "standardized" way to retrieve the CLI args that will 158 | @REM work with both Windows and non-Windows executions. 159 | set MAVEN_CMD_LINE_ARGS=%* 160 | 161 | %MAVEN_JAVA_EXE% ^ 162 | %JVM_CONFIG_MAVEN_PROPS% ^ 163 | %MAVEN_OPTS% ^ 164 | %MAVEN_DEBUG_OPTS% ^ 165 | -classpath %WRAPPER_JAR% ^ 166 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ 167 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 168 | if ERRORLEVEL 1 goto error 169 | goto end 170 | 171 | :error 172 | set ERROR_CODE=1 173 | 174 | :end 175 | @endlocal & set ERROR_CODE=%ERROR_CODE% 176 | 177 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost 178 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 179 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" 180 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" 181 | :skipRcPost 182 | 183 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 184 | if "%MAVEN_BATCH_PAUSE%"=="on" pause 185 | 186 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% 187 | 188 | cmd /C exit /B %ERROR_CODE% 189 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | org.springframework.boot 7 | spring-boot-starter-parent 8 | 2.3.5.RELEASE 9 | 10 | 11 | com.yilmazgokhan 12 | architecture 13 | 0.0.1-SNAPSHOT 14 | architecture 15 | Base Architecture project for Spring Boot 16 | 17 | 1.8 18 | 19 | 20 | 21 | 22 | org.springframework.boot 23 | spring-boot-starter-web 24 | 25 | 26 | org.springframework.boot 27 | spring-boot-starter-data-rest 28 | 29 | 30 | javax.persistence 31 | javax.persistence-api 32 | 33 | 34 | 35 | 36 | com.h2database 37 | h2 38 | runtime 39 | 40 | 41 | 42 | 43 | 44 | org.springframework.boot 45 | spring-boot-starter-data-jpa 46 | 47 | 48 | 49 | 50 | 51 | org.projectlombok 52 | lombok 53 | 1.18.24 54 | 55 | 56 | 57 | 58 | 59 | io.springfox 60 | springfox-swagger2 61 | 3.0.0 62 | 63 | 64 | io.springfox 65 | springfox-swagger-ui 66 | 2.9.2 67 | 68 | 69 | 70 | 71 | 72 | com.squareup.retrofit2 73 | retrofit 74 | 2.3.0 75 | 76 | 77 | com.squareup.retrofit2 78 | converter-gson 79 | 2.3.0 80 | 81 | 82 | 83 | 84 | 85 | org.modelmapper 86 | modelmapper 87 | 2.4.4 88 | 89 | 90 | 91 | org.springframework.boot 92 | spring-boot-starter-test 93 | test 94 | 95 | 96 | org.junit.vintage 97 | junit-vintage-engine 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | org.springframework.boot 107 | spring-boot-maven-plugin 108 | 109 | 110 | 111 | 112 | 113 | -------------------------------------------------------------------------------- /screenshots/diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yilmazgokhan/Spring-Boot-Base-Architecture/bc20b1f2f683d7b542d1aae5a895461945dca430/screenshots/diagram.png -------------------------------------------------------------------------------- /screenshots/get_user_fail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yilmazgokhan/Spring-Boot-Base-Architecture/bc20b1f2f683d7b542d1aae5a895461945dca430/screenshots/get_user_fail.png -------------------------------------------------------------------------------- /screenshots/get_user_ok.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yilmazgokhan/Spring-Boot-Base-Architecture/bc20b1f2f683d7b542d1aae5a895461945dca430/screenshots/get_user_ok.png -------------------------------------------------------------------------------- /screenshots/spring_boot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yilmazgokhan/Spring-Boot-Base-Architecture/bc20b1f2f683d7b542d1aae5a895461945dca430/screenshots/spring_boot.png -------------------------------------------------------------------------------- /screenshots/swagger_ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yilmazgokhan/Spring-Boot-Base-Architecture/bc20b1f2f683d7b542d1aae5a895461945dca430/screenshots/swagger_ui.png -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/ArchitectureApplication.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | import org.springframework.scheduling.annotation.EnableScheduling; 6 | import springfox.documentation.swagger2.annotations.EnableSwagger2; 7 | 8 | import java.util.Date; 9 | 10 | @EnableSwagger2 11 | @EnableScheduling 12 | @SpringBootApplication 13 | public class ArchitectureApplication { 14 | 15 | public static void main(String[] args) { 16 | SpringApplication.run(ArchitectureApplication.class, args); 17 | System.out.println(new Date(System.currentTimeMillis())); 18 | } 19 | 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/client/ClientProcess.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.client; 2 | 3 | import okhttp3.OkHttpClient; 4 | import org.springframework.stereotype.Service; 5 | import retrofit2.Call; 6 | import retrofit2.Callback; 7 | import retrofit2.Response; 8 | import retrofit2.Retrofit; 9 | import retrofit2.converter.gson.GsonConverterFactory; 10 | 11 | import static com.yilmazgokhan.architecture.util.Constants.Client.BASE_URL; 12 | 13 | @Service 14 | public class ClientProcess { 15 | 16 | //region 17 | private Retrofit retrofitClient; 18 | //endregion 19 | 20 | public ClientProcess() { 21 | OkHttpClient.Builder httpClient = new OkHttpClient.Builder(); 22 | retrofitClient = new Retrofit.Builder() 23 | .baseUrl(BASE_URL) 24 | .addConverterFactory(GsonConverterFactory.create()) 25 | .client(httpClient.build()) 26 | .build(); 27 | } 28 | 29 | public void sendRequest(Object obj) { 30 | ClientService service = retrofitClient.create(ClientService.class); 31 | Call call = service.sendRequest(); 32 | call.enqueue(new Callback() { 33 | @Override 34 | public void onResponse(Call call, Response response) { 35 | // TODO: Handle response here. 36 | } 37 | 38 | @Override 39 | public void onFailure(Call call, Throwable throwable) { 40 | System.out.println(throwable.getCause().toString()); 41 | } 42 | }); 43 | } 44 | } -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/client/ClientService.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.client; 2 | 3 | import retrofit2.Call; 4 | import retrofit2.http.GET; 5 | 6 | public interface ClientService { 7 | 8 | @GET("temp") 9 | Call sendRequest(); 10 | } -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/config/SwaggerConfig.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.config; 2 | 3 | import org.springframework.context.annotation.Bean; 4 | import org.springframework.context.annotation.Configuration; 5 | import org.springframework.http.ResponseEntity; 6 | import springfox.documentation.builders.ApiInfoBuilder; 7 | import springfox.documentation.builders.PathSelectors; 8 | import springfox.documentation.builders.RequestHandlerSelectors; 9 | import springfox.documentation.service.ApiInfo; 10 | import springfox.documentation.spi.DocumentationType; 11 | import springfox.documentation.spring.web.plugins.Docket; 12 | import springfox.documentation.swagger2.annotations.EnableSwagger2; 13 | 14 | import java.time.LocalDate; 15 | 16 | @Configuration 17 | @EnableSwagger2 18 | public class SwaggerConfig { 19 | 20 | ApiInfo apiInfo() { 21 | return new ApiInfoBuilder() 22 | .title("Spring Boot Base Architecture API") 23 | .version("0.0.1") 24 | .description("Spring Boot Base Architecture Project") 25 | .build(); 26 | } 27 | 28 | @Bean 29 | public Docket customImplementation() { 30 | return new Docket(DocumentationType.SWAGGER_2) 31 | .apiInfo(apiInfo()) 32 | .select().paths(PathSelectors.any()) 33 | .apis(RequestHandlerSelectors.basePackage("com.yilmazgokhan")) 34 | .build() 35 | .pathMapping("/") 36 | .useDefaultResponseMessages(false) 37 | .directModelSubstitute(LocalDate.class, String.class) 38 | .genericModelSubstitutes(ResponseEntity.class); 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/controller/UserController.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.controller; 2 | 3 | import com.yilmazgokhan.architecture.entity.User; 4 | import com.yilmazgokhan.architecture.exception.core.ArchitectureException; 5 | import com.yilmazgokhan.architecture.facade.UserFacade; 6 | import com.yilmazgokhan.architecture.model.common.ResponseHandler; 7 | import com.yilmazgokhan.architecture.model.user.UserModel; 8 | import io.swagger.annotations.Api; 9 | import io.swagger.annotations.ApiOperation; 10 | import lombok.RequiredArgsConstructor; 11 | import org.springframework.http.HttpStatus; 12 | import org.springframework.http.ResponseEntity; 13 | import org.springframework.web.bind.annotation.*; 14 | 15 | import static com.yilmazgokhan.architecture.util.Constants.UserPaths.USER_PATH; 16 | 17 | @RestController 18 | @RequiredArgsConstructor 19 | @RequestMapping(USER_PATH) 20 | @Api(value = USER_PATH, tags = "User APIs") 21 | public class UserController { 22 | 23 | //region 24 | private final UserFacade facade; 25 | //endregion 26 | 27 | /** 28 | * Save user 29 | * 30 | * @param model as UserModel 31 | * @return User 32 | * @throws ArchitectureException 33 | */ 34 | @PostMapping 35 | @ApiOperation(value = "Save User", response = User.class) 36 | public ResponseEntity saveUser(@RequestBody UserModel model) throws ArchitectureException { 37 | return ResponseHandler.response(HttpStatus.OK, facade.saveUser(model), true); 38 | } 39 | 40 | /** 41 | * Get user by id 42 | * 43 | * @param userId as String 44 | * @return User 45 | * @throws ArchitectureException 46 | */ 47 | @GetMapping 48 | @ApiOperation(value = "Get User", response = User.class) 49 | public ResponseEntity getUser(@RequestHeader String userId) throws ArchitectureException { 50 | return ResponseHandler.response(HttpStatus.OK, facade.getUser(userId), true); 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/entity/User.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.entity; 2 | 3 | import lombok.AllArgsConstructor; 4 | import lombok.Getter; 5 | import lombok.NoArgsConstructor; 6 | import lombok.Setter; 7 | 8 | import javax.persistence.Column; 9 | import javax.persistence.Entity; 10 | import javax.persistence.Id; 11 | import javax.persistence.Table; 12 | 13 | @Entity 14 | @Table(name = "users") 15 | @Getter 16 | @Setter 17 | @AllArgsConstructor 18 | @NoArgsConstructor 19 | public class User { 20 | 21 | @Id 22 | @Column(name = "userId", nullable = false, unique = true) 23 | private String userId; 24 | 25 | @Column(name = "name") 26 | private String name; 27 | 28 | @Column(name = "username") 29 | private String username; 30 | 31 | } -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/exception/CustomExceptionHandler.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.exception; 2 | 3 | import com.yilmazgokhan.architecture.exception.core.ArchitectureException; 4 | import com.yilmazgokhan.architecture.exception.core.ErrorResponse; 5 | import org.springframework.http.ResponseEntity; 6 | import org.springframework.web.bind.annotation.ExceptionHandler; 7 | import org.springframework.web.bind.annotation.RestControllerAdvice; 8 | 9 | @RestControllerAdvice 10 | public class CustomExceptionHandler { 11 | 12 | @ExceptionHandler(ArchitectureException.class) 13 | public final ResponseEntity handle(ArchitectureException exception) { 14 | ErrorResponse response = new ErrorResponse(exception); 15 | return ResponseEntity 16 | .status(exception.getStatus()) 17 | .body(response); 18 | } 19 | } -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/exception/common/InvalidParamException.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.exception.common; 2 | 3 | import com.yilmazgokhan.architecture.exception.core.ArchitectureException; 4 | import org.springframework.http.HttpStatus; 5 | 6 | import static com.yilmazgokhan.architecture.util.Constants.Exception.Common.INVALID_PARAM; 7 | import static com.yilmazgokhan.architecture.util.Constants.Exception.Common.INVALID_PARAM_CODE; 8 | 9 | 10 | public class InvalidParamException extends ArchitectureException { 11 | 12 | //region 13 | private static final long serialVersionUID = 1L; 14 | //endregion 15 | 16 | public InvalidParamException() { 17 | super(); 18 | this.code = INVALID_PARAM_CODE; 19 | this.msg = INVALID_PARAM; 20 | this.status = HttpStatus.BAD_REQUEST; 21 | } 22 | } -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/exception/core/ArchitectureException.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.exception.core; 2 | 3 | import lombok.Getter; 4 | import lombok.NoArgsConstructor; 5 | import lombok.Setter; 6 | import org.springframework.http.HttpStatus; 7 | 8 | @Getter 9 | @Setter 10 | @NoArgsConstructor 11 | public class ArchitectureException extends Exception { 12 | protected String code; 13 | protected String msg; 14 | protected String stack; 15 | protected HttpStatus status; 16 | } -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/exception/core/ErrorResponse.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.exception.core; 2 | 3 | import lombok.NoArgsConstructor; 4 | 5 | @NoArgsConstructor 6 | public class ErrorResponse extends Response { 7 | 8 | public ErrorResponse(ArchitectureException exception) { 9 | this.result = false; 10 | this.status = exception.status.value(); 11 | this.error_code = exception.getCode(); 12 | this.msg = exception.getMsg(); 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/exception/core/Response.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.exception.core; 2 | 3 | import lombok.Getter; 4 | import lombok.NoArgsConstructor; 5 | import lombok.Setter; 6 | 7 | @Getter 8 | @Setter 9 | @NoArgsConstructor 10 | public class Response { 11 | protected boolean result; 12 | protected int status; 13 | protected String error_code; 14 | protected String msg; 15 | } 16 | -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/exception/user/UserAlreadyExistException.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.exception.user; 2 | 3 | import com.yilmazgokhan.architecture.exception.core.ArchitectureException; 4 | import org.springframework.http.HttpStatus; 5 | 6 | import static com.yilmazgokhan.architecture.util.Constants.Exception.User.USER_ALREADY_EXIST; 7 | import static com.yilmazgokhan.architecture.util.Constants.Exception.User.USER_ALREADY_EXIST_CODE; 8 | 9 | public class UserAlreadyExistException extends ArchitectureException { 10 | 11 | //region 12 | private static final long serialVersionUID = 1L; 13 | //endregion 14 | 15 | public UserAlreadyExistException() { 16 | super(); 17 | this.code = USER_ALREADY_EXIST_CODE; 18 | this.msg = USER_ALREADY_EXIST; 19 | this.status = HttpStatus.BAD_REQUEST; 20 | } 21 | } -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/exception/user/UserNotFoundException.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.exception.user; 2 | 3 | import com.yilmazgokhan.architecture.exception.core.ArchitectureException; 4 | import org.springframework.http.HttpStatus; 5 | 6 | import static com.yilmazgokhan.architecture.util.Constants.Exception.User.USER_NOT_FOUND; 7 | import static com.yilmazgokhan.architecture.util.Constants.Exception.User.USER_NOT_FOUND_CODE; 8 | 9 | public class UserNotFoundException extends ArchitectureException { 10 | 11 | //region 12 | private static final long serialVersionUID = 1L; 13 | //endregion 14 | 15 | public UserNotFoundException() { 16 | super(); 17 | this.code = USER_NOT_FOUND_CODE; 18 | this.msg = USER_NOT_FOUND; 19 | this.status = HttpStatus.NOT_FOUND; 20 | } 21 | } -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/facade/UserFacade.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.facade; 2 | 3 | import com.yilmazgokhan.architecture.entity.User; 4 | import com.yilmazgokhan.architecture.exception.common.InvalidParamException; 5 | import com.yilmazgokhan.architecture.exception.core.ArchitectureException; 6 | import com.yilmazgokhan.architecture.exception.user.UserAlreadyExistException; 7 | import com.yilmazgokhan.architecture.exception.user.UserNotFoundException; 8 | import com.yilmazgokhan.architecture.model.user.UserModel; 9 | import com.yilmazgokhan.architecture.service.UserService; 10 | import lombok.RequiredArgsConstructor; 11 | import org.modelmapper.ModelMapper; 12 | import org.springframework.stereotype.Service; 13 | 14 | @Service 15 | @RequiredArgsConstructor 16 | public class UserFacade { 17 | 18 | //region 19 | private final UserService userService; 20 | //endregion 21 | 22 | /** 23 | * Get user by id 24 | * 25 | * @param userId as String 26 | * @return User 27 | * @throws ArchitectureException 28 | */ 29 | public Object getUser(String userId) throws ArchitectureException { 30 | try { 31 | //Checking params 32 | if (userId.isEmpty()) 33 | throw new InvalidParamException(); 34 | //Checking user 35 | User user = userService.getUserById(userId); 36 | if (user == null) 37 | throw new UserNotFoundException(); 38 | return user; 39 | } catch (ArchitectureException exception) { 40 | throw exception; 41 | } 42 | } 43 | 44 | /** 45 | * Save user 46 | * 47 | * @param model as UserModel 48 | * @return User 49 | * @throws ArchitectureException 50 | */ 51 | public Object saveUser(UserModel model) throws ArchitectureException { 52 | try { 53 | //Checking params 54 | if (model == null || model.getUserId().isEmpty() || 55 | model.getName().isEmpty() || model.getUsername().isEmpty()) 56 | throw new InvalidParamException(); 57 | //Checking if user is already exist 58 | User existUser = userService.getUserById(model.getUserId()); 59 | if (existUser != null) 60 | throw new UserAlreadyExistException(); 61 | //Mapping model UserModel -> User 62 | User user = new ModelMapper().map(model, User.class); 63 | return userService.saveUser(user); 64 | } catch (ArchitectureException exception) { 65 | throw exception; 66 | } 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/model/common/ResponseHandler.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.model.common; 2 | 3 | import org.springframework.http.HttpStatus; 4 | import org.springframework.http.ResponseEntity; 5 | 6 | import java.util.Date; 7 | import java.util.HashMap; 8 | import java.util.Map; 9 | 10 | public class ResponseHandler { 11 | 12 | public static ResponseEntity response(HttpStatus status, Object data, boolean result) { 13 | Map map = new HashMap<>(); 14 | try { 15 | map.put("timestamp", new Date()); 16 | map.put("status", status.value()); 17 | map.put("result", result); 18 | map.put("data", data); 19 | return new ResponseEntity<>(map, status); 20 | } catch (Exception exception) { 21 | System.out.println(exception.getMessage()); 22 | map.clear(); 23 | map.put("timestamp", new Date()); 24 | map.put("status", HttpStatus.INTERNAL_SERVER_ERROR.value()); 25 | map.put("result", false); 26 | map.put("message", exception.getMessage()); 27 | map.put("data", null); 28 | return new ResponseEntity<>(map, status); 29 | } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/model/user/UserModel.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.model.user; 2 | 3 | import lombok.AllArgsConstructor; 4 | import lombok.Getter; 5 | import lombok.NoArgsConstructor; 6 | import lombok.Setter; 7 | 8 | @Getter 9 | @Setter 10 | @NoArgsConstructor 11 | @AllArgsConstructor 12 | public class UserModel { 13 | private String userId; 14 | private String name; 15 | private String username; 16 | } 17 | -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/repository/UserRepository.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.repository; 2 | 3 | import com.yilmazgokhan.architecture.entity.User; 4 | import org.springframework.data.jpa.repository.JpaRepository; 5 | import org.springframework.stereotype.Repository; 6 | 7 | @Repository 8 | public interface UserRepository extends JpaRepository { 9 | 10 | /** 11 | * SQL query: SELECT * FROM users WHERE userId = 12 | * 13 | * @param id as String 14 | * @return User 15 | */ 16 | User getUserByUserId(String id); 17 | } -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/service/UserService.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.service; 2 | 3 | import com.yilmazgokhan.architecture.entity.User; 4 | import com.yilmazgokhan.architecture.repository.UserRepository; 5 | import lombok.RequiredArgsConstructor; 6 | import org.springframework.stereotype.Service; 7 | 8 | @Service 9 | @RequiredArgsConstructor 10 | public class UserService { 11 | 12 | //region 13 | private final UserRepository repository; 14 | //endregion 15 | 16 | /** 17 | * Get user by id 18 | * 19 | * @param userId as String 20 | * @return User 21 | */ 22 | public User getUserById(String userId) { 23 | return repository.getUserByUserId(userId); 24 | } 25 | 26 | /** 27 | * Save user 28 | * 29 | * @param user as User 30 | * @return User 31 | */ 32 | public User saveUser(User user) { 33 | return repository.save(user); 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /src/main/java/com/yilmazgokhan/architecture/util/Constants.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture.util; 2 | 3 | public class Constants { 4 | 5 | public static final String API_VERSION = "/v1"; 6 | public static final String BASE_URL = "/architecture_api" + API_VERSION; 7 | 8 | public static final class UserPaths { 9 | public static final String USER_PATH = BASE_URL + "/user"; 10 | } 11 | 12 | public static final class Exception { 13 | public static final class Common { 14 | public static final String INVALID_PARAM_CODE = "000001"; 15 | public static final String INVALID_PARAM = "Invalid request params"; 16 | } 17 | 18 | public static final class User { 19 | 20 | public static final String USER_NOT_FOUND_CODE = "000100"; 21 | public static final String USER_NOT_FOUND = "User not found"; 22 | 23 | public static final String USER_ALREADY_EXIST_CODE = "000101"; 24 | public static final String USER_ALREADY_EXIST = "User already exist"; 25 | } 26 | } 27 | 28 | public static final class Client { 29 | public static final String BASE_URL = "https://yilmazgokhan.github.io/"; 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | spring.datasource.url=jdbc:h2:mem:base 2 | spring.datasource.driverClassName=org.h2.Driver 3 | spring.datasource.username=root 4 | spring.datasource.password= 5 | spring.jpa.hibernate.ddl-auto=update 6 | spring.h2.console.enabled=true 7 | spring.h2.console.path=/h2-console 8 | spring.h2.console.settings.web-allow-others=true 9 | server.port=8080 10 | 11 | logging.level.org.hibernate.SQL=DEBUG 12 | logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE -------------------------------------------------------------------------------- /src/test/java/com/yilmazgokhan/architecture/ArchitectureApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.yilmazgokhan.architecture; 2 | 3 | import org.junit.jupiter.api.Test; 4 | import org.springframework.boot.test.context.SpringBootTest; 5 | 6 | @SpringBootTest 7 | class ArchitectureApplicationTests { 8 | 9 | @Test 10 | void contextLoads() { 11 | } 12 | 13 | } 14 | --------------------------------------------------------------------------------