Bayangkan kamu adalah seorang penyanyi top, dan penggemarmu bertanya siang dan malam untuk single terbarumu.
Untuk mendapatkan kelegaan, kamu berjanji untuk mengirimkan single tersebut kepada mereka ketika diterbitkan. Kamu memberikan sebuah daftar kepada penggemarmu. Mereka dapat mengisi alamat surel mereka, sehingga saat lagu sudah tersedia, semua pihak yang berlangganan langsung menerimanya. Dan bahkan jika ada yang salah, katakanlah, ada kebakaran di dalam studio, sehingga kamu tidak dapat menerbitkan lagu, mereka masih akan diberitahu.
Semua orang senang: kamu, karena orang-orang tidak memadati kamu lagi, dan penggemar, karena mereka tidak ketinggalan singlenya.
- ???Kode produksi??? itu melakukan sesuatu dan membutuhkan waktu. Sebagai contoh, sebuah kode yang memuat data melalui jaringan. Itu adalah seorang ???penyanyi???.
- ???Kode pengkonsumsi??? yang menginginkan hasil dari ???kode produksi??? setelah siap. Banyak fungsi yang mungkin membutuhkan hasil itu. Ini adalah ???penggemar???.
- Promise adalah objek Javascript khusus yang menghubungkan ???kode produksi??? dan ???kode pengkonsumi??? secara bersamaan. Dalam analogi kami: ini adalah ???daftar berlangganan???. ???Kode produksi??? membutuhkan waktu berapa pun untuk menghasilkan hasil yang dijanjikan, dan ???Promise??? membuat hasil tersebut tersedia untuk semua kode yang berlangganan ketika hasilnya sudah siap.
Analogi ini tidak terlalu akurat, karena promise JavaScript lebih kompleks dari daftar berlangganan sederhana: daftar tersebut memiliki fitur dan batasan tambahan. Tetapi untuk awal tidak apa-apa.
Syntax constructor untuk objek promise adalah:
let promise = new Promise(function(resolve, reject) {
// eksekutor (kode produksi, "penyanyi")
});
Fungsi yang dilewatkan ke new Promise
disebut sebagai exekutor. Ketika new Promise
dibuat, exekutor tersebut berjalan secara otomatis. Exekutor itu berisi kode produksi, yang pada akhirnya harus memproduksi hasil. Dalam analogi di atas: exekutor adalah ???penyanyi???.
Argumen resolve
dan reject
adalah callback yang disediakan oleh JavaScript itu sendiri. Kode kita hanya ada di dalam eksekutor.
Ketika eksekutor mendapatkan hasilnya, baik itu cepat atau lambat ??? tidak masalah, eksekutor harus memanggil salah satu dari callback ini:
resolve(value)
??? jika pekerjaan selesai dengan sukses, dengan hasilvalue
.reject(error)
??? jika terjadi kesalahan,error
adalah objek kesalahan.
Jadi untuk meringkas: eksekutor berjalan secara otomatis, eksekutor harus melakukan pekerjaan dan kemudian memanggil salah satu dari resolve
atau reject
.
Objek promise
yang dikembalikan oleh constructor new Promise
memiliki properti internal:
state
??? pada awalnya"pending"
, kemudian berubah menjadi"fulfilled"
saatresolve
dipanggil atau"rejected"
ketikareject
dipanggil.result
??? pada awalnyaundefined
, kemudian berubah menjadivalue
ketikaresolve(value)
dipanggil atauerror
ketikareject(error)
dipanggil.
Jadi eksekutor akhirnya memindahkan promise
ke salah satu dari kondisi ini:
Nanti kita akan melihat bagaimana ???penggemar??? dapat berlangganan kepada perubahan ini.
Berikut ini contoh constructor promise dan fungsi eksekutor sederhana dengan ???kode produksi??? yang membutuhkan waktu (melalui setTimeout
):
let promise = new Promise(function(resolve, reject) {
// fungsi tersebut dieksekusi secara otomatis ketika "promise" dibangun
// setelah 1 detik menandakan bahwa pekerjaan selesai dengan hasil "done"
setTimeout(() => resolve("done"), 1000);
});
Kita dapat melihat dua hal dengan menjalankan kode di atas:
-
Exekutor dipanggil secara langsung dan otomatis (oleh
new Promise
). -
Exekutor menerima dua argumen:
resolve
danreject
??? fungsi ini sudah ditentukan sebelumnya oleh mesin JavaScript. Jadi kita tak perlu membuatnya. Kita hanya harus memanggil salah satu dari dua argumen tersebut ketika siap.Setelah satu detik ???memproses??? eksekutor memanggil
resolve("done")
untuk memproduksi hasilnya. Ini mengubah status objekpromise
:
Itu adalah contoh penyelesaian pekerjaan yang sukses, sebuah ???promise fulfilled???.
Dan sekarang adalah contoh eksekutor menolak promise dengan sebuah error:
let promise = new Promise(function(resolve, reject) {
// setelah 1 detik menandakan bahwa pekerjaan selesai dengan sebuah "error"
setTimeout(() => reject(new Error("Whoops!")), 1000);
});
Panggilan untuk reject(...)
memindahkan objek promise ke status "rejected"
:
Untuk meringkas, eksekutor harus melakukan pekerjaan (sesuatu yang biasanya membutuhkan waktu) dan kemudian memanggil resolve
atau reject
untuk mengubah state objek promise yang sesuai.
Promise yang diputuskan atau ditolak disebut ???diselesaikan???, sebagai lawan dari promise ???pending??? awalnya.
Eksekutor harus memanggil hanya satu resolve
atau satu reject
. Setiap perubahan status adalah final.
Semua panggilan resolve
dan reject
lebih lanjut diabaikan:
let promise = new Promise(function(resolve, reject) {
resolve("done");
reject(new Error("???")); // diabaikan
setTimeout(() => resolve("???")); // diabaikan
});
Idenya adalah bahwa pekerjaan yang dilakukan oleh eksekutor mungkin hanya memiliki satu hasil atau error.
Juga, resolve
/reject
hanya berharap satu argumen (atau tidak ada) dan akan mengabaikan argumen tambahan.
Error
Seandainya terjadi kesalahan, eksekutor harus memanggil reject
. Itu bisa dilakukan dengan segala jenis argumen (seperti resolve
). Tetapi direkomendasikan untuk menggunakan objek Error
(atau objek yang mewarisi dari Error
). Alasannya akan segera menjadi jelas.
resolve
/reject
Dalam praktiknya, eksekutor biasanya melakukan sesuatu secara asynchronous dan memanggil resolve
/reject
setelah beberapa waktu, tetapi tidak harus. Kita juga bisa memanggil resolve
atau reject
secara langsung, seperti ini:
let promise = new Promise(function(resolve, reject) {
// tidak mengambil waktu kita untuk melakukan pekerjaan itu
resolve(123); // secara langsung memberikan hasil: 123
});
Misalnya, ini mungkin terjadi ketika kita memulai suatu pekerjaan tetapi kemudian melihat segalanya sudah selesai dan di-cache.
Tidak apa-apa. Kita segera menyelesaikan promise.
State
dan result
bersifat internal
Properti state
dan result
objek Promise bersifat internal. Kita tidak bisa mengakses properti tersebut secara langsung. Kita bisa menggunakan method .then
/.catch
/.finally
untuk melakukannya. Penjelasan method-method tersebut ada di bawah ini.
Konsumen: then, catch, finally
Objek Promise berfungsi sebagai tautan antara eksekutor (???kode produksi??? atau ???penyanyi???) dan fungsi konsumsi (???penggemar???), yang akan menerima hasil atau error. Fungsi konsumsi bisa didaftarkan (berlangganan) menggunakan method .then
, .catch
and .finally
.
then
Yang paling penting, yang mendasar adalah .then
.
Syntaxnya adalah:
promise.then(
function(result) { /* menangani hasil yang sukses */ },
function(error) { /* menangani sebuah "error" */ }
);
Argumen pertama dari .then
adalah fungsi yang berjalan ketika promise terselesaikan, dan menerima hasil.
Argumen kedua dari .then
adalah fungsi yang berjalan ketika promise ditolak, dan menerima error.
Sebagai contoh, disini reaksi ketika promise berhasil diselesaikan:
let promise = new Promise(function(resolve, reject) {
setTimeout(() => resolve("done!"), 1000);
});
// resolve menjalankan fungsi pertama di .then
promise.then(
result => alert(result), // menampilkan "done!" setelah satu detik
error => alert(error) // tidak dijalankan
);
Fungsi pertama dijalankan.
Dan dalam hal penolakan ??? yang kedua:
let promise = new Promise(function(resolve, reject) {
setTimeout(() => reject(new Error("Whoops!")), 1000);
});
// reject menjalankan fungsi kedua di .then
promise.then(
result => alert(result), // tidak dijalankan
error => alert(error) // menampilkan "Error: Whoops!" setelah satu detik
);
Jika kita hanya tertarik pada penyelesaian yang berhasil, maka kita hanya dapat menyediakan satu argumen fungsi .then
:
let promise = new Promise(resolve => {
setTimeout(() => resolve("done!"), 1000);
});
promise.then(alert); // menampilkan "done!" setelah satu detik
catch
Jika kita hanya tertarik pada error, maka kita dapat menggunakan null
sebagai argumen pertama: .then(null, errorHandlingFunction)
. Atau kita dapat menggunakan .catch(errorHandlingFunction)
, yang mana keduanya sama persis:
let promise = new Promise((resolve, reject) => {
setTimeout(() => reject(new Error("Whoops!")), 1000);
});
// .catch(f) sama seperti promise.then(null, f)
promise.catch(alert); // menampilkan "Error: Whoops!" setelah satu detik
Panggilan .catch(f)
adalah analog lengkap dari .then(null, f)
, itu hanya sebuah singkatan.
finally
Sama seperti ada klausa finally
dalam try {...} catch {...}
, ada finally
dalam promises.
Panggilan .finally(f)
mirip dengan .then(f, f)
dalam arti bahwa f
selalu berjalan ketika promise diselesaikan: apakah itu resolve atau reject.
finally
adalah penanganan yang baik untuk melakukan pembersihan, mis. menghentikan indikator pemuatan kita, karena tidak diperlukan lagi, apa pun hasilnya.
Seperti ini:
new Promise((resolve, reject) => {
/* lakukan sesuatu yang membutuhkan waktu, dan kemudian panggil resolve/reject */
})
// berjalan ketika "promise" diselesaikan, tidak peduli sukses atau tidak
.finally(() => hentikan indikator pemuatan)
.then(result => munculkan hasil, err => munculkan "error")
Tapi ini bukan alias dari then(f,f)
. Ada beberapa perbedaan penting:
-
Handler
finally
tidak memiliki argumen. Didalamfinally
kita tidak tahu apakah promise sukses atau tidak. Tidak apa-apa, karena tugas kita biasanya melakukan prosedur penyelesaian ???umum???. -
Handler
finally
melewatkan hasil dan error ke handler selanjutnya.Misalnya, di sini hasilnya dilewatkan melalui
finally
kethen
:new Promise((resolve, reject) => { setTimeout(() => resolve("result"), 2000) }) .finally(() => alert("Promise ready")) .then(result => alert(result)); // <-- .then menangani hasilnya
Dan di sini ada error di dalam promise, dilewatkan melalui
finally
kecatch
:new Promise((resolve, reject) => { throw new Error("error"); }) .finally(() => alert("Promise ready")) .catch(err => alert(err)); // <-- .catch menangani objek galat
Itu sangat nyaman, karena
finally
tidak dimaksudkan untuk memproses hasil dari promise. Jadi itu melewatinya.Kita akan berbicara lebih banyak tentang chaining promise dan passing-result antara handler di bab selanjutnya.
-
Terakhir, namun tidak kalah pentingnya, syntax
.finally(f)
lebih nyaman daripada.then(f, f)
: tidak perlu menduplikasi fungsif
.
Jika promise tertunda, handler .then/catch/finally
akan menunggu promise tersebut. Jika tidak, jika promise sudah selesai, handler langsung menjalankan:
// "promise" diselesaikan segera setelah dibuat
let promise = new Promise(resolve => resolve("done!"));
promise.then(alert); // done! (muncul sekarang)
Perhatikan bahwa ini membuat Promise lebih efektif daripada skenario ???daftar berlangganan??? di kehidupan nyata. Jika penyanyi sudah merilis lagu mereka dan kemudian seseorang mendaftar di daftar berlangganan, mereka mungkin tidak akan menerima lagu itu. Berlangganan dalam kehidupan nyata harus dilakukan sebelum acara tersebut.
Promise lebih fleksibel. Kita bisa menambahkan handlers kapan saja: jika hasilnya sudah ada, mereka langsung mengeksekusi.
Selanjutnya, mari kita lihat contoh-contoh yang lebih praktis tentang bagaimana promise dapat membantu kita menulis kode asynchronous.
Contoh: loadScript
Kita punya fungsi loadScript
untuk memuat skrip dari bab sebelumnya.
Inilah varian berbasis callback, hanya untuk mengingatkan kita tentang itu:
function loadScript(src, callback) {
let script = document.createElement('script');
script.src = src;
script.onload = () => callback(null, script);
script.onerror = () => callback(new Error(`Script load error for ${src}`));
document.head.append(script);
}
Mari tulis ulang menggunakan Promise.
Fungsi baru loadScript
tidak akan memerlukan callback. Sebagai gantinya, fungsi tersebut akan membuat dan mengembalikkan sebuah objek Promise yang diselesaikan ketika pemuatan sudah selesai. Kode yang paling luar dapat menambah handler (fungsi berlangganan) dengan menggunakan .then
:
function loadScript(src) {
return new Promise(function(resolve, reject) {
let script = document.createElement('script');
script.src = src;
script.onload = () => resolve(script);
script.onerror = () => reject(new Error(`Script load error for ${src}`));
document.head.append(script);
});
}
Pemakaian:
let promise = loadScript("https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.11/lodash.js");
promise.then(
script => alert(`${script.src} is loaded!`),
error => alert(`Error: ${error.message}`)
);
promise.then(script => alert('Another handler...'));
Kita dapat segera melihat beberapa manfaat melalui pola berbasis callback:
Promise | Callback |
---|---|
Promise memungkinkan kita melakukan hal-hal dalam urutan alami. Pertama, kita menjalankan loadScript(script) , dan .then kita menulis apa yang harus dilakukan dengan hasilnya. |
Kita harus punya fungsi callback yang kita miliki saat memanggil loadScript(script, callback) . Dengan kata lain, kita harus tau apa yang harus dilakukan dengan hasil sebelum loadScript dipanggil. |
Kita dapat memanggil .then pada Promise sebanyak yang kita inginkan. Setiap kali, kita tambahkan ???fan??? baru, fungsi berlangganan baru, ke ???daftar berlangganan???. Lebih lanjut tentang ini di bab selanjutnya: Promises chaining. |
Hanya ada satu callback. |
Jadi promise memberikan kita aliran kode dan fleksibilitas yang lebih baik. Tetapi masih ada lagi. Kita akan melihatnya di bab-bab selanjutnya.