Spring | Reflection을 사용하여 Annotation 가져오기

해당 내용은 공부의 목적으로 기록되었으며,
아래 내용은 모두 구글 검색으로 공부 블로그를 참고하여 작성했습니다.
열심히 배우는 중입니다. 감사합니다.

 

 

---

 

 

📌 리플렉션 (Reflection)

리플렉션은 생성자, 메소드, 필드 등 클래스에 대한 정보를 아주 자세히 알려주는 자바 API 이다.
대표적인 예시로 여러 라이브러리, 프레임워크에서 사용되는 어노테이션이 리플렉션을 통해 확인하는 방법 등이 있다.
리플렉션을 사용하면 접근 제어자와 무관하게 클래스의 필드나 메소드도 가져와서 호출할 수 있다.

 

📌 어노테이션 (Annotation) 가져오기

대표적인 예시 중 하나를 실습해봤다.

 

📌 임의 어노테이션 생성

 

어노테이션의 폴더 구성

Controller, RequestMapping, Service 를 생성

 

임의 어노테이션의 코드

package com.example.mvcpractice.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Controller {
}

 

 

📌 어노테이션 선언코드

어노테이션을 선언하기 위한 코드로 @Target 이라는 기능이 있다. 해당 사용자가 만든 어노테이션이 부착될 수 있는 타입을 지정한다. (타입: 클래스, 생성자, 메서드 등등)

 

어노테이션 선언코드 구성

사용자 생성: @Controller

import java.lang.annotation.ElementType;

@Target({ElementType.TYPE})
// TYPE 이외에도 CONSTRUCTOR, METHOD, FIELD 가 있으며, 원하는 타입을 작성한다.
public @interface Controller {
}

 

@Retention은 해당 어노테이션이 언제까지 유지할지 알려주는 어노테이션이다.

어노테이션을 선언하기 위해서 사용자의 생성 어노테이션 또한 어느 시점까지 유효한지를 명시해줘야 한다.

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface Controller {
}

 

@Retention에 사용하는 RetentionPolicy는 SOURCE, CLASS, RUNTIME 이렇게 3가지 속성을 사용할 수 있다. 

* SOURCE

- 커스텀한 어노테이션을 주석처럼 사용하고 싶을 때 사용한다.

- 사용할 경우 컴파일 후 생성된 .class 에 해당 어노테이션 정보가 사라지고 소스코드까지만 유지한다.

- 컴파일 후 해당 어노테이션은 사라진다.

 

* CLASS

- @Retention의 기본값 클래스 타입이다.

- 런타임 시 클래스를 메모리로 읽어오면 해당 정보는 사라진다.

 

* RUNTIME

- 클래스를 메모리에 읽어왔을 때까지 유지한다.

- 코드에서 이 정보를 바탕으로 특정 로직을 실행할 수 있다.

 

📌 어노테이션 부착 클래스 생성

 

HomeController.class

 

생성한 어노테이션을 부착할 클래스를 생성한다.

package com.example.mvcpractice.controller;

import com.example.mvcpractice.annotation.Controller;
// 해당 패키지를 확인하면 사용자 생성 어노테이션임을 알 수 있다.
import com.example.mvcpractice.annotation.RequestMapping;
import com.example.mvcpractice.annotation.RequestMethod;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Controller // 사용자 생성 어노테이션
public class HomeController {

    @RequestMapping(value = "/", method = RequestMethod.GET)
    public String home(HttpServletRequest request, HttpServletResponse response) {
        return "home";
    }
}

 

📌 테스트 코드

 

테스트 클래스 생성

ReflectionTest.class

 

테스트 코드

package com.example.mvcpractice;

import com.example.mvcpractice.annotation.Controller;
import com.example.mvcpractice.annotation.Service;
import org.junit.jupiter.api.Test;
import org.reflections.Reflections;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.lang.annotation.Annotation;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

public class ReflectionTest {
    private static final Logger logger = LoggerFactory.getLogger(ReflectionTest.class);
    // 사용자가 생성한 어노테이션을 로그로 확인한다.

    @Test
    void controllerScan() {
        Set<Class<?>> beans = getTypesAnnotatedWith(List.of(Controller.class, Service.class));

        logger.info("beans: [{}]", beans);
        // beans 에 담긴 내용을 로그를 통해 확인할 수 있다.
    }

    // getTypesAnnotatedWith() 메서드를 통해 Controller과 Service 어노테이션이 부착된 클래스를 찾는다.
    private static Set<Class<?>> getTypesAnnotatedWith(List<Class<? extends Annotation>> annotations) {
        Reflections reflections = new Reflections("com.example.mvcpractice");
        // reflection 의 해당 패키지 밑에 있는 클래스에 대한 정보를 가져온다.

        Set<Class<?>> beans = new HashSet<>();
        annotations.forEach(annotation -> beans.addAll(reflections.getTypesAnnotatedWith(annotation)));
        // reflections.getTypesAnnotatedWith() 의 함수를 사용해 클래스가 위치한 패키지 정보를 담는다.

        return beans;
    }
}

 

실행 결과

어노테이션 Controller와 Service 가 부착된 클래스 정보를 가져왔다.

 

 

테스트 코드2

    @Test
    void showClass() {
        Class<User> clazz = User.class;
        logger.info(clazz.getName());

        logger.info("User all declarde fields [{}]", Arrays.stream(clazz.getDeclaredFields()).collect(Collectors.toList()));
        // getDeclaredFields(): User 클래스에 선언된 모든 필드(String userId, String name)를 가져온다.
        logger.info("User all declarde constructors [{}]", Arrays.stream(clazz.getDeclaredConstructors()).collect(Collectors.toList()));
        // getDeclaredConstructors(): User 클래스에 선언 되어있는 모든 생성자(User(...))를 가져온다.
        logger.info("User all declarde Methods [{}]", Arrays.stream(clazz.getDeclaredMethods()).collect(Collectors.toList()));
        // getDeclaredMethods(): User 클래스에 선언된 메소드(equalsUser(...))를 가져온다.
    }

 

실행 결과

 

📌 끝으로

Reflection을 공부하면서 자주 등장하는 말이 있는데 '굳이 알아야할까?', '활용할 일이 거의 없다' 등이다.

생각처럼 정보를 확인하는 기능이지만, 흔히 사용하게 될 구체적인 클래스를 모를리 없어 사용하지 않는 듯 하다.

그리고 단점으로 알려진 내용들 중, 성능 오버헤드가 있다.

컴파일 타임이 아닌 런타임에 동적으로 타입을 분석하고 정보를 가져오므로 JVM을 최적화 할 수 없다고 한다.

(아직 무슨 소리인지 잘 모르겠지만, 안좋은 것 같다.)

단점이라 말하고 예상못할 부작용을 굳이 감수할 필요는 없기 때문에 사용하지 말자는 결론에 도달했다.

 

찾으면서 배운 어노테이션의 선언코드도 알게되었다.아직까지 직접적으로 어노테이션을 생성하고 사용하기까지 실력이 부족하지만, 좋은 공부가 되었다.

 

 

 

출처 | hudi

자바 리플렉션 (Reflection) 기초

출처 | goodGid

Spring MVC - @Retention 애노테이션

출처 | Tecoble

Reflection API 간단히 알아보자.