Google Mirror API ช่วยให้คุณสามารถแทรกไฟล์แนบเมื่อสร้างรายการในไทม์ไลน์ใหม่
ตัวเลือกการอัปโหลด
Google Mirror API ช่วยให้คุณอัปโหลดข้อมูลหรือสื่อไบนารีบางประเภทได้ จะมีการระบุลักษณะเฉพาะของข้อมูลที่คุณอัปโหลดไว้ในหน้าอ้างอิงสำหรับวิธีการที่รองรับการอัปโหลดสื่อ ดังนี้
- ขนาดไฟล์สูงสุดที่อัปโหลด: จำนวนข้อมูลสูงสุดที่คุณสามารถจัดเก็บด้วยวิธีนี้
- ประเภท MIME ของสื่อที่ยอมรับ: ประเภทข้อมูลไบนารีที่คุณจัดเก็บได้โดยใช้วิธีนี้
คุณส่งคำขออัปโหลดด้วยวิธีใดก็ได้ต่อไปนี้ ระบุวิธีที่คุณใช้กับพารามิเตอร์คำขอ uploadType
- การอัปโหลดอย่างง่าย:
uploadType=media
สำหรับการโอนไฟล์ขนาดเล็กอย่างรวดเร็ว เช่น ขนาดไม่เกิน 5 MB - การอัปโหลดหลายส่วน:
uploadType=multipart
เพื่อการโอนไฟล์ขนาดเล็กและข้อมูลเมตาอย่างรวดเร็ว จะโอนไฟล์พร้อมกับข้อมูลเมตาที่อธิบาย ทั้งหมดนี้ในคำขอเดียว - การอัปโหลดที่กลับมาดำเนินการต่อได้:
uploadType=resumable
เพื่อการโอนที่เชื่อถือได้ โดยเฉพาะอย่างยิ่งกับไฟล์ขนาดใหญ่ ด้วยวิธีการนี้ คุณจะใช้คำขอเริ่มต้นเซสชัน ซึ่งอาจรวมข้อมูลเมตาไว้ด้วยก็ได้ นี่เป็นกลยุทธ์ที่ดีสำหรับแอปพลิเคชันส่วนใหญ่ เนื่องจากใช้ได้กับไฟล์ขนาดเล็กด้วย แต่จะต้องเสียค่าใช้จ่ายเป็นคําขอ HTTP เพิ่มอีก 1 รายการต่อการอัปโหลด
เมื่อคุณอัปโหลดสื่อ คุณจะใช้ URI พิเศษ อันที่จริงแล้ว วิธีการที่รองรับการอัปโหลดสื่อมีปลายทาง URI 2 รายการ ได้แก่
URL /upload สำหรับสื่อ รูปแบบของปลายทางการอัปโหลดคือ URI ของทรัพยากรมาตรฐานที่มีคำนำหน้า "/upload" ใช้ URI นี้เมื่อโอนข้อมูลสื่อ
เช่น
POST /upload/mirror/v1/timeline
URI ของทรัพยากรมาตรฐานสำหรับข้อมูลเมตา หากทรัพยากรมี ช่องข้อมูลเหล่านี้จะใช้ในการจัดเก็บข้อมูลเมตาที่อธิบายถึงการอัปโหลด คุณสามารถใช้ URI นี้เมื่อสร้างหรืออัปเดตค่าข้อมูลเมตาได้
ตัวอย่าง
POST /mirror/v1/timeline
การอัปโหลดที่ง่ายดาย
วิธีที่ง่ายที่สุดในการอัปโหลดไฟล์คือการสร้างคำขออัปโหลดแบบง่ายๆ ตัวเลือกนี้เป็นตัวเลือกที่ดีในกรณีต่อไปนี้
- ไฟล์มีขนาดเล็กพอที่จะอัปโหลดอีกครั้งได้ หากการเชื่อมต่อล้มเหลว
- ไม่มีข้อมูลเมตาที่จะส่ง กรณีนี้อาจเกิดขึ้นหากคุณวางแผนที่จะส่งข้อมูลเมตาของทรัพยากรนี้ในคำขอแยกต่างหาก หรือหากระบบไม่รองรับหรือไม่มีข้อมูลเมตา
หากต้องการใช้การอัปโหลดแบบง่าย ให้ส่งคำขอ POST
หรือ PUT
ไปยัง URI /upload ของเมธอด แล้วเพิ่มพารามิเตอร์การค้นหา uploadType=media
เช่น
POST https://www.googleapis.com/upload/mirror/v1/timeline?uploadType=media
ส่วนหัว HTTP ที่จะใช้เมื่อส่งคำขออัปโหลดอย่างง่ายประกอบด้วย:
Content-Type
ตั้งค่าเป็นประเภทข้อมูลอัปโหลดสื่อที่ยอมรับของวิธีการ 1 ประเภท ซึ่งระบุในการอ้างอิง APIContent-Length
กำหนดจำนวนไบต์ที่คุณกำลังอัปโหลด แต่ไม่จำเป็นต้องระบุหากใช้การเข้ารหัสการโอนเป็นกลุ่ม
ตัวอย่าง: การอัปโหลดแบบง่าย
ตัวอย่างต่อไปนี้จะแสดงการใช้คำขออัปโหลดแบบง่ายสำหรับ Google Mirror API
POST /upload/mirror/v1/timeline?uploadType=media HTTP/1.1 Host: www.googleapis.com Content-Type: image/jpeg Content-Length: number_of_bytes_in_file Authorization: Bearer your_auth_token JPEG data
หากคำขอสำเร็จ เซิร์ฟเวอร์จะส่งคืนรหัสสถานะ HTTP 200 OK
พร้อมกับข้อมูลเมตาดังนี้
HTTP/1.1 200 Content-Type: application/json { "text": "Hello world!" }
การอัปโหลดหลายส่วน
หากมีข้อมูลเมตาที่ต้องการส่งไปพร้อมกับข้อมูลที่อัปโหลด คุณจะส่งคำขอ multipart/related
รายการเดียวได้ ซึ่งเป็นตัวเลือกที่ดีหากข้อมูลที่คุณส่งมีขนาดเล็กพอที่จะอัปโหลดอีกครั้งได้ หากการเชื่อมต่อล้มเหลว
หากต้องการใช้การอัปโหลดแบบหลายส่วน ให้ส่งคำขอ POST
หรือ PUT
ไปยัง URI /upload ของเมธอด แล้วเพิ่มพารามิเตอร์การค้นหา uploadType=multipart
เช่น
POST https://www.googleapis.com/upload/mirror/v1/timeline?uploadType=multipart
ส่วนหัว HTTP ระดับบนสุดที่จะใช้เมื่อส่งคำขออัปโหลดที่มีหลายส่วนมีดังนี้
Content-Type
ตั้งค่าเป็น "หลายส่วน/เกี่ยวข้อง" และรวมสตริงขอบเขตที่ใช้เพื่อระบุส่วนต่างๆ ของคำขอContent-Length
. ตั้งค่าเป็นจํานวนไบต์ทั้งหมดในเนื้อหาคําขอ สื่อของคำขอต้องเล็กกว่าขนาดไฟล์สูงสุดที่ระบุไว้สำหรับวิธีนี้
เนื้อหาของคำขอมีรูปแบบเป็นเนื้อหา multipart/related
ประเภท [RFC2387] และมี 2 ส่วนเท่านั้น แต่ละส่วนจะระบุด้วยสตริงขอบเขต และสตริงขอบเขตสุดท้ายจะตามด้วยขีดกลาง 2 ตัว
แต่ละส่วนของคำขอแบบหลายส่วนต้องมีส่วนหัว Content-Type
เพิ่มเติม ดังนี้
- ส่วนข้อมูลเมตา: ต้องมาก่อนและ
Content-Type
ต้องตรงกับรูปแบบข้อมูลเมตาที่ยอมรับรูปแบบใดรูปแบบหนึ่ง - ส่วนสื่อ: ต้องอยู่หลังสุด และ
Content-Type
ต้องตรงกับประเภท MIME ของสื่อที่วิธีการยอมรับ
โปรดดูข้อมูลอ้างอิง API สำหรับรายการประเภท MIME ของสื่อที่ยอมรับและขีดจำกัดขนาดของไฟล์ที่อัปโหลดแต่ละวิธี
หมายเหตุ: หากต้องการสร้างหรืออัปเดตส่วนข้อมูลเมตา
เพียงแค่ส่งคำขอ POST
หรือ PUT
ไปยังปลายทางทรัพยากรมาตรฐานเท่านั้น โดยไม่ต้องอัปโหลดข้อมูลที่เกี่ยวข้อง
https://www.googleapis.com/mirror/v1/timeline
ตัวอย่าง: การอัปโหลดหลายส่วน
ตัวอย่างด้านล่างแสดงคําขอการอัปโหลดแบบหลายส่วนสําหรับ Google Mirror API
POST /upload/mirror/v1/timeline?uploadType=multipart HTTP/1.1 Host: www.googleapis.com Authorization: Bearer your_auth_token Content-Type: multipart/related; boundary=foo_bar_baz Content-Length: number_of_bytes_in_entire_request_body --foo_bar_baz Content-Type: application/json; charset=UTF-8 { "text": "Hello world!" } --foo_bar_baz Content-Type: image/jpeg JPEG data --foo_bar_baz--
หากคำขอสำเร็จ เซิร์ฟเวอร์จะแสดงรหัสสถานะ HTTP 200 OK
พร้อมกับข้อมูลเมตา
HTTP/1.1 200 Content-Type: application/json { "text": "Hello world!" }
การอัปโหลดที่ดำเนินการต่อได้
คุณสามารถใช้โปรโตคอลการอัปโหลดที่อัปโหลดต่อได้เพื่ออัปโหลดไฟล์ข้อมูลอย่างน่าเชื่อถือยิ่งขึ้น โปรโตคอลนี้ช่วยให้คุณดำเนินการอัปโหลดต่อได้หลังจากการสื่อสารไม่สำเร็จทำให้การไหลของข้อมูลหยุดชะงัก ซึ่งจะเป็นประโยชน์อย่างยิ่งหากคุณกำลังโอนไฟล์ขนาดใหญ่และมีโอกาสที่จะเกิดความขัดข้องของเครือข่ายหรือการถ่ายโอนข้อมูลอื่นไม่สำเร็จ เช่น เมื่ออัปโหลดจากแอปไคลเอ็นต์บนอุปกรณ์เคลื่อนที่ นอกจากนี้ยังช่วยลดการใช้แบนด์วิดท์ในกรณีที่เครือข่ายล้มเหลว เนื่องจากคุณไม่ต้องรีสตาร์ทการอัปโหลดไฟล์ขนาดใหญ่ตั้งแต่ต้น
ขั้นตอนสำหรับการอัปโหลดที่ดำเนินการต่อได้มีดังนี้
- เริ่มเซสชันที่กลับมาทำงานต่อได้ ส่งคำขอเริ่มต้นไปยัง URI การอัปโหลดที่มีข้อมูลเมตา หากมี
- บันทึก URI ของเซสชันที่ดำเนินการต่อได้ บันทึก URI ของเซสชันที่ส่งคืนในการตอบกลับคำขอเริ่มต้น เพราะคุณจะใช้สำหรับคำขอที่เหลือในเซสชันนี้
- อัปโหลดไฟล์ ส่งไฟล์สื่อไปยัง URI เซสชันที่ดำเนินการต่อได้
นอกจากนี้ แอปที่ใช้การอัปโหลดต่อได้จะต้องมีโค้ดเพื่อกลับมาอัปโหลดที่หยุดชะงักอีกครั้ง หากการอัปโหลดขัดข้อง ให้ดูปริมาณข้อมูลที่ได้รับสำเร็จ แล้วอัปโหลดต่อโดยเริ่มจากจุดนั้น
หมายเหตุ: URI การอัปโหลดจะหมดอายุหลังจากผ่านไป 1 สัปดาห์
ขั้นตอนที่ 1: เริ่มเซสชันที่กลับมาทำงานต่อได้
หากต้องการเริ่มการอัปโหลดที่ดำเนินการต่อได้ ให้ส่งคำขอ POST
หรือ PUT
ไปยัง URI /upload ของเมธอด แล้วเพิ่มพารามิเตอร์การค้นหา
uploadType=resumable
เช่น
POST https://www.googleapis.com/upload/mirror/v1/timeline?uploadType=resumable
สำหรับคำขอเริ่มต้นนี้ เนื้อหาว่างเปล่าหรือมีข้อมูลเมตาเท่านั้น คุณจะต้องโอนเนื้อหาจริงของไฟล์ที่คุณต้องการอัปโหลดในคำขอที่ตามมา
ใช้ส่วนหัว HTTP ต่อไปนี้กับคำขอเริ่มต้นX-Upload-Content-Type
ตั้งค่าเป็นประเภท MIME ของสื่อของข้อมูลการอัปโหลดที่จะโอนในคำขอต่อๆ มาX-Upload-Content-Length
กำหนดจำนวนไบต์ของข้อมูลการอัปโหลดที่จะโอนในคำขอที่ตามมา หากไม่ทราบความยาว ณ เวลาที่ส่งคำขอนี้ ก็ละเว้นส่วนหัวนี้ได้- หากระบุข้อมูลเมตา:
Content-Type
ตั้งค่าตามประเภทข้อมูลของข้อมูลเมตา Content-Length
. ตั้งค่าเป็นจํานวนไบต์ที่ระบุในส่วนเนื้อหาของคําขอเริ่มต้นนี้ ไม่จําเป็นหากใช้การเข้ารหัสการโอนแบบแบ่งกลุ่ม
ดูข้อมูลอ้างอิง API เพื่อดูรายการประเภท MIME ของสื่อที่ยอมรับและขีดจำกัดขนาดของไฟล์ที่อัปโหลดสำหรับแต่ละเมธอด
ตัวอย่าง: คำขอเริ่มเซสชันที่ดำเนินการต่อได้
ตัวอย่างต่อไปนี้แสดงวิธีเริ่มเซสชันที่กลับมาทำงานอีกครั้งสําหรับ Google Mirror API
POST /upload/mirror/v1/timeline?uploadType=resumable HTTP/1.1 Host: www.googleapis.com Authorization: Bearer your_auth_token Content-Length: 38 Content-Type: application/json; charset=UTF-8 X-Upload-Content-Type: image/jpeg X-Upload-Content-Length: 2000000 { "text": "Hello world!" }
หมายเหตุ: สำหรับคำขออัปเดตแบบเริ่มใหม่ได้ครั้งแรกที่ไม่มีข้อมูลเมตา ให้เว้นเนื้อหาของคำขอว่างไว้และตั้งค่าส่วนหัว Content-Length
เป็น 0
ส่วนถัดไปจะอธิบายถึงวิธีจัดการคำตอบ
ขั้นตอนที่ 2: บันทึก URI ของเซสชันที่ดำเนินการต่อได้
หากคำขอเริ่มต้นเซสชันสำเร็จ เซิร์ฟเวอร์ API จะตอบกลับด้วยรหัสสถานะ HTTP 200 OK
นอกจากนี้จะมีส่วนหัว Location
ที่ระบุ URI ของเซสชันที่เรียกได้ว่าดำเนินการต่อได้ ส่วนหัว Location
ที่แสดงในตัวอย่างด้านล่างมีส่วนพารามิเตอร์การค้นหาของ upload_id
ที่ให้รหัสการอัปโหลดที่ไม่ซ้ำกันซึ่งใช้กับเซสชันนี้
ตัวอย่าง: การตอบกลับการเริ่มต้นเซสชันที่กลับมาทำงานต่อได้
การตอบกลับคำขอในขั้นตอนที่ 1 มีดังนี้
HTTP/1.1 200 OK Location: https://www.googleapis.com/upload/mirror/v1/timeline?uploadType=resumable&upload_id=xa298sd_sdlkj2 Content-Length: 0
ค่าของส่วนหัว Location
ดังที่แสดงในการตอบกลับตัวอย่างด้านบนคือ URI ของเซสชันที่คุณจะใช้เป็นปลายทาง HTTP เพื่ออัปโหลดไฟล์จริงหรือค้นหาสถานะการอัปโหลด
คัดลอกและบันทึก URI ของเซสชันเพื่อให้ใช้สำหรับคำขอที่ตามมาได้
ขั้นตอนที่ 3: อัปโหลด
หากต้องการอัปโหลดไฟล์ ให้ส่งคำขอ PUT
ไปยัง URI การอัปโหลดที่คุณได้รับในขั้นตอนก่อนหน้า รูปแบบของคำขออัปโหลดคือ
PUT session_uri
ส่วนหัว HTTP ที่จะใช้เมื่อส่งคำขออัปโหลดไฟล์ที่ดำเนินการต่อได้มี Content-Length
ตั้งค่านี้ตามจำนวนไบต์ที่คุณอัปโหลดในคำขอนี้ ซึ่งโดยทั่วไปจะเป็นขนาดไฟล์อัปโหลด
ตัวอย่าง: คำขออัปโหลดไฟล์ที่กลับมาทำงานต่อได้
นี่คือคำขอที่กลับมาดำเนินการต่อได้เพื่ออัปโหลดไฟล์ JPEG ขนาด 2,000,000 ไบต์ทั้งหมดสำหรับตัวอย่างปัจจุบัน
PUT https://www.googleapis.com/upload/mirror/v1/timeline?uploadType=resumable&upload_id=xa298sd_sdlkj2 HTTP/1.1 Content-Length: 2000000 Content-Type: image/jpeg bytes 0-1999999
หากคำขอประสบความสำเร็จ เซิร์ฟเวอร์จะตอบสนองด้วย HTTP 201 Created
พร้อมด้วยข้อมูลเมตาที่เชื่อมโยงกับทรัพยากรนี้ หากคำขอแรกของเซสชันที่กลับมาทำงานต่อได้คือ PUT
ให้อัปเดตทรัพยากรที่มีอยู่ การตอบกลับว่าสำเร็จจะเป็น 200 OK
พร้อมกับข้อมูลเมตาที่เชื่อมโยงกับทรัพยากรนี้
หากคำขออัปโหลดถูกขัดจังหวะ หรือหากคุณได้รับการตอบกลับ HTTP 503 Service Unavailable
หรือ 5xx
อื่นๆ จากเซิร์ฟเวอร์ ให้ทำตามขั้นตอนที่ระบุไว้ในทำให้การอัปโหลดที่หยุดชะงักกลับมาทำงานอีกครั้ง
การอัปโหลดไฟล์เป็นกลุ่ม
การอัปโหลดที่กลับมาดำเนินการต่อได้ช่วยให้คุณแบ่งไฟล์ออกเป็นหลายส่วนและส่งคําขอชุดหนึ่งเพื่ออัปโหลดแต่ละส่วนตามลำดับได้ เราไม่แนะนําให้ใช้แนวทางนี้ เนื่องจากมีต้นทุนด้านประสิทธิภาพที่เชื่อมโยงกับคําขอเพิ่มเติม และโดยทั่วไปแล้วก็ไม่จําเป็น อย่างไรก็ตาม คุณอาจต้องใช้การแบ่งข้อมูลเพื่อลดปริมาณการโอนข้อมูลในคำขอหนึ่งๆ ฟังก์ชันนี้มีประโยชน์เมื่อมีการจำกัดเวลาที่แน่นอนสำหรับคำขอแต่ละรายการ ดังเช่นที่ใช้กับคำขอ Google App Engine บางคลาส นอกจากนี้ คุณยังทำสิ่งต่างๆ ได้ เช่น ระบุตัวบ่งชี้ความคืบหน้าการอัปโหลดสำหรับเบราว์เซอร์รุ่นเดิมที่ไม่รองรับความคืบหน้าการอัปโหลดโดยค่าเริ่มต้น
อัปโหลดต่อ
หากคำขออัปโหลดถูกยกเลิกก่อนที่จะได้รับการตอบกลับ หรือหากคุณได้รับการตอบกลับ HTTP 503 Service Unavailable
จากเซิร์ฟเวอร์ คุณจะต้องดำเนินการอัปโหลดที่หยุดชะงักอีกครั้ง หากต้องการทำสิ่งต่อไปนี้
- สถานะคำขอ ค้นหาสถานะปัจจุบันของการอัปโหลดโดยส่งคำขอ
PUT
ที่ว่างเปล่าไปยัง URI การอัปโหลด สําหรับคําขอนี้ ส่วนหัว HTTP ควรมีส่วนหัวContent-Range
ที่ระบุว่าไม่ทราบตําแหน่งปัจจุบันในไฟล์ เช่น ตั้งค่าContent-Range
เป็น*/2000000
หากความยาวไฟล์ทั้งหมดคือ 2,000,000 หากไม่ทราบขนาดเต็มของไฟล์ ให้ตั้งค่าContent-Range
เป็น*/*
หมายเหตุ: คุณสามารถขอสถานะระหว่างแต่ละกลุ่มได้ ไม่ใช่เฉพาะในกรณีที่การอัปโหลดถูกขัดจังหวะ ซึ่งจะมีประโยชน์ เช่น หากต้องการแสดงตัวบ่งชี้ความคืบหน้าในการอัปโหลดสำหรับเบราว์เซอร์รุ่นเดิม
- รับจำนวนไบต์ที่อัปโหลด ประมวลผลคำตอบจากการค้นหาสถานะ เซิร์ฟเวอร์ใช้ส่วนหัว
Range
ในการตอบกลับเพื่อระบุไบต์ที่ได้รับจนถึงตอนนี้ ตัวอย่างเช่น ส่วนหัวRange
ของ0-299999
ระบุว่าได้รับไฟล์ 300,000 ไบต์แรกแล้ว - อัปโหลดข้อมูลที่เหลือ สุดท้าย เมื่อคุณทราบตําแหน่งที่จะส่งคําขอต่อแล้ว ให้ส่งข้อมูลที่เหลือหรือข้อมูลส่วนที่เป็นปัจจุบัน โปรดทราบว่าคุณต้องถือว่าข้อมูลที่เหลือเป็นกลุ่มแยกต่างหากไม่ว่าในกรณีใดก็ตาม คุณจึงต้องส่งส่วนหัว
Content-Range
เมื่ออัปโหลดต่อ
ตัวอย่าง: การอัปโหลดที่หยุดชะงักต่อ
1) ขอสถานะการอัปโหลด
คำขอต่อไปนี้ใช้ส่วนหัว Content-Range
เพื่อระบุว่าตำแหน่งปัจจุบันในไฟล์ 2,000,000 ไบต์ไม่รู้จัก
PUT {session_uri} HTTP/1.1 Content-Length: 0 Content-Range: bytes */2000000
2) ดึงจำนวนไบต์ที่อัปโหลดไว้จากคำตอบ
การตอบกลับของเซิร์ฟเวอร์ใช้ส่วนหัว Range
เพื่อระบุว่าได้รับไฟล์ 43 ไบต์แรกของไฟล์แล้ว ใช้ค่าด้านบนของส่วนหัว Range
เพื่อกำหนดตำแหน่งที่จะเริ่มการอัปโหลดต่อ
HTTP/1.1 308 Resume Incomplete Content-Length: 0 Range: 0-42
หมายเหตุ: การตอบกลับสถานะอาจเป็น 201 Created
หรือ 200 OK
หากการอัปโหลดเสร็จสมบูรณ์ ปัญหานี้อาจเกิดขึ้นหากการเชื่อมต่อขัดข้องหลังจากที่อัปโหลดไบต์ทั้งหมดแล้ว แต่ก่อนที่ไคลเอ็นต์จะได้รับการตอบกลับจากเซิร์ฟเวอร์
3) อัปโหลดต่อจากที่หยุดไว้
คําขอต่อไปนี้จะอัปโหลดต่อโดยส่งไบต์ที่เหลือของไฟล์โดยเริ่มจากไบต์ที่ 43
PUT {session_uri} HTTP/1.1 Content-Length: 1999957 Content-Range: bytes 43-1999999/2000000 bytes 43-1999999
แนวทางปฏิบัติแนะนำ
เมื่ออัปโหลดสื่อ คุณควรตระหนักถึงแนวทางปฏิบัติที่ดีที่สุดบางอย่างที่เกี่ยวข้องกับการจัดการข้อผิดพลาด
- ดำเนินการอัปโหลดต่อหรือลองอีกครั้งหากอัปโหลดไม่สำเร็จเนื่องจากการเชื่อมต่อขัดข้องหรือเกิดข้อผิดพลาด
5xx
ต่อไปนี้500 Internal Server Error
502 Bad Gateway
503 Service Unavailable
504 Gateway Timeout
- ใช้กลยุทธ์ Exponential Backoff หากระบบแสดงข้อผิดพลาดเกี่ยวกับเซิร์ฟเวอร์
5xx
เมื่อกลับมาดำเนินการต่อหรือพยายามส่งคำขออัปโหลดอีกครั้ง ข้อผิดพลาดเหล่านี้อาจเกิดขึ้นหากเซิร์ฟเวอร์ทำงานหนักเกินไป Exponential Backoff ช่วยลดปัญหาเหล่านี้ในช่วงที่มีคำขอเป็นจำนวนมากหรือมีการรับส่งข้อมูลในเครือข่ายปริมาณมาก - คำขอประเภทอื่นๆ ไม่ควรจัดการด้วย Exponential Backoff แต่คุณยังคงลองส่งคำขอเหล่านั้นได้หลายครั้ง เมื่อพยายามส่งคำขอเหล่านี้ซ้ำ ให้จำกัดจำนวนครั้งในการส่งคำขอซ้ำ เช่น รหัสของคุณอาจจำกัดจำนวนการลองใหม่ไม่เกิน 10 ครั้งก่อนที่จะรายงานข้อผิดพลาด
- จัดการข้อผิดพลาด
404 Not Found
และ410 Gone
เมื่ออัปโหลดต่อได้โดยเริ่มอัปโหลดทั้งหมดตั้งแต่ต้น
Exponential Backoff
Exponential Backoff เป็นกลยุทธ์การจัดการข้อผิดพลาดมาตรฐานสําหรับแอปพลิเคชันเครือข่าย ซึ่งไคลเอ็นต์จะส่งคําขอที่ล้มเหลวอีกครั้งเป็นระยะๆ โดยใช้เวลานานขึ้นเรื่อยๆ หากคำขอจำนวนมากหรือปริมาณการรับส่งข้อมูลในเครือข่ายจำนวนมากทำให้เซิร์ฟเวอร์แสดงผลข้อผิดพลาด การใช้ Exponential Backoff อาจเป็นกลยุทธ์ที่ดีในการจัดการข้อผิดพลาดเหล่านั้น ในทางกลับกัน วิธีนี้ไม่ใช่กลยุทธ์ที่เกี่ยวข้องในการจัดการกับข้อผิดพลาดที่ไม่เกี่ยวข้องกับปริมาณของเครือข่ายหรือเวลาในการตอบสนอง เช่น ข้อมูลเข้าสู่ระบบการให้สิทธิ์ไม่ถูกต้องหรือข้อผิดพลาดไฟล์ไม่พบ
ใช้งานอย่างเหมาะสม Exponential Backoff จะเพิ่มประสิทธิภาพในการใช้แบนด์วิดท์ ลดจำนวนคำขอที่ต้องใช้เพื่อให้การตอบสนองประสบความสำเร็จ และเพิ่มอัตราการส่งข้อมูลของคำขอในสภาพแวดล้อมที่เกิดขึ้นพร้อมกันให้สูงสุด
ขั้นตอนในการใช้งาน Exponential Backoff อย่างง่ายมีดังนี้
- ส่งคำขอไปยัง API
- ได้รับการตอบกลับ
HTTP 503
ซึ่งบ่งชี้ว่าคุณควรลองส่งคำขออีกครั้ง - โปรดรอ 1 วินาที + สุ่มตัวเลข_จำนวนมิลลิวินาที แล้วลองส่งคำขออีกครั้ง
- ได้รับคําตอบ
HTTP 503
ซึ่งหมายความว่าคุณควรลองส่งคําขออีกครั้ง - รอ 2 วินาที + random_number_milliseconds แล้วลองส่งคำขออีกครั้ง
- ได้รับการตอบกลับ
HTTP 503
ซึ่งบ่งชี้ว่าคุณควรลองส่งคำขออีกครั้ง - โปรดรอ 4 วินาที + สุ่มตัวเลข_มิลลิวินาที แล้วลองส่งคำขออีกครั้ง
- ได้รับการตอบกลับ
HTTP 503
ซึ่งบ่งชี้ว่าคุณควรลองส่งคำขออีกครั้ง - โปรดรอ 8 วินาที + สุ่มตัวเลข_จำนวนมิลลิวินาที แล้วลองส่งคำขออีกครั้ง
- ได้รับการตอบกลับ
HTTP 503
ซึ่งบ่งชี้ว่าคุณควรลองส่งคำขออีกครั้ง - โปรดรอ 16 วินาที + สุ่มตัวเลข_จำนวนมิลลิวินาที แล้วลองส่งคำขออีกครั้ง
- หยุด รายงานหรือบันทึกข้อผิดพลาด
ในขั้นตอนด้านบน สุ่มตัวเลข_จำนวน_มิลลิวินาที คือจำนวนมิลลิวินาทีแบบสุ่มที่น้อยกว่าหรือเท่ากับ 1000 ซึ่งเป็นสิ่งจำเป็น เนื่องจากการหน่วงเวลาแบบสุ่มเล็กน้อยจะช่วยกระจายภาระงานอย่างสม่ำเสมอมากขึ้นและหลีกเลี่ยงการประทับใจเซิร์ฟเวอร์ ค่าของ random_number_milliseconds ต้องได้รับการกําหนดใหม่หลังจากการรอแต่ละครั้ง
หมายเหตุ: การรอจะมีค่าเป็น (2 ^ n) + sample_number_milliseconds โดยที่ n คือจำนวนเต็มที่เพิ่มขึ้นแบบโมโนนิกซึ่งตอนแรกเริ่มเป็น 0 จำนวนเต็ม n จะเพิ่มขึ้น 1 ครั้งต่อการทำซ้ำแต่ละครั้ง (คำขอแต่ละรายการ)
อัลกอริทึมจะถูกตั้งค่าให้สิ้นสุดเมื่อ n เท่ากับ 5 เพดานนี้จะป้องกันไม่ให้ไคลเอ็นต์ลองซ้ำไปเรื่อยๆ และทำให้เกิดความล่าช้ารวมอยู่ที่ประมาณ 32 วินาทีก่อนที่คำขอจะถือว่าเป็น "ข้อผิดพลาดที่ไม่สามารถกู้คืนได้" ทั้งนี้ คุณจะลองส่งซ้ำได้ไม่เกินจำนวนครั้งที่กำหนด โดยเฉพาะหากการอัปโหลดที่ใช้เวลานาน อย่าลืมจำกัดการหน่วงเวลาลองอีกครั้งในระดับที่สมเหตุสมผล เช่น น้อยกว่า 1 นาที