Escribe menos código tedioso, con Lombok

Lombok es una biblioteca de software para Java, que contiene varias transformaciones aplicadas al código en tiempo de compilación, ayudándonos con varias de las tareas más tediosas de la programación en Java.

El Jar es además ejecutable, contiene un programa que detecta los IDE's instalados, como Eclipse (y los basados en Eclipse como STS), IDEA y me parece que NetBeans. Esto es necesario en el IDE para la compilación, pero en realidad si se usa un editor de texto regular para programar, o un sistema automatizado de construcción de proyectos, basta con agregar lombok.jar al classpath de compilación.

La versión más reciente es la 0.10.0 que trae algunas monerías adicionales a las que ya se incluían en versiones anteriores y además ya no requiere incluir el Jar en tiempo de ejecución; todas las transformaciones se realizan en tiempo de compilación.

También ya es compatible con Java 7.

Bueno pero, ¿qué son estas transformaciones? Vienen en forma de anotaciones, y creo que la manera más fácil de entenderlas es con ejemplos.

Propiedades, Beans

Empecemos por las anotaciones para propiedades y beans. En vez de esto:

Simplemente puedes hacer esto:

La anotación   va sobre una variable de instancia, y causa que se genere un método para modificarla. La anotación   también va sobre una variable de instancia y causa que se genere un método para obtenerla.

Si tienen un bean, que sólo contiene datos, en vez de tener que generar getters y setters con el IDE, pueden usar estas anotaciones; pero de hecho si quieren getter y setter para todas las propiedades del objeto, así como los métodos  ,   y  , entonces simplemente pueden usar la anotación  :

La clase Ejemplo será un bean común y corriente, con su constructor default, los getters y setters para nombre y fecha, y tendrá los métodos equals, hashCode y toString.

La clase Otro tendrá un constructor que recibe una cadena que se asigna a nombre, tendrá solamente getter para nombre, getter y setter para entero, y los 3 métodos que también tiene Ejemplo.

Estas son de las cosas que más utilizo de Lombok. No tener que volver a escribir un setter ni un getter me ahorra algo de tiempo, porque no solamente se trata de escribirlo o generarlo con el IDE; si posteriormente cambiamos el nombre de la propiedad, o queremos cambiar su visibilidad o hacerla de sólo lectura, etc, hay que mantener ese código y si se olvida modificarlo puede ser una fuente de errores.

Constructores

Otra anotación muy útil que uso cuando tengo algunos Runnables o clases que se usan para ejecutar tareas y luego desecharlas es  :

Al momento de compilar, esta clase en vez del constructor default, tendrá un constructor que recibe un Algo y un OtraCosa, y los asignará a las propiedades marcadas como finales. La propiedad "estado" es modificable, por lo tanto no es considerada para el constructor. Si además quieren tener el constructor que tenga los 3 valores, pueden agregar la anotación  .

Si quieren implementar el patrón factory, una de estas anotaciones les basta, solamente tienen que agregar un modificar. Y pueden anotar las propiedades que no deben aceptar nulos:

La clase Fabricado tendrá un constructor privado que acepta una cadena y una fecha, así como un método estático   que devuelve instancias de Fabricado con los valores especificados. Si se quiere crear una instancia con  , se arroja una NPE porque el campo obligatorio no acepta nulos.

Manejo de recursos

Todos conocemos el patrón de uso de recursos como streams y conexiones: manejarlos dentry de un try-catch-finally o al menos un try-finally, cerrándolos en el finally:

Incluso hay quienes tienen código así, medio genérico, para abrir archivos o hacer algo con una conexión de JDBC, y evitarse así la talacha de estar escribiendo eso una y otra vez. Lombok nos ofrece una anotación para ahorrarnos todo eso. Este código, al compilarse, queda igual que el anterior:

El código que nunca tuviste que escribir es código que nunca tendrás que mantener (ni tú ni nadie más).

Excepciones

El manejo de excepciones es algo que nos trae de cabeza a muchos. Con las RuntimeExceptions pues podemos de repente hacernos de la vista gorda, pero con las Exception, o las cachamos, o las tenemos que declarar y se hace una cadena en donde alguien en algún momento debe manejarla. Y se dan casos en donde hay excepciones que SABEMOS que no van a ocurrir, pero como estamos invocando código que las declara, tenemos que manejarlas, y poner un try-catch y comentar en el catch "ESTO NUNCA OCURRIRA" y explicar por qué.

Un ejemplo simple: tenemos un arreglo de bytes que queremos convertir a una cadena usando UTF-8. El constructor de String que recibe un encoding arroja  , por si le pasamos un encoding que no tenga la JVM. Pero también sabemos que la JVM viene incluida siempre con UTF-8, de modo que en ese caso específico, en la práctica nunca se arrojará la excepción. Entonces, en vez de tener que declararla, o cacharla y no hacer nada, podemos usar una anotación de Lombok:

La anotación   debe usarse indicando la clase de excepción que queremos enmascarar. Lo que hace esta anotación no es transformar el código para meter un try-catch que no haga nada; simplemente oculta la excepción al compilador pero si en tiempo de ejecución se arroja, será arrojada de manera normal. Termina ocurriendo como en Groovy o Scala, donde todas las excepciones son de tiempo de ejecución y por lo tanto sólo ponemos try-catch cuando vamos a manejar la excepción que se arroja.

val: Inferencia de tipos en variables finales

Cuando tenemos variables locales finales, el código puede ser algo redundante:

En el segundo caso, Java 7 lo más que puede hacer por nosotros es ayudarnos a no teclear el segundo  . Pero Lombok nos ofrece algo mejor: la palabra  , que funciona de manera similar esa palabra reservada de Scala: marca la variable como final, y hace inferencia del tipo que se le asigna. De modo que esto nos resulta en el mismo código compilado que lo anterior:

Conclusión

Lombok nos puede ayudar a evitar el tener que escribir varias de las partes más tediosas de nuestro código Java. Y dado que no agrega dependencias en tiempo de compilación, puede ser utilizada sin muchos problemas, sólo se requiere para compilar. Adicionalmente, la integración con Eclipse y NetBeans es muy buena, y existen plugins para IDEA y probablemente otros IDE's.

No he mencionado todas las anotaciones que incluye Lombok, solamente lo que creo que puede ayudar de manera más inmediata a la mayoría de los programadores. Espero lo encuentren tan útil como yo.