At object anonymous как исправить
Перейти к содержимому

At object anonymous как исправить

  • автор:

Ошибки в JavaScript и как их исправить

JavaScript может быть кошмаром при отладке: некоторые ошибки, которые он выдает, могут быть очень трудны для понимания с первого взгляда, и выдаваемые номера строк также не всегда полезны. Разве не было бы полезно иметь список, глядя на который, можно понять смысл ошибок и как исправить их? Вот он!

Ниже представлен список странных ошибок в JavaScript. Разные браузеры могут выдавать разные сообщения об одинаковых ошибках, поэтому приведено несколько примеров там, где возможно.

Как читать ошибки?

Перед самим списком, давайте быстро взглянем на структуру сообщения об ошибке. Понимание структуры помогает понимать ошибки, и вы получите меньше проблем, если наткнетесь на ошибки, не представленные в этом списке.

Типичная ошибка из Chrome выглядит так:

Uncaught TypeError: undefined is not a function 
  1. Uncaught TypeError: эта часть сообщения обычно не особо полезна. Uncaught значит, что ошибка не была перехвачена в catch , а TypeError — это название ошибки.
  2. undefined is not a function: это та самая часть про ошибку. В случае с сообщениями об ошибках, читать их нужно прямо буквально. Например, в этом случае, она значит то, что код попытался использовать значение undefined как функцию.

Теперь к самим ошибкам.

Uncaught TypeError: undefined is not a function

Связанные ошибки: number is not a function, object is not a function, string is not a function, Unhandled Error: ‘foo’ is not a function, Function Expected

Возникает при попытке вызова значения как функции, когда значение функцией не является. Например:

var foo = undefined; foo(); 

Эта ошибка обычно возникает, если вы пытаетесь вызвать функцию для объекта, но опечатались в названии.

var x = document.getElementByID('foo'); 

Несуществующие свойства объекта по-умолчанию имеют значение undefined , что приводит к этой ошибке.

Другие вариации, такие как “number is not a function” возникают при попытке вызвать число, как будто оно является функцией.

Как исправить ошибку: убедитесь в корректности имени функции. Для этой ошибки, номер строки обычно указывает в правильное место.

Uncaught ReferenceError: Invalid left-hand side in assignment

Связанные ошибки: Uncaught exception: ReferenceError: Cannot assign to ‘functionCall()’, Uncaught exception: ReferenceError: Cannot assign to ‘this’

Вызвано попыткой присвоить значение тому, чему невозможно присвоить значение.

Наиболее частый пример этой ошибки — это условие в if:

if(doSomething() = 'somevalue') 

В этом примере программист случайно использовал один знак равенства вместо двух. Выражение “left-hand side in assignment” относится к левой части знака равенства, а, как можно видеть в данном примере, левая часть содержит что-то, чему нельзя присвоить значение, что и приводит к ошибке.

Как исправить ошибку: убедитесь, что вы не пытаетесь присвоить значение результату функции или ключевому слову this .

Uncaught TypeError: Converting circular structure to JSON

Связанные ошибки: Uncaught exception: TypeError: JSON.stringify: Not an acyclic Object, TypeError: cyclic object value, Circular reference in value argument not supported

Всегда вызвано циклической ссылкой в объекте, которая потом передается в JSON.stringify .

var a = < >; var b = < a: a >; a.b = b; JSON.stringify(a); 

Так как a и b в примере выше имеют ссылки друг на друга, результирующий объект не может быть приведен к JSON.

Как исправить ошибку: удалите циклические ссылки, как в примере выше, из всех объектов, которые вы хотите сконвертировать в JSON.

Unexpected token ;

Связанные ошибки: Expected ), missing ) after argument list

Интерпретатор JavaScript что-то ожидал, но не обнаружил там этого. Обычно вызвано пропущенными фигурными, круглыми или квадратными скобками.

Токен в данной ошибке может быть разным — может быть написано “Unexpected token ]”, “Expected

Как исправить ошибку: иногда номер строки не указывает на правильное местоположение, что затрудняет исправление ошибки.

Ошибка с [ ] < >( ) обычно вызвано несовпадающей парой. Проверьте, все ли ваши скобки имеют закрывающую пару. В этом случае, номер строки обычно указывает на что-то другое, а не на проблемный символ.

Unexpected / связано с регулярными выражениями. Номер строки для данного случая обычно правильный.

Unexpected; обычно вызвано символом; внутри литерала объекта или массива, или списка аргументов вызова функции. Номер строки обычно также будет верным для данного случая.

Uncaught SyntaxError: Unexpected token ILLEGAL

Связанные ошибки: Unterminated String Literal, Invalid Line Terminator

В строковом литерале пропущена закрывающая кавычка.

Как исправить ошибку: убедитесь, что все строки имеют правильные закрывающие кавычки.

Uncaught TypeError: Cannot read property ‘foo’ of null, Uncaught TypeError: Cannot read property ‘foo’ of undefined

Связанные ошибки: TypeError: someVal is null, Unable to get property ‘foo’ of undefined or null reference

Попытка прочитать null или undefined так, как будто это объект. Например:

var someVal = null; console.log(someVal.foo); 

Как исправить ошибку: обычно вызвано опечатками. Проверьте, все ли переменные, использованные рядом со строкой, указывающей на ошибку, правильно названы.

Uncaught TypeError: Cannot set property ‘foo’ of null, Uncaught TypeError: Cannot set property ‘foo’ of undefined

Связанные ошибки: TypeError: someVal is undefined, Unable to set property ‘foo’ of undefined or null reference

Попытка записать null или undefined так, как будто это объект. Например:

var someVal = null; someVal.foo = 1; 

Как исправить ошибку: это тоже обычно вызвано ошибками. Проверьте имена переменных рядом со строкой, указывающей на ошибку.

Uncaught RangeError: Maximum call stack size exceeded

Связанные ошибки: Uncaught exception: RangeError: Maximum recursion depth exceeded, too much recursion, Stack overflow

Обычно вызвано неправильно программной логикой, что приводит к бесконечному вызову рекурсивной функции.

Как исправить ошибку: проверьте рекурсивные функции на ошибки, которые могут вынудить их делать рекурсивные вызовы вечно.

Uncaught URIError: URI malformed

Связанные ошибки: URIError: malformed URI sequence

Вызвано некорректным вызовом decodeURIComponent .

Как исправить ошибку: убедитесь, что вызовы decodeURIComponent на строке ошибки получают корректные входные данные.

XMLHttpRequest cannot load some/url. No ‘Access-Control-Allow-Origin’ header is present on the requested resource

Связанные ошибки: Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at some/url

Эта проблема всегда связана с использованием XMLHttpRequest.

Как исправить ошибку: убедитесь в корректности запрашиваемого URL и в том, что он удовлетворяет same-origin policy. Хороший способ найти проблемный код — посмотреть на URL в сообщении ошибки и найти его в своём коде.

InvalidStateError: An attempt was made to use an object that is not, or is no longer, usable

Связанные ошибки: InvalidStateError, DOMException code 11

Означает то, что код вызвал функцию, которую нельзя было вызывать в текущем состоянии. Обычно связано c XMLHttpRequest при попытке вызвать на нём функции до его готовности.

var xhr = new XMLHttpRequest(); xhr.setRequestHeader('Some-Header', 'val'); 

В данном случае вы получите ошибку потому, что функция setRequestHeader может быть вызвана только после вызова xhr.open .

Как исправить ошибку: посмотрите на код в строке, указывающей на ошибку, и убедитесь, что он вызывается в правильный момент или добавляет нужные вызовы до этого (как с xhr.open ).

Заключение

JavaScript содержит в себе одни из самых бесполезных ошибок, которые я когда-либо видел, за исключением печально известной Expected T_PAAMAYIM_NEKUDOTAYIM в PHP. Большая ознакомленность с ошибками привносит больше ясности. Современные браузеры тоже помогают, так как больше не выдают абсолютно бесполезные ошибки, как это было раньше.

Какие самые непонятные ошибки вы встречали? Делитесь своими наблюдениями в комментариях.

P.S. Этот перевод можно улучшить, отправив PR здесь.

  • Веб-разработка
  • JavaScript

At object anonymous как исправить

Watch out when ‘importing’ variables to a closure’s scope — it’s easy to miss / forget that they are actually being *copied* into the closure’s scope, rather than just being made available.

So you will need to explicitly pass them in by reference if your closure cares about their contents over time:

$one (); // outputs NULL: $result is not in scope
$two (); // outputs int(0): $result was copied
$three (); // outputs int(1)
?>

Another less trivial example with objects (what I actually tripped up on):

//set up variable in advance
$myInstance = null ;

$broken = function() uses ( $myInstance )
if(!empty( $myInstance )) $myInstance -> doSomething ();
>;

//$myInstance might be instantiated, might not be
if( SomeBusinessLogic :: worked () == true )
$myInstance = new myClass ();
>

$broken (); // will never do anything: $myInstance will ALWAYS be null inside this closure.
$working (); // will call doSomething if $myInstance is instantiated

8 years ago

/*
(string) $name Name of the function that you will add to class.
Usage : $Foo->add(function()<>,$name);
This will add a public function in Foo Class.
*/
class Foo
public function add ( $func , $name )
$this -> < $name >= $func ;
>
public function __call ( $func , $arguments ) call_user_func_array ( $this ->< $func >, $arguments );
>
>
$Foo = new Foo ();
$Foo -> add (function() echo «Hello World» ;
>, «helloWorldFunction» );
$Foo -> add (function( $parameterone ) echo $parameterone ;
>, «exampleFunction» );
$Foo -> helloWorldFunction (); /*Output : Hello World*/
$Foo -> exampleFunction ( «Hello PHP» ); /*Output : Hello PHP*/
?>

10 years ago

In case you were wondering (cause i was), anonymous functions can return references just like named functions can. Simply use the & the same way you would for a named function. right after the `function` keyword (and right before the nonexistent name).

$x =& $fn ();
var_dump ( $x , $value ); // ‘int(0)’, ‘int(0)’
++ $x ;
var_dump ( $x , $value ); // ‘int(1)’, ‘int(1)’

5 years ago

Every instance of a lambda has own instance of static variables. This provides for great event handlers, accumulators, etc., etc.

Creating new lambda with function() < . >; expression creates new instance of its static variables. Assigning a lambda to a variable does not create a new instance. A lambda is object of class Closure, and assigning lambdas to variables has the same semantics as assigning object instance to variables.

Example script: $a and $b have separate instances of static variables, thus produce different output. However $b and $c share their instance of static variables — because $c is refers to the same object of class Closure as $b — thus produce the same output.

function generate_lambda () : Closure
# creates new instance of lambda
return function( $v = null ) static $stored ;
if ( $v !== null )
$stored = $v ;
return $stored ;
>;
>

$a = generate_lambda (); # creates new instance of statics
$b = generate_lambda (); # creates new instance of statics
$c = $b ; # uses the same instance of statics as $b

$a ( ‘test AAA’ );
$b ( ‘test BBB’ );
$c ( ‘test CCC’ ); # this overwrites content held by $b, because it refers to the same object

var_dump ([ $a (), $b (), $c () ]);
?>

This test script outputs:
array(3) [0]=>
string(8) «test AAA»
[1]=>
string(8) «test CCC»
[2]=>
string(8) «test CCC»
>

6 years ago

One way to call a anonymous function recursively is to use the USE keyword and pass a reference to the function itself:

5 years ago

Beware of using $this in anonymous functions assigned to a static variable.

class Foo public function bar () static $anonymous = null ;
if ( $anonymous === null ) // Expression is not allowed as static initializer workaround
$anonymous = function () return $this ;
>;
>
return $anonymous ();
>
>

$a = new Foo ();
$b = new Foo ();
var_dump ( $a -> bar () === $a ); // True
var_dump ( $b -> bar () === $a ); // Also true
?>

In a static anonymous function, $this will be the value of whatever object instance that method was called on first.

To get the behaviour you’re probably expecting, you need to pass the $this context into the function.

class Foo public function bar () static $anonymous = null ;
if ( $anonymous === null ) // Expression is not allowed as static initializer workaround
$anonymous = function ( self $thisObj ) return $thisObj ;
>;
>
return $anonymous ( $this );
>
>

$a = new Foo ();
$b = new Foo ();
var_dump ( $a -> bar () === $a ); // True
var_dump ( $b -> bar () === $a ); // False
?>

14 years ago

When using anonymous functions as properties in Classes, note that there are three name scopes: one for constants, one for properties and one for methods. That means, you can use the same name for a constant, for a property and for a method at a time.

Since a property can be also an anonymous function as of PHP 5.3.0, an oddity arises when they share the same name, not meaning that there would be any conflict.

Consider the following example:

class MyClass const member = 1 ;

public function member () return «method ‘member'» ;
>

public function __construct () $this -> member = function () return «anonymous function ‘member'» ;
>;
>
>

header ( «Content-Type: text/plain» );

$myObj = new MyClass ();

var_dump ( MyClass :: member ); // int(1)
var_dump ( $myObj -> member ); // object(Closure)#2 (0) <>
var_dump ( $myObj -> member ()); // string(15) «method ‘member'»
$myMember = $myObj -> member ;
var_dump ( $myMember ()); // string(27) «anonymous function ‘member'»
?>

That means, regular method invocations work like expected and like before. The anonymous function instead, must be retrieved into a variable first (just like a property) and can only then be invoked.

12 years ago

/*
* An example showing how to use closures to implement a Python-like decorator
* pattern.
*
* My goal was that you should be able to decorate a function with any
* other function, then call the decorated function directly:
*
* Define function: $foo = function($a, $b, $c, . ) <. >
* Define decorator: $decorator = function($func) <. >
* Decorate it: $foo = $decorator($foo)
* Call it: $foo($a, $b, $c, . )
*
* This example show an authentication decorator for a service, using a simple
* mock session and mock service.
*/

/*
* Define an example decorator. A decorator function should take the form:
* $decorator = function($func) * return function() use $func) * // Do something, then call the decorated function when needed:
* $args = func_get_args($func);
* call_user_func_array($func, $args);
* // Do something else.
* >;
* >;
*/
$authorise = function( $func ) return function() use ( $func ) if ( $_SESSION [ ‘is_authorised’ ] == true ) $args = func_get_args ( $func );
call_user_func_array ( $func , $args );
>
else echo «Access Denied» ;
>
>;
>;

/*
* Define a function to be decorated, in this example a mock service that
* need to be authorised.
*/
$service = function( $foo ) echo «Service returns: $foo » ;
>;

/*
* Decorate it. Ensure you replace the origin function reference with the
* decorated function; ie just $authorise($service) won’t work, so do
* $service = $authorise($service)
*/
$service = $authorise ( $service );

/*
* Establish mock authorisation, call the service; should get
* ‘Service returns: test 1’.
*/
$_SESSION [ ‘is_authorised’ ] = true ;
$service ( ‘test 1’ );

/*
* Remove mock authorisation, call the service; should get ‘Access Denied’.
*/
$_SESSION [ ‘is_authorised’ ] = false ;
$service ( ‘test 2’ );

10 years ago

Beware that since PHP 5.4 registering a Closure as an object property that has been instantiated in the same object scope will create a circular reference which prevents immediate object destruction:

class Test
private $closure ;

public function __construct ()
$this -> closure = function () >;
>

public function __destruct ()
echo «destructed\n» ;
>
>

new Test ;
echo «finished\n» ;

?>

To circumvent this, you can instantiate the Closure in a static method:

public function __construct ()
$this -> closure = self :: createClosure ();
>

public static function createClosure ()
return function () >;
>

10 years ago

Some comparisons of PHP and JavaScript closures.

=== Example 1 (passing by value) ===
PHP code:
$aaa = 111 ;
$func = function() use( $aaa )< print $aaa ; >;
$aaa = 222 ;
$func (); // Outputs «111»
?>

Similar JavaScript code:

Be careful, following code is not similar to previous code:

var aaa = 111;
var bbb = aaa;
var func = function()< alert(bbb); >;
aaa = 222;
func(); // Outputs «111», but only while «bbb» is not changed after function declaration

// And this technique is not working in loops:
var functions = [];
for (var i = 0; i < 2; i++)
var i2 = i;
functions.push(function()< alert(i2); >);
>
functions[0](); // Outputs «1», wrong!
functions[1](); // Outputs «1», ok

=== Example 2 (passing by reference) ===
PHP code:
$aaa = 111 ;
$func = function() use(& $aaa )< print $aaa ; >;
$aaa = 222 ;
$func (); // Outputs «222»
?>

Similar JavaScript code:

6 years ago

As of PHP 7.0, you can use IIFE(Immediately-invoked function expression) by wrapping your anonymous function with ().

$type = ‘number’ ;
var_dump ( . ( function() use ( $type ) <
if ( $type == ‘number’ ) return [ 1 , 2 , 3 ];
else if ( $type == ‘alphabet’ ) return [ ‘a’ , ‘b’ , ‘c’ ];
> )() );
?>

7 years ago

PERFORMANCE BENCHMARK 2017!

I decided to compare a single, saved closure against constantly creating the same anonymous closure on every loop iteration. And I tried 10 million loop iterations, in PHP 7.0.14 from Dec 2016. Result:

a single saved closure kept in a variable and re-used (10000000 iterations): 1.3874590396881 seconds

new anonymous closure created each time (10000000 iterations): 2.8460240364075 seconds

In other words, over the course of 10 million iterations, creating the closure again during every iteration only added a total of «1.459 seconds» to the runtime. So that means that every creation of a new anonymous closure takes about 146 nanoseconds on my 7 years old dual-core laptop. I guess PHP keeps a cached «template» for the anonymous function and therefore doesn’t need much time to create a new instance of the closure!

So you do NOT have to worry about constantly re-creating your anonymous closures over and over again in tight loops! At least not as of PHP 7! There is absolutely NO need to save an instance in a variable and re-use it. And not being restricted by that is a great thing, because it means you can feel free to use anonymous functions exactly where they matter, as opposed to defining them somewhere else in the code. 🙂

14 years ago

You can always call protected members using the __call() method — similar to how you hack around this in Ruby using send.

class Fun
<
protected function debug ( $message )
<
echo «DEBUG: $message \n» ;
>

public function yield_something ( $callback )
<
return $callback ( «Soemthing!!» );
>

public function having_fun ()
<
$self =& $this ;
return $this -> yield_something (function( $data ) use (& $self )
<
$self -> debug ( «Doing stuff to the data» );
// do something with $data
$self -> debug ( «Finished doing stuff with the data.» );
>);
>

// Ah-Ha!
public function __call ( $method , $args = array())
<
if( is_callable (array( $this , $method )))
return call_user_func_array (array( $this , $method ), $args );
>
>

$fun = new Fun ();
echo $fun -> having_fun ();

13 years ago

Here is an example of one way to define, then use the variable ( $this ) in Closure functions. The code below explores all uses, and shows restrictions.

The most useful tool in this snippet is the requesting_class() function that will tell you which class is responsible for executing the current Closure().

Overview:
————————
Successfully find calling object reference.
Successfully call $this(__invoke);
Successfully reference $$this->name;
Successfully call call_user_func(array($this, ‘method’))

Failure: reference anything through $this->
Failure: $this->name = »;
Failure: $this->delfect();

function requesting_class ()
foreach( debug_backtrace ( true ) as $stack ) if(isset( $stack [ ‘object’ ])) return $stack [ ‘object’ ];
>
>

class Person
public $name = » ;
public $head = true ;
public $feet = true ;
public $deflected = false ;

function __invoke ( $p ) < return $this ->$p ; >
function __toString () < return 'this' ; >// test for reference

function __construct ( $name ) < $this ->name = $name ; >
function deflect () < $this ->deflected = true ; >

public function shoot ()
< // If customAttack is defined, use that as the shoot resut. Otherwise shoot feet
if( is_callable ( $this -> customAttack )) return call_user_func ( $this -> customAttack );
>

$p = new Person ( ‘Bob’ );

$p -> customAttack =
function()

echo $this ; // Notice: Undefined variable: this

#$this = new Class() // FATAL ERROR

// Trick to assign the variable ‘$this’
extract (array( ‘this’ => requesting_class ())); // Determine what class is responsible for making the call to Closure

var_dump ( $this ); // Passive reference works
var_dump ( $ $this ); // Added to class: function __toString()

$name = $this ( ‘name’ ); // Success
echo $name ; // Outputs: Bob
echo ‘
‘ ;
echo $ $this -> name ;

call_user_func_array (array( $this , ‘deflect’ ), array()); // SUCCESSFULLY CALLED

#$this->head = 0; //** FATAL ERROR: Using $this when not in object context
$ $this -> head = 0 ; // Successfully sets value

12 years ago

Since it is possible to assign closures to class variables, it is a shame it is not possible to call them directly. ie. the following does not work:
class foo

public function __construct () $this -> test = function( $a ) print » $a \n» ;
>;
>
>

$f -> test ();
?>

However, it is possible using the magic __call function:
class foo

public function __construct () $this -> test = function( $a ) print » $a \n» ;
>;
>

public function __call ( $method , $args ) if ( $this -> < $method >instanceof Closure ) return call_user_func_array ( $this ->< $method >, $args );
> else return parent :: __call ( $method , $args );
>
>
>
$f = new foo ();
$f -> test ();
?>
it
Hope it helps someone 😉

14 years ago

If you want to check whether you’re dealing with a closure specifically and not a string or array callback you can do this:

13 years ago

If you want to make a recursive closure, you will need to write this:

function($param1, $param2) use ($some_var1, $some_var2)

call_user_func(__FUNCTION__, $other_param1, $other_param2);

If you need to pass values by reference you should check out

If you’re wondering if $some_var1 and $some_var2 are still visible by using the call_user_func, yes, they are available.

4 months ago

«If this automatic binding of the current class is not wanted, then static anonymous functions may be used instead. «

The main reason why you would not want automatic binding is that as long as the Closure object created for the anonymous function exists, it retains a reference to the object that spawned it, preventing the object from being destroyed, even if the object is no longer alive anywhere else in the program, and even if the function itself doesn’t use $this.

class Foo
public function __construct (private string $id )
echo «Creating Foo » . $this -> id , «\n» ;
>
public function gimme_function ()
return function()<>;
>
public function gimme_static_function ()
return static function()<>;
>
public function __destruct ()
echo «Destroying Foo » . $this -> id , «\n» ;
>
>

echo «An object is destroyed as soon as its last reference is removed.\n» ;
$t = new Foo ( ‘Alice’ );
$t = new Foo ( ‘Bob’ ); // Causes Alice to be destroyed.
// Now destroy Bob.
unset( $t );
echo «—\n» ;

echo «A non-static anonymous function retains a reference to the object which created it.\n» ;
$u = new Foo ( ‘Carol’ );
$ufn = $u -> gimme_function ();
$u = new Foo ( ‘Daisy’ ); // Does not cause Carol to be destroyed,
// because there is still a reference to
// it in the function held by $ufn.
unset( $u ); // Causes Daisy to be destroyed.
echo «—\n» ; // Note that Carol hasn’t been destroyed yet.

echo «A static anonymous function does not retain a reference to the object which created it.\n» ;
$v = new Foo ( ‘Eve’ );
$vfn = $v -> gimme_static_function ();
$v = new Foo ( ‘Farid’ ); // The function held by $vfn does not
// hold a reference to Eve, so Eve does get destroyed here.
unset( $v ); // Destroy Farid
echo «—\n» ;
// And then the program finishes, discarding any references to any objects still alive
// (specifically, Carol).
?>

Because $ufn survived to the end of the end of the program, Carol survived as well. $vfn also survived to the end of the program, but the function it contained was declared static, so didn’t retain a reference to Eve.

Anonymous functions that retain references to otherwise-dead objects are therefore a potential source of memory leaks. If the function has no use for the object that spawned it, declaring it static prevents it from causing the object to outlive its usefulness.

  • Функции
    • Функции, определяемые пользователем
    • Аргументы функции
    • Возврат значений
    • Обращение к функциям через переменные
    • Встроенные функции
    • Анонимные функции
    • Стрелочные функции
    • Синтаксис callable-​объектов первого класса
    • Copyright © 2001-2024 The PHP Group
    • My PHP.net
    • Contact
    • Other PHP.net sites
    • Privacy policy

    Замыкания

    Замыкание — это комбинация функции и лексического окружения, в котором эта функция была определена. Другими словами, замыкание даёт вам доступ к Scope (en-US) внешней функции из внутренней функции. В JavaScript замыкания создаются каждый раз при создании функции, во время её создания.

    Лексическая область видимости

    Рассмотрим следующий пример:

    function init()  var name = "Mozilla"; // name - локальная переменная, созданная в init function displayName()  // displayName() - внутренняя функция, замыкание alert(name); // displayName() использует переменную, объявленную в родительской функции > displayName(); > init(); 

    init() создаёт локальную переменную name и определяет функцию displayName() . displayName() — это внутренняя функция — она определена внутри init() и доступна только внутри тела функции init() . Обратите внимание, что функция displayName() не имеет никаких собственных локальных переменных. Однако, поскольку внутренние функции имеют доступ к переменным внешних функций, displayName() может иметь доступ к переменной name , объявленной в родительской функции init() .

    Выполните этот код и обратите внимание, что команда alert() внутри displayName() благополучно выводит на экран содержимое переменной name объявленной в родительской функции. Это пример так называемой лексической области видимости (lexical scoping): в JavaScript область действия переменной определяется по её расположению в коде (это очевидно лексически), и вложенные функции имеют доступ к переменным, объявленным вовне. Этот механизм и называется Lexical scoping (область действия, ограниченная лексически).

    Замыкание

    Рассмотрим следующий пример:

    function makeFunc()  var name = "Mozilla"; function displayName()  alert(name); > return displayName; > var myFunc = makeFunc(); myFunc(); 

    Если выполнить этот код, то результат будет такой же, как и выполнение init() из предыдущего примера: строка «Mozilla» будет показана в JavaScript alert диалоге. Что отличает этот код и представляет для нас интерес, так это то, что внутренняя функция displayName() была возвращена из внешней до того, как была выполнена.

    На первый взгляд, кажется неочевидным, что этот код правильный, но он работает. В некоторых языках программирования локальные переменные-функции существуют только во время выполнения этой функции. После завершения выполнения makeFunc() можно ожидать, что переменная name больше не будет доступна. Однако, поскольку код продолжает нормально работать, очевидно, что это не так в случае JavaScript.

    Причина в том, что функции в JavaScript формируют так называемые замыкания. Замыкание — это комбинация функции и лексического окружения, в котором эта функция была объявлена. Это окружение состоит из произвольного количества локальных переменных, которые были в области действия функции во время создания замыкания. В рассмотренном примере myFunc — это ссылка на экземпляр функции displayName , созданной в результате выполнения makeFunc . Экземпляр функции displayName в свою очередь сохраняет ссылку на своё лексическое окружение, в котором есть переменная name . По этой причине, когда происходит вызов функции myFunc , переменная name остаётся доступной для использования и сохранённый в ней текст «Mozilla» передаётся в alert .

    А вот немного более интересный пример — функция makeAdder :

    function makeAdder(x)  return function (y)  return x + y; >; > var add5 = makeAdder(5); var add10 = makeAdder(10); console.log(add5(2)); // 7 console.log(add10(2)); // 12 

    Здесь мы определили функцию makeAdder(x) , которая получает единственный аргумент x и возвращает новую функцию. Эта функция получает единственный аргумент y и возвращает сумму x и y .

    По существу makeAdder — это фабрика функций: она создаёт функции, которые могут прибавлять определённое значение к своему аргументу. В примере выше мы используем нашу фабричную функцию для создания двух новых функций — одна прибавляет 5 к своему аргументу, вторая прибавляет 10.

    add5 и add10 — это примеры замыканий. Эти функции делят одно определение тела функции, но при этом они сохраняют различные окружения. В окружении функции add5 x — это 5, в то время как в окружении add10 x — это 10.

    Замыкания на практике

    Замыкания полезны тем, что позволяют связать данные (лексическое окружение) с функцией, которая работает с этими данными. Очевидна параллель с объектно-ориентированным программированием, где объекты позволяют нам связать некоторые данные (свойства объекта) с одним или несколькими методами.

    Следовательно, замыкания можно использовать везде, где вы обычно использовали объект с одним единственным методом.

    Такие ситуации повсеместно встречаются в web-разработке. Большое количество front-end кода, который мы пишем на JavaScript, основано на обработке событий. Мы описываем какое-то поведение, а потом связываем его с событием, которое создаётся пользователем (например, клик мышкой или нажатие клавиши). При этом наш код обычно привязывается к событию в виде обратного/ответного вызова (callback): callback функция — функция выполняемая в ответ на возникновение события.

    Давайте рассмотрим практический пример: допустим, мы хотим добавить на страницу несколько кнопок, которые будут менять размер текста. Как вариант, мы можем указать свойство font-size на элементе body в пикселах, а затем устанавливать размер прочих элементов страницы (таких, как заголовки) с использованием относительных единиц em:

    body  font-family: Helvetica, Arial, sans-serif; font-size: 12px; > h1  font-size: 1.5em; > h2  font-size: 1.2em; > 

    Тогда наши кнопки будут менять свойство font-size элемента body, а остальные элементы страницы просто получат это новое значение и отмасштабируют размер текста благодаря использованию относительных единиц.

    Используем следующий JavaScript:

    function makeSizer(size)  return function ()  document.body.style.fontSize = size + "px"; >; > var size12 = makeSizer(12); var size14 = makeSizer(14); var size16 = makeSizer(16); 

    Теперь size12 , size14 , и size16 — это функции, которые меняют размер текста в элементе body на значения 12, 14, и 16 пикселов, соответственно. После чего мы цепляем эти функции на кнопки примерно так:

    .getElementById("size-12").onclick = size12; document.getElementById("size-14").onclick = size14; document.getElementById("size-16").onclick = size16; 
    a href="#" id="size-12">12a> a href="#" id="size-14">14a> a href="#" id="size-16">16a> 

    Эмуляция частных (private) методов с помощью замыканий

    Языки вроде Java позволяют нам объявлять частные (private) методы . Это значит, что они могут быть вызваны только методами того же класса, в котором объявлены.

    JavaScript не имеет встроенной возможности сделать такое, но это можно эмулировать с помощью замыкания. Частные методы полезны не только тем, что ограничивают доступ к коду, это также мощное средство глобальной организации пространства имён, позволяющее не засорять публичный интерфейс вашего кода внутренними методами классов.

    Код ниже иллюстрирует, как можно использовать замыкания для определения публичных функций, которые имеют доступ к закрытым от пользователя (private) функциям и переменным. Такая манера программирования называется модульное программирование:

    var Counter = (function ()  var privateCounter = 0; function changeBy(val)  privateCounter += val; > return  increment: function ()  changeBy(1); >, decrement: function ()  changeBy(-1); >, value: function ()  return privateCounter; >, >; >)(); alert(Counter.value()); /* Alerts 0 */ Counter.increment(); Counter.increment(); alert(Counter.value()); /* Alerts 2 */ Counter.decrement(); alert(Counter.value()); /* Alerts 1 */ 

    Тут много чего поменялось. В предыдущем примере каждое замыкание имело свой собственный контекст исполнения (окружение). Здесь мы создаём единое окружение для трёх функций: Counter.increment , Counter.decrement , и Counter.value .

    Единое окружение создаётся в теле анонимной функции, которая исполняется в момент описания. Это окружение содержит два приватных элемента: переменную privateCounter и функцию changeBy(val) . Ни один из этих элементов не доступен напрямую, за пределами этой самой анонимной функции. Вместо этого они могут и должны использоваться тремя публичными функциями, которые возвращаются анонимным блоком кода (anonymous wrapper), выполняемым в той же анонимной функции.

    Эти три публичные функции являются замыканиями, использующими общий контекст исполнения (окружение). Благодаря механизму lexical scoping в Javascript, все они имеют доступ к переменной privateCounter и функции changeBy .

    Заметьте, мы описываем анонимную функцию, создающую счётчик, и тут же запускаем её, присваивая результат исполнения переменной Counter . Но мы также можем не запускать эту функцию сразу, а сохранить её в отдельной переменной, чтобы использовать для дальнейшего создания нескольких счётчиков вот так:

    var makeCounter = function ()  var privateCounter = 0; function changeBy(val)  privateCounter += val; > return  increment: function ()  changeBy(1); >, decrement: function ()  changeBy(-1); >, value: function ()  return privateCounter; >, >; >; var Counter1 = makeCounter(); var Counter2 = makeCounter(); alert(Counter1.value()); /* Alerts 0 */ Counter1.increment(); Counter1.increment(); alert(Counter1.value()); /* Alerts 2 */ Counter1.decrement(); alert(Counter1.value()); /* Alerts 1 */ alert(Counter2.value()); /* Alerts 0 */ 

    Заметьте, что счётчики работают независимо друг от друга. Это происходит потому, что у каждого из них в момент создания функцией makeCounter() также создавался свой отдельный контекст исполнения (окружение). То есть приватная переменная privateCounter в каждом из счётчиков это действительно отдельная, самостоятельная переменная.

    Используя замыкания подобным образом, вы получаете ряд преимуществ, обычно ассоциируемых с объектно-ориентированным программированием, таких как изоляция и инкапсуляция.

    Создание замыканий в цикле: Очень частая ошибка

    До того, как в версии ECMAScript 6 ввели ключевое слово let , постоянно возникала следующая проблема при создании замыканий внутри цикла. Рассмотрим пример:

    p id="help">Helpful notes will appear herep> p>E-mail: input type="text" id="email" name="email" />p> p>Name: input type="text" id="name" name="name" />p> p>Age: input type="text" id="age" name="age" />p> 
    function showHelp(help)  document.getElementById("help").innerHTML = help; > function setupHelp()  var helpText = [  id: "email", help: "Ваш адрес e-mail" >,  id: "name", help: "Ваше полное имя" >,  id: "age", help: "Ваш возраст (Вам должно быть больше 16)" >, ]; for (var i = 0; i  helpText.length; i++)  var item = helpText[i]; document.getElementById(item.id).onfocus = function ()  showHelp(item.help); >; > > setupHelp(); 

    Массив helpText описывает три подсказки для трёх полей ввода. Цикл пробегает эти описания по очереди и для каждого из полей ввода определяет, что при возникновении события onfocus для этого элемента должна вызываться функция, показывающая соответствующую подсказку.

    Если вы запустите этот код, то увидите, что он работает не так, как мы ожидаем интуитивно. Какое поле вы бы ни выбрали, в качестве подсказки всегда будет высвечиваться сообщение о возрасте.

    Проблема в том, что функции, присвоенные как обработчики события onfocus , являются замыканиями. Они состоят из описания функции и контекста исполнения (окружения), унаследованного от функции setupHelp . Было создано три замыкания, но все они были созданы с одним и тем же контекстом исполнения. К моменту возникновения события onfocus цикл уже давно отработал, а значит, переменная item (одна и та же для всех трёх замыканий) указывает на последний элемент массива, который как раз в поле возраста.

    В качестве решения в этом случае можно предложить использование функции, фабричной функции (function factory), как уже было описано выше в примерах:

    function showHelp(help)  document.getElementById("help").innerHTML = help; > function makeHelpCallback(help)  return function ()  showHelp(help); >; > function setupHelp()  var helpText = [  id: "email", help: "Ваш адрес e-mail" >,  id: "name", help: "Ваше полное имя" >,  id: "age", help: "Ваш возраст (Вам должно быть больше 16)" >, ]; for (var i = 0; i  helpText.length; i++)  var item = helpText[i]; document.getElementById(item.id).onfocus = makeHelpCallback(item.help); > > setupHelp(); 

    Вот это работает как следует. Вместо того, чтобы делить на всех одно окружение, функция makeHelpCallback создаёт каждому из замыканий своё собственное, в котором переменная item указывает на правильный элемент массива helpText .

    Соображения по производительности

    Не нужно без необходимости создавать функции внутри функций в тех случаях, когда замыкания не нужны. Использование этой техники увеличивает требования к производительности как в части скорости, так и в части потребления памяти.

    Как пример, при написании нового класса есть смысл помещать все методы в прототип его объекта, а не описывать их в тексте конструктора. Если сделать по-другому, то при каждом создании объекта для него будет создан свой экземпляр каждого из методов, вместо того, чтобы наследовать их из прототипа.

    Давайте рассмотрим не очень практичный, но показательный пример:

    function MyObject(name, message)  this.name = name.toString(); this.message = message.toString(); this.getName = function ()  return this.name; >; this.getMessage = function ()  return this.message; >; > 

    Поскольку вышеприведённый код никак не использует преимущества замыканий, его можно переписать следующим образом:

    function MyObject(name, message)  this.name = name.toString(); this.message = message.toString(); > MyObject.prototype =  getName: function ()  return this.name; >, getMessage: function ()  return this.message; >, >; 

    Методы вынесены в прототип. Тем не менее, переопределять прототип — само по себе является плохой привычкой, поэтому давайте перепишем всё так, чтобы новые методы просто добавились к уже существующему прототипу.

    function MyObject(name, message)  this.name = name.toString(); this.message = message.toString(); > MyObject.prototype.getName = function ()  return this.name; >; MyObject.prototype.getMessage = function ()  return this.message; >; 

    Код выше можно сделать аккуратнее:

    function MyObject(name, message)  this.name = name.toString(); this.message = message.toString(); > (function ()  this.getName = function ()  return this.name; >; this.getMessage = function ()  return this.message; >; >).call(MyObject.prototype); 

    В обоих примерах выше методы определяются один раз — в прототипе. И все объекты, использующие данный прототип, будут использовать это определение без дополнительного расхода вычислительных ресурсов. Смотрите подробное описание в статье Подробнее об объектной модели (en-US) .

    Found a content problem with this page?

    • Edit the page on GitHub.
    • Report the content issue.
    • View the source on GitHub.

    This page was last modified on 7 авг. 2023 г. by MDN contributors.

    Your blueprint for a better internet.

    Подробное руководство по обработке ошибок в Node.js

    Если вы писали что-то большее, чем программы «Hello world», вы, вероятно, знакомы с концепцией ошибок в программировании. Это ошибки в вашем коде, часто называемые «bugs», которые приводят к сбою программы или неожиданному поведению. В отличие от некоторых языков, таких как Go и Rust, где вы вынуждены взаимодействовать с потенциальными ошибками на каждом этапе пути, в JavaScript и Node.js можно обойтись без согласованной стратегии обработки ошибок.

    Однако это не обязательно должно быть так, потому что обработка ошибок Node.js может быть довольно простой, если вы знакомы с шаблонами, используемыми для создания, доставки и обработки потенциальных ошибок. Эта статья призвана познакомить вас с этими шаблонами, чтобы вы могли сделать свои программы более надежными, гарантируя, что вы обнаружите потенциальные ошибки и обработаете их надлежащим образом, прежде чем развертывать свое приложение в рабочей среде!

    Что такое ошибки в Node.js

    Ошибка в Node.js — это любой экземпляр объекта Error . Типичные примеры включают встроенные классы ошибок, таких как ReferenceError , RangeError , TypeError , URIError , EvalError , и SyntaxError . Определяемые пользователем ошибки также можно создавать путем расширения базового объекта Error , встроенного класса ошибок или другой пользовательской ошибки. При создании ошибок таким образом вы должны передать строку сообщения, описывающую ошибку. Доступ к этому сообщению можно получить через свойство объекта message . Объект Error также содержит name в свойстве stack , указав имя ошибки и точки в коде, на котором он был создан, соответственно.

    const userError = new TypeError("Something happened!"); console.log(userError.name); // TypeError console.log(userError.message); // Something happened! console.log(userError.stack); /*TypeError: Something happened! at Object. (/home/ayo/dev/demo/main.js:2:19) at node:internal/main/run_main_module:17:47 */ 

    Получив объект Error , вы можете передать его функции или вернуть из функции. Вы также можете сделать throw , что приведет к тому, что объект Error станет исключением. Как только вы выдаете ошибку, она всплывает в стеке до тех пор, пока ее где-нибудь не поймают. Если вам не удастся еt поймать, онf станет неперехваченным исключением, которое может привести к сбою вашего приложения!

    Как устранить ошибки

    Подходящий способ устранения ошибок из функции JavaScript зависит от того, выполняет ли функция синхронную или асинхронную операцию. В этом разделе я подробно опишу четыре распространенных шаблона устранения ошибок из функции в приложении Node.js.

    1. Исключения

    Наиболее распространенный способ устранения ошибок функциями — их генерация. Когда вы выдаете ошибку, она становится исключением и должна быть перехвачена где-то в стеке с помощью блока try/catch . Если ошибка может всплывать в стеке без обнаружения, она становится uncaughtException , что приводит к преждевременному завершению работы приложения. Например, встроенный метод JSON.parse() выдает ошибку, если его строковый аргумент не является допустимым объектом JSON.

    function parseJSON(data) < return JSON.parse(data); >try < const result = parseJSON('A string'); >catch (err) < console.log(err.message); // Unexpected token A in JSON at position 0 >

    Чтобы использовать этот шаблон в своих функциях, все, что вам нужно сделать, это добавить ключевое слово throw перед экземпляром ошибки. Этот шаблон сообщения об ошибках и их обработки идиоматичен для функций, выполняющих синхронные операции.

    function square(num) < if (typeof num !== 'number') < throw new TypeError(`Expected number but got: $`); > return num * num; > try < square('8'); >catch (err) < console.log(err.message); // Expected number but got: string >

    2. Обратные вызовы с ошибкой

    Из-за своей асинхронной природы Node.js широко использует функции обратного вызова для большей части обработки ошибок. Функция обратного вызова передается в качестве аргумента другой функции и выполняется, когда функция завершает свою работу. Если вы какое-то время писали код JavaScript, вы, вероятно, знаете, что шаблон обратного вызова широко используется во всем коде JavaScript.

    Node.js использует в большинстве своих асинхронных методов соглашение об обратном вызове «сначала ошибка», чтобы убедиться, что ошибки проверяются должным образом до того, как будут использованы результаты операции. Эта функция обратного вызова обычно является последним аргументом функции, инициирующей асинхронную операцию, и вызывается один раз при возникновении ошибки или при получении результата операции. Ее подпись показана ниже:

    function (err, result) <> 

    Первый аргумент зарезервирован для объекта ошибки. Если в ходе асинхронной операции возникает ошибка, она будет доступна через аргумент err и result будет иметь значение undefined. Однако, если ошибки не возникнет err будет null или undefined и result будет содержать ожидаемый результат операции. Этот шаблон можно продемонстрировать, прочитав содержимое файла с помощью встроенного метода fs.readFile() :

    const fs = require('fs'); fs.readFile('/path/to/file.txt', (err, result) => < if (err) < console.error(err); return; >// Log the file contents if no error console.log(result); >); 

    Как вы можете видеть метод readFile() ожидает функцию обратного вызова в качестве своего последнего аргумента, который придерживается описанной ранее сигнатуры функции «сначала ошибка». В этом сценарии аргумент result содержит содержимое прочитанного файла, если не возникает ошибки. В противном случае undefined и аргумент err заполняется объектом ошибки, содержащим информацию о проблеме (например, файл не найден или недостаточные разрешения).

    Как правило, методы, которые используют этот шаблон обратного вызова для доставки ошибок, не могут знать, насколько важна ошибка, которую они производят, для вашего приложения. Это может быть серьезным или тривиальным. Вместо того, чтобы принимать решение самостоятельно, ошибка отправляется вам для обработки. Важно контролировать поток содержимого функции обратного вызова, всегда проверяя наличие ошибки перед попыткой доступа к результату операции. Игнорировать ошибки небезопасно, и вы не должны доверять содержимому result перед проверкой ошибок.

    Если вы хотите использовать этот шаблон обратного вызова с первой ошибкой в ​​своих собственных асинхронных функциях, все, что вам нужно сделать, это принять функцию в качестве последнего аргумента и вызвать ее, как показано ниже:

    function square(num, callback) < if (typeof callback !== 'function') < throw new TypeError(`Callback must be a function. Got: $`); > // simulate async operation setTimeout(() => < if (typeof num !== 'number') < // if an error occurs, it is passed as the first argument to the callback callback(new TypeError(`Expected number but got: $`)); return; > const result = num * num; // callback is invoked after the operation completes with the result callback(null, result); >, 100); > 

    Любому вызывающему объекту этой функции square потребуется передать функцию обратного вызова, чтобы получить доступ к ее результату или ошибке. Обратите внимание, что во время выполнения возникает исключение, если аргумент обратного вызова не является функцией.

    square('8', (err, result) => < if (err) < console.error(err) return >console.log(result); >); 

    Вам не нужно напрямую обрабатывать ошибку в функции обратного вызова. Вы можете распространить его вверх по стеку, передав его другому обратному вызову, но не генерируйте исключение из функции, потому что оно не будет перехвачено, даже если вы окружите код блоком try/catch . Асинхронное исключение невозможно перехватить, поскольку окружающий блок try/catch завершается до выполнения обратного вызова. Таким образом, исключение будет распространяться на вершину стека, вызывая сбой приложения, если для него не зарегистрирован обработчик process.on(‘uncaughtException’) , который будет обсуждаться позже.

    try < square('8', (err, result) => < if (err) < throw err; // not recommended >console.log(result); >); > catch (err) < // This won't work console.error("Caught error: ", err); >

    3. Отказ от промисов

    Промисы — это современный способ выполнения асинхронных операций в Node.js, и в настоящее время они обычно предпочтительнее обратных вызовов, потому что этот подход имеет лучший поток, который соответствует тому, как мы анализируем программы, особенно с шаблоном async/await . Любой API-интерфейс Node.js, который использует обратные вызовы для асинхронной обработки ошибок, может быть преобразован в промисы с помощью встроенного метода util.promisify() . Например, вот как можно использовать метод fs.ReadFile() для использования промисов:

    const fs = require('fs'); const util = require('util'); const readFile = util.promisify(fs.readFile); 

    Переменная ReadFile — это обещанная версия fs.ReadFile() , в которой отклонения промисов используются для сообщения об ошибках. Эти ошибки могут быть обнаружены с помощью метода цепочки catch , как показано ниже:

    readFile('/path/to/file.txt') .then((result) => console.log(result)) .catch((err) => console.error(err)); 

    Вы также можете использовать обещанные API в функции async , такой как показанна ниже. Это преобладающий способ использования обещаний в современном JavaScript, потому что код читается как синхронный код, а для обработки ошибок можно использовать знакомый механизм try/catch . Важно использовать await перед асинхронным методом, чтобы промис был выполнен (выполнен или отклонен) до того, как функция возобновит свое выполнение. Если промис отклоняется, выражение await выдает отклоненное значение, которое впоследствии перехватывается в окружающем блоке catch

    (async function callReadFile() < try < const result = await readFile('/path/to/file.txt'); console.log(result); >catch (err) < console.error(err); >>)(); 

    Вы можете использовать промисы в своих асинхронных функциях, возвращая промис из функции и помещая код функции в обратный вызов промиса. Если есть ошибка, reject с объектом Error . В противном случае resolve промис с результатом, чтобы оно было доступно в цепочке метода .then или непосредственно в качестве значения функции async при использовании async/await .

    function square(num) < return new Promise((resolve, reject) => < setTimeout(() =>< if (typeof num !== 'number') < reject(new TypeError(`Expected number but got: $`)); > const result = num * num; resolve(result); >, 100); >); > square('8') .then((result) => console.log(result)) .catch((err) => console.error(err)); 

    4. Генераторы событий

    Другой шаблон, который можно использовать при работе с длительными асинхронными операциями, которые могут привести к множеству ошибок или результатов, заключается в возврате EventEmitter из функции и создании события как в случае успеха, так и в случае неудачи. Пример этого кода показан ниже:

    const < EventEmitter >= require('events'); function emitCount() < const emitter = new EventEmitter(); let count = 0; // Async operation const interval = setInterval(() =>< count++; if (count % 4 == 0) < emitter.emit( 'error', new Error(`Something went wrong on count: $`) ); return; > emitter.emit('success', count); if (count === 10) < clearInterval(interval); emitter.emit('end'); >>, 1000); return emitter; > 

    Функция emitCount() возвращает новый источник событий, который сообщает как об успехе, так и о сбое в асинхронной операции. Функция увеличивает переменную count и генерирует событие success каждую секунду, а также событие error , если count делится на 4 . Когда count достигает 10, генерируется событие end . Этот шаблон позволяет выполнять потоковую передачу результатов по мере их поступления, а не ждать завершения всей операции.

    Вот как вы можете обрабатывать и реагировать на каждое из событий, исходящих от функции emitCount() :

    const counter = emitCount(); counter.on('success', (count) => < console.log(`Count is: $`); >); counter.on('error', (err) => < console.error(err.message); >); counter.on('end', () => < console.info('Counter has ended'); >); 

    Как вы можете видеть на изображении выше, функция обратного вызова для каждого обработчика событий выполняется независимо, как только событие генерируется. Событие error является особым случаем в Node.js, потому что, если для него нет обработчика, процесс Node.js завершится сбоем. Вы можете закомментировать обработчик событий error выше и запустить программу, чтобы посмотреть, что произойдет.

    Расширение объекта ошибки

    Использование встроенных классов ошибок или универсального экземпляра объекта Error обычно недостаточно точно для сообщения всех различных типов ошибок. Поэтому необходимо создавать пользовательские классы ошибок, чтобы лучше отражать типы ошибок, которые могут возникнуть в вашем приложении. Например, у вас может быть класс ValidationError для ошибок, возникающих при проверке пользовательского ввода, DatabaseError для операций с базой данных, класс TimeoutError для операций, для которых истекают назначенные им тайм-ауты, и так далее.

    Пользовательские классы ошибок, расширяющие объект ошибки, сохранят основные свойства ошибки, такие как message , name , и stack , но они также могут иметь собственные свойства. Например ValidationError можно улучшить, добавив значимые свойства, такие как часть ввода, вызвавшую ошибку. По сути, вы должны включить достаточно информации, чтобы обработчик ошибок правильно обработал ошибку или создал свои собственные сообщения об ошибках.

    Вот как расширить встроенный объект Error в Node.js:

    class ApplicationError extends Error < constructor(message) < super(message); // name is set to the name of the class this.name = this.constructor.name; >> class ValidationError extends ApplicationError < constructor(message, cause) < super(message); this.cause = cause >> 

    Приведенный выше класс ApplicationError является общей ошибкой для приложения, а класс ValidationError представляет любую ошибку, возникающую при проверке пользовательского ввода. Он наследуется от класса ApplicationError и дополняет его свойством cause , чтобы указать ввод, вызвавший ошибку. Вы можете использовать пользовательские ошибки в своем коде так же, как и с обычной ошибкой. Например, вы можете throw :

    function validateInput(input) < if (!input) < throw new ValidationError('Only truthy inputs allowed', input); >return input; > try < validateInput(userJson); >catch (err) < if (err instanceof ValidationError) < console.error(`Validation error: $, caused by: $`); return; > console.error(`Other error: $`); > 

    Ключевое слово instanceof следует использовать для проверки определенного типа ошибок, как показано выше. Не используйте имя ошибки для проверки типа, как в err.name === ‘ValidationError’ , потому что это не сработает, если ошибка получена из подкласса ValidationError .

    Типы ошибок

    Полезно различать разные типы ошибок, которые могут возникнуть в приложении Node.js. Как правило, ошибки можно разделить на две основные категории: ошибки программиста и операционные проблемы. Плохие или неверные аргументы функции — это пример проблем первого типа, тогда как временные сбои при работе с внешними API относятся ко второй категории.

    1. Операционные ошибки

    Операционные ошибки — это в основном ожидаемые ошибки, которые могут возникнуть в процессе выполнения приложения. Это не обязательно ошибки, но внешние обстоятельства, которые могут нарушить ход выполнения программы. В таких случаях все последствия ошибки можно понять и соответствующим образом обработать. Некоторые примеры операционных ошибок в Node.js включают следующее:

    1. Запрос API завершается ошибкой по какой-либо причине (например, сервер не работает или превышен лимит скорости).
    2. Соединение с базой данных потеряно, возможно, из-за неисправного сетевого соединения.
    3. ОС не может выполнить ваш запрос на открытие файла или запись в него.
    4. Пользователь отправляет на сервер неверный ввод, например неверный номер телефона или адрес электронной почты.

    Эти ситуации не возникают из-за ошибок в коде приложения, но с ними нужно правильно обращаться. В противном случае они могут вызвать более серьезные проблемы.

    2. Ошибки программиста

    Ошибки программиста — это ошибки в логике или синтаксисе программы, которые можно исправить только путем изменения исходного кода. Эти типы ошибок не могут быть обработаны, потому что по определению они являются ошибками в программе. Вот некоторые примеры ошибок программиста:

    1. Синтаксические ошибки, такие как невозможность закрыть фигурную скобку.
    2. Ошибки типа, когда вы пытаетесь сделать что-то недопустимое, например, выполнять операции с операндами несовпадающих типов.
    3. Неверные параметры при вызове функции.
    4. Ссылочные ошибки при неправильном написании имени переменной, функции или свойства.
    5. Попытка доступа к местоположению за концом массива.
    6. Не удалось обработать операционную ошибку.

    Оперативная обработка ошибок

    Операционные ошибки в основном предсказуемы, поэтому их необходимо предвидеть и учитывать в процессе разработки. По сути, обработка этих типов ошибок включает в себя рассмотрение того, может ли операция завершиться неудачно, почему она может завершиться неудачно и что должно произойти, если это произойдет. Рассмотрим несколько стратегий обработки операционных ошибок в Node.js.

    1. Сообщите об ошибке вверх по стеку

    Во многих случаях подходящим действием является остановка потока выполнения программы, очистка всех незавершенных процессов и сообщение об ошибке вверх по стеку, чтобы ее можно было обработать соответствующим образом. Часто это правильный способ устранения ошибки, когда функция, в которой она возникла, находится ниже по стеку и не имеет достаточно информации для непосредственной обработки ошибки. Сообщить об ошибке можно с помощью любого из методов доставки ошибок, описанных ранее в этой статье.

    2. Повторите операцию

    Сетевые запросы к внешним службам иногда могут завершаться ошибкой, даже если запрос полностью действителен. Это может быть связано с временным сбоем, который может возникнуть при сбое сети или перегрузке сервера. Такие проблемы обычно непродолжительны, поэтому вместо того, чтобы немедленно сообщать об ошибке, вы можете повторить запрос несколько раз, пока он не будет успешным или пока не будет достигнуто максимальное количество повторных попыток. Первое соображение заключается в том, чтобы определить, уместно ли повторить запрос. Например, если исходный код состояния HTTP-ответа — 500, 503 или 429, может оказаться целесообразным повторить запрос после небольшой задержки.

    Вы можете проверить, присутствует ли в ответе HTTP-заголовок Retry-After. В этом заголовке указывается точное время ожидания перед выполнением последующего запроса. Если заголовок Retry-After не существует, вам необходимо отложить последующий запрос и постепенно увеличивать задержку для каждой последующей повторной попытки. Это известно как экспоненциальная стратегия отсрочки. Вам также необходимо определить максимальный интервал задержки и количество повторных попыток запроса, прежде чем отказаться от него. В этот момент вы должны сообщить вызывающему абоненту, что целевая служба недоступна.

    3. Отправить ошибку клиенту

    Имея дело с внешним вводом от пользователей, следует исходить из того, что ввод неверен по умолчанию. Поэтому первое, что нужно сделать перед запуском каких-либо процессов, — это проверить ввод и незамедлительно сообщить пользователю о любых ошибках, чтобы его можно было исправить и повторно отправить. При доставке ошибок клиента не забудьте включить всю информацию, необходимую клиенту для создания сообщения об ошибке, понятного пользователю.

    4. Прервать программу

    В случае неисправимых системных ошибок единственным разумным действием является регистрация ошибки и немедленное завершение программы. Возможно, вы даже не сможете корректно завершить работу сервера, если исключение невозможно восстановить на уровне JavaScript. В этот момент от системного администратора может потребоваться изучить проблему и исправить ее, прежде чем программа сможет снова запуститься.

    Предотвращение ошибок программиста

    Из-за своей природы ошибки программиста не могут быть обработаны; это ошибки в программе, возникающие из-за неработающего кода или логики, которые впоследствии необходимо исправлять. Однако есть несколько вещей, которые вы можете сделать, чтобы значительно снизить частоту их появления в вашем приложении.

    1. Примите TypeScript

    TypeScript — является строго типизированным надмножеством JavaScript. Его основная цель разработки — статическая идентификация конструкций, которые могут быть ошибочными, без каких-либо штрафов во время выполнения. Приняв TypeScript в свой проект (с максимально строгими параметрами компилятора), вы сможете устранить целый класс ошибок программиста во время компиляции. Например, после проведения постфактум-анализа ошибок было подсчитано, что 38% ошибок в кодовой базе Airbnb можно было предотвратить с помощью TypeScript.

    Когда вы переносите весь свой проект на TypeScript, такие ошибки, как « undefined is not a function», синтаксические ошибки или ошибки ссылок, больше не должны существовать в вашей кодовой базе. К счастью, это не так страшно, как кажется. Миграция всего вашего приложения Node.js на TypeScript может выполняться поэтапно, чтобы вы могли сразу же начать пожинать плоды в важнейших частях кодовой базы. Вы также можете использовать такой инструмент, как ts-migrate, если вы собираетесь выполнить миграцию за один раз.

    2. Определите поведение для неверных параметров

    Многие ошибки программиста возникают из-за передачи неправильных параметров. Это может быть связано не только с очевидными ошибками, такими как передача строки вместо числа, но и с тонкими ошибками, например, когда аргумент функции имеет правильный тип, но выходит за пределы того, что может обработать функция. Когда программа запущена и функция вызывается таким образом, она может незаметно завершиться ошибкой и выдать неправильное значение, например NaN . Когда сбой в конце концов заметен (обычно после прохождения через несколько других функций), может быть трудно определить его причины.

    Вы можете справиться с неправильными параметрами, определив их поведение, выдав ошибку или вернув специальное значение, такое как null , undefined , или -1 , когда проблема может быть решена локально. Первый — это подход, используемый JSON.parse() , который генерирует исключение SyntaxError , если строка для синтаксического анализа не является допустимой JSON, тогда как метод string.indexOf() является примером последнего. Что бы вы ни выбрали, обязательно задокументируйте, как функция обрабатывает ошибки, чтобы вызывающая сторона знала, чего ожидать.

    3. Автоматизированное тестирование

    Сам по себе язык JavaScript мало помогает вам найти ошибки в логике вашей программы, поэтому вам нужно запустить программу, чтобы определить, работает ли она должным образом. Наличие набора автоматизированных тестов повышает вероятность того, что вы обнаружите и исправите различные ошибки программиста, особенно логические. Они также помогают выяснить, как функция работает с нетипичными значениями. Использование среды тестирования, такой как Jest или Mocha, — хороший способ начать модульное тестирование приложений Node.js.

    Неперехваченные исключения и необработанные отказы от промисов

    Неперехваченные исключения и необработанные отклонения промисов вызваны ошибками программиста, возникающими из-за невозможности перехватить сгенерированное исключение и отклонение промисов соответственно. Событие uncaughtException возникает, когда исключение, созданное где-либо в приложении, не перехвачено до того, как оно достигнет цикла событий. Если обнаружено неперехваченное исключение, приложение немедленно выйдет из строя, но вы можете добавить обработчик этого события, чтобы переопределить это поведение. Действительно, многие люди используют это как крайний способ поглотить ошибку, чтобы приложение могло продолжать работать, как будто ничего не произошло:

    // unsafe process.on('uncaughtException', (err) => < console.error(err); >); 

    Однако это неправильное использование этого события, поскольку наличие необработанного исключения указывает на то, что приложение находится в неопределенном состоянии. Таким образом, попытка нормального возобновления работы без восстановления после ошибки считается небезопасной и может привести к дальнейшим проблемам, таким как утечка памяти и зависание сокетов. Надлежащее использование обработчика uncaughtException заключается в очистке всех выделенных ресурсов, закрытии соединений и регистрации ошибки для последующей оценки перед выходом из процесса.

    // better process.on('uncaughtException', (err) => < Honeybadger.notify(error); // log the error in a permanent storage // attempt a gracefully shutdown server.close(() =>< process.exit(1); // then exit >); // If a graceful shutdown is not achieved after 1 second, // shut down the process completely setTimeout(() => < process.abort(); // exit immediately and generate a core dump file >, 1000).unref() >); 

    Точно так же событие unhandledRejection генерируется, когда отклоненное обещание не обрабатывается блоком catch . В отличие от uncaughtException , эти события не вызывают немедленного сбоя приложения. Однако необработанные отказы от промисов устарели и могут немедленно прервать процесс в будущем выпуске Node.js. Вы можете отслеживать необработанные отказы обещаний через обработчик событий unhandledRejection , как показано ниже:

    process.on('unhandledRejection', (reason, promise) => < Honeybadger.notify(< message: 'Unhandled promise rejection', params: < promise, reason, >, >); server.close(() => < process.exit(1); >); setTimeout(() => < process.abort(); >, 1000).unref() >); 

    Вы всегда должны запускать свои серверы с помощью диспетчера процессов, который автоматически перезапустит их в случае сбоя. Распространенным является PM2, но у вас также есть systemd или upstart в Linux, и пользователи Docker могут использовать его политику перезапуска. Как только это будет сделано, надежный сервис будет восстановлен почти мгновенно, и вы по-прежнему будете иметь сведения о неперехваченном исключении, чтобы его можно было быстро исследовать и исправить. Вы можете пойти дальше, запустив более одного процесса и используя балансировщик нагрузки для распределения входящих запросов. Это поможет предотвратить простои в случае временной потери одного из экземпляров.

    Централизованная отчетность об ошибках

    Ни одна стратегия обработки ошибок не будет полной без надежной стратегии ведения журнала для вашего работающего приложения. Когда происходит сбой, важно выяснить, почему он произошел, записав как можно больше информации о проблеме. Централизация этих журналов позволяет легко получить полную информацию о вашем приложении. Вы сможете сортировать и фильтровать свои ошибки, просматривать основные проблемы и подписываться на оповещения, чтобы получать уведомления о новых ошибках.

    Honeybadger предоставляет все необходимое для отслеживания ошибок, возникающих в вашем рабочем приложении. Выполните следующие шаги, чтобы интегрировать его в свое приложение Node.js:

    1. Установите пакет

    Используйте npm для установки пакета:

    $ npm install @honeybadger-io/js --save 

    2. Импортируйте библиотеку

    Импортируйте библиотеку и настройте ее с помощью своего ключа API, чтобы начать сообщать об ошибках:

    const Honeybadger = require('@honeybadger-io/js'); Honeybadger.configure(< apiKey: '[ YOUR API KEY HERE ]' >); 

    3. Сообщите об ошибках

    Вы можете сообщить об ошибке, вызвав метод notify() , как показано в следующем примере:

    try < // . error producing code >catch(error)

    Для получения дополнительной информации о том, как Honeybadger интегрируется с веб-фреймворками Node.js, см. полную документацию или ознакомьтесь с образцом приложения Node.js/Express на GitHub.

    Резюме

    Класс (или подкласс) Error всегда должен быть использован для связи ошибок в коде. Технически, вы можете throw что угодно в JavaScript, а не только объекты Error , но это не рекомендуется, так как это значительно снижает полезность ошибки и делает обработку ошибок подверженной ошибкам. Последовательно используя объекты Error , вы можете надежно рассчитывать на доступ error.message или error.stack в местах, где ошибки обрабатываются или регистрируются. Вы даже можете дополнить класс ошибок другими полезными свойствами, относящимися к контексту, в котором произошла ошибка.

    Операционные ошибки неизбежны и должны учитываться в любой корректной программе. В большинстве случаев следует использовать стратегию исправимых ошибок, чтобы программа могла продолжать работать без сбоев. Однако, если ошибка достаточно серьезная, может быть целесообразно завершить программу и перезапустить ее. Попробуйте завершить работу корректно, если возникнут такие ситуации, чтобы программа могла снова запуститься в чистом состоянии.

    Ошибки программиста нельзя обработать или исправить, но их можно смягчить с помощью набора автоматизированных тестов и инструментов статической типизации. При написании функции определите поведение для неверных параметров и действуйте соответствующим образом после их обнаружения. Разрешите сбой программы при обнаружении uncaughtException или unhandledRejection . Не пытайтесь исправить такие ошибки!

    Используйте службу мониторинга ошибок, например Honeybadger, для сбора и анализа ваших ошибок. Это может помочь вам значительно повысить скорость отладки и разрешения проблем.

    Вывод

    Правильная обработка ошибок является непреложным требованием, если вы хотите писать хорошее и надежное программное обеспечение. Используя методы, описанные в этой статье, вы будете на правильном пути к этому.

    Спасибо за чтение и удачного кодирования!

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *