[Java] Reflection

 

✅  Reflection이란?

 

 - Reflection은 클래스 필드, 메서드의 구체적인 타입이나 정보를 알지 못하더라도

    해당 클래스의 필드, 메서드, 타입들에 접근할 수 있도록 해주는 Java api이다.

 

 - 컴파일타임이 아니라, 런타임에 특정 클래스의 정보를 동적으로 추출한다.

 

 

🐥 이번 포스팅에는 reflection으로 클래스 정보를 어떻게 가져올 수 있는지,

    reflection을 사용하면 왜 좋은지 정리해보고자 한당

 

---

 

우선 아래와 같이 User 클래스를 만들었다.

 

이제 reflection을 통해 User 클래스 외부에서 User 클래스의 필드, 메서드들을 가져와서 사용해볼 것이다.

public class User {

    private String name;
    private int age;

    private User(){
        this.name = "guest";
        this.age = 0;
    }
    
    public User(int age){
        this.name = "guest";
        this.age = age;
    }
    
    public User(String name, int age){
        this.name = name;
        this.age = age;
    }
    
    public String getName(){
        return this.name;
    }
    
    public int getAge(){
        return this.age;
    }
    
    private void setName(String name){
        this.name = name;
    }

}

 

 

 

✅ 클래스 정보 가져오기 (3가지 방법)

 

 - java.lang.Class 클래스 이용

🐥 java.lang.Class 클래스
  - 실행중인 자바 애플리케이션의 클래스와 인터페이스의 정보를 가지고 있는 클래스이다.
  - public constructor가 따로 없고, JVM이 Class object를 자동으로 생성해준다.

 

 

 1️⃣ 클래스타입.class 로 가져오기

Class userClass = User.class;

 

2️⃣ 인스턴스 생성 후, getClass 메서드를 통해 가져오기

User user = new User("user", 20);
Class userClass = user.getClass();

 

3️⃣ 스태틱 메서드 forName()으로 가져오기

Class userClass = Class.forName("com.sy.reflection.User");

 

 

 

✅ get 메서드 vs getDeclared 메서드

 

클래스 정보를 가져왔으면,

java.lang.reflect 패키지의 하위 클래스들을 이용해서 필드와 메서드들에 접근이 가능하다.

여기에는 get으로 시작되는 메서드들과 getDeclared로 시작되는 메서드들이 있다.

 

우선 둘의 차이점부터 알고 차근차근 살펴보도록 하자!

 

get___()	상위 클래스와 인터페이스로부터 상속받은 메서드를 포함하여 모든 public 요소를 가져온다.
getDeclared___()	상위 클래스와 인터페이스로부터 상속받은 메서드를 제외하고, 해당 클래스에 직접 정의한 모든 요소를 접근제어자에 관계 없이 가져온다. (private, protected, public 모두 가져온다는 뜻이다.)

 

 

 

✅  생성자 가져오기

 

 - java.lang.reflect.Constructor 클래스 이용

 

 - getConstructor() 또는 getDeclaredConstructor()를 통해 생성자를 가져오고,

    newInstance 메서드를 사용하여 인스턴스를 생성할 수 있다.

 

 - 생성자에 파라미터가 있는 경우, 파라미터 타입을 순서대로 적어주면 된다.

 

// 생성자 가져오기
Constructor noArgsConstructor = userClass.getDeclaredConstructor();
noArgsConstructor.setAccessible(true); // IllegalAccessException 방지

Constructor oneArgConstructor = userClass.getDeclaredConstructor(int.class);
Constructor allArgsConstructor = userClass.getDeclaredConstructor(String.class, int.class);

// 인스턴스 생성하기 (인스턴스는 Object 타입으로 생성된다.)
User user1 = (User) noArgsConstructor.newInstance();
User user2 = (User) oneArgConstructor.newInstance(30);
User user3 = (User) allArgsConstructor.newInstance("sy", 24);

 

위에서 작성한 User 클래스를 보면

첫번째 생성자는 private으로 작성되어 있고, 나머지 생성자들은 public으로 작성되어 있다.

 

생성자가 private으로 정의되어 있는 경우에는,

두 번째 라인처럼 setAccesible(true) 설정을 미리 해주어야

java.lang.IllegalAccessException이 발생하지 않는다!!!

 

 

✅ 필드 가져오기

 

 - java.lang.reflect.Field 클래스 이용

 

 - 위에서와 마찬가지로 private 필드에 대해서는 setAccesible(true) 로 설정을 해주어야 가져올 수 있다.

 - 위에서와 마찬가지로 필드는 Object 타입으로 가져와지기 때문에 타입캐스팅을 따로 해주어야 한다.

 

 - 필드의 getter가 따로 정의되어 있지 않아도 get메서드를 통해 인스턴스의 필드 value를 가져올 수 있다.

 

User userSy = (User) allArgsConstructor.newInstance("sy", 24);

Field[] fields = userClass.getDeclaredFields();
for(Field field : fields){
        field.setAccessible(true);
        System.out.println("Field type=" + field.getType());
        System.out.println("Field name=" + field.getName());
        System.out.println("Field value=" + field.get(userSy)); // 인스턴스 이름
        System.out.println("--------");
}

/* 
output:
Field type=int
Field name=age
Field value=24
*/

 

 

 - 필드의 setter가 정의되어 있지 않아도, set 메서드를 사용해서 인스턴스의 필드값을 변경할 수 있다.

 

Field nameField = userClass.getDeclaredField("name");
nameField.setAccessible(true);
nameField.set(userSy, "SYSY"); //  인스턴스 이름, 파라미터

System.out.println(nameField.get(userSy)); // output: SYSY

 

 

 

✅ 메서드 가져오기

 

 - java.lang.reflect.Method 이용

 

 - 위에서와 마찬가지로 private 메서드에 대해서는 setAccesible(true) 로 설정을 해주어야 가져올 수 있다.

 - 만약 파라미터를 가지는 메서드라면, 메서드를 가져올 때 파라미터 타입을 순서대로 적어주면 된다.

 

 - invoke 메서드를 이용하여 클래스의 메서드를 직접 호출해 사용할 수 있다.

 

// 메서드 정보 가져오기
Method[] methods = userClass.getDeclaredMethods();
for(Method method : methods){
    method.setAccessible(true);
    System.out.println(method);
}
/*
output:
private void com.sy.reflection.User.setName(java.lang.String)
public int com.sy.reflection.User.getAge()
*/

// invoke() 로 메서드 호출하기
Method setUserName = userClass.getDeclaredMethod("setName", String.class); // 메서드명, 파라미터 타입
setUserName.setAccessible(true);
setUserName.invoke(userSy, "sy"); // 인스턴스명, 파라미터

System.out.println(nameField.get(userSy)); // output: sy

 

 

 

✅  References

 - https://hudi.blog/java-reflection/