Я сейчас продемонстрирую утилиту, с помощью которой Вы можете делать это. Данный инструмент автоматически генерирует регулярный и устойчивый метод toString() для указанного класса, почти устраняя потраченное на разрабатку время. Это также унифицирует формат метода toString(). Если Вы изменяете этот формат, Вы должны перекомпилировать методы toString(); однако это намного проще, чем изменять вручную сотни или тысячи классов.

Поддержка сгенерированного кода также проста. Если Вы добавляете большее количество атрибутов в классы, Вам необходимо проделать изменения также в методе toString(). Так как генерация методов toString автоматизирована, Вам необходимо запустить утилиту снова на классе, чтобы проделать Ваши замены. Данный подход более прост и менее подверженный ошибкам по сравнению с изменением кода вручную.

Данная статья не предлагает объяснение reflection API; но последующий код предполагает, что Вы имеете, по крайней мере, понимание концепции отражения (reflection). Вы можете заглянуть в раздел Ресурсов, в документацию reflection API. Утилита выглядит следующим образом:

package fareed.publications.utilities;
import java.lang.reflect.*;

public class ToStringGenerator {
 public static void main(String[] args) {
  if (args.length == 0) {
   System.out.println("Provide the class name 
 as the command line argument");
   System.exit(0);
  }

  try {

  Class targetClass = Class.forName(args[0]);

  if (!targetClass.isPrimitive() 
 && targetClass != String.class) {
   Field fields[] = targetClass.getDeclaredFields();

   Class cSuper = targetClass.getSuperclass();
 // Retrieving the super class

    output("StringBuffer buffer
 = new StringBuffer(500);");
 // Buffer Construction

    if (cSuper != null && cSuper != Object.class) {
    output("buffer.append(super.toString());");
 // Super class's toString()
    }

   for (int j = 0; j < fields.length; j++) {
    output("buffer.append(\"" + 
 fields[j].getName() + " = \");");
 // Append Field name

    if (fields[j].getType().isPrimitive() || 
 fields[j].getType() == String.class) 
 // Check for a primitive or string
     output("buffer.append(this." + 
 fields[j].getName() + ");");
 // Append the primitive field value
     else
    {
     /* It is NOT a primitive field so this requires
 a check for the NULL value for the aggregated object */
     output("if ( this." + 
 fields[j].getName() + "!= null )" );
      output("buffer.append(this." + 
 fields[j].getName() + ".toString());");
     output("else buffer.append(\"value is null\"); ");
    } // end of else
    } // end of for loop
     output("return buffer.toString();");
  }
    } catch (ClassNotFoundException e) {
   System.out.println("Class not found in the class path");
   System.exit(0);
   }
   }

  private static void output(String data) {
 System.out.println(data);
 }

}

Формат кода также зависит от ваших требований для проекта. Некоторые разработчики могут предпочесть сохранить код в определяемом пользователем файле на диске. Другие разработчики удовлетворятся стандартным консольным выводом system.out, который позволяет им копировать и вставлять код в файл вручную. Я оставляю выбор на Ваше усмотрение и использую самый простой метод — инструкции system.out.

Имеются два важных ограничения к этому подходу. Первый — это то, что он не поддерживает объекты, содержащие циклы(циклические ссылки). Например, если объект A содержит ссылку на объекту B, который в свою очередь содержит ссылку на объект A, то данный метод работать не будет. Однако, такой случай довольно редкий для проектов.

Второе ограничение — это то, что добавление или вычитание полей(members) требует перекомпиляции метода toString(). Поскольку это должно быть сделано с или без инструмента, это не проблема для этого подхода.

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

После того, как этот совет (Tip 99) был опубликован, я получил несколько предложений от читателей о том, как улучшить код. В этом продолжении, я объясняю, как я модифицировал утилиту, основываясь на этих предложениях и моем собственном понимании. Вы можете найти исходный текст программы с этими усовершенствованиями в разделе Ресурсы.

Усовершенствование #1, предложенное Sangeeta Varma

Усовершенствование #2, предложенное Chris Sanscraint

Усовершенствование #3, предложенное Eric Ye

Модификации Кода

Syed Fareed Ahmad — программист на языке Java, проектировщик и архитектор в Лахоре, Пакистан. Он участвует в развитии языка Java — (Servlets, JSP, и EJB), проектах WebSphere-, и XML-based e-commerce решениях.

• For the follow-up source code: http://www.javaworld.com/ javatips/javatip99/javatip99.zip
• Reflection documentation at Sun's Website: http://java.sun.com/products/ jdk/1.1/docs/guide/ reflection/
• View all previous Java Tips and submit your own: http://www.javaworld.com/ javatips/jw-javatips.index.html