JavaScript - від зворотних викликів до асинхронізації / очікування

JavaScript є синхронним. Це означає, що він виконає ваш код за замовленням після підняття. Перш ніж код виконується, varі functionоголошення "піднімаються" до верхньої частини їхньої області дії.

Це приклад синхронного коду:

console.log('1') console.log('2') console.log('3')

Цей код надійно реєструє “1 2 3”.

Асинхронні запити будуть чекати закінчення таймера або запиту відповіді, поки решта коду продовжує виконуватися. Тоді, коли настане час, зворотний виклик активує ці асинхронні запити.

Це приклад асинхронного коду:

console.log('1') setTimeout(function afterTwoSeconds() { console.log('2') }, 2000) console.log('3')

Це фактично реєструватиме "1 3 2", оскільки "2" знаходиться на а, setTimeoutякий буде виконаний, у цьому прикладі, лише через дві секунди. Ваша програма не зависає, очікуючи закінчення двох секунд. Натомість він продовжує виконувати решту коду, і коли закінчується час очікування, він повертається до afterTwoSeconds.

Ви можете запитати: "Чому це корисно?" або “Як отримати так, щоб мій асинхронний код став синхронізованим?”. Сподіваюся, я зможу показати вам відповіді.

"Проблема"

Скажімо, наша мета - шукати користувача GitHub та отримати всі сховища цього користувача. Річ у тім, що ми не знаємо точного імені користувача. Тож ми маємо перерахувати всіх користувачів з однаковим іменем та відповідні сховища.

Не потрібно надто фантазувати, щось подібне

У цих прикладах код запиту використовуватиме XHR (XMLHttpRequest). Ви можете замінити його на jQuery $.ajaxабо на найновіший рідний підхід fetch. І те, і інше дасть вам обіцянки, що підійдуть за ворота.

Це буде дещо змінено залежно від вашого підходу, але для початку:

// url argument can be something like '//api.github.com/users/daspinola/repos' function request(url) { const xhr = new XMLHttpRequest(); xhr.timeout = 2000; xhr.onreadystatechange = function(e) { if (xhr.readyState === 4) { if (xhr.status === 200) { // Code here for the server answer when successful } else { // Code here for the server answer when not successful } } } xhr.ontimeout = function () { // Well, it took to long do some code here to handle that } xhr.open('get', url, true) xhr.send(); }

Пам’ятайте, що в цих прикладах важливою частиною є не кінцевий результат коду. Натомість вашою метою має стати розуміння відмінностей підходів та способи їх використання для розвитку.

Зворотній дзвінок

Ви можете зберегти посилання на функцію у змінній при використанні JavaScript. Тоді ви можете використовувати їх як аргументи іншої функції для подальшого виконання. Це наш “зворотний дзвінок”.

Одним із прикладів може бути:

// Execute the function "doThis" with another function as parameter, in this case "andThenThis". doThis will execute whatever code it has and when it finishes it should have "andThenThis" being executed. doThis(andThenThis) // Inside of "doThis" it's referenced as "callback" which is just a variable that is holding the reference to this function function andThenThis() { console.log('and then this') } // You can name it whatever you want, "callback" is common approach function doThis(callback) { console.log('this first') // the '()' is when you are telling your code to execute the function reference else it will just log the reference callback() }

Використання callbackдля вирішення нашої проблеми дозволяє зробити щось подібне до requestфункції, яку ми визначили раніше:

function request(url, callback) { const xhr = new XMLHttpRequest(); xhr.timeout = 2000; xhr.onreadystatechange = function(e) { if (xhr.readyState === 4) { if (xhr.status === 200) { callback(null, xhr.response) } else { callback(xhr.status, null) } } } xhr.ontimeout = function () { console.log('Timeout') } xhr.open('get', url, true) xhr.send(); }

Наша функція для запиту тепер прийме callbackтак, що при виконанні requestйого буде викликано у випадку помилки та у випадку успіху.

const userGet = `//api.github.com/search/users?page=1&q=daspinola&type=Users` request(userGet, function handleUsersList(error, users) { if (error) throw error const list = JSON.parse(users).items list.forEach(function(user) { request(user.repos_url, function handleReposList(err, repos) { if (err) throw err // Handle the repositories list here }) }) })

Порушення цього:

  • Ми робимо запит на отримання сховищ користувачів
  • Після завершення запиту ми використовуємо зворотний виклик handleUsersList
  • Якщо помилки немає, ми аналізуємо відповідь нашого сервера на об'єкт, що використовує JSON.parse
  • Потім ми повторюємо наш список користувачів, оскільки він може мати більше одного

    Для кожного користувача ми запитуємо його список сховищ.

    У першій відповіді ми використаємо URL-адресу, що повертається для кожного користувача

    Ми телефонуємо repos_urlяк URL-адреса для наших наступних запитів або з першої відповіді

  • Коли запит завершить зворотний дзвінок, ми зателефонуємо

    Це буде обробляти або його помилку, або відповідь зі списком сховищ для цього користувача

Примітка : Надсилання помилки спочатку як параметра є звичайною практикою, особливо при використанні Node.js.

Більш «повним» та читабельним підходом було б обробляти помилки. Ми б тримали зворотний виклик окремо від виконання запиту.

Щось на зразок цього:

try { request(userGet, handleUsersList) } catch (e) { console.error('Request boom! ', e) } function handleUsersList(error, users) { if (error) throw error const list = JSON.parse(users).items list.forEach(function(user) { request(user.repos_url, handleReposList) }) } function handleReposList(err, repos) { if (err) throw err // Handle the repositories list here console.log('My very few repos', repos) }

У результаті виникають такі проблеми, як гонки та проблеми з обробкою помилок. Перегони трапляються, коли ти не контролюєш, кого ти отримаєш першим. Ми запитуємо інформацію для всіх них, якщо їх більше, ніж одна. Ми не приймаємо замовлення до уваги. Наприклад, користувач 10 може бути першим, а користувач 2 останнім. Ми маємо можливе рішення далі в статті.

Основна проблема зворотних дзвінків полягає в тому, що технічне обслуговування та читабельність можуть стати проблемою. Це начебто вже є, і код навряд чи щось робить. Це відоме як пекло зворотного виклику, якого можна уникнути наступним підходом.

Обіцянки

Обіцяє, що ви зможете зробити свій код більш читабельним. Новий розробник може прийти до бази коду і побачити чіткий порядок виконання вашого коду.

Для створення обіцянки ви можете використовувати:

const myPromise = new Promise(function(resolve, reject) { // code here if (codeIsFine) { resolve('fine') } else { reject('error') } }) myPromise .then(function whenOk(response) { console.log(response) return response }) .catch(function notOk(err) { console.error(err) })

Розкладемо його:

  • Обіцянка ініціалізується тегами, functionякі мають resolveі rejectоператори
  • Введіть асинхронний код всередині Promiseфункції

    resolve коли все відбувається за бажанням

    Інакше reject

  • Коли a resolveзнайдено, .thenметод буде виконаний для цьогоPromise

    Коли a reject знайдено, .catch буде спрацьовано

Що слід пам’ятати:

  • resolve and reject only accept one parameter

    resolve(‘yey’, ‘works’) will only send ‘yey’ to the .then callback function

  • If you chain multiple .then

    Add a return if you want the next .then value not to be undefined

  • When a reject is caught with .catch if you have a .then chained to it

    It will still execute that .then

    You can see the .then as an “always executes” and you can check an example in this comment

  • With a chain on .then if an error happens on the first one

    It will skip subsequent .then until it finds a .catch

  • A promise has three states

    pending

  • When waiting for a resolve or reject to happen

    resolved

    rejected

  • Once it’s in a resolved or rejected state

    It cannot be changed

Note: You can create promises without the function at the moment of declarations. The way that I’m showing it is only a common way of doing it.

“Theory, theory, theory…I’m confused” you may say.

Let’s use our request example with a promise to try to clear things up:

function request(url) { return new Promise(function (resolve, reject) { const xhr = new XMLHttpRequest(); xhr.timeout = 2000; xhr.onreadystatechange = function(e) { if (xhr.readyState === 4) { if (xhr.status === 200) { resolve(xhr.response) } else { reject(xhr.status) } } } xhr.ontimeout = function () { reject('timeout') } xhr.open('get', url, true) xhr.send(); }) }

In this scenario when you execute request it will return something like this:

const userGet = `//api.github.com/search/users?page=1&q=daspinola&type=Users` const myPromise = request(userGet) console.log('will be pending when logged', myPromise) myPromise .then(function handleUsersList(users) { console.log('when resolve is found it comes here with the response, in this case users ', users) const list = JSON.parse(users).items return Promise.all(list.map(function(user) { return request(user.repos_url) })) }) .then(function handleReposList(repos) { console.log('All users repos in an array', repos) }) .catch(function handleErrors(error) { console.log('when a reject is executed it will come here ignoring the then statement ', error) })

This is how we solve racing and some of the error handling problems. The code is still a bit convoluted. But its a way to show you that this approach can also create readability problems.

A quick fix would be to separate the callbacks like so:

const userGet = `//api.github.com/search/users?page=1&q=daspinola&type=Users` const userRequest = request(userGet) // Just by reading this part out loud you have a good idea of what the code does userRequest .then(handleUsersList) .then(repoRequest) .then(handleReposList) .catch(handleErrors) function handleUsersList(users) { return JSON.parse(users).items } function repoRequest(users) { return Promise.all(users.map(function(user) { return request(user.repos_url) })) } function handleReposList(repos) { console.log('All users repos in an array', repos) } function handleErrors(error) { console.error('Something went wrong ', error) }

By looking at what userRequest is waiting in order with the .then you can get a sense of what we expect of this code block. Everything is more or less separated by responsibility.

This is “scratching the surface” of what Promises are. To have a great insight on how they work I cannot recommend enough this article.

Generators

Another approach is to use the generators. This is a bit more advance so if you are starting out feel free to jump to the next topic.

One use for generators is that they allow you to have async code looking like sync.

They are represented by a * in a function and look something like:

function* foo() { yield 1 const args = yield 2 console.log(args) } var fooIterator = foo() console.log(fooIterator.next().value) // will log 1 console.log(fooIterator.next().value) // will log 2 fooIterator.next('aParam') // will log the console.log inside the generator 'aParam'

Instead of returning with a return, generators have a yield statement. It stops the function execution until a .next is made for that function iteration. It is similar to .then promise that only executes when resolved comes back.

Our request function would look like this:

function request(url) { return function(callback) { const xhr = new XMLHttpRequest(); xhr.onreadystatechange = function(e) { if (xhr.readyState === 4) { if (xhr.status === 200) { callback(null, xhr.response) } else { callback(xhr.status, null) } } } xhr.ontimeout = function () { console.log('timeout') } xhr.open('get', url, true) xhr.send() } }

We want to have the url as an argument. But instead of executing the request out of the gate we want it only when we have a callback to handle the response.

Our generator would be something like:

function* list() { const userGet = `//api.github.com/search/users?page=1&q=daspinola&type=Users` const users = yield request(userGet) yield for (let i = 0; i<=users.length; i++) { yield request(users[i].repos_url) } }

It will:

  • Wait until the first request is prepared
  • Return a function reference expecting a callback for the first request

    Our request function accepts a url

    and returns a function that expects a callback

  • Expect a users to be sent in the next .next
  • Iterate over users
  • Wait for a .next for each of the users
  • Return their respective callback function

So an execution of this would be:

try { const iterator = list() iterator.next().value(function handleUsersList(err, users) { if (err) throw err const list = JSON.parse(users).items // send the list of users for the iterator iterator.next(list) list.forEach(function(user) { iterator.next().value(function userRepos(error, repos) { if (error) throw repos // Handle each individual user repo here console.log(user, JSON.parse(repos)) }) }) }) } catch (e) { console.error(e) }

We could separate the callback functions like we did previously. You get the deal by now, a takeaway is that we now can handle each individual user repository list individually.

I have mixed felling about generators. On one hand I can get a grasp of what is expected of the code by looking at the generator.

But its execution ends up having similar problems to the callback hell.

Like async/await, a compiler is recommended. This is because it isn’t supported in older browser versions.

Also it isn’t that common in my experience. So it may generate confusing in codebases maintained by various developers.

An awesome insight of how generators work can be found in this article. And here is another great resource.

Async/Await

This method seems like a mix of generators with promises. You just have to tell your code what functions are to be async. And what part of the code will have to await for that promise to finish.

sumTwentyAfterTwoSeconds(10) .then(result => console.log('after 2 seconds', result)) async function sumTwentyAfterTwoSeconds(value) { const remainder = afterTwoSeconds(20) return value + await remainder } function afterTwoSeconds(value) { return new Promise(resolve => { setTimeout(() => { resolve(value) }, 2000); }); }

In this scenario:

  • We have sumTwentyAfterTwoSeconds as being an async function
  • We tell our code to wait for the resolve or reject for our promise function afterTwoSeconds
  • It will only end up in the .then when the await operations finish

    In this case there is only one

Applying this to our request we leave it as a promise as seen earlier:

function request(url) { return new Promise(function(resolve, reject) { const xhr = new XMLHttpRequest(); xhr.onreadystatechange = function(e) { if (xhr.readyState === 4) { if (xhr.status === 200) { resolve(xhr.response) } else { reject(xhr.status) } } } xhr.ontimeout = function () { reject('timeout') } xhr.open('get', url, true) xhr.send() }) }

We create our async function with the needed awaits like so:

async function list() { const userGet = `//api.github.com/search/users?page=1&q=daspinola&type=Users` const users = await request(userGet) const usersList = JSON.parse(users).items usersList.forEach(async function (user) { const repos = await request(user.repos_url) handleRepoList(user, repos) }) } function handleRepoList(user, repos) { const userRepos = JSON.parse(repos) // Handle each individual user repo here console.log(user, userRepos) }

So now we have an async list function that will handle the requests. Another async is needed in the forEach so that we have the list of repos for each user to manipulate.

We call it as:

list() .catch(e => console.error(e))

This and the promises approach are my favorites since the code is easy to read and change. You can read about async/await more in depth here.

A downside of using async/await is that it isn’t supported in the front-end by older browsers or in the back-end. You have to use the Node 8.

You can use a compiler like babel to help solve that.

“Solution”

You can see the end code accomplishing our initial goal using async/await in this snippet.

A good thing to do is to try it yourself in the various forms referenced in this article.

Conclusion

Depending on the scenario you might find yourself using:

  • async/await
  • callbacks
  • mix

It’s up to you what fits your purposes. And what lets you maintain the code so that it is understandable to others and your future self.

Note: Any of the approaches become slightly less verbose when using the alternatives for requests like $.ajax and fetch.

Let me know what you would do different and different ways you found to make each approach more readable.

This is Article 11 of 30. It is part of a project for publishing an article at least once a week, from idle thoughts to tutorials. Leave a comment, follow me on Diogo Spínola and then go back to your brilliant project!