snowdeer's Code Holic
스프링 부트는 어플리케이션 설정 값을 정의하기 위해 다음과 같은 방법을 제공하고 있습니다.
SERVICE.MESSAGE.TEXT="hello"
service:
message:
text: "hello"
좀 더 복잡한 설정을 사용할 때는 yaml 파일을 이용하는 것이 가독성이나 관리가 더 쉽습니다.
java jar ./snowdeer.jar --service.message.text="hello"
앞서 포스팅한 PathVariable 간단한 예제의 예제 코드는 다음과 같습니다.
@Service
class SimpleService {
fun hello(name: String): String {
return "hello $name"
}
}
@Controller
class SimpleController(val simpleService: SimpleService) {
@RequestMapping(value = ["/user/{name}"], method = arrayOf(RequestMethod.GET))
@ResponseBody
fun hello(@PathVariable name: String): String {
return simpleService.hello(name)
}
}
SimpleController 클래스에서 SimpleService 인스턴스를 클래스 생성자의 매개변수로 전달하고 있습니다.
만약 해당 인자를 생성자의 매개 변수를 전달하고 싶지 않을 때는 다음과 같이 @Autowired 어노테이션을 이용할 수 있습니다.
@Controller
class SimpleController() {
@Autowired
private lateinit var service: SimpleService
@RequestMapping(value = ["/user/{name}"], method = arrayOf(RequestMethod.GET))
@ResponseBody
fun hello(@PathVariable name: String): String {
return service.hello(name)
}
}
이와 같이 사용하는 것을 의존성 삽입(Dependency Injection)이라고 합니다.
위에서 만들었던 SimpleService 클래스를 다음과 같이 인터페이스와 구현체로 분리할 수 있습니다.
interface SimpleService {
fun hello(name: String): String
}
@Service
class SimpleServiceImpl : SimpleService {
override fun hello(name: String): String {
return "hello $name"
}
}
그리고 SimpleController도 다음과 같이 수정합니다.
@Controller
class SimpleController() {
@Autowired
private lateinit var service: SimpleService
@RequestMapping(value = ["/user/{name}"], method = arrayOf(RequestMethod.GET))
@ResponseBody
fun hello(@PathVariable name: String): String {
return service.hello(name)
}
}
위 SimpleController 코드 안에는 SimpleServiceImpl과 관련된 코드가 하나도 없습니다.
그런데도 스프링 부트가 SimpleService 인터페이스를 구현하는 적절한 인스턴스를 연결해서 매핑하는 것을 확인할 수 있습니다.
만약 SimpleService 인터페이스를 구현한 SimpleServiceImpl2 클래스를 추가로 생성하면
실행할 때 다음과 같은 오류가 발생합니다.
Field service in com.snowdeer.board.controller.SimpleController required a single bean, but 2 were found:
- simpleServiceImpl: defined in file [/Users/snowdeer/Workspace/SpringBoot/board/build/classes/kotlin/main/com/snowdeer/board/service/SimpleServiceImpl.class]
- simpleServiceImpl2: defined in file [/Users/snowdeer/Workspace/SpringBoot/board/build/classes/kotlin/main/com/snowdeer/board/service/SimpleServiceImpl2.class]
이와 같이 의존 관계 자동 설정을 이용하면 다음과 같은 장점을 얻을 수 있습니다.
샘플 프로젝트를 생성하고 다음 파일들을 생성합니다.
import org.springframework.stereotype.Service
@Service
class SimpleService {
fun hello(name: String): String {
return "hello $name"
}
}
위 클래스는 아직 큰 의미는 없고, 단순 메소드를 제공하는 클래스입니다.
import com.snowdeer.board.service.SimpleService
import org.springframework.stereotype.Controller
import org.springframework.web.bind.annotation.PathVariable
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RequestMethod
import org.springframework.web.bind.annotation.ResponseBody
@Controller
class SimpleController(val simpleService: SimpleService) {
@RequestMapping(value = ["/user/{name}"], method = arrayOf(RequestMethod.GET))
@ResponseBody
fun hello(@PathVariable name: String): String {
return simpleService.hello(name)
}
}
위와 같이 코드를 만들면, /user/name에 해당하는 URL의 name 부분을 경로 파라메터로 받을 수 있습니다.
H2 데이터베이스는 자바 기반의 RDBMS(Relational DataBase Management System)입니다. 용량이 적으며, 브라우저 기반의 콘솔 등을 지원하여 장점이 많습니다. Spring Boot에서 별도 데이터베이스를 설치하지 않고 바로 사용할 수 있는 점도 장점입니다.
Spring Initializer 웹사이트에서 의존성(Dependencies) 부분에서
‘H2 Database’ 항목과 ‘Spring Data JPA’ 항목을 선택하고
프로젝트를 생성해주면 자동으로 build.gradle에 반영이 됩니다.
그리고 application.properties 파일에 속성값을 지정해줘야 합니다. 여기서는 application.yaml 파일을 이용해서 설정하도록 하겠습니다.
기존의 application.properties 파일을 지우고 application.yaml 파일을 생성하고 아래의 내용을 작성합니다.
server:
port: 8000
spring:
h2:
console:
enabled: true
path: /h2_db
datasource:
driver-class-name: org.h2.Driver
url: jdbc:h2:file:./h2_db;AUTO_SERVER=TRUE
username: snowdeer
password: 1234
url 항목에서 jdbc:h2:file는 데이터베이스를 파일에 저장하겠다는 의미이며, ./h2_db는 파일 경로입니다.
위와 같이 설정한 다음 http://localhost:8000 주소에 접속하면 H2 Console 웹페이지가 열립니다.
JDBC URL항목이jdbc:h2:~/test으로 되어 있을텐데, 위에서yaml파일에 작성한jdbc:h2:file:./h2_db값을 넣어줘야 합니다.
Spring Boot 2.0.0 M2 버전부터 기본적으로 사용하는 커넥션 풀(Connection Pool)이 Tomcat에서 HikariCP로 변경되었습니다.
application.yaml에 HikariCP 연결 정보를 반영해서 다음과 같이 수정합니다.
server:
port: 8000
spring:
h2:
console:
enabled: true
path: /h2_db
datasource:
hikari:
driver-class-name: org.h2.Driver
jdbc-url: jdbc:h2:file:./h2_db
username: snowdeer
password: 1234
connection-test-query: SELECT 1
데이터베이스 사용을 위한 기본적인 설정을 합니다.
import com.zaxxer.hikari.HikariConfig
import com.zaxxer.hikari.HikariDataSource
import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.context.annotation.PropertySource
import javax.sql.DataSource
@Configuration
@PropertySource("classpath:application.yaml")
class DatabaseConfiguration {
@Bean
@ConfigurationProperties(prefix = "spring.datasource.hikari")
fun hikariConfig(): HikariConfig {
return HikariConfig()
}
@Bean
@Throws(Exception::class)
fun dataSource(): DataSource {
val dataSource = HikariDataSource(hikariConfig())
println(dataSource.toString())
return dataSource
}
}
지금까지 문제없이 작성되었다면 빌드 및 실행이 가능할 것입니다.
프로젝트 생성은 Spring Initializer 웹사이트를 이용해서 생성할 수 있습니다. 또는 CLI(Command line interface)를 이용해서도 동일한 결과를 얻을 수 있습니다.
해당 페이지에 접속해서 다음과 같이 항목을 선택합니다.
그리고 Generate 버튼을 누르면 hello.zip 파일이 생성될 것입니다. 원하는 경로에 압축을 풉니다.
spring init \ --dependencies=web \ --groupId=com.snowdeer \ --artifactId=hello \ --name="Hello SnowDeer" \ --package-name=com.snowdeer.hello \ --language=kotlin \ --version=2.2.0 \ --build gradle \ hello
위 명령어를 이용해서 빈 프로젝트를 생성할 수 있습니다.
그 외에도 curl 명령어를 이용해서 가져오는 방법이 있는데, 3가지 전부 start.spring.io로부터 가져오는 방법이라 동일합니다.
[여기(https://spring.io/guides/tutorials/spring-boot-kotlin/)를 참고하세요.
해당 프로젝트가 있는 디렉토리로 이동하여
gradle bootRun
명령을 내리면 기본 웹사이트가 구동이 됩니다. http://localhost:8080으로 접속해서 확인을 해봅니다.
‘Whitelabel Error Page’ 페이지가 뜨면 정상 동작하고 있는 것입니다.
이제 해당 프로젝트의 src/main/kotlin/com/snowdeer/hello 디렉토리로 이동합니다.
아마 HelloSnowDeerApplication.kt 파일은 자동으로 만들어졌을 것입니다.
같은 디렉토리에 HelloController.kt 파일을 생성하고 아래 내용을 입력합니다.
package com.snowdeer.hello
import org.springframework.web.bind.annotation.RestController
import org.springframework.web.bind.annotation.RequestMapping
@RestController
class HelloController {
@RequestMapping("/")
fun hello() : String {
return "Hello, SnowDeer"
}
}
여기까지 구현한 다음, 해당 프로젝트를 새로 실행합니다. 그리고 http://localhost:8080에 접속하면
위에서 구현한 페이지가 정상적으로 출력되는 것을 확인할 수 있습니다.
위에서 HelloController 클래스를 생성하고 그 뒤로 아무런 작업을 안해도 어플리케이션이 컨트롤러를 찾고 요청을 처리하는 것을
볼 수 있습니다.
스프링 부트 어플리케이션이 시작될 때, 어플리케이션 컨텍스트 클래스 아래의 모든 클래스와 패키지를 반복적으로 스캔하고,
어떤 클래스라고 하더라도 컴포넌트 어노테이션만 추가하면 클래스의 인스턴스를 생성하고 스프링 부트 어플리케이션 컨텍스트에 추가합니다.
이러한 기능을 컴포넌트 스캔(Component Scan)이라고 합니다.
좀 더 정확히 말하면 컴포넌트 스캔은 @Component 어노테이션이 붙은 모든 클래스를 스캔합니다.
위에서 @RestController 어노테이션을 사용했고, 그 외에도 보통 @Controller 어노테이션을 사용하는데
선언부로 가면 다음과 같이 @Component 어노테이션이 포함되어 있는 것을 확인할 수 있습니다.
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Controller {
@AliasFor(annotation = Component.class)
String value() default "";
}