├── .gitignore ├── README.md ├── build.gradle.kts ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat └── src ├── main ├── kotlin │ └── hello │ │ ├── Application.kt │ │ ├── Customer.kt │ │ ├── CustomerController.kt │ │ └── CustomerRepository.kt └── resources │ └── schema.sql └── test └── kotlin └── hello └── ApplicationTests.kt /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | .idea/ 3 | *.iml 4 | .gradle/ 5 | /out/ 6 | .kotlin/ -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Spring Boot Kotlin sample project 2 | 3 | This is the source code for a sample Spring Boot application developed with Kotlin and Spring Data JDBC. 4 | 5 | **See also https://github.com/spring-guides/tut-spring-boot-kotlin for a more complete Spring Boot + Kotlin + JPA example.** 6 | 7 | You can launch the application with by running: 8 | 9 | $ ./gradlew bootRun 10 | 11 | And request http://localhost:8080/customers. 12 | 13 | This project uses a [Gradle Kotlin DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html). 14 | 15 | This project is Apache 2.0 licensed. 16 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | import org.springframework.boot.gradle.tasks.bundling.BootBuildImage 2 | 3 | plugins { 4 | val kotlinVersion = "2.0.0" 5 | id("org.springframework.boot") version "3.3.1" 6 | id("io.spring.dependency-management") version "1.1.5" 7 | kotlin("jvm") version kotlinVersion 8 | kotlin("plugin.spring") version kotlinVersion 9 | } 10 | 11 | group = "hello" 12 | version = "1.0.0-SNAPSHOT" 13 | 14 | java { 15 | toolchain { 16 | languageVersion = JavaLanguageVersion.of(17) 17 | } 18 | } 19 | 20 | repositories { 21 | mavenCentral() 22 | } 23 | 24 | dependencies { 25 | implementation("org.springframework.boot:spring-boot-starter-web") 26 | implementation("org.springframework.boot:spring-boot-starter-data-jdbc") 27 | implementation("org.jetbrains.kotlin:kotlin-reflect") 28 | implementation("com.fasterxml.jackson.module:jackson-module-kotlin") 29 | implementation("com.h2database:h2") 30 | 31 | testImplementation("org.springframework.boot:spring-boot-starter-test") 32 | } 33 | 34 | kotlin { 35 | compilerOptions { 36 | freeCompilerArgs.addAll("-Xjsr305=strict") 37 | } 38 | } 39 | 40 | tasks.named("bootBuildImage") { 41 | // For multi arch (Apple Silicon) support 42 | builder.set("paketobuildpacks/builder-jammy-buildpackless-tiny") 43 | buildpacks.set(listOf("paketobuildpacks/java")) 44 | } 45 | 46 | tasks.withType { 47 | useJUnitPlatform() 48 | } 49 | 50 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sdeleuze/spring-boot-kotlin-demo/f67c62d7cd553978be41196d0e565a1f44c9d925/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /src/main/kotlin/hello/Application.kt: -------------------------------------------------------------------------------- 1 | package hello 2 | 3 | import org.slf4j.LoggerFactory 4 | import org.springframework.boot.CommandLineRunner 5 | import org.springframework.boot.autoconfigure.SpringBootApplication 6 | import org.springframework.boot.runApplication 7 | import org.springframework.context.annotation.Bean 8 | 9 | @SpringBootApplication 10 | class Application { 11 | 12 | private val log = LoggerFactory.getLogger(Application::class.java) 13 | 14 | @Bean 15 | fun init(repository: CustomerRepository) = CommandLineRunner { 16 | // save a couple of customers 17 | repository.save(Customer("Jack", "Bauer")) 18 | repository.save(Customer("Chloe", "O'Brian")) 19 | repository.save(Customer("Kim", "Bauer")) 20 | repository.save(Customer("David", "Palmer")) 21 | repository.save(Customer("Michelle", "Dessler")) 22 | 23 | // fetch all customers 24 | log.info("Customers found with findAll():") 25 | log.info("-------------------------------") 26 | repository.findAll().forEach { log.info(it.toString()) } 27 | log.info("") 28 | 29 | // fetch an individual customer by ID 30 | val customer = repository.findById(1L) 31 | customer.ifPresent { 32 | log.info("Customer found with findById(1L):") 33 | log.info("--------------------------------") 34 | log.info(it.toString()) 35 | log.info("") 36 | } 37 | 38 | // fetch customers by last name 39 | log.info("Customer found with findByLastName('Bauer'):") 40 | log.info("--------------------------------------------") 41 | repository.findByLastName("Bauer").forEach { log.info(it.toString()) } 42 | log.info("") 43 | } 44 | 45 | } 46 | 47 | fun main() { 48 | runApplication() 49 | } 50 | -------------------------------------------------------------------------------- /src/main/kotlin/hello/Customer.kt: -------------------------------------------------------------------------------- 1 | package hello 2 | 3 | import org.springframework.data.annotation.Id 4 | import org.springframework.data.relational.core.mapping.Table 5 | 6 | @Table 7 | data class Customer( 8 | val firstName: String, 9 | val lastName: String, 10 | @Id 11 | val id: Long? = null) 12 | -------------------------------------------------------------------------------- /src/main/kotlin/hello/CustomerController.kt: -------------------------------------------------------------------------------- 1 | package hello 2 | 3 | import org.springframework.web.bind.annotation.GetMapping 4 | import org.springframework.web.bind.annotation.PathVariable 5 | import org.springframework.web.bind.annotation.RestController 6 | 7 | @RestController 8 | class CustomerController(private val repository: CustomerRepository) { 9 | 10 | @GetMapping("/customers") 11 | fun findAll() = repository.findAll() 12 | 13 | @GetMapping("/customers/{lastName}") 14 | fun findByLastName(@PathVariable lastName:String) 15 | = repository.findByLastName(lastName) 16 | } -------------------------------------------------------------------------------- /src/main/kotlin/hello/CustomerRepository.kt: -------------------------------------------------------------------------------- 1 | package hello 2 | 3 | import org.springframework.data.repository.CrudRepository 4 | 5 | interface CustomerRepository : CrudRepository { 6 | 7 | fun findByLastName(lastName: String): Iterable 8 | } 9 | -------------------------------------------------------------------------------- /src/main/resources/schema.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE customer ( 2 | id INTEGER GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, 3 | first_name VARCHAR(30), 4 | last_name VARCHAR(30) 5 | ); -------------------------------------------------------------------------------- /src/test/kotlin/hello/ApplicationTests.kt: -------------------------------------------------------------------------------- 1 | package hello 2 | 3 | import org.junit.jupiter.api.Assertions.assertEquals 4 | import org.junit.jupiter.api.Test 5 | import org.springframework.beans.factory.annotation.Autowired 6 | import org.springframework.boot.test.context.SpringBootTest 7 | import org.springframework.boot.test.context.SpringBootTest.WebEnvironment 8 | import org.springframework.boot.test.web.client.TestRestTemplate 9 | import org.springframework.boot.test.web.client.getForObject 10 | 11 | @SpringBootTest(webEnvironment= WebEnvironment.RANDOM_PORT) 12 | class ApplicationTests(@Autowired private val restTemplate: TestRestTemplate) { 13 | 14 | @Test 15 | fun findAll() { 16 | val content = """[{"firstName":"Jack","lastName":"Bauer","id":1},{"firstName":"Chloe","lastName":"O'Brian","id":2},{"firstName":"Kim","lastName":"Bauer","id":3},{"firstName":"David","lastName":"Palmer","id":4},{"firstName":"Michelle","lastName":"Dessler","id":5}]""" 17 | assertEquals(content, restTemplate.getForObject("/customers")) 18 | } 19 | 20 | } 21 | --------------------------------------------------------------------------------