Java toString (), используя отражение?

Question

На днях я писал toString () для класса в Java, вручную записывая каждый элемент класса в String, и мне пришло в голову, что с помощью отражения можно создать общий метод toString () это может работать на всех классах. И.Е. он определит имена и значения полей и отправит их в строку.

Получить имена полей довольно просто, вот что придумал сотрудник:

public static List initFieldArray(String className) throws ClassNotFoundException {

    Class c = Class.forName(className);
    Field field[] = c.getFields();
    List<String> classFields = new ArrayList(field.length);

    for (int i = 0; i < field.length; i++) {
        String cf = field[i].toString();
        classFields.add(cf.substring(cf.lastIndexOf(".") + 1));
    }

    return classFields;
}

Используя фабрику, я мог бы снизить накладные расходы на производительность, сохранив поля один раз, при первом вызове toString (). Однако поиск значений может быть намного дороже.

Из-за эффективности отражения это может быть более гипотетическим, чем практическим. Но меня интересует идея рефлексии и то, как я могу использовать ее для улучшения своего повседневного программирования.

Answer 1

Apache commons-lang ReflectionToStringBuilder сделает это за вас.

import org.apache.commons.lang3.builder.ReflectionToStringBuilder

// your code goes here

public String toString() {
   return ReflectionToStringBuilder.toString(this);
}

Answer 2

Другой вариант, если вы согласны с JSON, - это библиотека GSON от Google.

public String toString() {
    return new GsonBuilder().setPrettyPrinting().create().toJson(this);
}

Это сделает отражение для вас. Это создает хороший, легко читаемый файл JSON. Легко читаемый, относительный, неопытные люди могут найти JSON пугающим.

Вы также можете сделать GSONBuilder переменной-членом, если не хотите обновлять ее каждый раз.

Если у вас есть данные, которые не могут быть напечатаны (например, поток), или данные, которые вы просто не хотите печатать, вы можете просто добавить теги @Expose к атрибутам, которые хотите распечатать, и затем использовать следующую строку.

 new GsonBuilder()
.setPrettyPrinting()
.excludeFieldsWithoutExposeAnnotation()
.create()
.toJson(this);

Answer 3

с отражением, поскольку я не знал о библиотеке apache:

(помните, что если вы сделаете это, вам, вероятно, придется иметь дело с подобъектами и убедиться, что они печатаются правильно - в частности, массивы не покажут вам ничего полезного)

@Override
public String toString()
{
    StringBuilder b = new StringBuilder("[");
    for (Field f : getClass().getFields())
    {
        if (!isStaticField(f))
        {
            try
            {
                b.append(f.getName() + "=" + f.get(this) + " ");
            } catch (IllegalAccessException e)
            {
                // pass, don't print
            }
        }
    }
    b.append(']');
    return b.toString();
}


private boolean isStaticField(Field f)
{
    return Modifier.isStatic(f.getModifiers());
}

Answer 4

Если вы используете Eclipse, вы также можете взглянуть на JUtils toString generator , который делает это статически (генерируя метод в вашем исходном коде).

Answer 5

Не рефлексия, но я взглянул на генерацию метода toString (вместе с equals / hashCode) в качестве шага после компиляции с использованием манипулирования байт-кодом. Результаты были смешанными.

Answer 6

Вы можете использовать уже реализованные библиотеки, например ReflectionToStringBuilder из Apache commons-lang. Как уже упоминалось.

Или напишите smt, похожий самостоятельно, с помощью API отражения .

Вот пример :

class UniversalAnalyzer {

   private ArrayList<Object> visited = new ArrayList<Object>();

   /**
    * Converts an object to a string representation that lists all fields.
    * @param obj an object
    * @return a string with the object's class name and all field names and
    * values
    */
   public String toString(Object obj) {
      if (obj == null) return "null";
      if (visited.contains(obj)) return "...";
      visited.add(obj);
      Class cl = obj.getClass();
      if (cl == String.class) return (String) obj;
      if (cl.isArray()) {
         String r = cl.getComponentType() + "[]{";
         for (int i = 0; i < Array.getLength(obj); i++) {
            if (i > 0) r += ",";
            Object val = Array.get(obj, i);
            if (cl.getComponentType().isPrimitive()) r += val;
            else r += toString(val);
         }
         return r + "}";
      }

      String r = cl.getName();
      // inspect the fields of this class and all superclasses
      do {
         r += "[";
         Field[] fields = cl.getDeclaredFields();
         AccessibleObject.setAccessible(fields, true);
         // get the names and values of all fields
         for (Field f : fields) {
            if (!Modifier.isStatic(f.getModifiers())) {
               if (!r.endsWith("[")) r += ",";
               r += f.getName() + "=";
               try {
                  Class t = f.getType();
                  Object val = f.get(obj);
                  if (t.isPrimitive()) r += val;
                  else r += toString(val);
               } catch (Exception e) {
                  e.printStackTrace();
               }
            }
         }
         r += "]";
         cl = cl.getSuperclass();
      } while (cl != null);

      return r;
   }    
}

Answer 7

Вот Netbeans, эквивалентный ответу Оливье; плагин smart-codegen для Netbeans .