¿Cómo probar si una cadena es JSON o no?

Tengo una simple llamada AJAX, y el servidor devolverá una cadena JSON con datos útiles o una cadena de mensaje de error producida por la función PHP mysql_error(). ¿Cómo puedo probar si estos datos son una cadena JSON o el mensaje de error?

Sería bueno usar una función llamada isJSONal igual que puede usar la función instanceofpara probar si algo es una matriz.

Esto es lo que quiero:

if (isJSON(data)){
    //do some data stuff
}else{
    //report the error
    alert(data);
}

Utilice JSON.parse

function isJson(str) {
    try {
        JSON.parse(str);
    } catch (e) {
        return false;
    }
    return true;
}

Este código es JSON.parse(1234)o JSON.parse(0)o JSON.parse(false)o JSON.parse(null)todo volverá realidad.

function isJson(str) {
    try {
        JSON.parse(str);
    } catch (e) {
        return false;
    }
    return true;
}

Entonces reescribí el código de esta manera:

function isJson(item) {
    item = typeof item !== "string"
        ? JSON.stringify(item)
        : item;

    try {
        item = JSON.parse(item);
    } catch (e) {
        return false;
    }

    if (typeof item === "object" && item !== null) {
        return true;
    }

    return false;
}

Resultado de la prueba:

Resultado de la prueba isJson

Recapitulemos esto (para 2019+).

Argumento : Los valores tales como true, false, nullson válidas JSON (?)

HECHO : Estos valores primitivos son JSON-parsable pero no son estructuras JSON bien formadas . La especificación JSON indica que JSON se basa en dos estructuras: una colección de pares de nombre / valor (objeto) o una lista ordenada de valores (matriz).

Argumento : el manejo de excepciones no debe usarse para hacer algo esperado.
(¡Este es un comentario que tiene más de 25 votos a favor!)

HECHO : ¡No! Definitivamente es legal usar try / catch, especialmente en un caso como este. De lo contrario, necesitaría hacer muchas cosas de análisis de cadenas como las operaciones de tokenizing / regex; lo que tendría un desempeño terrible.

hasJsonStructure()

Esto es útil si su objetivo es verificar si algunos datos / texto tienen el formato de intercambio JSON adecuado.

function hasJsonStructure(str) {
    if (typeof str !== 'string') return false;
    try {
        const result = JSON.parse(str);
        const type = Object.prototype.toString.call(result);
        return type === '[object Object]' 
            || type === '[object Array]';
    } catch (err) {
        return false;
    }
}

Uso:

hasJsonStructure('true')             // —» false
hasJsonStructure('{"x":true}')       // —» true
hasJsonStructure('[1, false, null]') // —» true

safeJsonParse()

Y esto es útil si desea tener cuidado al analizar algunos datos a un valor de JavaScript.

function safeJsonParse(str) {
    try {
        return [null, JSON.parse(str)];
    } catch (err) {
        return [err];
    }
}

Uso:

const [err, result] = safeJsonParse('[Invalid JSON}');
if (err) {
    console.log('Failed to parse JSON: ' + err.message);
} else {
    console.log(result);
}

Si el servidor responde con JSON, entonces tendría un application/jsontipo de contenido; si responde con un mensaje de texto sin formato, debería tener un text/plaintipo de contenido. Asegúrese de que el servidor responde con el tipo de contenido correcto y pruébelo.

cuando se utiliza jQuery $.ajax()la respuesta tendrá la responseJSONpropiedad si la respuesta fue JSON, esto podría verificarse así:

if (xhr.hasOwnProperty('responseJSON')) {}

Me gusta la mejor respuesta, pero si es una cadena vacía, devuelve verdadero. Así que aquí hay una solución:

function isJSON(MyTestStr){
    try {
        var MyJSON = JSON.stringify(MyTestStr);
        var json = JSON.parse(MyJSON);
        if(typeof(MyTestStr) == 'string')
            if(MyTestStr.length == 0)
                return false;
    }
    catch(e){
        return false;
    }
    return true;
}

var parsedData;

try {
    parsedData = JSON.parse(data)
} catch (e) {
    // is not a valid JSON string
}

Sin embargo, le sugeriré que su llamada / servicio http debe devolver siempre datos en el mismo formato. Entonces, si tiene un error, debe tener un objeto JSON que envuelva este error:

{"error" : { "code" : 123, "message" : "Foo not supported" } } 

Y tal vez use, además del estado HTTP, un código 5xx.

Bueno ... Depende de la forma en que recibe sus datos. Creo que el servidor está respondiendo con una cadena con formato JSON (usando json_encode () en PHP, por ejemplo). Si está utilizando la publicación JQuery y establece que los datos de respuesta sean un formato JSON y es un JSON con formato incorrecto, esto producirá un error:

$.ajax({
  type: 'POST',
  url: 'test2.php',
  data: "data",
  success: function (response){

        //Supposing x is a JSON property...
        alert(response.x);

  },
  dataType: 'json',
  //Invalid JSON
  error: function (){ alert("error!"); }
});

Pero, si está usando la respuesta de tipo como texto, necesita usar $ .parseJSON. Según el sitio jquery: "Pasar una cadena JSON con formato incorrecto puede generar una excepción". Así su código será:

$.ajax({
  type: 'POST',
  url: 'test2.php',
  data: "data",
  success: function (response){

        try {
            parsedData = JSON.parse(response);
        } catch (e) {
            // is not a valid JSON string
        }

  },
  dataType: 'text',
});

Probablemente hay pruebas que puede hacer, por ejemplo, si sabe que el JSON devuelto siempre estará rodeado {y }luego podría probar esos caracteres o algún otro método hacky. O puede usar la biblioteca json.org JS para intentar analizarla y comprobar si tiene éxito.

Sin embargo, sugeriría un enfoque diferente. Su script PHP actualmente devuelve JSON si la llamada es exitosa, pero algo más si no lo es. ¿Por qué no siempre devolver JSON?

P.ej

Llamada exitosa:

{ "status": "success", "data": [ <your data here> ] }

Llamada errónea:

{ "status": "error", "error": "Database not found" }

Esto facilitaría mucho más la escritura de su JS del lado del cliente: todo lo que tiene que hacer es verificar el miembro de "estado" y actuar en consecuencia.

Solo uso 2 líneas para realizar eso:

var isValidJSON = true;
try { JSON.parse(jsonString) } catch { isValidJSON = false }

¡Eso es todo!

Pero tenga en cuenta que hay 2 trampas:
1. JSON.parse(null)devuelve null
2. Cualquier número o cadena se puede analizar con el JSON.parse()método.
   JSON.parse("5")devuelve 5
   JSON.parse(5)devuelve5

Juguemos un poco sobre el código:

// TEST 1
var data = '{ "a": 1 }'

// Avoiding 'null' trap! Null is confirmed as JSON.
var isValidJSON = data ? true : false
try { JSON.parse(data) } catch(e) { isValidJSON = false }

console.log("data isValidJSON: ", isValidJSON);
console.log("data isJSONArray: ", isValidJSON && JSON.parse(data).length ? true : false);

Console outputs:
data isValidJSON:  true
data isJSONArray:  false


// TEST 2
var data2 = '[{ "b": 2 }]'

var isValidJSON = data ? true : false
try { JSON.parse(data2) } catch(e) { isValidJSON = false }

console.log("data2 isValidJSON: ", isValidJSON);
console.log("data2 isJSONArray: ", isValidJSON && JSON.parse(data2).length ? true : false);

Console outputs:
data2 isValidJSON:  true
data2 isJSONArray:  true


// TEST 3
var data3 = '[{ 2 }]'

var isValidJSON = data ? true : false
try { JSON.parse(data3) } catch(e) { isValidJSON = false }

console.log("data3 isValidJSON: ", isValidJSON);
console.log("data3 isJSONArray: ", isValidJSON && JSON.parse(data3).length ? true : false);

Console outputs:
data3 isValidJSON:  false
data3 isJSONArray:  false


// TEST 4
var data4 = '2'

var isValidJSON = data ? true : false
try { JSON.parse(data4) } catch(e) { isValidJSON = false }

console.log("data4 isValidJSON: ", isValidJSON);
console.log("data4 isJSONArray: ", isValidJSON && JSON.parse(data4).length ? true : false);


Console outputs:
data4 isValidJSON:  true
data4 isJSONArray:  false


// TEST 5
var data5 = ''

var isValidJSON = data ? true : false
try { JSON.parse(data5) } catch(e) { isValidJSON = false }

console.log("data5 isValidJSON: ", isValidJSON);
console.log("data5 isJSONArray: ", isValidJSON && JSON.parse(data5).length ? true : false);


Console outputs:
data5 isValidJSON:  false
data5 isJSONArray:  false

// TEST 6
var data6; // undefined

var isValidJSON = data ? true : false
try { JSON.parse(data6) } catch(e) { isValidJSON = false }

console.log("data6 isValidJSON: ", isValidJSON);
console.log("data6 isJSONArray: ", isValidJSON && JSON.parse(data6).length ? true : false);

Console outputs:
data6 isValidJSON:  false
data6 isJSONArray:  false

Puede intentar decodificarlo y detectar la excepción (nativa o json2.js ):

try {
  newObj = JSON.parse(myJsonString);
} catch (e) {
  console.log('Not JSON');
}

Sin embargo, sugeriría que la respuesta siempre sea válida JSON. Si recibe un error de su consulta MySQL, simplemente envíe JSON con el error:

{"error":"The MySQL error string."}

Y entonces:

if (myParsedJSON.error) {
  console.log('An error occurred: ' + myParsedJSON.error);
}

Advertencia: para los métodos en los que se confía JSON.parse: las matrices y las cadenas entre comillas también pasarán (es decir console.log(JSON.parse('[3]'), JSON.parse('"\uD800"'))) .

Para evitar todas las primitivas JSON que no sean objetos (booleano, nulo, matriz, número, cadena), sugiero usar lo siguiente:

/* Validate a possible object ie. o = { "a": 2 } */
const isJSONObject = (o) => 
  !!o && (typeof o === 'object') && !Array.isArray(o) && 
  (() => { try { return Boolean(JSON.stringify(o)); } catch { return false } })()

/* Validate a possible JSON object represented as string ie. s = '{ "a": 3 }' */
function isJSONObjectString(s) {
    try {
        const o = JSON.parse(s);
        return !!o && (typeof o === 'object') && !Array.isArray(o)
    } catch {
        return false
    }
}

Explicación del código

• !! o - No es falso (excluye nulo, que se registra como tipo de 'objeto')
• (typeof o === 'objeto') - Excluye booleano, número y cadena
• ! Array.isArray (o) - Excluir matrices (que se registran como typeof 'object')
• intente ... JSON.stringify / JSON.parse - Pregunta al motor de JavaScript para determinar si JSON es válido

¿Por qué no usar la respuesta hasJsonStructure ()?

Confiar en toString()no es una buena idea. Esto se debe a que diferentes motores de JavaScript pueden devolver una representación de cadena diferente. En general, los métodos que dependen de esto pueden fallar en diferentes entornos o pueden estar sujetos a fallar más tarde si el motor cambia el resultado de la cadena

¿Por qué atrapar una excepción no es un truco?

Se mencionó que atrapar una excepción para determinar la validez de algo nunca es el camino correcto. Este es generalmente un buen consejo, pero no siempre. En este caso, es probable que la captura de excepciones sea la mejor ruta porque se basa en la implementación del motor JavaScript para validar los datos JSON.

Confiar en el motor JS ofrece las siguientes ventajas:

1. Más exhaustivo y continuamente actualizado a medida que cambian las especificaciones JSON
2. Es probable que corra más rápido (ya que es un código de nivel inferior)

Cuando tenga la oportunidad de apoyarse en el motor de JavaScript, sugeriría hacerlo. Particularmente en este caso. Aunque puede parecer extraño detectar una excepción, en realidad solo está manejando dos posibles estados de retorno de un método externo.

Aquí hay un código con algunas modificaciones menores en la respuesta de Bourne. Como JSON.parse (número) funciona bien sin ninguna excepción, se agrega isNaN.

function isJson(str) {
    try {
        JSON.parse(str);
    } catch (e) {
        return false;
    }
    return isNaN(str);
}

Todas las cadenas json comienzan con '{' o '[' y terminan con el correspondiente '}' o ']', así que verifíquelo.

Así es como lo hace Angular.js:

var JSON_START = /^\[|^\{(?!\{)/;
var JSON_ENDS = {
  '[': /]$/,
  '{': /}$/
};

function isJsonLike(str) {
    var jsonStart = str.match(JSON_START);
    return jsonStart && JSON_ENDS[jsonStart[0]].test(str);
}

https://github.com/angular/angular.js/blob/v1.6.x/src/ng/http.js