¿Cómo se organiza el código fuente de clase en Java?

Question

Por ahora, mi clase promedio contiene aproximadamente 500 líneas de código y aproximadamente 50 métodos. IDE es Eclipse, donde giré "Guardar acciones" para que los métodos se clasifiquen en orden alfabético, primero con métodos públicos y luego con métodos privados. Para encontrar cualquier método específico en el código, utilizo "Esquema rápido". Si es necesario, la "Jerarquía de llamadas abiertas" muestra la secuencia de métodos que llamaron uno por uno.

Este enfoque proporciona las ventajas siguientes:

• puedo empezar a escribir nuevo método sin pensar dónde colocarlo en el código, ya que después de guardarlo se colocará por Eclipse para apropiarse de forma automática.
• siempre encuentro métodos públicos en la parte superior del código (no tiene que buscar a toda la clase para ellos)

Sin embargo, hay algunas desventajas:

al refactorizar método grandes en otros más pequeños No estoy muy satisfecho de que los nuevos métodos privados estén ubicados en diferentes partes del código y, por lo tanto, es un poco difícil seguir el concepto del código. Para evitar eso, los nombro de alguna manera extraña para mantenerlos cerca de cada uno, por ejemplo: showPageFirst(), showPageSecond() en lugar de showFirstPage(), showSecondPage().

¿Puede haber algunos enfoques mejores?

Answer 1

Bueno, nombrando a sus métodos de manera que será más fácil de detectar en su IDE no es muy buena. Su nombre debe reflejar lo que hacen, nada más.

Como respuesta a su pregunta, probablemente lo mejor que puede hacer es dividir su clase en varias clases y aislar grupos de métodos que tienen algo en común en cada una de esas clases. Por ejemplo, si usted tiene

public void largeMethodThatDoesSomething() { 
//do A 
//do B 
//do C 
} 

que luego de haber refactorizado tal que:

public void largeMethodThatDoesSomething() { 
doA(); 
doB(); 
doC(); 
} 

private void doA() {}; 
private void doB() {}; 
private void doC() {}; 

se puede hacer una clase llamada SomethingDoer donde se colocan todos estos 4 metods y luego utiliza una instancia de esa clase en tu clase original.

Answer 2

Organizar la manera que describió suena mejor que el 99% del código de Java que he visto hasta ahora. Sin embargo, por otro lado, asegúrese de que sus clases no crezcan demasiado y que los métodos no sean enormes.

clases por lo general debe ser inferior a 1000 líneas y métodos de menos de 150.

Answer 3

No se preocupe por ordenar físicamente sus métodos dentro de la clase, si no puede verlos simplemente use Ctrl-O y comience a escribir el nombre del método y saltará directamente a él.

Tener nombres de método de autodescripción da como resultado un código más fácil de mantener que nombrarlos artificialmente para mantenerlos en orden alfabético.

Sugerencia: aprender sus teclas de acceso directo y va a mejorar su productividad

Answer 4

organizar el código de sus audiencias.Por ejemplo, una clase en una biblioteca podría tener estas audiencias:

1. Cliente API que desea obtener más detalles sobre cómo funciona un método público.
2. Un desarrollador que desea encontrar el método adecuado para realizar un pequeño cambio.
3. Un responsable más serio que quiere hacer una refactorización significativa o agregar funcionalidad.

Para los clientes que utilizan el código fuente, desea presentar los conceptos básicos. Primero tenemos un comentario de doc de clase que incluye un glosario de términos importantes y ejemplos de uso. Luego tenemos el código relacionado con un término, luego los relacionados con otro, luego los relacionados con un tercero.

Para los encargados de mantenimiento, cualquier par de métodos que probablemente tengan que cambiar juntos debería estar cerca. Un método público y su ayudante privado y todas las constantes relacionadas solo deberían aparecer juntas.

Ambos grupos de usuarios reciben ayuda agrupando a los miembros de la clase en secciones lógicas que están documentadas por separado.

Por ejemplo, una clase de colección puede tener varias preocupaciones principalmente ortogonales que no se pueden dividir fácilmente en clases separadas, pero que se pueden dividir en secciones separadas.

1. mutators
2. descriptores de acceso
3. iteración
4. serializar y toString
5. Igualdad, comparabilidad, hash