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

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

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

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 (). Однако поиск значений может быть намного дороже.

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


person James McMahon    schedule 14.01.2009    source источник
comment
Из jdk api Результатом должно быть краткое, но информативное представление, удобное для чтения. - автоматически сгенерированное значение - хорошее приближение, но иногда вам просто нужно укусить пулю и написать свое собственное.   -  person wds    schedule 14.01.2009
comment
См. Также Автоматическое создание метода toString   -  person Vadzim    schedule 06.12.2013
comment
возможный дубликат java toString для любого объекта   -  person msangel    schedule 03.08.2015
comment
@msangel этот вопрос предшествует этому вопросу на два года. Также этот вопрос отличается в том смысле, что он не спрашивает конкретно об отражении.   -  person James McMahon    schedule 04.08.2015
comment
Поправка, упустил свою точку зрения об отражении. Я думаю, что это на самом деле дубликат этого вопроса.   -  person James McMahon    schedule 04.08.2015


Ответы (7)


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

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

// your code goes here

public String toString() {
   return ReflectionToStringBuilder.toString(this);
}
person krosenvold    schedule 14.01.2009
comment
Да, я действительно видел это сразу после того, как разместил этот вопрос. Меня все еще интересуют подробности. Я собираюсь изучить их код и то, как они его реализуют. - person James McMahon; 14.01.2009
comment
+1. При использовании этого следует понимать, что отражение на порядок медленнее, чем явный доступ к полю. В некоторых случаях, особенно с объектами, которые все еще находятся в разработке и могут быть изменены, отражение является хорошей идеей. В противном случае, вероятно, лучше использовать явный ToStringBuilder - person kdgregory; 14.01.2009

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

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

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

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

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

 new GsonBuilder()
.setPrettyPrinting()
.excludeFieldsWithoutExposeAnnotation()
.create()
.toJson(this);
person Daniel Schmidt    schedule 19.01.2016

С отражением, поскольку я не знал о библиотеке 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());
}
person Steve B.    schedule 14.01.2009

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

person Olivier    schedule 14.01.2009
comment
Это интересно, я лично не использую eclipse, но уверен, что некоторым из моих коллег это будет интересно. - person James McMahon; 14.01.2009

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

person McDowell    schedule 14.01.2009
comment
Это выглядит довольно интересно, мне придется его прочитать, когда у меня будет возможность. Похоже, это действительно хороший подход. Немногое для моей конкретной области, бизнес-приложений, но если бы некоторые из них могли заставить ваш подход работать без сучка и задоринки, из них был бы хороший JSR. - person James McMahon; 14.01.2009

Вы можете использовать уже реализованные библиотеки, например 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;
   }    
}
person catch23    schedule 20.09.2014
comment
Рад, что кто-то предоставил индивидуальное решение, которое я мог настроить. Ни одно из решений OTB не будет печатать имена или модификаторы классов полей. - person TastyWheat; 14.06.2019

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

person James McMahon    schedule 17.03.2009