JavaScriptでカスタムエラーを作成するにはどうすればよいですか？

Question

何らかの理由で、次のスニペットではコンストラクター委任が機能していないようです。

function NotImplementedError() { 
  Error.apply(this, arguments); 
}
NotImplementedError.prototype = new Error();

var nie = new NotImplementedError("some message");
console.log("The message is: '"+nie.message+"'")

これを実行すると、The message is: ''が得られます。理由、または新しいErrorサブクラスを作成するより良い方法があるかどうかについてのアイデアはありますか？知らないネイティブapplyコンストラクターへのErroringに問題はありますか？

Answer 1

コードを更新して、プロトタイプをError.prototypeおよびinstanceofに割り当て、アサートを機能させます。

function NotImplementedError(message) {
    this.name = "NotImplementedError";
    this.message = (message || "");
}
NotImplementedError.prototype = Error.prototype;

ただし、私はあなた自身のオブジェクトを投げて、nameプロパティをチェックするだけです。

throw {name : "NotImplementedError", message : "too lazy to implement"}; 

コメントに基づいて編集

コメントを見て、Nicholas Zakasが article で行ったように、プロトタイプをnew Error()の代わりにError.prototypeに割り当てる理由を思い出そうとして、 jsFiddleを作成しました 以下のコード：

function NotImplementedError(message) {
  this.name = "NotImplementedError";
  this.message = (message || "");
}
NotImplementedError.prototype = Error.prototype;

function NotImplementedError2(message) {
  this.message = (message || "");
}
NotImplementedError2.prototype = new Error();

try {
  var e = new NotImplementedError("NotImplementedError message");
  throw e;
} catch (ex1) {
  console.log(ex1.stack);
  console.log("ex1 instanceof NotImplementedError = " + (ex1 instanceof NotImplementedError));
  console.log("ex1 instanceof Error = " + (ex1 instanceof Error));
  console.log("ex1.name = " + ex1.name);
  console.log("ex1.message = " + ex1.message);
}

try {
  var e = new NotImplementedError2("NotImplementedError2 message");
  throw e;
} catch (ex1) {
  console.log(ex1.stack);
  console.log("ex1 instanceof NotImplementedError2 = " + (ex1 instanceof NotImplementedError2));
  console.log("ex1 instanceof Error = " + (ex1 instanceof Error));
  console.log("ex1.name = " + ex1.name);
  console.log("ex1.message = " + ex1.message);
}

コンソール出力はこれでした。

undefined
ex1 instanceof NotImplementedError = true
ex1 instanceof Error = true
ex1.name = NotImplementedError
ex1.message = NotImplementedError message
Error
    at window.onload (http://fiddle.jshell.net/MwMEJ/show/:29:34)
ex1 instanceof NotImplementedError2 = true
ex1 instanceof Error = true
ex1.name = Error
ex1.message = NotImplementedError2 message

これは、エラーのスタックプロパティがthrow eが発生した場所ではなく、new Error()が作成された行番号であったことを私が遭遇した「問題」を確認します。ただし、Errorオブジェクトに影響を与えるNotImplementedError.prototype.name = "NotImplementedError"行の副作用がある方が良い場合があります。

また、NotImplementedError2に注意してください。.nameを明示的に設定しないと、「エラー」と等しくなります。ただし、コメントで述べたように、そのバージョンはプロトタイプをnew Error()に設定するため、NotImplementedError2.prototype.name = "NotImplementedError2"を設定してOKにすることができます。

Answer 2

上記の答えはすべてひどいです-本当に。 107個のUPSを使用する場合でも！本当の答えはこちらです：

Errorオブジェクトから継承-メッセージプロパティはどこにありますか？

TL; DR：

A. messageが設定されていない理由は、Errorが新しいErrorオブジェクトを返す関数であり、not何らかの方法でthisを操作します。

B.この権利を行う方法は、コンストラクターから適用の結果を返すことと、通常の複雑なjavascriptyの方法でプロトタイプを設定することです。

function MyError() {
    var temp = Error.apply(this, arguments);
    temp.name = this.name = 'MyError';
    this.message = temp.message;
    if(Object.defineProperty) {
        // getter for more optimizy goodness
        /*this.stack = */Object.defineProperty(this, 'stack', { 
            get: function() {
                return temp.stack
            },
            configurable: true // so you can change it if you want
        })
    } else {
        this.stack = temp.stack
    }
}
//inherit prototype using ECMAScript 5 (IE 9+)
MyError.prototype = Object.create(Error.prototype, {
    constructor: {
        value: MyError,
        writable: true,
        configurable: true
    }
});

var myError = new MyError("message");
console.log("The message is: '" + myError.message + "'"); // The message is: 'message'
console.log(myError instanceof Error); // true
console.log(myError instanceof MyError); // true
console.log(myError.toString()); // MyError: message
console.log(myError.stack); // MyError: message \n 
// <stack trace ...>


 
//for EMCAScript 4 or ealier (IE 8 or ealier), inherit prototype this way instead of above code:
/*
var IntermediateInheritor = function() {};
IntermediateInheritor.prototype = Error.prototype;
MyError.prototype = new IntermediateInheritor();
*/

tmpおよびstackのみを明示的に設定するのではなく、message Errorのすべての列挙不可能なプロパティを列挙するために何らかのトリックを行うことができますが、トリックはサポートされていませんie <9

Answer 3

ES2015では、classを使用してこれをきれいに行うことができます。

class NotImplemented extends Error {
  constructor(message = "", ...args) {
    super(message, ...args);
    this.message = message + " has not yet been implemented.";
  }
}

これはグローバルErrorプロトタイプを変更せず、message、name、およびその他の属性をカスタマイズし、スタックを適切にキャプチャします。また、かなり読みやすいです。

もちろん、古いブラウザでコードを実行する場合は、babelなどのツールを使用する必要があります。

Answer 4

カスタムエラーの作成方法について誰かが興味がある場合andスタックトレースを取得します。

function CustomError(message) {
  this.name = 'CustomError';
  this.message = message || '';
  var error = new Error(this.message);
  error.name = this.name;
  this.stack = error.stack;
}
CustomError.prototype = Object.create(Error.prototype);

try {
  throw new CustomError('foobar');
}
catch (e) {
  console.log('name:', e.name);
  console.log('message:', e.message);
  console.log('stack:', e.stack);
}

Answer 5

function InvalidValueError(value, type) {
    this.message = "Expected `" + type.name + "`: " + value;
    var error = new Error(this.message);
    this.stack = error.stack;
}
InvalidValueError.prototype = new Error();
InvalidValueError.prototype.name = InvalidValueError.name;
InvalidValueError.prototype.constructor = InvalidValueError;

Answer 6

標準のこのセクションでは、Error.apply呼び出しがオブジェクトを初期化しない理由を説明します。

15.11.1関数として呼び出されるエラーコンストラクター

Errorがコンストラクターとしてではなく関数として呼び出されると、新しいErrorオブジェクトを作成して初期化します。したがって、関数呼び出しError（...）は、同じ引数を持つオブジェクト作成式new Error（...）と同等です。

この場合、Error関数はおそらくコンストラクターとして呼び出されていないと判断するため、thisオブジェクトを初期化するのではなく、新しいErrorインスタンスを返します。

次のコードでテストすると、これが実際に何が起こっているのかがわかります。

function NotImplementedError() { 
   var returned = Error.apply(this, arguments);
   console.log("returned.message = '" + returned.message + "'");
   console.log("this.message = '" + this.message + "'");
}
NotImplementedError.prototype = new Error();

var nie = new NotImplementedError("some message");

これを実行すると、次の出力が生成されます。

returned.message = 'some message'
this.message = ''

Answer 7

これと同様の問題がありました。私のエラーは、instanceofとErrorとNotImplementedの両方である必要があり、コンソールで一貫したバックトレースを生成する必要もあります。

私の解決策：

var NotImplemented = (function() {
  var NotImplemented, err;
  NotImplemented = (function() {
    function NotImplemented(message) {
      var err;
      err = new Error(message);
      err.name = "NotImplemented";
      this.message = err.message;
      if (err.stack) this.stack = err.stack;
    }
    return NotImplemented;
  })();
  err = new Error();
  err.name = "NotImplemented";
  NotImplemented.prototype = err;

  return NotImplemented;
}).call(this);

// TEST:
console.log("instanceof Error: " + (new NotImplemented() instanceof Error));
console.log("instanceof NotImplemented: " + (new NotImplemented() instanceofNotImplemented));
console.log("message: "+(new NotImplemented('I was too busy').message));
throw new NotImplemented("just didn't feel like it");

Node.jsで実行した結果：

instanceof Error: true
instanceof NotImplemented: true
message: I was too busy

/private/tmp/t.js:24
throw new NotImplemented("just didn't feel like it");
      ^
NotImplemented: just didn't feel like it
    at Error.NotImplemented (/Users/colin/projects/gems/jax/t.js:6:13)
    at Object.<anonymous> (/Users/colin/projects/gems/jax/t.js:24:7)
    at Module._compile (module.js:449:26)
    at Object.Module._extensions..js (module.js:467:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Module.runMain (module.js:487:10)
    at process.startup.processNextTick.process._tickCallback (node.js:244:9)

エラーは私の基準の3つすべてに合格し、stackプロパティは非標準ですが、 ほとんどの新しいブラウザーでサポートされています これは私の場合は受け入れられます。

Answer 8

Joyentによれば スタックプロパティを混乱させるべきではありません（これは多くの回答でわかります）。パフォーマンスに悪影響を与えるからです。彼らが言うことは次のとおりです。

stack：通常、これを台無しにしないでください。それを増強しないでください。 V8は、誰かが実際にプロパティを読み取った場合にのみ計算するため、処理可能なエラーのパフォーマンスが大幅に向上します。プロパティを拡張するためだけにプロパティを読み取ると、呼び出し元がスタックを必要としない場合でも、コストを支払うことになります。

元のエラーをラップするという考え はスタックを渡すためのすてきな代替品です。

上記を考慮して、カスタムエラーを作成する方法を次に示します。

es5バージョン：

function RError(options) {
    options = options || {}; // eslint-disable-line no-param-reassign
    this.name = options.name;
    this.message = options.message;
    this.cause = options.cause;

    // capture stack (this property is supposed to be treated as private)
    this._err = new Error();

    // create an iterable chain
    this.chain = this.cause ? [this].concat(this.cause.chain) : [this];
}
RError.prototype = Object.create(Error.prototype, {
    constructor: {
        value: RError,
        writable: true,
        configurable: true
    }
});

Object.defineProperty(RError.prototype, 'stack', {
    get: function stack() {
        return this.name + ': ' + this.message + '\n' + this._err.stack.split('\n').slice(2).join('\n');
    }
});

Object.defineProperty(RError.prototype, 'why', {
    get: function why() {
        var _why = this.name + ': ' + this.message;
        for (var i = 1; i < this.chain.length; i++) {
            var e = this.chain[i];
            _why += ' <- ' + e.name + ': ' + e.message;
        }
        return _why;
    }
});

// usage

function fail() {
    throw new RError({
        name: 'BAR',
        message: 'I messed up.'
    });
}

function failFurther() {
    try {
        fail();
    } catch (err) {
        throw new RError({
            name: 'FOO',
            message: 'Something went wrong.',
            cause: err
        });
    }
}

try {
    failFurther();
} catch (err) {
    console.error(err.why);
    console.error(err.stack);
    console.error(err.cause.stack);
}

es6バージョン：

class RError extends Error {
    constructor({name, message, cause}) {
        super();
        this.name = name;
        this.message = message;
        this.cause = cause;
    }
    [Symbol.iterator]() {
        let current = this;
        let done = false;
        const iterator = {
            next() {
                const val = current;
                if (done) {
                    return { value: val, done: true };
                }
                current = current.cause;
                if (!val.cause) {
                    done = true;
                }
                return { value: val, done: false };
            }
        };
        return iterator;
    }
    get why() {
        let _why = '';
        for (const e of this) {
            _why += `${_why.length ? ' <- ' : ''}${e.name}: ${e.message}`;
        }
        return _why;
    }
}

// usage

function fail() {
    throw new RError({
        name: 'BAR',
        message: 'I messed up.'
    });
}

function failFurther() {
    try {
        fail();
    } catch (err) {
        throw new RError({
            name: 'FOO',
            message: 'Something went wrong.',
            cause: err
        });
    }
}

try {
    failFurther();
} catch (err) {
    console.error(err.why);
    console.error(err.stack);
    console.error(err.cause.stack);
}

ソリューションをモジュールに入れました。ここにあります： https://www.npmjs.com/package/rerror

Answer 9

コンストラクターパターンを使用して、新しいエラーオブジェクトを作成しました。 Errorインスタンスなどのプロトタイプチェーンを定義しました。 MDN エラーコンストラクター リファレンスを参照してください。

これでこのスニペットを確認できますGist。

実装

// Creates user-defined exceptions
var CustomError = (function() {
  'use strict';

  //constructor
  function CustomError() {
    //enforces 'new' instance
    if (!(this instanceof CustomError)) {
      return new CustomError(arguments);
    }
    var error,
      //handles the arguments object when is passed by enforcing a 'new' instance
      args = Array.apply(null, typeof arguments[0] === 'object' ? arguments[0] : arguments),
      message = args.shift() || 'An exception has occurred';

    //builds the message with multiple arguments
    if (~message.indexOf('}')) {
      args.forEach(function(arg, i) {
        message = message.replace(RegExp('\\{' + i + '}', 'g'), arg);
      });
    }

    //gets the exception stack
    error = new Error(message);
    //access to CustomError.prototype.name
    error.name = this.name;

    //set the properties of the instance
    //in order to resemble an Error instance
    Object.defineProperties(this, {
      stack: {
        enumerable: false,
        get: function() { return error.stack; }
      },
      message: {
        enumerable: false,
        value: message
      }
    });
  }

  // Creates the prototype and prevents the direct reference to Error.prototype;
  // Not used new Error() here because an exception would be raised here,
  // but we need to raise the exception when CustomError instance is created.
  CustomError.prototype = Object.create(Error.prototype, {
    //fixes the link to the constructor (ES5)
    constructor: setDescriptor(CustomError),
    name: setDescriptor('JSU Error')
  });

  function setDescriptor(value) {
    return {
      configurable: false,
      enumerable: false,
      writable: false,
      value: value
    };
  }

  //returns the constructor
  return CustomError;
}());

使用法

CustomErrorコンストラクターは、メッセージを作成するために多くの引数を受け取ることができます。

var err1 = new CustomError("The url of file is required"),
    err2 = new CustomError("Invalid Date: {0}", +"date"),
    err3 = new CustomError("The length must be greater than {0}", 4),
    err4 = new CustomError("Properties .{0} and .{1} don't exist", "p1", "p2");

throw err4;

そして、これがカスタムエラーの外観です。

Answer 10

スタックトレースまたはtoStringでメッセージが同じになるように、このようにして、名前または名前とメッセージを渡すことができます。たとえば、HTTPエラーをスローする場合に便利です。ハンドラーはユーザーにerror.toString()するだけで、エラーやその他のエラーをエレガントに処理できます。

class AppException extends Error {
  constructor(code, message) {
    const fullMsg = message ? `${code}: ${message}` : code;
    super(fullMsg);
    this.name = code;
    this.message = fullMsg;
  }
  
  toString() {
    return this.message;
  }
}

// Just an error name
try {
  throw new AppException('Forbidden');
} catch(e) {
  console.error(e);
  console.error(e.toString());
}

// A name and a message
try {
  throw new AppException('Forbidden', 'You don\'t have access to this page');
} catch(e) {
  console.error(e);
  console.error(e.toString());
}

Answer 11

このようなものを実装する必要があり、自分のエラー実装でスタックが失われたことがわかりました。私がしなければならなかったことは、ダミーエラーを作成し、そこからスタックを取得することでした：

My.Error = function (message, innerException) {
    var err = new Error();
    this.stack = err.stack; // IMPORTANT!
    this.name = "Error";
    this.message = message;
    this.innerException = innerException;
}
My.Error.prototype = new Error();
My.Error.prototype.constructor = My.Error;
My.Error.prototype.toString = function (includeStackTrace) {
    var msg = this.message;
    var e = this.innerException;
    while (e) {
        msg += " The details are:\n" + e.message;
        e = e.innerException;
    }
    if (includeStackTrace) {
        msg += "\n\nStack Trace:\n\n" + this.stack;
    }
    return msg;
}

Answer 12

これは私の実装です：

class HttpError extends Error {
  constructor(message, code = null, status = null, stack = null, name = null) {
    super();
    this.message = message;
    this.status = 500;

    this.name = name || this.constructor.name;
    this.code = code || `E_${this.name.toUpperCase()}`;
    this.stack = stack || null;
  }

  static fromObject(error) {
    if (error instanceof HttpError) {
      return error;
    }
    else {
      const { message, code, status, stack } = error;
      return new ServerError(message, code, status, stack, error.constructor.name);
    }
  }

  expose() {
    if (this instanceof ClientError) {
      return { ...this };
    }
    else {
      return {
        name: this.name,
        code: this.code,
        status: this.status,
      }
    }
  }
}

class ServerError extends HttpError {}

class ClientError extends HttpError { }

class IncorrectCredentials extends ClientError {
  constructor(...args) {
    super(...args);
    this.status = 400;
  }
}

class ResourceNotFound extends ClientError {
  constructor(...args) {
    super(...args);
    this.status = 404;
  }
}

使用例＃1：

app.use((req, res, next) => {
  try {
    invalidFunction();
  }
  catch (err) {
    const error = HttpError.fromObject(err);
    return res.status(error.status).send(error.expose());
  }
});

使用例＃2：

router.post('/api/auth', async (req, res) => {
  try {
    const isLogged = await User.logIn(req.body.username, req.body.password);

    if (!isLogged) {
      throw new IncorrectCredentials('Incorrect username or password');
    }
    else {
      return res.status(200).send({
        token,
      });
    }
  }
  catch (err) {
    const error = HttpError.fromObject(err);
    return res.status(error.status).send(error.expose());
  }
});

Answer 13

コンストラクターはファクトリーメソッドのようで、必要なものを返す必要があります。追加のメソッド/プロパティが必要な場合は、オブジェクトを返す前にそれらをオブジェクトに追加できます。

function NotImplementedError(message) { return new Error("Not implemented", message); }

x = new NotImplementedError();

なぜあなたはこれをする必要があるのか​​分かりませんが。単にnew Error...を使用しないのはなぜですか？ JavaScript（またはおそらく型指定されていない言語）では、カスタム例外はあまり追加されません。

Answer 14

これはCesium DeveloperErrorでうまく実装されています：

• ドキュメント
• ソース

簡略化された形式：

var NotImplementedError = function(message) {
    this.name = 'NotImplementedError';
    this.message = message;
    this.stack = (new Error()).stack;
}

// Later on...

throw new NotImplementedError();

Answer 15

別の代替手段は、すべての環境で動作しない可能性があります。少なくともnodejs 0.8で動作することを保証します

function myError(msg){ 
      var e = new Error(msg); 
      _this = this; 
      _this.__proto__.__proto__ = e;
}

Answer 16

Node/Chromeを使用している場合。次のスニペットは、次の要件を満たす拡張機能を取得します。

• err instanceof Error
• err instanceof CustomErrorType
• console.log（）は、メッセージ付きで作成されたときに[CustomErrorType]を返します
• console.log（）は、メッセージなしで作成されたときに[CustomErrorType: message]を返します
• throw/stackは、エラーが作成された時点の情報を提供します。
• Node.JSおよびChromeで最適に動作します。
• Chrome、Safari、Firefox、およびIE 8+のinstanceofチェックに合格しますが、Chrome/Safariの外部に有効なスタックはありません。クロムでデバッグできるため、これで問題ありませんが、特定のエラータイプを必要とするコードはクロスブラウザーで機能します。 Nodeのみが必要な場合は、ifステートメントを簡単に削除できます。すぐに使用できます。

スニペット

var CustomErrorType = function(message) {
    if (Object.defineProperty) {
        Object.defineProperty(this, "message", {
            value : message || "",
            enumerable : false
        });
    } else {
        this.message = message;
    }

    if (Error.captureStackTrace) {
        Error.captureStackTrace(this, CustomErrorType);
    }
}

CustomErrorType.prototype = new Error();
CustomErrorType.prototype.name = "CustomErrorType";

使用法

var err = new CustomErrorType("foo");

出力

var err = new CustomErrorType("foo");
console.log(err);
console.log(err.stack);

[CustomErrorType: foo]
CustomErrorType: foo
    at Object.<anonymous> (/errorTest.js:27:12)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:497:10)
    at startup (node.js:119:16)
    at node.js:906:3

/errorTest.js:30
        throw err;
              ^
CustomErrorType: foo
    at Object.<anonymous> (/errorTest.js:27:12)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:497:10)
    at startup (node.js:119:16)
    at node.js:906:3

Answer 17

instanceofを使用できないことを犠牲にして、以下は元のスタックトレースを保持し、非標準のトリックを使用しません。

// the function itself
var fixError = function(err, name) {
    err.name = name;
    return err;
}

// using the function
try {
    throw fixError(new Error('custom error message'), 'CustomError');
} catch (e) {
    if (e.name == 'CustomError')
        console.log('Wee! Custom Error! Msg:', e.message);
    else
        throw e; // unhandled. let it propagate upwards the call stack
}