web-dev-qa-db-ja.com

JavaScriptのカスタム例外

JavaScriptでユーザー定義の例外のカスタムタイプを定義できますか?できれば、どうすればいいですか?

215
Manki

から 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:[email protected]\">system administrator</a>.",
  toString:    function(){return this.name + ": " + this.message;} 
}; 
223
jon077

エラーからプロトタイプを継承するカスタム例外を作成する必要があります。例えば:

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;

これは基本的に、上記の disfated の単純化されたバージョンであり、Firefoxや他のブラウザーでスタックトレースが機能するように強化されています。彼が投稿したのと同じテストを満たします:

使用法:

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

そして、それは期待されます:

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!
84
asselin

次の例のように、独自の例外とその処理を実装できます。

// 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");
    }
}

型付き例外をキャッチするための別の構文がありますが、これはすべてのブラウザーで機能するわけではありません(たとえば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");
}
79
Sergey Ilinsky

はい。整数、文字列、オブジェクトなど何でも好きなものを投げることができます。オブジェクトをスローする場合は、他の状況でオブジェクトを作成するのと同じように、新しいオブジェクトを作成してからスローします。 MozillaのJavascriptリファレンス にはいくつかの例があります。

39
Rob Kennedy
function MyError(message) {
 this.message = message;
}

MyError.prototype = new Error;

これにより、次のような使用が可能になります。

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

要するに:

  • トランスパイルなしでES6を使用している場合

    class CustomError extends Error { /* ... */}
    

    現在のベストプラクティスは、 ES6構文を使用したJavascriptのエラーの拡張 を参照してください。

  • Babel transpilerを使用している場合:

オプション1: babel-plugin-transform-b​​uiltin-extend を使用

オプション2:自分でやる(同じライブラリからヒントを得た)

    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);
  • pure ES5を使用している場合:

    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;
    }
    
  • 代替: Classtrophobic frameworkを使用

説明:

ES6とBabelを使用してErrorクラスを拡張するのはなぜ問題ですか?

これは、CustomErrorのインスタンスがそのように認識されなくなったためです。

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

実際、Babelの公式ドキュメントから、 組み込みJavaScriptクラスを拡張することはできませんDateArrayDOMErrorなど)を使用します。

この問題は次のとおりです。

他のSO回答はどうですか?

与えられたすべての答えはinstanceofの問題を修正しますが、通常のエラーconsole.logを失います:

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

上記の方法を使用すると、instanceofの問題を修正するだけでなく、通常のエラーconsole.logも保持されます。

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

私はプロトタイプの継承を使用するアプローチをよく使用します。 toString()をオーバーライドすると、Firebugのようなツールが、[object Object]の代わりに実際の情報をコンソールに記録して、例外を捕捉できないという利点があります。

instanceofを使用して、例外のタイプを判別します。

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();
11
Matthias

ネイティブErrorの動作と完全に同一のカスタムエラーを作成する方法を次に示します。この手法Chromeおよびnode.jsでのみ動作します今のところ。私もそれを使用することはお勧めしませんそれが何をするのか理解していないなら。

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;
    }

})();

安心して

/**
 * 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)

その後、次のように使用できます。

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

NotImplementedErrorと同じようにErrorを使用します。

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

そして、それは期待されます:

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!

error.stackは完全に正しく動作し、NotImplementedErrorコンストラクター呼び出しは含まれないことに注意してください(v8のError.captureStackTrace()のおかげです)。

注意。いeval()があります。使用される唯一の理由は、正しいerr.constructor.nameを取得することです。必要ない場合は、すべてを少し簡素化できます。

11
disfated

throw ステートメントを使用します。

JavaScriptは(Javaが行うように)例外タイプが何であるかを気にしません。 JavaScriptはただ気づくだけで、例外があり、それをキャッチすると、その例外が「言う」ことを「見る」ことができます。

異なる例外タイプをスローする必要がある場合は、例外の文字列/オブジェクト、つまりメッセージを含む変数を使用することをお勧めします。必要な場所で「throw myException」を使用し、キャッチで、キャッチした例外をmyExceptionと比較します。

5
Xn0vv3r

ES6

新しいクラスと拡張キーワードを使用すると、はるかに簡単になりました。

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

MDNの この例 を参照してください。

複数のエラーを定義する必要がある場合(コードをテストします here !):

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;

コードの大部分は次からコピーされます。 JavaScriptのエラーを拡張する良い方法は何ですか?

1
Peter Tseng

ES2015クラスで使用する asselin の答えの代替

class InvalidArgumentException extends Error {
    constructor(message) {
        super();
        Error.captureStackTrace(this, this.constructor);
        this.name = "InvalidArgumentException";
        this.message = message;
    }
}
1
Mr Tsjolder
//create error object
var error = new Object();
error.reason="some reason!";

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

次に、理由または必要なプロパティをエラーオブジェクトに追加して取得します。エラーをより合理的にすることにより。

1
Mateen