스프링 부트의 Auto Configuration 직접 구현해보기

 

"Xxx-Spring-Boot-Starter" 자동 설정을 직접 구현하는 방법이다.

jueun-spring-boot-starter 구현하기

1. maven 프로젝트 생성, 의존성 추가

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.jueun</groupId>
    <artifactId>jueun-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure-processor</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>

    <!--두 의존성의 버전 관리를 위해 관리 영역 추가 -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.0.3.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

</project>

2. DTO(VO) 작성

package com.jueun;

public class Holoman {
    String name;
    int howLong;
    
    // getter(), setter(), toString() 생략
}

3. @Configuration 파일 작성

package com.jueun;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class HolomanConfiguration {

    @Bean
    public Holoman holoman(){
        Holoman holoman = new Holoman();
        holoman.setHowLong(5);
        holoman.setName("jueun");
        return holoman;
    }

}

4. spring.factories 파일 작성

서비스 프로바이더 같은 패턴이라고 한다.

src/main/resource/META-INF에 spring.factories을 생성하고 spring.factories 안에 자동 설정 파일을 추가한다.

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.jueun.HolomanConfiguration

5. mvn install

지금까지 작성한 파일 구조는 아래와 같다.

Maven > install 더블클릭

프로젝트를 build를 해서 jar 파일이 생성된 것을 다른 maven 프로젝트에서도 사용할 수 있도록 local maven 저장소에다가 설치를 하는 것이다.

자동 설정 실행하기

이제 자동 설정을 다른 프로젝트에서 불러와서 실행되는지 확인해보자!

1. spring boot 프로젝트를 생성, 의존성 추가

의존성이 잘 들어왔는지 확인할 수있다.

<dependency>
            <groupId>com.jueun</groupId>
            <artifactId>jueun-spring-boot-starter</artifactId>
            <version>1.0-SNAPSHOT</version>
</dependency>

2. Runner 클래스 작성

package com.jueun.mainproject;

import com.jueun.Holoman;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;

@Component
public class HolomanRunner implements ApplicationRunner {

    @Autowired
    Holoman holoman;

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(holoman);
    }

}

3. 실행

Application 클래스에서는 Holoman에 대한 그 어떤 내용도 적혀있지 않으나, 실행해보면 출력되는 것을 확인할 수 있다.

package com.jueun.mainproject;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

출력 확인

---

문제점 1

더 나아가서 메인 프로젝트에서 내가 원하는 빈의 값을 직접 등록해보자

package com.jueun.mainproject;

import com.jueun.Holoman;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public Holoman holoman(){
        Holoman holoman = new Holoman();
        holoman.setHowLong(50);
        holoman.setName("jueun2");
        return holoman;
    }

}

하지만 여전히 실행값은 jueun, 5 값이 출력된다.

그 이유는 ComponentScan 이후에 EnableAutoConfiguration으로 빈을 등록하기 때문이다.

@ComponentScan 시 jueun2, 50 값이 써졌지만, @EnableAutoConfiguration 시, jueun, 5 값을 덮어썼다.

이 문제는 내가 쓴 빈이 우선시 되지 않는 것이다.

이와 관련될 글은 이 링크에서 확인할 수 있다.

스프링 부트 자동설정 간단하게 이해하기

해결 방법

@ConditionalOnMissingBean

이를 해결하기 위해서는 @ConditionalOnMissingBean을 사용할 수 있다.

ComponentScan으로 jueun2, 50 값의 Holoman이 있으니 AutoConfiguration 시에 jueun, 5 값의 빈은 등록하지 않도록 지정하는 것이다.

package com.jueun;

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class HolomanConfiguration {

    @Bean
    @ConditionalOnMissingBean
    public Holoman holoman(){
        Holoman holoman = new Holoman();
        holoman.setHowLong(5);
        holoman.setName("jueun");
        return holoman;
    }

}

다시 mvn install하고 메이븐 프로젝트에서는 maven에 대해서 refresh한다.

maven refresh

---

문제점 2

public Holoman holoman(){
        Holoman holoman = new Holoman();
        holoman.setHowLong("jueun");
        holoman.setName(5);
        return holoman;
}

위와 같이 빈에 값을 등록하기 위해 함수는 쓰는 것은 비효율적이다.

properties 파일에서 값을 바꾸는 것 만으로 빈의 값을 변경하고 싶다.

해결 방법

1. @ConfigurationProperties("")

package com.jueun;


import org.springframework.boot.context.properties.ConfigurationProperties;

// 메인프로젝트에서 holoman로 시작하여 프로퍼티로 접근한다.
@ConfigurationProperties("holoman")
public class HolomanProperties {
    private  String name;
    private int howLong;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getHowLong() {
        return howLong;
    }

    public void setHowLong(int howLong) {
        this.howLong = howLong;
    }
}

2. HolomanConfiguration 작성

@EnableConfigurationProperties(HolomanProperties.class)

package com.jueun;

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableConfigurationProperties(HolomanProperties.class)
public class HolomanConfiguration {

    // @Bean으로 정의하는 메소드의 매개변수는 자동으로 스프링이 주입
    @Bean
    @ConditionalOnMissingBean
    public Holoman holoman(HolomanProperties properties){
        Holoman holoman = new Holoman();
        holoman.setHowLong(properties.getHowLong());
        holoman.setName(properties.getName());
        return holoman;
    }

}

3, 프로퍼티 키값 자동 완성 의존성 추가

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

4. mvn install / 메인은 Maven refresh

5. application.properties 파일 작성

holoman.name=jueun3
holoman.how-long=30

출력 확인