Tipo di eccezione personalizzato


224

Posso definire un tipo personalizzato per le eccezioni definite dall'utente in JavaScript? Se è così, come lo farei?


3
Attenzione. Secondo JavaScript in 10 minuti non otterrai una traccia dello stack se lanci un valore senza scatola.
Janus Troelsen,

exceptionsjs.com offre la possibilità di creare eccezioni personalizzate e fornisce alcune eccezioni mancanti tra cui ArgumentException e NotImplemented per impostazione predefinita.
Steven Wexler,

Risposte:


232

Da WebReference :

throw { 
  name:        "System Error", 
  level:       "Show Stopper", 
  message:     "Error detected. Please contact the system administrator.", 
  htmlMessage: "Error detected. Please contact the <a href=\"mailto:sysadmin@acme-widgets.com\">system administrator</a>.",
  toString:    function(){return this.name + ": " + this.message;} 
}; 

7
@ b.long È in "JavaScript: The Good Parts" (ottimo libro IMO). Questa anteprima di Google Libri mostra la sezione: books.google.com/books?id=PXa2bby0oQ0C&pg=PA32&lpg=PA32
orip

11
L'aggiunta di un metodo toString lo mostrerà bene nella console javascript. senza mostra come: Uncaught # <Oggetto> con toString mostra come: Uncaught System Error: Errore rilevato. Si prega di contattare l'amministratore di sistema.
JDC,

11
Ciò non ti consentirà di accumulare tracce a meno che tu non erediti da Errore
Luca H

Come puoi filtrare all'interno di un blocco catch per funzionare solo con questo errore personalizzato?
Overdrivr

@overdrivr qualcosa come catch (e) { if (e instanceof TypeError) { … } else { throw e; } }⦃⦄ o catch (e) { switch (e.constructor) { case TypeError: …; break; default: throw e; }⦃⦄.
Sam Boosalis,

92

È necessario creare un'eccezione personalizzata che eredita prototipicamente da Errore. Per esempio:

function InvalidArgumentException(message) {
    this.message = message;
    // Use V8's native method if available, otherwise fallback
    if ("captureStackTrace" in Error)
        Error.captureStackTrace(this, InvalidArgumentException);
    else
        this.stack = (new Error()).stack;
}

InvalidArgumentException.prototype = Object.create(Error.prototype);
InvalidArgumentException.prototype.name = "InvalidArgumentException";
InvalidArgumentException.prototype.constructor = InvalidArgumentException;

Questa è fondamentalmente una versione semplificata di ciò che è sfigurato pubblicato sopra con il miglioramento che le tracce dello stack funzionano su Firefox e altri browser. Soddisfa gli stessi test che ha pubblicato:

Uso:

throw new InvalidArgumentException();
var err = new InvalidArgumentException("Not yet...");

E si comporterà è previsto:

err instanceof InvalidArgumentException          // -> true
err instanceof Error                             // -> true
InvalidArgumentException.prototype.isPrototypeOf(err) // -> true
Error.prototype.isPrototypeOf(err)               // -> true
err.constructor.name                             // -> InvalidArgumentException
err.name                                         // -> InvalidArgumentException
err.message                                      // -> Not yet...
err.toString()                                   // -> InvalidArgumentException: Not yet...
err.stack                                        // -> works fine!

80

Potresti implementare le tue eccezioni e la loro gestione, ad esempio come qui:

// define exceptions "classes" 
function NotNumberException() {}
function NotPositiveNumberException() {}

// try some code
try {
    // some function/code that can throw
    if (isNaN(value))
        throw new NotNumberException();
    else
    if (value < 0)
        throw new NotPositiveNumberException();
}
catch (e) {
    if (e instanceof NotNumberException) {
        alert("not a number");
    }
    else
    if (e instanceof NotPositiveNumberException) {
        alert("not a positive number");
    }
}

Esiste un'altra sintassi per rilevare un'eccezione digitata, sebbene non funzionerà in tutti i browser (ad esempio non in IE):

// define exceptions "classes" 
function NotNumberException() {}
function NotPositiveNumberException() {}

// try some code
try {
    // some function/code that can throw
    if (isNaN(value))
        throw new NotNumberException();
    else
    if (value < 0)
        throw new NotPositiveNumberException();
}
catch (e if e instanceof NotNumberException) {
    alert("not a number");
}
catch (e if e instanceof NotPositiveNumberException) {
    alert("not a positive number");
}

2
Il sito Web MSN riporta questo avviso relativo alle condizioni rilevate: Non standard Questa funzione non è standard e non è su una traccia standard. Non utilizzarlo su siti di produzione rivolti al Web: non funzionerà per tutti gli utenti. Potrebbero esserci anche grandi incompatibilità tra le implementazioni e il comportamento potrebbe cambiare in futuro.
Lawrence Dol,

40

Sì. Puoi lanciare tutto quello che vuoi: numeri interi, stringhe, oggetti, qualunque cosa. Se vuoi lanciare un oggetto, crea semplicemente un nuovo oggetto, proprio come faresti per crearne uno in altre circostanze, e poi lancialo. Il riferimento Javascript di Mozilla ha diversi esempi.


26
function MyError(message) {
 this.message = message;
}

MyError.prototype = new Error;

Questo consente l'utilizzo come ..

try {
  something();
 } catch(e) {
  if(e instanceof MyError)
   doSomethingElse();
  else if(e instanceof Error)
   andNowForSomethingCompletelyDifferent();
}

Questo breve esempio non funzionerebbe esattamente allo stesso modo anche se non ereditassi il prototipo di Error? Non mi è chiaro cosa ti guadagni in questo esempio.
EleventyOne,

1
No, e instanceof Errorsarebbe falso.
Morgan ARR Allen,

Infatti. Ma poiché e instanceof MyErrorsarebbe vero, l' else if(e instanceof Error)affermazione non sarebbe mai stata valutata.
EleventyOne,

Bene, questo è solo un esempio di come funzionerebbe questo stile di try / catch. Dove else if(e instanceof Error)sarebbe l'ultima cattura. Probabilmente seguito da un semplice else(che non ho incluso). Un po 'come default:in un'istruzione switch ma per errori.
Morgan ARR Allen

15

In breve:

Opzione 1: usa babel-plugin-transform-builtin-extension

Opzione 2: fai da te (ispirato alla stessa libreria)

    function CustomError(...args) {
      const instance = Reflect.construct(Error, args);
      Reflect.setPrototypeOf(instance, Reflect.getPrototypeOf(this));
      return instance;
    }
    CustomError.prototype = Object.create(Error.prototype, {
      constructor: {
        value: Error,
        enumerable: false,
        writable: true,
        configurable: true
      }
    });
    Reflect.setPrototypeOf(CustomError, Error);
  • Se si utilizza ES5 puro :

    function CustomError(message, fileName, lineNumber) {
      const instance = new Error(message, fileName, lineNumber);
      Object.setPrototypeOf(instance, Object.getPrototypeOf(this));
      return instance;
    }
    CustomError.prototype = Object.create(Error.prototype, {
      constructor: {
        value: Error,
        enumerable: false,
        writable: true,
        configurable: true
      }
    });
    if (Object.setPrototypeOf){
        Object.setPrototypeOf(CustomError, Error);
    } else {
        CustomError.__proto__ = Error;
    }
  • Alternativa: utilizzare la struttura Classtrophobic

Spiegazione:

Perché l'estensione della classe Error tramite ES6 e Babel è un problema?

Perché un'istanza di CustomError non è più riconosciuta come tale.

class CustomError extends Error {}
console.log(new CustomError('test') instanceof Error);// true
console.log(new CustomError('test') instanceof CustomError);// false

In effetti, dalla documentazione ufficiale di Babele, tu può non estendersi alcun built-in classi JavaScript come Date, Array, DOMo Error.

Il problema è descritto qui:

E le altre risposte SO?

Tutte le risposte fornite risolvono il instanceofproblema ma perdi l'errore normale console.log:

console.log(new CustomError('test'));
// output:
// CustomError {name: "MyError", message: "test", stack: "Error↵    at CustomError (<anonymous>:4:19)↵    at <anonymous>:1:5"}

Considerando che usando il metodo sopra menzionato, non solo risolvi il instanceofproblema ma mantieni anche l'errore regolare console.log:

console.log(new CustomError('test'));
// output:
// Error: test
//     at CustomError (<anonymous>:2:32)
//     at <anonymous>:1:5

11

Ecco come è possibile creare errori personalizzati con un Errorcomportamento completamente identico al comportamento nativo . Questa tecnica funziona solo in Chrome e node.js per ora. Inoltre non consiglierei di usarlo se non capisci cosa fa.

Error.createCustromConstructor = (function() {

    function define(obj, prop, value) {
        Object.defineProperty(obj, prop, {
            value: value,
            configurable: true,
            enumerable: false,
            writable: true
        });
    }

    return function(name, init, proto) {
        var CustomError;
        proto = proto || {};
        function build(message) {
            var self = this instanceof CustomError
                ? this
                : Object.create(CustomError.prototype);
            Error.apply(self, arguments);
            Error.captureStackTrace(self, CustomError);
            if (message != undefined) {
                define(self, 'message', String(message));
            }
            define(self, 'arguments', undefined);
            define(self, 'type', undefined);
            if (typeof init == 'function') {
                init.apply(self, arguments);
            }
            return self;
        }
        eval('CustomError = function ' + name + '() {' +
            'return build.apply(this, arguments); }');
        CustomError.prototype = Object.create(Error.prototype);
        define(CustomError.prototype, 'constructor', CustomError);
        for (var key in proto) {
            define(CustomError.prototype, key, proto[key]);
        }
        Object.defineProperty(CustomError.prototype, 'name', { value: name });
        return CustomError;
    }

})();

Come risultato otteniamo

/**
 * name   The name of the constructor name
 * init   User-defined initialization function
 * proto  It's enumerable members will be added to 
 *        prototype of created constructor
 **/
Error.createCustromConstructor = function(name, init, proto)

Quindi puoi usarlo in questo modo:

var NotImplementedError = Error.createCustromConstructor('NotImplementedError');

E usa NotImplementedErrorcome faresti Error:

throw new NotImplementedError();
var err = new NotImplementedError();
var err = NotImplementedError('Not yet...');

E si comporterà è previsto:

err instanceof NotImplementedError               // -> true
err instanceof Error                             // -> true
NotImplementedError.prototype.isPrototypeOf(err) // -> true
Error.prototype.isPrototypeOf(err)               // -> true
err.constructor.name                             // -> NotImplementedError
err.name                                         // -> NotImplementedError
err.message                                      // -> Not yet...
err.toString()                                   // -> NotImplementedError: Not yet...
err.stack                                        // -> works fine!

Si noti che error.stackfunziona perfettamente e non includeNotImplementedError chiamata del costruttore (grazie ai v8 Error.captureStackTrace()).

Nota. C'è brutto eval(). L'unico motivo per cui viene utilizzato è quello di essere corretti err.constructor.name. Se non ti serve, puoi semplificare un po 'tutto.


2
Error.apply(self, arguments)è specificato per non funzionare . Suggerisco invece di copiare la traccia dello stack che è compatibile con più browser.
Kornel,

11

Uso spesso un approccio con eredità prototipale. L'override toString()ti dà il vantaggio che strumenti come Firebug registreranno le informazioni effettive anziché[object Object] sulla console per eccezioni non rilevate.

Uso instanceof per determinare il tipo di eccezione.

main.js

// just an exemplary namespace
var ns = ns || {};

// include JavaScript of the following
// source files here (e.g. by concatenation)

var someId = 42;
throw new ns.DuplicateIdException('Another item with ID ' +
    someId + ' has been created');
// Firebug console:
// uncaught exception: [Duplicate ID] Another item with ID 42 has been created

Exception.js

ns.Exception = function() {
}

/**
 * Form a string of relevant information.
 *
 * When providing this method, tools like Firebug show the returned 
 * string instead of [object Object] for uncaught exceptions.
 *
 * @return {String} information about the exception
 */
ns.Exception.prototype.toString = function() {
    var name = this.name || 'unknown';
    var message = this.message || 'no description';
    return '[' + name + '] ' + message;
};

DuplicateIdException.js

ns.DuplicateIdException = function(message) {
    this.name = 'Duplicate ID';
    this.message = message;
};

ns.DuplicateIdException.prototype = new ns.Exception();

8

ES6

Con la nuova classe ed estendi parole chiave ora è molto più semplice:

class CustomError extends Error {
  constructor(message) {
    super(message);
    //something
  }
}

7

Usa il tiro dichiarazione di .

A JavaScript non importa quale sia il tipo di eccezione (come fa Java). JavaScript si accorge solo che c'è un'eccezione e quando lo catturi, puoi "guardare" cosa dice l'eccezione ".

Se hai diversi tipi di eccezione che devi lanciare, ti suggerirei di usare variabili che contengono la stringa / oggetto dell'eccezione, ad esempio il messaggio. Laddove necessario, usa "usa myException" e, nella cattura, confronta l'eccezione rilevata con myException.


1

Vedi questo esempio in MDN.

Se devi definire più errori (prova qui il codice !):

function createErrorType(name, initFunction) {
    function E(message) {
        this.message = message;
        if (Error.captureStackTrace)
            Error.captureStackTrace(this, this.constructor);
        else
            this.stack = (new Error()).stack;
        initFunction && initFunction.apply(this, arguments);
    }
    E.prototype = Object.create(Error.prototype);
    E.prototype.name = name;
    E.prototype.constructor = E;
    return E;
}
var InvalidStateError = createErrorType(
    'InvalidStateError',
    function (invalidState, acceptedStates) {
        this.message = 'The state ' + invalidState + ' is invalid. Expected ' + acceptedStates + '.';
    });

var error = new InvalidStateError('foo', 'bar or baz');
function assert(condition) { if (!condition) throw new Error(); }
assert(error.message);
assert(error instanceof InvalidStateError);  
assert(error instanceof Error); 
assert(error.name == 'InvalidStateError');
assert(error.stack);
error.message;

Il codice viene copiato principalmente da: qual è un buon modo per estendere l'errore in JavaScript?


1

Un'alternativa alla risposta di asselin per l'uso con le classi ES2015

class InvalidArgumentException extends Error {
    constructor(message) {
        super();
        Error.captureStackTrace(this, this.constructor);
        this.name = "InvalidArgumentException";
        this.message = message;
    }
}

1
//create error object
var error = new Object();
error.reason="some reason!";

//business function
function exception(){
    try{
        throw error;
    }catch(err){
        err.reason;
    }
}

Ora impostiamo aggiungere il motivo o le proprietà che vogliamo all'oggetto errore e recuperarlo. Rendendo l'errore più ragionevole.

Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.