스프링부트 소개

0. 스프링부트SpringBoot란?

Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can "just run". We take an opinionated view of the Spring platform and third-party libraries so you can get started with minimum fuss. Most Spring Boot applications need very little Spring configuration.

• 스프링부트는 단독실행되는, 실행하기만 하면 되는 상용화 가능한 수준의 스프링 기반 애플리케이션을, 쉽게 만들어낼 수 있다.
• 최소한의 설정으로 스프링 플랫폼과 서드파티 라이브러리들을 사용할 수 있도록 하고 있다.

스프링 기반의 애플리케이션을 개발하기 쉽도록 기본설정되어 있는 설정을 기반으로 해서 빠르게 개발할 수 있도록 해주는 개발플랫폼이랄까?

0.1. 스프링부트 기능

• Create stand-alone Spring applications

  단독실행가능한 스프링애플리케이션을 생성한다.,

• Embed Tomcat, Jetty or Undertow directly (no need to deploy WAR files)

  내장형 톰캣, 제티 혹은 언더토우를 내장(WAR 파일로 배포할 경우에는 필요없음)

• Provide opinionated 'starter' component to simplify your build configuration

  기본설정되어 있는 'starter' 컴포넌트들을 쉽게 추가

• Automatically configure Spring whenever possible

  가능한 자동설정되어 있음

• Provide production-ready features such as metrics, health checks and externalized configuration

  상용화에 필요한 통계, 상태 점검 및 외부설정을 제공

• Absolutely no code generation and no requirement for XML configuration

  설정을 위한 XML 코드를 생성하거나 요구하지 않음

1. 스프링부트 시작하기

1.1. 스프링부트 프로젝트 생성하기

• 주의사항

  • 네트워크가 연결되어 있어야 한다.

    그렇다면, 네트워크가 연결되지 않은 인트라넷 환경에서는 어떻게 해야할까? = 넥서스Nexus 에 스프링부트 설정을 해야겠지요? 사실, 안해봐서 모르겠음. @_@);;

  • Maven 혹은 Gradle 플러그인이 IDE에 설치되어 있어야 한다.

1.1.1. http://start.spring.io/ 에서 생성하기

1.1.1.1. 프로젝트 메타데이터를 등록

• Maven 보다는 Gradle
  • Maven 예제가 많은 편이지만, Maven의 골, 페이즈만으로는 프로젝트의 필요한 기능을 모두 지원하지 못할 수도 있음
  • Gradle은 Groovy DSL로 구성되어 있어서 그루비를 익혀야하지만, 지원되는 기능을 익히고 나면 훨씬 강력해짐
• 배포형태에 따라서 war 또는 jar
  • 기본적으로는 단독실행가능지만, 프로젝트 환경에 따라 배포할 수도 있으니 war도 가능

1.1.1.2. [Generate Project] 버튼클릭

• 'artifact' 이름으로 된 zip 파일 다운로드

1.1.1.3. IDE에서 Import Project

1.1.2. STS에서 생성하기

1.1.2.1. [File]-[New]-[Spring Starter project] 선택

1.1.2.2. 사용하려는 스프링 starter 선택

• 최초에는 필요한 라이브러리들을 다운로드 받는데 상단한 시간이 소요된다.

1.2. 스프링부트 프로젝트 실행

• [Run as] - [Spring Boot App] 선택
• [gradle] - [Tasks quick launcher] 을 이용해서 실행
  • 프로젝트 지정된 JDK 버전과 IDE 실행 JDK 버전이 다르면...
• 프로젝트 생성 위치에서 $ gradle bootRun 명령 실행

2. 스프링부트 구성 살펴보기

2.1. 최초 생성된 스프링부트 프로젝트 살펴보기

2.1.1. jar 프로젝트

• build.gradle

//코드 생략
apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'idea'
apply plugin: 'spring-boot'
apply plugin: 'io.spring.dependency-management'
 
jar {
    baseName = 'demo'
    version = '0.0.1-SNAPSHOT'
}
//코드생략
dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    testCompile("org.springframework.boot:spring-boot-starter-test")
}

• {artifact-name}Application.java
• IDE에서 Java Application project로 인식
• build 태스크 실행시 demo.jar 생성
• 실행

$ java -jar demo.jar

2.1.2. war 프로젝트

• build.gradle

//코드생략
apply plugin: 'java'
apply plugin: 'eclipse-wtp'
apply plugin: 'idea'
apply plugin: 'spring-boot'
apply plugin: 'io.spring.dependency-management'
apply plugin: 'war'
 
war {
    baseName = 'demowar'
    version = '0.0.1-SNAPSHOT'
}
//코드생략
configurations {
    providedRuntime
}
 
dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    providedRuntime("org.springframework.boot:spring-boot-starter-tomcat")
    testCompile("org.springframework.boot:spring-boot-starter-test")
}

• public class ServletInitializer extends SpringBootServletInitializer 클래스가 있음
• IDE에서 웹프로젝트로 인식
• build 태스크 실행시 demowar.war 생성
• 실행
  • https://spring.io/guides/gs/convert-jar-to-war/

    $ java -jar demowar.war

2.1.3. Excutable JAR

• 자세히 알고 싶다면 http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#executable-jar 를 보고 알려주세요...!

2.2. @SpringBootApplication

• 코드

/**
 * Indicates a {@link Configuration configuration} class that declares one or more
 * {@link Bean @Bean} methods and also triggers {@link EnableAutoConfiguration
 * auto-configuration} and {@link ComponentScan component scanning}. This is a convenience
 * annotation that is equivalent to declaring {@code @Configuration},
 * {@code @EnableAutoConfiguration} and {@code @ComponentScan}.
 * 
 * @author Phillip Webb
 * @since 1.2.0
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Configuration
@EnableAutoConfiguration
@ComponentScan
public @interface SpringBootApplication {
 
    /**
     * Exclude specific auto-configuration classes such that they will never be applied.
     * @return the classes to exclude
     */
    Class<?>[] exclude() default {};
 
}

• @SpringBootApplication 애노테이션이 선언된 애플리케이션 클래스는 패키지 루트에 위치하는 것이 좋다.
  • 물론 @ComponentScan에 별도의 패키지를 지정할 수 있지만 굳이~ 그렇게 하지 맙시다.
  • Locating the main application class 의 기본적인 구조를 따르는 걸 권장하고 싶음

    com
    +- example
         +- myproject
             +- Application.java
             |
             +- domain
             |   +- Customer.java
             |   +- CustomerRepository.java
             |
             +- service
             |   +- CustomerService.java
             |
             +- web
                 +- CustomerController.java

3. 스프링부트 설정

3.1. 스프링부트 자동설정AutoConfig

3.1.1. autoconfigure 패키지 확인

• spring-boot-autoconfigure 살펴보기

3.1.2. @Conditional, @ConditionalOnBean, @ConditionalOnMissingBean, @ConditionalOnClass 조건에 따라 스프링 빈Bean 으로 등록

• @ConditionalOnBean
• @ConditionalOnMissingBean
• @ConditionalOnClass

3.2. 외부설정 하기

• Common Application properties
• 스프링부트의 프로퍼티스 확인순서에 따라서 외부요인들을 읽어오게 됨
• Environment

  3.2.1. application.properties

• PropertySource

  3.2.2. application.yml

• YamlPropertySourceLoader

3.2.3. 프로파일즈 활용하기

• 로컬, 개발, 테스트, 운영 설정을 각각 관리 및 적용
• Profiles - springframework
• 환경별 설정요소를 한곳에서 집중하여 관리할 수 있음

3.2.3.1. 기존 방식

• 설정디렉토리를 분리
  • config/local
  • config/development
  • config/test
  • config/production
• 빌드시 프로파일을 지정하여 지정한 설정디렉토리의 설정파일을 적용하는 형식을 취함

3.2.3.2. application.properties

• application-{profiles}.properties
  • application-local.properties
  • application-development.properties
  • application-test.properties
  • application-production.properties

3.2.3.3. application.yaml

• application.yaml

# 공통설정부분 지정가능
---
spring:
    profiles: local
---
spring:
  profiles: development
---
spring:
    profiles: test
---
spring:
  profiles: production

4. 스프링부트 확장하기

4.1. starter POMs 추가하기

• Starer POMs
• 추가시 spring.provides 에 연관된 스프링 라이브러리들이 정의되어 있다.
• 관련 의존성 라이브러리에 대해서는 starter 프로젝트 내부에 있는 pom.xml 에 정의되어 있음

4.2. 의존성 라이브러리 추가하기

4.2.1. 의존성 버전

• dependency-versions
  • 목록에 있는 의존성 라이브러리들은 버전을 정의하지 않으면, 기본지정된 버전이 적용됨
  • 별도의 버전을 지정할 수 있음

    4.2.2. 의존성 라이브러리 검색

• http://search.maven.org/
• http://mvnrepository.com/

● 개인적 목표

• JDK 8 이상 사용
• Gradle 사용
• SpringBoot 적용
  • 스프링 프레임워크 4.0 이상 적용
  • Spring Data JPA 사용

STS(Spring Tool Suite)를 3.7.0 으로 업그레이드를 하고나서 @ConfigurationProperties 애노테이션을 사용한 곳에 경고창이 뜨는 것을 보았다.

그 메시지를 살펴보면

When using @ConfigurationProperties it is recommended to add 'spring-boot-configuration-processor' to your classpath to generate configuration metadata

와 같다. @ConfigurationProperties 을 사용할 때는 spring-boot-configuration-processor를 클래스패스에 설정하는 것을 권장한다고. +_+)

그래서 찾아봤다.
> Spring Boot Support in Spring Tool Suite 3.6.4

이런 내용이 있다. 대략,

• STS 에서 간단하게 스프링부트 애플리케이션 생성하기
• STS 에서 부트 애플리케이션을 실행하고 디버깅하기
• STS Properties editor를 이용해서 설정프로퍼타이즈 편집하기
• @ConfigurationProperties를 사용하는 코드에서 설정프로퍼타이즈 편집하기

의 기능을 사용할 수 있다.

메이븐이라면 pom.xml에다가 아래 의존성을 추가하면 되고

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
</dependency>

그레들이라면 build.gradle에다가 아래 사항을 추가하는 것만으로도 해결완료~!

compile "org.springframework.boot:spring-boot-configuration-processor"

spring-boot-configuration-processor를 활용한 기능은 위에 링크한 글을 (같이) 살펴보자.

스프링시큐리티의 GrantedAuthority 인터페이스를 enum 타입으로 구현했는데, 이 구현체에 toString() 을 선언하면서 의도와는 다르게 동작하는 문제가 발생했다.

public enum MemberAuthority implements Ordered, GrantedAuthority, CodeableEnum {
    /**
     * Administrator
     */
    ADMINISTRATOR("administrator", "code.memberAuthority.administrator", 1),
    /**
     * Project Manager(project, project member, jobs of project management)
     */
    PROJECT_MANAGER("project-manager", "code.memberAuthority.projectManager", 2),
    /**
     * Operator( operator jobs of project)
     */
    OPERATOR("operator", "code.memberAuthority.operator", 3),
    /**
     * Inspector(monitoring)
     */
    INSPECTOR("inspector", "code.memberAuthority.inspector", 4);
 
    private String code;
    private String key;
    private int order;

이런 코드인데, toString() code, key, order 에 대한 내용을 출력하도록 만들면...MemberAuthority[code="project", key="code.memberAuthority.administrator", order=1]의 형태로 나오게 된다. 스프링시큐리티에서는 권한을 문자열로 받기에 ADMINISTRATOR 으로 나와야하는데... 전혀 다른 형태가 되어버리니 권한 체크가 제대로 되지 않을 수밖에...

○ 정리

• enum 타입에 대해서 toString()을 적용할 때는 잠시만 고심해보자.

○ SpringBoot 레퍼런스 가이드 설정부분

# FLYWAY (FlywayProperties)
flyway.check-location=false # check that migration scripts location exists
flyway.locations=classpath:db/migration # locations of migrations scripts
flyway.schemas= # schemas to update
flyway.init-version= 1 # version to start migration
flyway.init-sqls= # SQL statements to execute to initialize a connection immediately after obtaining it
flyway.sql-migration-prefix=V
flyway.sql-migration-suffix=.sql
flyway.enabled=true
flyway.url= # JDBC url if you want Flyway to create its own DataSource
flyway.user= # JDBC username if you want Flyway to create its own DataSource
flyway.password= # JDBC password if you want Flyway to create its own DataSource

예제에 보면 1 이 등록된 것을 볼 수 있다. 하지만!!

Caused by: org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 1 errors
Field error in object 'flyway' on field 'initVersion': rejected value [1]; codes [typeMismatch.flyway.initVersion,typeMismatch.initVersion,typeMismatch.org.flywaydb.core.api.MigrationVersion,typeMismatch]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [flyway.initVersion,initVersion]; arguments []; default message [initVersion]]; default message [Failed to convert property value of type 'java.lang.String' to required type 'org.flywaydb.core.api.MigrationVersion' for property 'initVersion'; nested exception is java.lang.IllegalStateException: Cannot convert value of type [java.lang.String] to required type [org.flywaydb.core.api.MigrationVersion] for property 'initVersion': no matching editors or conversion strategy found]
    at org.springframework.boot.bind.PropertiesConfigurationFactory.validate(PropertiesConfigurationFactory.java:296)
    at org.springframework.boot.bind.PropertiesConfigurationFactory.doBindPropertiesToTarget(PropertiesConfigurationFactory.java:255)
    at org.springframework.boot.bind.PropertiesConfigurationFactory.bindPropertiesToTarget(PropertiesConfigurationFactory.java:227)
    at org.springframework.boot.context.properties.ConfigurationPropertiesBindingPostProcessor.postProcessBeforeInitialization(ConfigurationPropertiesBindingPostProcessor.java:296)
    ... 26 more

ㅡ_-);; 그대로 따라해보면 저렇게 오류를 뱉는다.

스프링부트 1.2.3 에서 Flyway와 관련된 ... 부분에서 initVersion 항목이 Integer 가 아니라 MigrationVersion으로 변경이 되었다. 스프링부트 1.2.3 에서 제공하는 flywayDB는 3.1 버전으로, Flyway.class의 코드를 살펴보면

/**
 * Sets the version to tag an existing schema with when executing baseline.
 *
 * @param initVersion The version to tag an existing schema with when executing baseline. (default: 1)
 * @deprecated Use setBaselineVersion() instead. Will be removed in Flyway 4.0.
 */
@Deprecated
public void setInitVersion(MigrationVersion initVersion) {
    LOG.warn("Flyway.setInitVersion() is deprecated. Use setBaselineVersion() instead. Will be removed in Flyway 4.0.");
    this.baselineVersion = initVersion;
}
 
/**
 * Sets the version to tag an existing schema with when executing baseline.
 *
 * @param initVersion The version to tag an existing schema with when executing baseline. (default: 1)
 * @deprecated Use setBaselineVersion() instead. Will be removed in Flyway 4.0.
 */
@Deprecated
public void setInitVersion(String initVersion) {
    LOG.warn("Flyway.setInitVersion() is deprecated. Use setBaselineVersion() instead. Will be removed in Flyway 4.0.");
    this.baselineVersion = MigrationVersion.fromVersion(initVersion);
}

에서 보는 것처럼, 1, 2, 3으로 정의하던 initVersion 관련 항목이 @Depercated 처리되었다.

initVersion 으로 설정하는 부분

String initVersionProp = properties.getProperty("flyway.initVersion");
if (initVersionProp != null) {
    LOG.warn("flyway.initVersion is deprecated and will be removed in Flyway 4.0. Use flyway.baselineVersion instead.");
    setBaselineVersion(MigrationVersion.fromVersion(initVersionProp));
}

baselineVersion

String baselineVersionProp = properties.getProperty("flyway.baselineVersion");
if (baselineVersionProp != null) {
    setBaselineVersion(MigrationVersion.fromVersion(baselineVersionProp));
}

flyway의 릴리즈 노트를 보면 init 관련항목들이 baseline으로 변경된 것을 확인할 수 있었다. 두둥.

Issue 860 Deprecated init(), use baseline() instead.
Issue 860 Deprecated initVersion, use baselineVersion instead.
Issue 860 Deprecated initDescription, use baselineDescription instead.
Issue 860 Deprecated initOnMigrate, use baselineOnMigrate instead.
Issue 860 Deprecated FlywayCallback.beforeInit(), use FlywayCallback.beforeBaseline() instead.
Issue 860 Deprecated FlywayCallback.afterInit(), use FlywayCallback.afterBaseline() instead.
Issue 860 Deprecated MigrationState.PREINIT, use MigrationState.BELOW_BASELINE instead.
Issue 860 Deprecated MigrationType.INIT, use MigrationType.BASELINE instead.

◎ 정리

• initVersion 보다는 baselineVersion으로 옮겨가자.
• MigrationVersion 은 LATEST와 EMPTY 로 변환가능...
• 스프링부트에서 사용한 외부 라이브러리에서 오류가 발생한다면, 외부라이브러리와 관련된 가이드를 살펴보자.
  • 스프링부트 레퍼런스 가이드에 반영이 안되어 있을수도 있다.