Java 反射之实现 Map 转 Bean 操作

引子：

闲来无事突然想温习一下 java 的反射机制，于是就写了这篇通过反射实现集合转对象的底层操作。先说说学习反射机制都有哪些好处，首先大部分的框架源码多多少少都使用到了 java 反射，所以掌握以后可以增强我们阅读源码的能力。其次呢在项目中我们也可以写一些简单的工具类方法，比如 JSON 转 Bean，Copy Bean 等操作，这样的好处是我们可以针对业务逻辑去进行特殊处理，改起来也更加的方便。当然，别人写好的工具类，功能齐全，使用方便简单，相对来说还是更香的，比如常用的阿里提供的工具类、HuTool 等都很不错。下面也可以单纯当做回顾 java 反射知识来进行阅读。

正文：

介绍：mapToObject() 该方法可以将 Map 集合转换为对象，但是 Map 的** Key 值必须和 Bean 的属性名保持一致！**并且该方法不止可以转换 Map 集合， 包括 HttpServletRequest 请求、List集合等，只要遵守 key 值和对象属性名保持一致的原则就可以实现转换为 Bean 的需求。

---

接下来我们通过测试代码来了解该方法的使用和实现：
第一步，实体类的编写:

import lombok.Data;

import java.io.Serializable;

/**
 * User 实体类
 * 我们直接使用 lombok 来实现 get、set 的生成，不使用 lombok 的情况下也不会影响。
 */

@Data
public class User implements Serializable {

    private static final long serialVersionUID = 1L;
    private Integer id;
    private String userName;
    private String passWord;
    private Integer roleId;
    private Role role;
    private Permission permission;

}

第二步，Map 转换 Bean 方法（核心代码）：

   /**
     * 将 map 转换为 bean 对象
     * @param map 需要转换的 map 集合
     * @param clazz 需要转换的 bean 类型
     * @return
     */
    static Object mapToObject(HashMap<String, Object> map, Class clazz) {
        Object obj = null;
        ArrayList<String> nameList = new ArrayList<>(); // 初始化需要设置属性的集合
        if (map == null || clazz == null) {
            throw new NullPointerException("map => " + map + ", class => " + clazz);
        }
        try {
            Method[] methods = clazz.getMethods();
            for (int i = 0; i < methods.length; i++) {
                Method method = methods[i];
                String methodName = method.getName(); // 获取方法名
                // 判断该方法是否为 set 方法
                if (methodName.substring(0, 3).equals("set")) {
                    // 获取当前 set 的参数类型和名称
                    String name = methodName.substring(3);
                    Class<?>[] types = method.getParameterTypes();
                    // decapitalize 方法返回结果举例：“FooBah”变成了“fooBah”，“X”变成“X”，但“URL”保持为“URL”。
                    name = Introspector.decapitalize(name);
                    nameList.add(name); // 将需要set的值放入集合
                }
            }

            System.out.println("=============== 给对象 set 属性赋值开始 ===============");
            // 实例化对象
            obj = clazz.newInstance();
            // 获取该类的所有属性
            Field[] fields = clazz.getDeclaredFields();
            for (Field field : fields) {
                field.setAccessible(true); // 设置为 true 才能给属性设置值
                if (nameList.contains(field.getName())) {
                    System.out.println("属性 "+ field.getName() + " 设置值："+ map.get(field.getName()));
                    field.set(obj, map.get(field.getName()));  // 设置属性
                }
            }
            System.out.println("=============== 给对象 set 属性赋值结束 ===============");
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
        return obj;
    }

测试 Demo:

    public static void main(String[] args) {
        HashMap<String, Object> map = new HashMap<>();
        map.put("id", 1);
        map.put("userName", "lisa");
        map.put("passWord", "123");
        User user = (User) getUser(map, User.class);
        System.out.println(user);

    }

输出结果：

=============== 给对象 set 属性赋值开始 ===============
属性 id 设置值：1
属性 userName 设置值：lisa
属性 passWord 设置值：123
属性 roleId 设置值：null
属性 role 设置值：null
属性 permission 设置值：null
=============== 给对象 set 属性赋值结束 ===============
User(id=1, userName=lisa, passWord=123, roleId=null, role=null, permission=null)

---

但是从上面有一个问题，就是 User 对象里面还有一个 Role 对象和 Permission 对象。这两个对象里面的值怎么给它设置进去呢？就像我们使用 Spring 项目时，Controller 层方法直接以对象的形式接收数据一样，只要你传值正确，Spring 是可以将实体类以及实体类里面包含的其他实体类属性都进行赋值操作的，但是这需要有一个标识来说明这个属性是 bean 才行，所以我们接下来使用一个自定义的注解来实现这个功能。

新增 MappingObject 注解类：

import java.lang.annotation.*;

/**
 * 声明这是一个需要映射的对象,比如:
 * class User {
 *      private int id;
 *      @MappingObject
 *      private Rule rule;
 * }
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MappingObject {
    
}

更新后的 Map 转换 Bean 方法（核心代码）：

    /**
     * 将 map 转换为 bean 对象
     * @param map 需要转换的 map 集合
     * @param clazz 需要转换的 bean 类型
     * @return
     */
    static Object mapToObject(HashMap<String, Object> map, Class clazz) {
        Object obj = null;
        ArrayList<String> nameList = new ArrayList<>(); // 初始化需要设置属性的集合
        if (map == null || clazz == null) {
            throw new NullPointerException("map => " + map + ", class => " + clazz);
        }
        try {
            Method[] methods = clazz.getMethods();
            for (int i = 0; i < methods.length; i++) {
                Method method = methods[i];
                String methodName = method.getName(); // 获取方法名
                // 判断该方法是否为 set 方法
                if (methodName.substring(0, 3).equals("set")) {
                    // 获取当前 set 的参数类型和名称
                    String name = methodName.substring(3);
                    // decapitalize 方法返回结果举例：“FooBah”变成了“fooBah”，“X”变成“X”，但“URL”保持为“URL”。
                    name = Introspector.decapitalize(name);
                    nameList.add(name); // 将需要set的值放入集合
                }
            }

            System.out.println("=============== 给对象 " + clazz + "属性赋值开始 ===============");
            // 实例化对象
            obj = clazz.newInstance();
            // 获取该类的所有属性
            Field[] fields = clazz.getDeclaredFields();
            for (Field field : fields) {
                field.setAccessible(true); // 设置为 true 才能给属性设置值
                if (nameList.contains(field.getName())) {
                    // 获取该属性上的 MappingObject 注解
                    MappingObject mappingObject = field.getDeclaredAnnotation(MappingObject.class);
                    if (mappingObject != null) {
                        Class<?> type = field.getType();
                        Object o = mapToObject(map, type);
                        field.set(obj, o); // 递归设置内置对象属性
                    }else {
                        field.set(obj, map.get(field.getName()));  // 设置属性
                    }
                }
            }
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
        return obj;
    }

测试 Demo :

    public static void main(String[] args) {
        HashMap<String, Object> map = new HashMap<>();
        map.put("id", 1);
        map.put("userName", "lisa");
        map.put("passWord", "123");
        map.put("roleId", 1);
        map.put("roleName", "123");
        map.put("peId", 101);
        map.put("permissionName", "alibaba");
        User user = (User) mapToObject(map, User.class);
        System.out.println(user);
    }

输出结果：

=============== 给对象 class com.fjc.demo.pojo.User属性赋值开始 ===============
=============== 给对象 class com.fjc.demo.pojo.Role属性赋值开始 ===============
=============== 给对象 class com.fjc.demo.pojo.Permission属性赋值开始 ===============
User(id=1, userName=lisa, passWord=123, roleId=1, role=Role(roleId=1, roleName=123), permission=Permission(peId=101, permissionName=alibaba, roleId=1))

end.