JAVA | 리플렉션(Reflection) 알기

리플렉션이란 ?

---

1. 리플렉션(Reflection)

: 실행 중인 프로그램의 클래스, 메서드, 필드 등에 대한 정보를 얻거나 조작하는 기능을 제공하는 API

• 클래스의 정보 분석, 인스턴스 생성, 메서드 호출, 필드의 값을 가져오거나 설정 등의 작업 수행

 

2. 리플렉션이 이용되는 상황

1. 런타임 시에 동적으로 클래스를 로드해야 하는 경우

2. 클래스의 구조, 메서드, 필드 등에 대한 정보를 가져와서 분석해야 하는 경우

3. 클래스의 인스턴스를 생성하거나 메서드를 호출하거나 필드의 값을 변경해야 하는 경우

 

위의 설명으로는 이해가 어려우니 조금 더 알아보도록 하자.

 

---

# CASE 1

---

첫번째 경우에서, 다음과 같이 1차 개발자는 "/login"을 입력 받았을 때 uc.login() 메서드가 호출되도록,

"/join"을 입력 받았을 때 uc.join() 메서드가 호출되도록 하는 application을 만들었다.

 

import java.util.Scanner;

// 1차 개발자
public class App {
    public static void main(String[] args) {
        Scanner sc = new Scanner(System.in);
        String path = sc.nextLine();

        // path = "/login" -> uc.login()
        // path = "/join" -> uc.join();
        UserController uc = new UserController();

        if(path.equals("/login")){
            uc.login();
        }else if(path.equals("/join")){
            uc.join();
        }
    }
}

 

이 프로그램은 실행 시켰을 때 잘 돌아가기 때문에 잘 만들어진 프로그램이라고 볼 수 있다.

 

그렇다면, 이와 같은 프로그램을 2차 개발자가 사용하기 위해서는 무슨 정보가 필요할까 ?

 

다음과 같이 1. 메서드 명과 2. 클래스 명이 필요할 것이다.

 

// 2차 개발자
public class UserController {
    public void login(){
        System.out.println("login() 호출됨");
    }

    public void join(){
        System.out.println("join() 호출됨");
    }
}

 

하지만 1차 개발자는 일일이 메서드 명과 클래스 명을 전달하는 것보다 interface를 통해 메서드를 작성하고, override를 통해 구현하도록 하는 것이 더 편리할 것이다.

 

/*
	작성자 : 홍길동
    주의사항 : 구현체는 UserController로 해주세요 
*/

public interface UserCon {
	void login();
	void join();
}

 

그런데 여기서 2차 개발자가 새로운 기능을 추가하기 위해 메서드를 새로 생성한다면 어떻게 될까 ?

 

2차 개발자가 생성한 메서드는 당연히 작동되지 않을 거고 이와 같은 상황을 해결하기 위해서는 1차 개발자가 작성한 interface를 같이 수정해줘야 한다. (불필요한 유지보수)

 

결국 협업이 아닌, 판매를 위한 프로그램이라면 이 프로그램은 판매가 되지 않을 것이다. (OCP 위배 ?)

 

---

# CASE 2

---

두번째 경우이다. 이번에는 에너테이션을 활용해보려고 한다.

 

아래의 에너테이션은 메서드가 실행될 때 uri의 주소를 분석하는 에너테이션이다.

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

@Target(ElementType.METHOD) // 위치 = 메서드
@Retention(RetentionPolicy.RUNTIME) // 타이밍 = 실행시
public @interface RequestMapping {
    String uri();
}

 

그 결과로 @RequestMapping에 uri가 어떻게 들어오는지에 따라 다른 메서드를 실행하게 한다.

 

public class UserController {
    @RequestMapping(uri = "/login")
    public void login(){
        System.out.println("login() 호출됨");
    }

    @RequestMapping(uri = "/join")
    public void join(){
        System.out.println("join() 호출됨");
    }
}

 

다음 App 클래스에서 scanner를 통해 uri값을 입력 받고 findUri로 UserController() 객체와 uri가 매개변수로 들어간다.

findUri는 uri를 분석해 컨트롤러의 메서드를 실행한다.

 

import java.io.File;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.HashSet;
import java.util.Scanner;
import java.util.Set;

public class App {

    // 내용 분석해보기 혼자 !!!!!!!!
    // uri 분석해 컨트롤러의 메서드 실행해
    public static void findUri(UserController uc, String uri) throws Exception {
        boolean isFind = false;

        Method[] methods = uc.getClass().getDeclaredMethods(); // 2개

        for (Method mt : methods) {
            Annotation anno = mt.getDeclaredAnnotation(RequestMapping.class);
            RequestMapping rm = (RequestMapping) anno;
            if (rm.uri().equals(uri)) {
                isFind = true;
                mt.invoke(uc); // 해당 메서드를 실행 시켜라
            }
        }

        if(isFind == false){
            System.out.println("404 Not Found");
        }
    }

    public static void main(String[] args) throws Exception {
        Scanner sc = new Scanner(System.in);
        String uri = sc.nextLine();

        findUri(new UserController(), uri);

    }

}

 

이제는 UserController 안에서 새로운 메서드를 생성해도 @RequestMapping을 붙이면 실행이 되기 때문에 판매할 수 있는 프로그램이 된 것 같기도 하다.

 

 

하지만, 새로운 컨트롤러를 만들고 싶다면?

 

public class BoardController {

	@RequestMapping(uri = "/save")
    public void save() { System.out.println("save() 호출됨"); }
    
}

 

App 클래스에서 UserController 메서드만 findUri로 처리하고 있기 때문에, 이 BoardController를 호출할 수 있는 방법은 없다. 

---

# CASE 3

---

import java.io.File;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.net.URL;
import java.util.HashSet;
import java.util.Scanner;
import java.util.Set;

public class App {

    public static Set<Class> componentScan(String pkg) throws Exception {

        // 현재 App 파일의 경로
        ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
        Set<Class> classes = new HashSet<>();

        URL packageUrl = classLoader.getResource(pkg);
        File packageDirectory = new File(packageUrl.toURI());
        for (File file : packageDirectory.listFiles()) {
            if (file.getName().endsWith(".class")) {
                String className = pkg + "." + file.getName().replace(".class", "");
                //System.out.println(className);
                Class cls = Class.forName(className);
                classes.add(cls);
            }
        }
        return classes;
    }

    public static void findUri(Set<Class> classes, String uri) throws Exception {
        boolean isFind = false;
        for (Class cls : classes) {
            if (cls.isAnnotationPresent(Controller.class)) {
                Object instance = cls.newInstance();
                Method[] methods = cls.getDeclaredMethods();

                for (Method mt : methods) {
                    Annotation anno = mt.getDeclaredAnnotation(RequestMapping.class);
                    RequestMapping rm = (RequestMapping) anno;
                    if (rm.uri().equals(uri)) {
                        isFind = true;
                        mt.invoke(instance);
                    }
                }
            }
        }
        if(isFind == false){
            System.out.println("404 Not Found");
        }
    }

    public static void main(String[] args) throws Exception {
        Scanner sc = new Scanner(System.in);
        String uri = sc.nextLine();

        Set<Class> classes = componentScan("ex03");
        findUri(classes, uri);

    }

}

 

이제 변경사항이 눈에 띌텐데, componentScan 메서드를 이용해 package 내에 있는 모든 클래스를 classes에 넣는다.

 

이때의 componentScan 메서드에서는 

 

1, Thread.currentThread().getContext.ClassLoader()를 이용하여 현재 실행 중인 쓰레드의 클래스 로더를 얻어와서 해당 클래스 로더에게 resource 찾는 역할을 부여하고,

2. classes라는 hashset을 생성한다.

3. 리소스에서 해당 패키지의 Url을 읽어 packageDirectory에 저장한다.

4. 이 디렉토리의 파일들을 for문을 통해 .class로 끝나는 파일들만 찾는다.

5. 파일들을 그렇게 찾은 class들을 classes에 저장한다. 

 

그리고 findUri는 클래스들의 갯수만큼 for문을 통해 반복하고 해당 클래스의 어노테이션이 controller이면 clc.newInstance()를 통해 메모리를 띄운다. (동적 분석)

그 뒤는 case2의 경우와 같이 메서드를 반복하며 uri를 확인하고 메서드를 호출한다.

 

이와 같이 변경하게 되면, 다른 개발자들이 새로운 controller를 만들든 메서드를 만들든 모두 적절하게 사용될 수 있다.

 

---

결론

---

자바에서의 리플렉션

구체적인 클래스 타입을 알지 못해도 그 클래스의 메소드와 타입 그리고 변수들을 접근할 수 있도록 해주는 자바 API 이다.

> 위의 예시에서 CASE 3의 componentScan 메서드가 하는 일을 리플렉션이라고 할 수 있다.