Field

Field是一个类,位于java.lang.reflect包下。在Java反射中Field类描述的是类的属性信息，功能包括：

  • 获取当前对象的成员变量的类型
  • 对成员变量重新设值

    如何获取Field类对象

    一共有4种方法:

Class.getFields(): 获取类中public类型的属性，返回一个包含某些 Field 对象的数组，该数组包含此 Class 对象所表示的类或接口的所有可访问公共字段
getDeclaredFields(): 获取类中所有的属性(public、protected、default、private)，但不包括继承的属性，返回 Field 对象的一个数组
getField(String name)： 获取类特定的方法，name参数指定了属性的名称
getDeclaredField(String name): 获取类特定的方法，name参数指定了属性的名称

Field 类对象常用方法

  • 获取变量的类型：
    • Field.getType()：返回这个变量的类型
    • Field.getGenericType()：如果当前属性有签名属性类型就返回，否则就返回
    • Field.getType()

isEnumConstant() ： 判断这个属性是否是枚举类

  • 获取成员变量的修饰符
    • Field.getModifiers() 以整数形式返回由此 Field 对象表示的字段的 Java 语言修饰符
  • 获取和修改成员变量的值
    • getName()：获取属性的名字
    • get(Object obj) 返回指定对象obj上此Field表示的字段的值
    • set(Object obj,Object value) 将指定对象变量上此 Field 对象表示的字段设置为指定的新值

      实践

      案例一

      1. /**
      2. * 高亮内容替换原始内容
      3. * 原始Map中是下划线,需要转成对象中的字段数据，通过反射实现对象字段的get 和set方法
      4. * @param list         结果集合
      5. * @param column       高亮结果列
      6. * @param key          主键字段名
      7. * @param highlighting 高亮结果集合
      8. * @param isHigh       是否高亮显示,false - 不显示
      9. */
      10. @SneakyThrows
      11. public static void setHlContent(List<?> list, String[] column, String key, Map<String, Map<String, List<String>>> highlighting, Boolean isHigh) {
      12.    if (ObjectUtil.isEmpty(list) || ObjectUtil.isEmpty(column) || ObjectUtil.isEmpty(key) || !isHigh) {
      13.        return;
      14.    }
      15.    // 通过传递过来的class反射出他的原始对象
      16.    Class<?> var2 = null;
      17.    Method method = null;
      18.    for (Object o : list) {
      19.        var2 = o.getClass();
      20.        String primaryKey = "get".concat(StrUtil.captureName(key));
      21.        method = var2.getDeclaredMethod(primaryKey);
      22.        String value = (String) method.invoke(o);
      23.        Map<String, List<String>> stringListMap = highlighting.get(value);
      24.        // 为每个字段设置值
      25.        for (String field : column) {
      26.            String fieldKey = "set".concat(StrUtil.captureAndLineToHump(field));
      27.            method = var2.getDeclaredMethod(fieldKey, String.class);
      28.            // 获取数据
      29.            List<String> valueList = stringListMap.get(field);
      30.            if (ObjectUtil.isNotEmpty(valueList)) {
      31.                String fieldValue = valueList.get(0);
      32.                method.invoke(o, fieldValue);
      33.            }
      34.        }
      35.    }
      36. }

案例二

  1. //入参：request为原类型的对象，Sring[]为我想从request中保留的字段，我想要返回的类型为JSONObject
  2. public static JSONObject convertJson(Object request, String[] arr) {
  3.     try {
  4.         JSONObject result = new JSONObject();
  5.         if (StringUtils.isNotBlank(request.toString())) {
  6.             //第一步:获取操作类
  7.             Class clazz = request.getClass();
  8.             //第二步：获取此类的所有的公共（public）的字段，返回 Field 对象的一个数组
  9.             Field[] fields = clazz.getFields();
  10.             for (Field field : fields) {
  11.                 //第三步：获取字段的名称
  12.                 String fieldValue = field.getName();
  13.                 if(ArrayUtils.contains(arr,fieldValue)){
  14.                     //第四步：将字段名称和值进行存储
  15.                     result.put(fieldValue,field.get(request));
  16.                 }
  17.             }
  18.         }
  19.         return result;
  20.     } catch (Exception ex) {
  21.         logger.error(ex.getMessage());
  22.         return null;
  23.     }
  24. }

常见错误

set(Object obj, Object value) 时，新value和原value的类型不一致导致，如下：无法转换类型导致的 java.lang.IllegalArgumentException（注意：反射获取或者修改一个变量的值时，编译器不会进行自动装/拆箱，所以int 和Integer需手动修改）
set(Object obj, Object value) 时，修改 final类型的变量导致的 IllegalAccessException。由于 Field 继承自 AccessibleObject , 我们可以使用 AccessibleObject.setAccessible() 方法告诉安全机制，这个变量可以访问即可解决，如field.setAccessible(true)。
getField(String name) 或getFields() 获取非 public 的变量，编译器会报 java.lang.NoSuchFieldException 错。