JAVA利用反射清除实体类对应字段

JAVA利用反射清除实体类对应字段 前言

  为什么我会记录这篇文章呢，因为我看到项目中有大佬这么写的，我觉得挺不错所以记录下来，以后也可以如此使用。该方法通过**反射**来实现并且封装成单独的方法，以便于所有的实体类都可以便捷的使用。

使用场景

  该工具类适用于某些接口中一些参数不需要需要设置为null，通常我们都是在代码中调用对应字段的set方法显示的去进行设置为null。而该工具类则是通过反射来进行设置，凡是标注了对应注解的字段都会进行清空

工具类 1.自定义忽略字段注解IgnoreField

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface IgnoreField {
}

2.新增工具类

import com.weiyiji.annotation.IgnoreField;

import java.lang.reflect.Field;
import java.util.Collection;

public class BusinessFieldRemoveUtil {

    static String JAVA_LANG_STRING = "java.lang.String";

    public static void removeFields(Object object) throws Exception {
        try {
            removeField(object);
        } catch (Exception e) {
            throw new Exception("不需要的业务字段移除失败" + e.getMessage());
        }
    }

    private static void removeField(Object removeObject) throws IllegalAccessException {
        Class infoClass = removeObject.getClass();
        Field[] infoFieldArray = infoClass.getDeclaredFields();
        for (Field field : infoFieldArray) {
            if (field.isAnnotationPresent(IgnoreField.class)) {
                //字段使用了@WxNeedRemove进行标识
                if (field.getType().getTypeName().equals(JAVA_LANG_STRING)) {
                    field.setAccessible(true);
                    field.set(removeObject, null);
                } else {
                    field.setAccessible(true);
                    Object obj = field.get(removeObject);
                    if (obj == null) {
                        continue;
                    }
                    if (obj instanceof Collection) {
                        Collection collection = (Collection) obj;
                        for (Object o : collection) {
                            if (o != null) {
                                removeField(o);
                            }
                        }
                    } else {
                        removeField(obj);
                    }
                }
            }
        }
    }
}

使用案列 1.我们创建一个用户实体类，并在待忽略字段上添加对应注解

@Data
@Builder
public class User {
  private String name;
  private String address;
  @IgnoreField
  private String email;
  @IgnoreField
  private String qq;
  @IgnoreField
  private String wx;
}

2.测试工具类

  public static void main(String[] args) {
    User build =
        User.builder()
            .name("weiyiji")
            .qq("351094262")
            .address("华阳")
            .wx("zhaobolan520")
            .email("qq.com")
            .build();
    System.out.println(build);
    try {
      BusinessFieldRemoveUtil.removeFields(build);
      System.out.println(build);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

以上代码结果如下：

User(name=weiyiji, address=华阳, email=qq.com, qq=351094262, wx=zhaobolan520)
User(name=weiyiji, address=华阳, email=null, qq=null, wx=null)

可以看到，我们成功的将对应标注了注解的字段内容清空了，此方法可以大大的简化我们的冗余代码，并且可以整个项目通用，还是非常的实用的哟！