SpringのBeanUtils.copyPropertiesメソッド

6885 ワード

  • BeanUtilsのcopyPropertiesメソッドを使用して属性copyを作成します.使用上の注意点:
  • targetとsourceの属性名タイプと名前は同じ
  • でなければならない.
  • 名前大文字小文字機密
  • 名前の大文字と小文字が一致しない場合、またはタイプが一致しない場合は、スキップして属性コピー
  • をしません.
  • 原理copyPropertiesはjdkが持参した自省機構を用いた.自省して簡単に言えばjdkは反射の上でまた1層の包装をして、Beanオブジェクトの属性に対して読み書きします.大まかな論理は次のとおりです.
  • targetオブジェクトのプロパティ
  • を巡回する
  • targetオブジェクト属性を取得するwriteメソッド
  • targetオブジェクトの属性名に基づいてsourceオブジェクトの属性
  • を取得する.
  • 同じ名前の属性がある場合、sourceオブジェクト属性を呼び出すreadメソッドは値
  • を得る.
  • targetオブジェクト属性のwriteメソッドを呼び出し、属性に
  • を割り当てる.
    主なソースコードは以下の通りです:
    public abstract class BeanUtils {
    
        //      
    
        public static void copyProperties(Object source, Object target) throws BeansException {
            copyProperties(source, target, null, (String[]) null);
        }
    
        public static void copyProperties(Object source, Object target, Class> editable) throws BeansException {
            copyProperties(source, target, editable, (String[]) null);
        }
    
        public static void copyProperties(Object source, Object target, String... ignoreProperties) throws BeansException {
            copyProperties(source, target, null, ignoreProperties);
        }
    
        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;
            }
            //  target     ,    class   
            PropertyDescriptor[] targetPds = getPropertyDescriptors(actualEditable);
            //       
            List ignoreList = (ignoreProperties != null ? Arrays.asList(ignoreProperties) : null);
    
            //  target     
            for (PropertyDescriptor targetPd : targetPds) {
                //     
                Method writeMethod = targetPd.getWriteMethod();
                if (writeMethod != null && (ignoreList == null || !ignoreList.contains(targetPd.getName()))) {
                    //  target    ,  source     
                    PropertyDescriptor sourcePd = getPropertyDescriptor(source.getClass(), targetPd.getName());
                    if (sourcePd != null) {
                        //  source      
                        Method readMethod = sourcePd.getReadMethod();
                        //                       ,        
                        if (readMethod != null &&
                                ClassUtils.isAssignable(writeMethod.getParameterTypes()[0], readMethod.getReturnType())) {
                            try {
                                //       public ,   accessible=true
                                if (!Modifier.isPublic(readMethod.getDeclaringClass().getModifiers())) {
                                    readMethod.setAccessible(true);
                                }
                                Object value = readMethod.invoke(source);
                                //       public ,   accessible=true
                                if (!Modifier.isPublic(writeMethod.getDeclaringClass().getModifiers())) {
                                    writeMethod.setAccessible(true);
                                }
                                //target.setXXX(source.getXXX())
                                writeMethod.invoke(target, value);
                            }
                            catch (Throwable ex) {
                                throw new FatalBeanException(
                                        "Could not copy property '" + targetPd.getName() + "' from source to target", ex);
                            }
                        }
                    }
                }
            }
        }
    
        public static PropertyDescriptor[] getPropertyDescriptors(Class> clazz) throws BeansException {
            CachedIntrospectionResults cr = CachedIntrospectionResults.forClass(clazz);
            return cr.getPropertyDescriptors();
        }
    }