Ir al contenido
Sistema

Leer un archivo JSON con jq en Linux sin andar trasteando con grep

Avatar illustré de Julien Macé 3 min de lectura
Manchot Linux examinant une structure de données JSON
jq permet de lire une structure JSON sans dépendre de sa présentation sur une ligne ou sur dix.

Una respuesta de API llega en JSON, buscas un valor y luego terminas con grep y cut. Esto puede funcionar siempre que el archivo mantenga exactamente el mismo formato. Tan pronto como una clave pasa a un objeto anidado, aparece un arreglo o la respuesta se convierte en una página HTML después de un error HTTP, el script a veces lee el dato incorrecto.

jq lee la estructura JSON en lugar de buscar una secuencia de caracteres. Es la herramienta adecuada para extraer un campo, filtrar un arreglo y hacer que un script falle cuando falta el dato esperado.

Pingüino Linux examinando una estructura de datos JSON
jq permite leer una estructura JSON sin depender de su presentación en una línea o en diez.

Verificar jq y el archivo antes de la solicitud

En Debian o Ubuntu, instala el paquete con sudo apt update && sudo apt install jq. Fedora, RHEL y sus derivados generalmente utilizan sudo dnf install jq. Comienza por verificar el comando y el documento que tu script va a leer.

jq --version
jq empty config.json

jq empty no muestra el documento. Verifica su sintaxis y devuelve un error si el archivo está truncado o es inválido. Haz esta comprobación antes de un bucle, un despliegue o una modificación de configuración. Una respuesta HTTP 502 registrada en un archivo .json sigue siendo HTML, no JSON.

Extraer un campo y filtrar un arreglo

Para este archivo de prueba, el servicio tiene un nombre y un puerto, mientras que cada nodo tiene su propio estado.

{
  "service": {"name": "api", "port": 8080},
  "nodes": [
    {"name": "web-1", "enabled": true},
    {"name": "worker-1", "enabled": false}
  ]
}

La opción -r elimina las comillas alrededor de una cadena. Es útil cuando el valor debe ser utilizado por otro comando.

jq -r '.service.name' config.json
jq -r '.nodes[] | select(.enabled == true) | .name' config.json

El primer comando muestra api. El segundo recorre nodes, mantiene los objetos cuyo enabled es true, y luego muestra solo su nombre. El manual oficial de jq describe este recorrido con .[], los filtros y select().

Hacer que el script falle si falta el valor

Un script de administración no debe continuar con una variable vacía. La opción -e proporciona un código de retorno utilizable: cero si el último resultado está presente y es diferente de false o null, uno si el valor es false o null, cuatro si no se produce ningún resultado.

#!/usr/bin/env bash
set -euo pipefail

fichero="config.json"
jq empty "$fichero"

if port=$(jq -er '.service.port? // empty' "$fichero"); then
  printf 'Puerto configurado: %sn' "$port"
else
  printf 'Puerto ausente o JSON inválidon' >&2
  exit 1
fi

Mantén los filtros jq entre comillas en Bash. El shell no intentará interpretar $, [] o | antes de jq. Si el campo puede contener un secreto, evita también mostrarlo con printf en los registros de CI.

Por qué grep tiende a romperse

grep busca texto. No distingue entre una clave port en service y otra clave del mismo nombre en un objeto adyacente. El orden de los campos, los espacios, los saltos de línea y los caracteres escapados también pueden cambiar sin modificar el dato JSON.

Mantén grep para un registro de texto o una búsqueda rápida en un archivo que controlas. Para una respuesta de API, un archivo de configuración o una exportación, utiliza jq. Si necesitas primero recuperar la API, la guía curl en Linux ayuda a controlar el código HTTP y los encabezados antes de dar la respuesta a jq.

Mantener jq en su lugar en la automatización

Para un archivo de configuración o una respuesta API de tamaño normal, jq sigue siendo la opción más legible. En un documento muy grande, evita --slurp: esta opción carga todo el flujo en un arreglo. El modo --stream existe para procesar grandes flujos, pero impone un filtro diferente y merece una prueba en una copia.

También guardaría una copia antes de modificar JSON en su lugar. Para una configuración versionada, haz que jq escriba primero en un nuevo archivo, compáralo con diff -u, y luego reemplaza el original si el resultado coincide con lo esperado. El mismo principio evita sorpresas con sed en Linux.

Antes de dejar que un valor guíe otro comando, valida el JSON, extrae el campo con -e y controla su salida. Es más corto que un pipeline grep | cut, y sobre todo, el script se detiene cuando la estructura ya no es la esperada.

Compartir Facebook X WhatsApp LinkedIn Pinterest Reddit Correo