Java: получение свойств класса для построения строкового представления

Скажем, у меня есть класс, подобный этому (а также предположим, что все частные переменные:

public class Item {
    private String _id = null;
    private String _name = null;
    private String _description = null;

        ...
}

Теперь, если я хочу построить представление toString() этого класса, я бы сделал что-то вроде этого внутри класса Item:

@Override
public String toString() {
    return (_id + " " + _name + " " + _description);
}

Но что, если я скажу 15 частных переменных внутри класса? Должен ли я записывать имя каждой переменной как это?

В идеале, я хотел бы закончить задачу, выполнив итерацию через список частных переменных этого класса и построив строковое представление:

@Override
public String toString() {
    ArrayList<String> members = getClass().getMembers(); //Some method like this
    String string = "";
    for(...)
        string += members[i] + " ";
}

Или, возможно, метод toJSON, мне все равно нужен доступ к именам этих переменных. Любые предложения?

Ответ 1

Вы можете сделать:

@Override
public String toString() {
  StringBuilder sb = new StringBuilder();
  sb.append(getClass().getName());
  sb.append(": ");
  for (Field f : getClass().getDeclaredFields()) {
    sb.append(f.getName());
    sb.append("=");
    sb.append(f.get(this));
    sb.append(", ");
  }
  return sb.toString();
}

Не используйте конкатенацию строк для построения конечного результата из 15 членов данных, особенно если toString() будет называться много. Фрагментация памяти и накладные расходы могут быть очень высокими. Используйте StringBuilder для построения больших динамических строк.

Я обычно получаю свою IDE (IntelliJ), чтобы просто генерировать методы toString() для меня, а не использовать отражение для этого.

Другим интересным подходом является использование аннотации @ToString из Project Lombok:

import lombok.ToString;

@ToString(excludes="id")
public class ToStringExample {
  private static final int STATIC_VAR = 10;
  private String name;
  private Shape shape = new Square(5, 10);
  private String[] tags;
  private int id;

  @ToString(callSuper=true, includeFieldNames=true)
  public static class Square extends Shape {
    private final int width, height;

    public Square(int width, int height) {
      this.width = width;
      this.height = height;
    }
  }
}

Я нахожу это гораздо более предпочтительным, например, для разработчиков Jakarta Commons toString, потому что этот подход гораздо более настраиваемый и он также создан во время компиляции, а не во время выполнения.

Ответ 2

Проверьте этот API org.apache.commons.lang.builder.ToStringBuilder, он предоставляет несколько способов создания toString usinf-отражения или без отражения. Посмотрите также на другие подклассы.

Ответ 3

Это должно быть именно то, что вы ищете

    public String toString() {
    StringBuilder sb = new StringBuilder();
    try {
        Class c = Class.forName(this.getClass().getName());
        Method m[] = c.getDeclaredMethods();
        Object oo;

        for (int i = 0; i < m.length; i++)
            if (m[i].getName().startsWith("get")) {
                oo = m[i].invoke(this, null);
                sb.append(m[i].getName().substring(3) + ":"
                        + String.valueOf(oo) + "\n");
            }
    } catch (Throwable e) {
        System.err.println(e);
    }
    return sb.toString();
}

Ответ 4

Большинство IDE предоставляют способ создания метода toString в данном классе.

Учитывая класс Item с несколькими полями:

class Item {
    int i;
    int j;
    int k;
    int l;
    int m;
    int n;
    int o;  
}

Например, в Eclipse выполнение функции "Создать toString()" в классе Item выше приведет к созданию следующего:

@Override
public String toString() {
    return "Item [i=" + i + ", j=" + j + ", k=" + k + ", l=" + l + ", m="
            + m + ", n=" + n + ", o=" + o + "]";
}

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

Ответ 5

Существует такой api, и он называется Java Reflection

Чтобы выполнить то, что вы запрашиваете, вы можете просто сделать что-то вроде:

 Class<?> cls = this.getClass();
 Field fieldlist[] = cls.getDeclaredFields();
 for (Field aFieldlist : fieldlist) {
   // build toString output with StringBuilder()
 }

Ответ 6

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

Ответ 7

Начиная с хорошего медопольного ответа, вы можете использовать этот код, чтобы иметь строковое представление всех полей объекта, , даже если вы вне его class (очевидно, это только для полей с методом геттера):

/**Gives a string representation of the fields of the object
 * @param obj the object
 * @return
 */
private static String objectToString(Object obj) {
    StringBuilder sb = new StringBuilder();
    try {
        Class c = Class.forName(obj.getClass().getName());
        Method m[] = c.getDeclaredMethods();

        Object oo;
        for (int i = 0; i < m.length; i++)
            if (m[i].getName().startsWith("get")) {
                oo = m[i].invoke(obj, null);
                sb.append(m[i].getName().substring(3) + "="
                        + String.valueOf(oo) + "\n");
            }
    } catch (Throwable e) {
        System.err.println(e);
    }
    return sb.toString();
}