Java Bean轉Map的那些踩坑實戰

2022-07-10 10:00:28

一、背景

有些業務場景下需要將 Java Bean 轉成 Map 再使用。

以為很簡單場景，但是坑很多。

二、那些坑

2.0 測試物件

import lombok.Data;
import java.util.Date;

@Data
public class MockObject extends  MockParent{
    private Integer aInteger;
    private Long aLong;
    private Double aDouble;
    private Date aDate;
}

父類別

import lombok.Data;

@Data
public class MockParent {
    private Long parent;
}

2.1 JSON 反序列化了型別丟失

2.1.1 問題復現

將 Java Bean 轉 Map 最常見的手段就是使用 JSON 框架，如 fastjson 、 gson、jackson 等。但使用 JSON 將 Java Bean 轉 Map 會導致部分資料型別丟失。如使用 fastjson ，當屬性為 Long 型別但數位小於 Integer 最大值時，反序列成 Map 之後，將變為 Integer 型別。

maven 依賴：

<!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>2.0.8</version>
        </dependency>

範例程式碼：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.TypeReference;

import java.util.Date;
import java.util.Map;

public class JsonDemo {
    public static void main(String[] args) {
        MockObject mockObject = new MockObject();
        mockObject.setAInteger(1);
        mockObject.setALong(2L);
        mockObject.setADate(new Date());
        mockObject.setADouble(3.4D);
        mockObject.setParent(3L);
       String json = JSON.toJSONString(mockObject);
        Map<String,Object> map =  JSON.parseObject(json, new TypeReference<Map<String,Object>>(){});
        System.out.println(map);
    }
}

結果列印：

{"parent":3,"ADouble":3.4,"ALong":2,"AInteger":1,"ADate":1657299916477}

偵錯截圖：

通過 Java Visualizer 外掛進行視覺化檢視：

2.2.2 問題描述

存在兩個問題（1）通過 fastjson 將 Java Bean 轉為 Map ，型別會發生轉變。如 Long 變成 Integer ，Date 變成 Long, Double 變成 Decimal 型別等。（2）在某些場景下，Map 的 key 並非和屬性名完全對應，像是通過 get set 方法“推斷”出來的屬性名。

2.2 BeanMap 轉換屬性名錯誤

2.2.1 commons-beanutils 的 BeanMap

maven 版本：

<!-- https://mvnrepository.com/artifact/commons-beanutils/commons-beanutils -->
<dependency>
    <groupId>commons-beanutils</groupId>
    <artifactId>commons-beanutils</artifactId>
    <version>1.9.4</version>
</dependency>

程式碼範例：

import org.apache.commons.beanutils.BeanMap;
import third.fastjson.MockObject;
import java.util.Date;
public class BeanUtilsDemo {
    public static void main(String[] args) {
        MockObject mockObject = new MockObject();
        mockObject.setAInteger(1);
        mockObject.setALong(2L);
        mockObject.setADate(new Date());
        mockObject.setADouble(3.4D);
        mockObject.setParent(3L);
        BeanMap beanMap = new BeanMap(mockObject);
        System.out.println(beanMap);
    }
}

偵錯截圖：

存在和 cglib 一樣的問題，雖然型別沒問題但是屬性名還是不對。

原因分析：

   /**
     * Constructs a new <code>BeanMap</code> that operates on the
     * specified bean.  If the given bean is <code>null</code>, then
     * this map will be empty.
     *
     * @param bean  the bean for this map to operate on
     */
    public BeanMap(final Object bean) {
        this.bean = bean;
        initialise();
    }

關鍵程式碼：

    private void initialise() {
        if(getBean() == null) {
            return;
        }

        final Class<? extends Object>  beanClass = getBean().getClass();
        try {
            //BeanInfo beanInfo = Introspector.getBeanInfo( bean, null );
            final BeanInfo beanInfo = Introspector.getBeanInfo( beanClass );
            final PropertyDescriptor[] propertyDescriptors = beanInfo.getPropertyDescriptors();
            if ( propertyDescriptors != null ) {
                for (final PropertyDescriptor propertyDescriptor : propertyDescriptors) {
                    if ( propertyDescriptor != null ) {
                        final String name = propertyDescriptor.getName();
                        final Method readMethod = propertyDescriptor.getReadMethod();
                        final Method writeMethod = propertyDescriptor.getWriteMethod();
                        final Class<? extends Object> aType = propertyDescriptor.getPropertyType();

                        if ( readMethod != null ) {
                            readMethods.put( name, readMethod );
                        }
                        if ( writeMethod != null ) {
                            writeMethods.put( name, writeMethod );
                        }
                        types.put( name, aType );
                    }
                }
            }
        }
        catch ( final IntrospectionException e ) {
            logWarn(  e );
        }
    }

偵錯一下就會發現，問題出在 BeanInfo 裡面 PropertyDescriptor 的 name 不正確。

經過分析會發現 java.beans.Introspector#getTargetPropertyInfo 方法是欄位解析的關鍵

對於無參的以 get 開頭的方法名從 index =3 處擷取，如 getALong 擷取後為 ALong，如 getADouble 擷取後為 ADouble。

然後去構造 PropertyDescriptor:

/**
     * Creates <code>PropertyDescriptor</code> for the specified bean
     * with the specified name and methods to read/write the property value.
     *
     * @param bean   the type of the target bean
     * @param base   the base name of the property (the rest of the method name)
     * @param read   the method used for reading the property value
     * @param write  the method used for writing the property value
     * @exception IntrospectionException if an exception occurs during introspection
     *
     * @since 1.7
     */
    PropertyDescriptor(Class<?> bean, String base, Method read, Method write) throws IntrospectionException {
        if (bean == null) {
            throw new IntrospectionException("Target Bean class is null");
        }
        setClass0(bean);
        setName(Introspector.decapitalize(base));
        setReadMethod(read);
        setWriteMethod(write);
        this.baseName = base;
    }

底層使用 java.beans.Introspector#decapitalize 進行解析：

   /**
     * Utility method to take a string and convert it to normal Java variable
     * name capitalization.  This normally means converting the first
     * character from upper case to lower case, but in the (unusual) special
     * case when there is more than one character and both the first and
     * second characters are upper case, we leave it alone.
     * <p>
     * Thus "FooBah" becomes "fooBah" and "X" becomes "x", but "URL" stays
     * as "URL".
     *
     * @param  name The string to be decapitalized.
     * @return  The decapitalized version of the string.
     */
    public static String decapitalize(String name) {
        if (name == null || name.length() == 0) {
            return name;
        }
        if (name.length() > 1 && Character.isUpperCase(name.charAt(1)) &&
                        Character.isUpperCase(name.charAt(0))){
            return name;
        }
        char chars[] = name.toCharArray();
        chars[0] = Character.toLowerCase(chars[0]);
        return new String(chars);
    }

從程式碼中我們可以看出 (1) 當 name 的長度 > 1，且第一個字元和第二個字元都大寫時，直接返回引數作為PropertyDescriptor name。 (2) 否則將 name 轉為首字母小寫

這種處理本意是為了不讓屬性為類似 URL 這種縮略詞轉為 uRL ，結果“誤傷”了我們這種場景。

2.2.2 使用 cglib 的 BeanMap

cglib 依賴

<!-- https://mvnrepository.com/artifact/cglib/cglib -->
   <dependency>
            <groupId>cglib</groupId>
            <artifactId>cglib-nodep</artifactId>
            <version>3.2.12</version>
   </dependency>

程式碼範例：

import net.sf.cglib.beans.BeanMap;
import third.fastjson.MockObject;
import java.util.Date;
public class BeanMapDemo {
    public static void main(String[] args) {
        MockObject mockObject = new MockObject();
        mockObject.setAInteger(1);
        mockObject.setALong(2L);
        mockObject.setADate(new Date());
        mockObject.setADouble(3.4D);
        mockObject.setParent(3L);
        
        BeanMap beanMapp = BeanMap.create(mockObject);
        System.out.println(beanMapp);
    }
}

結果展示：

我們發現型別對了，但是屬性名依然不對。

關鍵程式碼： net.sf.cglib.core.ReflectUtils#getBeanGetters 底層也會用到 java.beans.Introspector#decapitalize 所以屬性名存在一樣的問題就不足為奇了。

三、解決辦法

3.1 解決方案

解決方案有很多，本文提供一個基於 dubbo的解決方案。

maven 依賴：

<!-- https://mvnrepository.com/artifact/org.apache.dubbo/dubbo -->
<dependency>
    <groupId>org.apache.dubbo</groupId>
    <artifactId>dubbo</artifactId>
    <version>3.0.9</version>
</dependency>

範例程式碼：

import org.apache.dubbo.common.utils.PojoUtils;
import third.fastjson.MockObject;
import java.util.Date;
public class DubboPojoDemo {
    public static void main(String[] args) {
        MockObject mockObject = new MockObject();
        mockObject.setAInteger(1);
        mockObject.setALong(2L);
        mockObject.setADate(new Date());
        mockObject.setADouble(3.4D);
        mockObject.setParent(3L);

        Object generalize = PojoUtils.generalize(mockObject);

        System.out.println(generalize);
    }
}

偵錯效果：

Java Visualizer 效果：

3.2 原理解析

大家可以下載原始碼來簡單研究下。 github.com/apache/dubb…

核心程式碼： org.apache.dubbo.common.utils.PojoUtils#generalize(java.lang.Object)

public static Object generalize(Object pojo) {
     eturn generalize(pojo, new IdentityHashMap());
}

關鍵程式碼：

// pojo 待轉換的物件
// history 快取 Map，提高效能
 private static Object generalize(Object pojo, Map<Object, Object> history) {
        if (pojo == null) {
            return null;
        }

         // 列舉直接返回列舉名
        if (pojo instanceof Enum<?>) {
            return ((Enum<?>) pojo).name();
        }
        
        // 列舉陣列，返回列舉名陣列
        if (pojo.getClass().isArray() && Enum.class.isAssignableFrom(pojo.getClass().getComponentType())) {
            int len = Array.getLength(pojo);
            String[] values = new String[len];
            for (int i = 0; i < len; i++) {
                values[i] = ((Enum<?>) Array.get(pojo, i)).name();
            }
            return values;
        }

        // 基本型別返回 pojo 自身
        if (ReflectUtils.isPrimitives(pojo.getClass())) {
            return pojo;
        }

        // Class 返回 name
        if (pojo instanceof Class) {
            return ((Class) pojo).getName();
        }

        Object o = history.get(pojo);
        if (o != null) {
            return o;
        }
        history.put(pojo, pojo);

// 陣列型別，遞迴
        if (pojo.getClass().isArray()) {
            int len = Array.getLength(pojo);
            Object[] dest = new Object[len];
            history.put(pojo, dest);
            for (int i = 0; i < len; i++) {
                Object obj = Array.get(pojo, i);
                dest[i] = generalize(obj, history);
            }
            return dest;
        }
// 集合型別遞迴
        if (pojo instanceof Collection<?>) {
            Collection<Object> src = (Collection<Object>) pojo;
            int len = src.size();
            Collection<Object> dest = (pojo instanceof List<?>) ? new ArrayList<Object>(len) : new HashSet<Object>(len);
            history.put(pojo, dest);
            for (Object obj : src) {
                dest.add(generalize(obj, history));
            }
            return dest;
        }
        // Map 型別，直接 對 key 和 value 處理
        if (pojo instanceof Map<?, ?>) {
            Map<Object, Object> src = (Map<Object, Object>) pojo;
            Map<Object, Object> dest = createMap(src);
            history.put(pojo, dest);
            for (Map.Entry<Object, Object> obj : src.entrySet()) {
                dest.put(generalize(obj.getKey(), history), generalize(obj.getValue(), history));
            }
            return dest;
        }
        Map<String, Object> map = new HashMap<String, Object>();
        history.put(pojo, map);
        
        // 開啟生成 class 則寫入 pojo 的class
        if (GENERIC_WITH_CLZ) {
            map.put("class", pojo.getClass().getName());
        }
        
      // 處理 get 方法 
        for (Method method : pojo.getClass().getMethods()) {
            if (ReflectUtils.isBeanPropertyReadMethod(method)) {
                ReflectUtils.makeAccessible(method);
                try {
                    map.put(ReflectUtils.getPropertyNameFromBeanReadMethod(method), generalize(method.invoke(pojo), history));
                } catch (Exception e) {
                    throw new RuntimeException(e.getMessage(), e);
                }
            }
        }
        // 處理公有屬性
        for (Field field : pojo.getClass().getFields()) {
            if (ReflectUtils.isPublicInstanceField(field)) {
                try {
                    Object fieldValue = field.get(pojo);
                    // 物件已經解析過，直接從快取裡讀提高效能
                    if (history.containsKey(pojo)) {
                        Object pojoGeneralizedValue = history.get(pojo);
                        // 已經解析過該屬性則跳過（如公有屬性，且有 get 方法的情況）
                        if (pojoGeneralizedValue instanceof Map
                            && ((Map) pojoGeneralizedValue).containsKey(field.getName())) {
                            continue;
                        }
                    }
                    if (fieldValue != null) {
                        map.put(field.getName(), generalize(fieldValue, history));
                    }
                } catch (Exception e) {
                    throw new RuntimeException(e.getMessage(), e);
                }
            }
        }
        return map;
    }

關鍵截圖

org.apache.dubbo.common.utils.ReflectUtils#getPropertyNameFromBeanReadMethod

public static String getPropertyNameFromBeanReadMethod(Method method) {
        if (isBeanPropertyReadMethod(method)) {
            // get 方法，則從 index =3 的字元小寫 + 後面的字串
            if (method.getName().startsWith("get")) {
                return method.getName().substring(3, 4).toLowerCase()
                        + method.getName().substring(4);
            }
            // is 開頭方法， index =2 的字元小寫 + 後面的字串
            if (method.getName().startsWith("is")) {
                return method.getName().substring(2, 3).toLowerCase()
                        + method.getName().substring(3);
            }
        }
        return null;
    }

因此， getALong 方法對應的屬性名被解析為 aLong。