[Spring] 객체복사 BeanUtils.copyProperties

서론 

스프링을 공부하다 보면 객체의 값을 그대로 복사해야 하는 경우가 있습니다. 그럴 때 Setter 메서드로 일일이 모두 작성하는 것은 코드의 길이와 작성 시간이 늘어나고, 가독성이 떨어지게 됩니다. 이때 BeanUtils.copyProperties를 통해 한 줄로 해결할 수 있습니다. 또한, 원하지 않는 값들은 추려내어 원하는 값들만 복사할 수도 있습니다.

BeanUtils.copyProperties

copyProperties은 Spring에서 제공하는 BeanUtils 클래스의 메서드입니다.

사용법은 아래와 같습니다.

BeanUtils.copyProperties(Object source, Object target, String... ignoreProperties)

• source: 원본 객체
• target: 복사 객체
• ignoreProperties: 복사하지 않을 필드명

ignoreProperties는 생략 가능하며, 생략 시 모든 필드가 복사됩니다.

한번 예제를 통해 실험해보겠습니다.

@SpringBootTest
class Test {


    @org.junit.jupiter.api.Test
    public void test() {
        // given
        class User {
            String name;
            int age;
            
            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;
            }


            @Override
            public boolean equals(Object o) {
                if (this == o) return true;
                if (o == null || getClass() != o.getClass()) return false;
                User user = (User) o;
                return age == user.age && Objects.equals(name, user.name);
            }

            @Override
            public int hashCode() {
                return Objects.hash(name, age);
            }
        }

        User user1 = new User();
        user1.setName("안주형");
        user1.setAge(25);

        // when
        User user2 = new User();
        BeanUtils.copyProperties(user1, user2);

        //then
        assertEquals(user1, user2);

        System.out.println("user1: " + user1.getName());
        System.out.println("user1: " + user1.getAge());
        System.out.println("user2: " + user2.getName());
        System.out.println("user2: " + user2.getAge());
    }
}

위 코드의 로직은 다음과 같습니다.

1. User의 인스턴스 {name: "안주형", age:25}인 인스턴스 user1 생성
2. User의 인스턴스 user2를 생성
3. user1의 필드 값을 user2에 복사
4. 객체의 주소가 아닌 필드 값을 비교하기 위해 equals와 hashCode 오버라이딩
5. assertEquals(user1, user2)를 통한 테스트

코드의 수행 결과는 다음과 같습니다.

코드 수행결과

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);

   for (PropertyDescriptor targetPd : targetPds) {
      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);

               // Ignore generic types in assignable check if either ResolvableType has unresolvable generics.
               boolean isAssignable =
                     (sourceResolvableType.hasUnresolvableGenerics() || targetResolvableType.hasUnresolvableGenerics() ?
                           ClassUtils.isAssignable(writeMethod.getParameterTypes()[0], readMethod.getReturnType()) :
                           targetResolvableType.isAssignableFrom(sourceResolvableType));

               if (isAssignable) {
                  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 ex) {
                     throw new FatalBeanException(
                           "Could not copy property '" + targetPd.getName() + "' from source to target", ex);
                  }
               }
            }
         }
      }
   }
}

 

주의

복사하려는 양쪽 객체에 Setter가 구현되어 있어야만 동작합니다.

 

참고

https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/beans/BeanUtils.html