בדף הזה מוסבר איך ליצור משימות ולהציב אותן בתורי דחיפה (push queue). כדי לעבד משימה, צריך ליצור אובייקט משימה חדש ולהוסיף אותו לתור. אתם יכולים לציין במפורש את השירות ואת ה-handler שמעבדים את המשימה, ואם רוצים, להעביר ל-handler נתונים ספציפיים למשימה. אפשר גם לשנות את הגדרות המשימה, למשל לתזמן את זמן הביצוע שלה או להגביל את מספר הניסיונות החוזרים במקרה של כישלון.
יצירת משימה חדשה
כדי ליצור משימה ולהוסיף אותה לתור, קוראים לפונקציה taskqueue.add().
ציון שירות ה-worker
כאשר משימה נשלפת מתור המשימות שלה, שירות תור המשימות שולח אותה לשירות worker. לכל משימה יש target ו-url, שקובעים איזה שירות ו-handler יבצעו בסופו של דבר את המשימה.
target
היעד מציין את השירות שיקבל את בקשת ה-HTTP כדי לבצע את המשימה. מחרוזת שמציינת שירות, גרסה או מכונה בכל אחד מהפורמטים הקנוניים. הטפסים הנפוצים ביותר הם:
service
version.service
instance.version.service
מחרוזת היעד מתווספת לשם הדומיין של האפליקציה. יש שלוש דרכים להגדיר את היעד של משימה:
מצהירים על היעד כשיוצרים את המשימה. אפשר להגדיר את היעד באופן מפורש באמצעות הפרמטר
targetבפונקציהtaskqueue.add(). ראו את הדוגמה שלמעלה.צריך לכלול הוראת
targetכשמגדירים תור ב-queue.yaml, כמו בהגדרה שלqueue-blue. כל המשימות שנוספו לתור עםtargetישתמשו ביעד הזה, גם אם הוקצה למשימה יעד אחר בזמן היצירה.אם לא צוין יעד באחת משתי השיטות הקודמות, היעד של המשימה הוא גרסת השירות שמוסיפה אותה לתור. שימו לב שאם מוסיפים משימה לתור מהשירות ומהגרסה שמוגדרים כברירת מחדל באופן הזה, וגרסת ברירת המחדל משתנה לפני שהמשימה מופעלת, היא תפעל בגרסת ברירת המחדל החדשה.
url
url בוחר את אחד ה-handlers בשירות היעד, שיבצע את המשימה.
הערך של url צריך להתאים לאחת מתבניות ה-URL של ה-handler בשירות היעד. השדה url יכול לכלול פרמטרים של שאילתה אם ה-method שצוינה במשימה היא GET או PULL. אם לא צוין url, המערכת תשתמש בכתובת ה-URL שמוגדרת כברירת מחדל /_ah/queue/[QUEUE_NAME], כאשר [QUEUE_NAME] הוא השם של התור של המשימה.
העברת נתונים ל-handler
אפשר להעביר נתונים ל-handler כפרמטרים של שאילתה בכתובת ה-URL של המשימה, אבל רק אם ה-method שצוינה במשימה היא GET או PULL.
אתם יכולים גם להשתמש בכל אחד מהשדות הבאים כדי להוסיף נתונים למשימה:
-
payload, שמעבירה את נתוני המשימה בגוף של בקשת ה-HTTP. params
שלוש הקריאות האלה שוות ערך:
taskqueue.add(method=GET, url='/update-counter?key=blue', target='worker')
taskqueue.add(url='/update-counter', params={'key': 'blue'}, target='worker')
taskqueue.add(url='/update-counter', payload="{'key': 'blue'}", target='worker')
איך נותנים שם למשימה
כשיוצרים משימה חדשה, App Engine מקצה לה שם ייחודי כברירת מחדל. עם זאת, אתם יכולים להקצות שם משלכם למשימה באמצעות הפרמטר name. אחד היתרונות של הקצאת שמות למשימות הוא ששמות המשימות עוברים תהליך של ביטול כפילויות, כך שאתם יכולים להשתמש בשמות המשימות כדי להבטיח שהמשימה תתווסף רק פעם אחת. מניעת הכפילויות נמשכת 9 ימים אחרי שהמשימה הושלמה או נמחקה.
חשוב לדעת שלוגיקת ביטול הכפילויות גורמת לתקורה משמעותית בביצועים, וכתוצאה מכך לעלייה בזמני האחזור ואולי גם לעלייה בשיעורי השגיאות שמשויכים למשימות בעלות שם. העלויות האלה יכולות לגדול באופן משמעותי אם שמות המשימות הם עוקבים, כמו חותמות זמן. לכן, אם אתם מקצים שמות משלכם, מומלץ להשתמש בקידומת מפוזרת היטב לשמות המשימות, כמו גיבוב (hash) של התוכן.
אם אתם מקצים שמות משלכם למשימות, שימו לב שהאורך המקסימלי של השם הוא 500 תווים, והשם יכול להכיל אותיות רישיות וקטנות, מספרים, קווים תחתונים ומקפים.
הוספת משימות באופן אסינכרוני
כברירת מחדל, הקריאות שמוסיפות משימות לתורים הן סינכרוניות. ברוב המקרים, קריאות סינכרוניות פועלות בצורה תקינה. הוספת משימה לתור היא בדרך כלל פעולה מהירה. יש אחוז קטן של פעולות הוספת משימות שיכולות להימשך הרבה יותר זמן, אבל הזמן החציוני להוספת משימה הוא פחות מ-5 אלפיות השנייה.
אי אפשר להוסיף פעולות של תור משימות לתורים שונים באצווה, ולכן Task Queue API מספק גם קריאות אסינכרוניות שמאפשרות להוסיף את המשימות האלה במקביל, וכך לצמצם עוד יותר את זמן האחזור. האפשרות הזו שימושית אם אתם מפתחים אפליקציה שרגישה מאוד לזמן אחזור, וצריכה לבצע כמה פעולות של הוספת משימות לתורים שונים בו-זמנית.
אם אתם רוצים לבצע קריאות אסינכרוניות לתור משימות, השתמשו בשיטות האסינכרוניות שסופקו על ידי המחלקה Queue של
מחלקה Queue
ואובייקט
RPC. מפעילים את get_result() על האובייקט RPC שמוחזר כדי לאלץ את השלמת הבקשה. כשמוסיפים משימות באופן אסינכרוני בטרנזקציה, צריך להפעיל את get_result() באובייקט RPC לפני שמבצעים את הטרנזקציה, כדי לוודא שהבקשה הסתיימה.
הוספת משימות לתור בטרנזקציות של Cloud Datastore
אפשר להוסיף משימה לתור כחלק מטרנזקציה של Datastore, כך שהמשימה תתווסף לתור רק אם הטרנזקציה תתבצע בהצלחה. משימות שנוספו בתוך טרנזקציה נחשבות לחלק ממנה, ויש להן אותה רמה של טרנזקציה .אפליקציה לא יכולה להוסיף יותר מחמש משימות טרנזקציונליות לתורי משימות במהלך טרנזקציה אחת. אסור לתת למשימות טרנזקציונליות שמות שהמשתמשים ציינו.
בדוגמת הקוד הבאה אפשר לראות איך להוסיף משימות טרנזקציות לתור דחיפה כחלק מטרנזקציה של Datastore:
from google.appengine.api import taskqueue
from google.appengine.ext import ndb
@ndb.transactional
def do_something_in_transaction():
taskqueue.add(url='/path/to/my/worker', transactional=True)
#...
do_something_in_transaction()
שימוש ב- deferred task library במקום בשירות של Worker
הגדרה של handler לכל משימה נפרדת (כפי שמתואר בקטעים הקודמים) יכולה להיות מסורבלת, כמו גם סריאליזציה ודה-סריאליזציה של ארגומנטים מורכבים למשימה – במיוחד אם יש לכם הרבה משימות קטנות ומגוונות שאתם רוצים להריץ בתור. ערכת ה-SDK של Python כוללת ספרייה (google.appengine.ext.deferred) שחושפת פונקציה פשוטה, שמאפשרת לעקוף את כל העבודה של הגדרת handler ייעודי למשימות, ושל סריאליזציה ודה-סריאליזציה של הפרמטרים.
כדי להשתמש בספרייה הזו, צריך להוסיף את deferred המובנה ל-app.yaml. למידע נוסף, קראו את הקטע Built-in Handlers במאמר העזר בנושא app.yaml.
כדי להשתמש בספרייה deferred, פשוט מעבירים את הפונקציה והארגומנטים שלה אל deferred.defer():
import logging
from google.appengine.ext import deferred
def do_something_expensive(a, b, c=None):
logging.info("Doing something expensive!")
# Do your work here
# Somewhere else
deferred.defer(do_something_expensive, "Hello, world!", 42, True)
הספרייה deferred אורזת את בקשה להפעלת פונקציה ואת הארגומנטים שלה, ואז מוסיפה אותה לתור המשימות. כשהמשימה מופעלת, הספרייה deferred מפעילה את do_something_expensive("Hello, world!", 42, True).
עבודה עם משימות באפליקציה מרובת דיירים
כברירת מחדל, תורי דחיפה משתמשים במרחב השמות הנוכחי, כפי שהוגדר במנהל מרחב השמות בזמן יצירת המשימה. אם האפליקציה שלכם משתמשת בריבוי דיירים (multitenancy), עיינו ב-Namespaces API.