¿Qué es Spring @pathvariable?: configura las variables de tu framework

Spring es un framework muy popular en el contexto Java. Una de sus funciones principales es el uso de anotaciones para simplificar el manejo de peticiones HTTP en arquitecturas tipo REST. Entre esas anotaciones encontramos @pathvariable, la cual nos ayuda a extraer valores dinámicos de manera directa de la URL y utilizarlos en forma de parámetros en los controladores. El día de hoy exploraremos cómo funciona esta herramienta y cómo configurarla.

¿Qué es la anotación @pathvariable?

@Pathvariable es una anotación perteneciente a Spring que nos permite extraer variables de la URL y pasarlas como parámetros a los métodos del controlador. Esto sirve para crear rutas dinámicas, lo cual es muy importante en arqutiecturas REST. En vez de estar dependiendo de rutas estáticas, podemos definir segmentos variables en la URL que pueden ser ajustados a diferentes peticiones y datos.

Si, por ejemplo, tienes un endpoint que te ayuda a obtener la información de un producto con base en su ID, podrías configurar la ruta como /productos/{id}. Aquí, {id}. En este caso, {id} es una variable que cambiará con base en el producto que quieras consultar. Gracias a @Pathvariable puedes capturar ese valor de la URL y procesarlo en tu controlador:

@GetMapping("/productos/{id}")
public String obtenerProducto(@PathVariable("id") String id) {
    return "Producto con ID: " + id;
}

En este caso, al acceder a /productos/123, el método extraerá “123” de la URL y lo utilizará como valor de la variable id.

¿Cómo funciona @pathvariable en Spring?

La anotación @pathvariable trabaja junto a las peticiones HTTP que envías a una aplicación. En el momento en que defines una variable en el segmento de la URL, como es el caso del ejemplo anterior, Spring es el encargado de mapear esa variable con el parámetro correspondiente en el método de tu controlador. Este mecanismo es de gran utilidad en aplicaciones que requieran operar con múltiples entidades o datos anidados, como veremos a continuación:

Relación de facturas y líneas de factura: un ejemplo

Para este ejemplo tenemos una aplicación que gestiona facturas y líneas de factura. La relación entre ambas entidades es de uno a muchos (una factura tiene múltiples líneas de factura). Puedes configurar un servicio REST para acceder tanto a las facturas como a sus líneas por medio de URLs dinámicas.

Estas son las clases que tienes en el proyecto:

public class Factura {
    private int numero;
    private String concepto;
    private List<LineaFactura> lineas = new ArrayList<>();

    // Constructores, getters y setters
}

public class LineaFactura {
    private int numero;
    private String concepto;
    private double importe;

    // Constructores, getters y setters
}

Con @PathVariable, puedes crear un servicio REST que permita acceder a una factura específica o a una línea de esa factura utilizando URLs como /facturas/{numero} o /facturas/{numero}/lineas/{numerolinea}.

@RequestMapping("/facturas/{numero}")
public Factura obtenerFactura(@PathVariable int numero) {
    // Lógica para devolver la factura correspondiente al número
}

@RequestMapping("/facturas/{numero}/lineas/{numerolinea}")
public LineaFactura obtenerLineaFactura(@PathVariable int numero, @PathVariable int numerolinea) {
    // Lógica para devolver la línea de factura correspondiente
}

Configuración de múltiples variables con @pathvariable

Otra de las cosas que puede hacer @pathvariable es manejar múltiples variables dentro de una misma ruta. Si necesitas trabajar con entidades relacionadas o, en su defecto, realizar operaciones más detalladas, puedes trabajar con esta opción.

En otro ejemplo, tenemos un sistema que maneja empleados y departamentos. Podrías definir una ruta que incluya el ID del empleado y el nombre del departamente al que pertenece :

@GetMapping("/empleados/{id}/departamento/{nombre}")
public String obtenerEmpleadoPorDepartamento(@PathVariable("id") String id, @PathVariable("nombre") String departamento) {
    return "Empleado con ID: " + id + " del departamento: " + departamento;
}

Aquí, puedes acceder a /empleados/123/departamento/ventas para obtener los datos del empleado “123” en el departamento “ventas”.

Manejo de variables opcionales

En algunos casos es posible que determinadas variables en la URL sean opcionales. Por defecto, @PathVariable marca los parámetros como obligatorios, pero puedes hacer que un parámetro sea opcional estableciendo el atributo required en false:

@GetMapping(value = {"/empleados", "/empleados/{id}"})
public String obtenerEmpleadoOpcional(@PathVariable(required = false) String id) {
    if (id != null) {
        return "Empleado con ID: " + id;
    } else {
        return "Lista de empleados";
    }
}

Esto hace posible que manejemos tanto las peticiones a /empleados (que devolverá una lista de empleados) como a /empleados/{id}, que devolverá la información de un empleado en particular.

Si ya tomaste la decisión de aprender a programar, pero no sabes dónde hacerlo, tenemos el bootcamp ideal para ti. Se trata del curso java, una formación completa que te ayudará a incursionar en el mundo tecnológico y a conseguir tu primer empleo en este campo. ¡Da un giro inesperado a tu vida y conviértete en una persona exitosa!