자동 구성 Auto Configuration 라이브러리 만들고 사용해보기

 

자동 구성 사용 전 스프링 라이브러리 만들고 사용해보기 (tistory.com)

자동 구성 사용 전 스프링 라이브러리 만들고 사용해보기

저번 글에서는 스프링 부트가 제공하는 자동 구성 Auto Configuration 기능을 사용하기 전에 직접 스프링 빈으로 등록해서 사용하는 라이브러리를 만들어봤다. 

이는 라이브러리를 사용할 때 필요한 빈들이 뭔지 알아야 하고, 이를 하나하나 빈으로 등록해줘야 한다는 단점이 있어는데 스프링 부트에서는 자동 구성 기능을 제공해서 스프링 빈들이 자동으로 등록될 수 있도록 도와준다. 

 

 

0️⃣ 자동 구성 라이브러리 만들기 

이번에도 라이브러리로 만들 프로젝트는 메모리 사용량을 실시간으로 조회할 수 있는 라이브러리로 

저번 글과 거의 동일하게 프로젝트를 생성해주면 된다. 

 

Memory

public class Memory
{
   private long used;
   private long max;
   
   public Memory(long used, long max)
   {
      this.used = used;
      this.max = max;
   }
   
   public long getUsed()
   {
      return used;
   }
   
   public long getMax()
   {
      return max;
   }
   
   @Override
   public String toString()
   {
      return "Memory{" +
            "used=" + used +
            ", max=" + max +
            '}';
   }
}

 

 

MemoryFinder 

@Slf4j
public class MemoryFinder
{
   
   public Memory get()
   {
      long max = Runtime.getRuntime().maxMemory(); // JVM이 사용할 수 있는 최대 메모리
      long total = Runtime.getRuntime().totalMemory();  // JVM이 확보한 전체 메모리
      long free = Runtime.getRuntime().freeMemory();  /// JVM이 확보한 전체 메모리 중 사용하지 않은 것
      
      long used = total - free;
      
      return new Memory(used, max);
   }
   
   @PostConstruct
   public void init()
   {
      log.info("init MemoryFinder");
   }
}

 

MemoryController

@Slf4j
@RestController
@RequiredArgsConstructor
public class MemoryController
{
   
   private final MemoryFinder memoryFinder;
   
   @GetMapping("/memory")
   public Memory system()
   {
      Memory memory = memoryFinder.get();
      log.info("memory = {}" , memory);
      
      return memory;
   }
}

 

 

MemoryAutoConfig

@AutoConfiguration
@ConditionalOnProperty(name = "memory", havingValue = "on")
public class MemoryAutoConfig
{
   @Bean
   public MemoryFinder memoryFinder()
   {
      return new MemoryFinder();
   }
   
   @Bean
   public MemoryController memoryController()
   {
      return new MemoryController(memoryFinder());
   }
}

이번에는 라이브러리 프로젝트에 Config 파일을 생성한 다음에 @AutoConfiguration 어노테이션을 추가해줬다. 

 

@AutoConfiguration 

: 스프링 부트가 제공하는 자동 구성 기능을 적용할 때 사용하는 어노테이션 

 

@ConditiotnalOnProperty

: memory = on 이라는 환경 정보가 있을 경우에만 이 라이브러리를 사용할수 있도록 어노테이션으로 지정해준다. 

이 어노테이션이 있으면 memory = on 이라는 환경 정보가 있는 경우에만 스프링 빈으로 등록해서 메모리 조회 기능을 사용할 수 있게 된다. 

(라이브러리를 가지고 있어도 상황에 따라서 기능을 키고 끌 수 있는 유연한 기능을 제공하게 된다.) 

 

 

1️⃣ 자동 구성 대상 지정해주기 

MemoryAutoConfig 파일을 생성하고 끝이 아니라  스프링 부트 자동 구성을 적용하려면, 다음 파일에 자동 구성 대상을 꼭 지정해줘야 한다. 

 

❗ 폴더 위치와 파일 이름이 길기 때문에 오타 주의 

src/main/resources/META-INF/spring/ 

org.springframework.boot.autoconfigure.AutoConfiguration.imports

memory.MemoryAutoConfig

해당 파일에 패키지명까지 포함해서 자동 구성 파일을 지정해준다. 

 

-> 이렇게 자동 구성 대상을 지정해주고 나면 스프링 부트는 시작 시점에 org.springframework.boot.autoconfigure.AutoConfiguration.imports 파일의 정보를 읽어서 자동 구성으로 사용하고, 따라서 내부에 지정해둔 MemoryAutoConfig가 자동으로 실행되어 스프링 빈으로 등록해준다. 

 

 

2️⃣ 라이브러리 빋드 후 사용하기 

gradlew clean build

위에 프로젝트를 만든 후 jar 파일을 만들었고.. 

 

이제 이 라이브러리를 사용하기 위한 프로젝트를 생성할 것이다. 

Lombok, Spring web 라이브러리를 선택한 다음 project-v2 프로젝트를 생성한다. 

 

HelloController

@RestController
public class HelloController
{
   
   @GetMapping("/hello")
   public String hello()
   {
      return "hello";
   }
}

정말 간단한 프로젝트이고, 이제 이 프로젝트에 memory-v2 라이브러리를 사용해볼 예정이다. 

전에 글에서 라이브러리 지정한 것과 비슷하게 

 

project-v2/libs 폴더를 만들고 memory-v2.jar 을 해당 폴더에 복사해준다. 

 

그리고 build.gradle에 memroy-v2.jar를 추가해주면 된다. 

dependencies {
    implementation files('libs/memory-v2.jar')
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

 

그리고 그 전에 자동 구성을 사용하기 전 memory-v1 라이브러리에서는 직접 스프링 빈으로 필요한 것들을 등록해줘야 했는데 

memory-v2 라이브러리에서는 스프링 부트 자동 구성이 설정되어있기 때문에 스프링 빈으로 등록할 필요가 없다. 

MemoryAutoConfig에서 @ConditionalOnProperty 에서 memory 환경 정보가 on 으로 설정된 경우에만 라이브러리의 기능을 사용할 수 있게 지정해뒀기 때문에 

 

IntelliJ에 환경 설정 정보를 추가해준다. 

 

 

📚 이렇게 스프링 부트가 제공하는 자동 구성 덕분에 하나하나 스프링 빈 등록을 한다거나 추가 설정 없이도 단순하게 라이브러리만 추가해주면 프로젝트를 편리하게 구성할 수 있게 됐다. 

그리고 @ConditionalOnProperty 어노테이션 덕분에 환경 설정 정보에 따라 해당 라이브러리의 기능을 키고 끌 수 있도록 유연하게 제공할 수도 있다.