Java toString () usando a reflexão?

Question

Eu estava escrevendo um toString () para uma classe em Java no outro dia escrevendo manualmente cada elemento da classe para uma String e ocorreu-me que o uso de reflexão pode ser possível criar um toString genérico () Método que poderia trabalhar em todas as classes. OU SEJA ele iria descobrir os nomes e valores de campo e enviá-los para a cadeia.

Obter os nomes dos campos é bastante simples, aqui está o que um colega de trabalho veio com:

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;
}

Usando uma fábrica que poderia reduzir a sobrecarga de desempenho, armazenando os campos uma vez, a primeira vez que o toString () é chamado. Contudo, encontrar os valores poderiam ser muito mais caro.

Devido ao desempenho de reflexão isso pode ser mais hipotético, em seguida, prático. Mas eu estou interessado na idéia de reflexão e como posso usá-lo para melhorar a minha programação de todos os dias.

Answer 1

Apache commons-lang ReflectionToStringBuilder faz isso para você.

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

// your code goes here

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

Answer 2

Outra opção, se você estiver ok com JSON, é a biblioteca Gson do Google.

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

Ele vai fazer a reflexão para você. Isso produz uma agradável e fácil de ler o arquivo JSON. Fácil de ler, sendo, pessoas tecnologia não relativos pode encontrar o JSON intimidante.

Você poderia fazer o GSONBuilder uma variável de membro também, se você não quer nova-lo cada vez.

Se você tiver dados que não podem ser impressos (como uma corrente) ou dados que você simplesmente não deseja imprimir, você pode simplesmente adicionar tags @Expose para os atributos que você deseja imprimir e, em seguida, use a seguinte linha.

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

Answer 3

W / reflexão, como eu não tinha tido conhecimento da biblioteca Apache:

(estar ciente de que se você fizer isso, você provavelmente vai precisar para lidar com subobjects e verifique se eles imprimir corretamente - em particular, as matrizes não irá mostrar-lhe alguma coisa útil)

@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

Se você estiver usando Eclipse, você pode também ter um olhar para JUtils toString gerador , que ele estaticamente (gerando o método em seu código-fonte).

Answer 5

Não reflexão, mas eu tinha um olhar para gerar o método toString (juntamente com iguais / hashCode) como uma etapa pós-compilação usando manipulação de bytecode. resultados foram mistos.

Answer 6

Você pode já usam bibliotecas implementadas, como ReflectionToStringBuilder de Apache commons-lang. Como foi mencionado.

ou escreva smt semelhante por si mesmo com reflexão API .

Aqui está algum exemplo :

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

Aqui está o Netbeans equivalente a resposta de Olivier; smart-codegen plugin para o Netbeans .