[Spring] 객체복사 BeanUtils.copyProperties() & 작동 원리

• 안녕하세요~ 이전에 운영하던 블로그 및 GitHub, 공부 내용을 정리하는 Study-GitHub 가 있습니다!

• 네이버 블로그

• GitHub

• Study-GitHub

• 🐔

---

✔ BeanUtils.copyProperties()

 

안녕하세요, 이번에 정리할 내용은 Spring의 BeanUtils 클래스의 copyProperties 메소드 입니다.

 

 

최근 스프링을 공부하며 Entity와 Dto 사이에서 값을 복사할때 이 메소드를 사용하는걸 봤었는데요,

따라서 정리해보고자 작성하게 되었습니다.

  public UserDto(User source) {
    copyProperties(source, this);

    this.profileImageUrl = source.getProfileImageUrl().orElse(null);
    this.lastLoginAt = source.getLastLoginAt().orElse(null);
  }

 

 

copyProperties 메소드는 원본 객체를 복사할 때 사용하는 메소드인데요,

만약 기존의 객체를 복사할 객체가 필요한데 Setter 메소드로 값을 설정한다면...?

필드의 갯수가 적으면 상관없겠지만, 많아지면 코드도 방대해지고 번거로워지는데요..

이때 copyProperties 메소드를 통해 편하게 복사를 할 수 있습니다. 😘

 

정확한 자료는 공식문서 에서 확인하시면 됩니다!

---

 

✔ copyProperties() 메소드

제 코드에 있는 BeanUtils 클래스는 Spring Framework의 5.2.10 버전이고 최신 버전은 5.3.4 인데요,

최신 버전에서는 메소드가 3개인데 제 코드에는 메소드가 4개가 오버로딩 되어있습니다.

 

Spring Framework 5.2.10

 

Spring Framework 5.3.4

BeanUtils 클래스의 copyProperties 메서드는 위와 같이 세 개의 메소드가 있습니다. 

* Spring Framework 5.3.4 API 입니다.

 

 

두 파라미터는 다음과 같은 특징을 가집니다.

    • 첫 번째 인자인 source 에는 getter 메소드가 존재해야 합니다.

    • 두 번째 인자인 target 에는 setter 메소드가 존재해야 합니다.

 

 

 

메소드의 갯수는 크게 중요하지 않은 것 같고, 다음 두 메소드에 대해 자세히 보면 좋을 것 같습니다. 😁

public static void copyProperties(Object source, Object target) throws BeansException {
    copyProperties(source, target, (Class)null, (String[])null);
}

public static void copyProperties(Object source, Object target, String... ignoreProperties) throws BeansException {
    copyProperties(source, target, (Class)null, ignoreProperties);
}

source는 원본 객체, target는 복사할 객체입니다.

ignoreProperties는 가변 인자로 파라미터를 받고 있는데요, 이는 객체를 복사할 때 설정을 제외할 수 있습니다.

 

 

 

이제 예제를 통해 살펴보겠습니다!

package com.github.prgrms.social.util;

import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;

public class BeanUtil {

    static class Source {
        private String name;
        private int age;
        private String email;

        public Source(String name, int age, String email) {
            this.name = name;
            this.age = age;
            this.email = email;
        }

        public String getName() {
            return name;
        }

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

        public int getAge() {
            return age;
        }

        public void setAge(int age) {
            this.age = age;
        }

        public String getEmail() {
            return email;
        }

        public void setEmail(String email) {
            this.email = email;
        }

        @Override
        public String toString() {
            return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)
                    .append("name", name)
                    .append("age", age)
                    .append("email", email)
                    .toString();
        }
    }

    static class Target {
        private String name;
        private int age;
        private String email;

        public Target(String name, int age, String email) {
            this.name = name;
            this.age = age;
            this.email = email;
        }

        public String getName() {
            return name;
        }

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

        public int getAge() {
            return age;
        }

        public void setAge(int age) {
            this.age = age;
        }

        public String getEmail() {
            return email;
        }

        public void setEmail(String email) {
            this.email = email;
        }

        @Override
        public String toString() {
            return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)
                    .append("name", name)
                    .append("age", age)
                    .append("email", email)
                    .toString();
        }

    }

    public static void main(String[] args) {
        Source source = new Source("JuHyun", 20, "a@a.com");
        Target target = new Target("JuBal", 30, "b@b.com");

        target.setName(source.getName());
        target.setAge(source.getAge());
        target.setEmail(source.getEmail());

        System.out.println(source.toString());
        System.out.println("===================");
        System.out.println(target.toString());
    }

}

 

 

 

 

Source와 Target 클래스에는 name, age, email의 속성이 있고 getter, setter, toString 메소드가 존재합니다.

(사실 위에서 말씀드린대로, Source 클래스에는 getter 메소드만, Target 클래스에는 setter 메소드만 존재해도 정상적으로 작동합니다 😊)

 

기존의 Source 객체를 Target 객체에 복사하기 위해 setter 메소드로 모두 값을 지정해주는데요,

        target.setName(source.getName());
        target.setAge(source.getAge());
        target.setEmail(source.getEmail());

위의 경우 필드가 몇 개 없기에 문제가 되지는 않지만, 이러한 필드가 많아질수록 코드가 방대해질 수 있습니다.

 

 

따라서 위 코드를 BeanUtils 클래스의 copyProperties 메소드를 사용하면 간략하게 객체를 복사할 수 있습니다.

    public static void main(String[] args) {
        Source source = new Source("JuHyun", 20, "a@a.com");
        Target target = new Target("JuBal", 30, "b@b.com");
        
        BeanUtils.copyProperties(source, target);

        System.out.println(source.toString());
        System.out.println("=================================================");
        System.out.println(target.toString());
    }

 

 

위는 Source의 모든 속성을 복사하는 특징이 있는데요,

만약 나는 모든 속성이 아닌 특정 속성만 복사하고자 한다.. 

할때 사용하는 것이 ignoreProperties 파라미터 입니다.

    public static void main(String[] args) {
        Source source = new Source("JuHyun", 20, "a@a.com");
        Target target = new Target("JuBal", 30, "b@b.com");

        BeanUtils.copyProperties(source, target, "age", "email");

        System.out.println(source.toString());
        System.out.println("=================================================");
        System.out.println(target.toString());
    }

위 결과를 보시면 age 와 email은 무시하도록 설정했으므로, 실제적으로는 name 값만 복사가 됩니다.

---

 

 

 

✔ 디버깅

 

실제 복사되는 copyProperties 메소드의 코드는 아래와 같습니다.

private static void copyProperties(Object source, Object target, @Nullable Class<?> editable, @Nullable String... ignoreProperties) throws BeansException {
        Assert.notNull(source, "Source must not be null");
        Assert.notNull(target, "Target must not be null");
        Class<?> actualEditable = target.getClass();
        if (editable != null) {
            if (!editable.isInstance(target)) {
                throw new IllegalArgumentException("Target class [" + target.getClass().getName() + "] not assignable to Editable class [" + editable.getName() + "]");
            }

            actualEditable = editable;
        }

        PropertyDescriptor[] targetPds = getPropertyDescriptors(actualEditable);
        List<String> ignoreList = ignoreProperties != null ? Arrays.asList(ignoreProperties) : null;
        PropertyDescriptor[] var7 = targetPds;
        int var8 = targetPds.length;

        for(int var9 = 0; var9 < var8; ++var9) {
            PropertyDescriptor targetPd = var7[var9];
            Method writeMethod = targetPd.getWriteMethod();
            if (writeMethod != null && (ignoreList == null || !ignoreList.contains(targetPd.getName()))) {
                PropertyDescriptor sourcePd = getPropertyDescriptor(source.getClass(), targetPd.getName());
                if (sourcePd != null) {
                    Method readMethod = sourcePd.getReadMethod();
                    if (readMethod != null && ClassUtils.isAssignable(writeMethod.getParameterTypes()[0], readMethod.getReturnType())) {
                        try {
                            if (!Modifier.isPublic(readMethod.getDeclaringClass().getModifiers())) {
                                readMethod.setAccessible(true);
                            }

                            Object value = readMethod.invoke(source);
                            if (!Modifier.isPublic(writeMethod.getDeclaringClass().getModifiers())) {
                                writeMethod.setAccessible(true);
                            }

                            writeMethod.invoke(target, value);
                        } catch (Throwable var15) {
                            throw new FatalBeanException("Could not copy property '" + targetPd.getName() + "' from source to target", var15);
                        }
                    }
                }
            }
        }

    }

코드가 좀 복잡한데요, 어떻게 동작하는지 궁금해서 디버깅을 통해 간략하게! 살펴보았습니다.

(잘못된 부분이 있으면 말씀해주시면 감사하겠습니다🤞)

 

 

 

위의 두 지점에 포인트를 걸고 디버깅을 실행해 보았습니다.

 

 

 

1) editable 체크

        Assert.notNull(source, "Source must not be null");
        Assert.notNull(target, "Target must not be null");
        Class<?> actualEditable = target.getClass();
        if (editable != null) {
            if (!editable.isInstance(target)) {
                throw new IllegalArgumentException("Target class [" + target.getClass().getName() + "] not assignable to Editable class [" + editable.getName() + "]");
            }

            actualEditable = editable;
        }

먼저 editable은 null이므로 위 문장은 필요가 없습니다.

 

 

 

2) 배열의 길이(필드) 및 ignoreList(속성 무시할 필드) 지정

        PropertyDescriptor[] targetPds = getPropertyDescriptors(actualEditable);
        List<String> ignoreList = ignoreProperties != null ? Arrays.asList(ignoreProperties) : null;
        PropertyDescriptor[] var7 = targetPds;
        int var8 = targetPds.length;

 

위와 같이 targetPds 배열의 길이가 나타나는데요, 

위 actualEditable은 target.getClass() 에서의 Class 입니다.

 

배열의 길이는 필드 갯수와 class를 합친 4 가 됩니다.

또한 ignoreList에 설정을 무시할 property들이 지정이 되는데요,

현재 age와 email을 지정했으므로, 위 ignoreList에는 "age" 와 "email" 의 값이 저장이 됩니다.

 

 

 

3) for문 - 실제 필드 복사

        for(int var9 = 0; var9 < var8; ++var9) {
            PropertyDescriptor targetPd = var7[var9];
            Method writeMethod = targetPd.getWriteMethod();
            if (writeMethod != null && (ignoreList == null || !ignoreList.contains(targetPd.getName()))) {
                PropertyDescriptor sourcePd = getPropertyDescriptor(source.getClass(), targetPd.getName());
                if (sourcePd != null) {
                    Method readMethod = sourcePd.getReadMethod();
                    if (readMethod != null) {
                        ResolvableType sourceResolvableType = ResolvableType.forMethodReturnType(readMethod);
                        ResolvableType targetResolvableType = ResolvableType.forMethodParameter(writeMethod, 0);
                        if (targetResolvableType.isAssignableFrom(sourceResolvableType)) {
                            try {
                                if (!Modifier.isPublic(readMethod.getDeclaringClass().getModifiers())) {
                                    readMethod.setAccessible(true);
                                }

                                Object value = readMethod.invoke(source);
                                if (!Modifier.isPublic(writeMethod.getDeclaringClass().getModifiers())) {
                                    writeMethod.setAccessible(true);
                                }

                                writeMethod.invoke(target, value);
                            } catch (Throwable var17) {
                                throw new FatalBeanException("Could not copy property '" + targetPd.getName() + "' from source to target", var17);
                            }
                        }
                    }
                }
            }
        }

마지막으로 for문 입니다.

위에서는 PropertyDescriptor 배열을 순회하며 ignoreList에 포함된(설정 제외) 필드일 경우, if문을 건너뛰고,

ignoreList에 포함되지 않은(값 복사) 필드일 경우, if문을 통해 실제 값을 복사하는 코드입니다.

 

위와 같이 age, email의 경우 모두 건너뛰지만

name의 경우 if문 내부로 들어가서 값을 복사합니다.

 

 

실제 Target 클래스의 setter를 사용하기 때문에 복사할 객체에는 setter 메소드가 필요합니다.

 

 

 

실제 Source 클래스의 getter를 사용하기 때문에 기존 객체는 getter 메소드가 필요합니다.

 

 

실제 값을 복사하는 부분입니다.

writeMethod의 invoke를 통해 target(복사할 객체)에 value(name="JuHyun") 의 값을 설정합니다.

 

 

 

위 writeMethod.invoke(target, value) 의 내부로 들어가면 위와 같이 setter 메소드가 실행이 됩니다.

리플렉션을 통해 작동하므로, value 값을 target에 값을 설정하는 걸 볼 수 있습니다.