Singleton orchestrators in Durable Functions (Azure Functions)
Cikk
Háttérfeladatok esetén gyakran meg kell győződnie arról, hogy egy adott vezénylőnek egyszerre csak egy példánya fut. Ezt a fajta egyszeri viselkedést Durable Functions úgy biztosíthatja, hogy egy adott példányazonosítót rendel hozzá egy vezénylőhöz a létrehozáskor.
Példa egyszemélyesre
Az alábbi példa egy HTTP-trigger függvényt mutat be, amely egyszeri háttérfeladat-vezénylést hoz létre. A kód biztosítja, hogy csak egy példány létezik egy adott példányazonosítóhoz.
[FunctionName("HttpStartSingle")]
public static async Task<HttpResponseMessage> RunSingle(
[HttpTrigger(AuthorizationLevel.Function, methods: "post", Route = "orchestrators/{functionName}/{instanceId}")] HttpRequestMessage req,
[DurableClient] IDurableOrchestrationClient starter,
string functionName,
string instanceId,
ILogger log)
{
// Check if an instance with the specified ID already exists or an existing one stopped running(completed/failed/terminated).
var existingInstance = await starter.GetStatusAsync(instanceId);
if (existingInstance == null
|| existingInstance.RuntimeStatus == OrchestrationRuntimeStatus.Completed
|| existingInstance.RuntimeStatus == OrchestrationRuntimeStatus.Failed
|| existingInstance.RuntimeStatus == OrchestrationRuntimeStatus.Terminated)
{
// An instance with the specified ID doesn't exist or an existing one stopped running, create one.
dynamic eventData = await req.Content.ReadAsAsync<object>();
await starter.StartNewAsync(functionName, instanceId, eventData);
log.LogInformation($"Started orchestration with ID = '{instanceId}'.");
return starter.CreateCheckStatusResponse(req, instanceId);
}
else
{
// An instance with the specified ID exists or an existing one still running, don't create one.
return new HttpResponseMessage(HttpStatusCode.Conflict)
{
Content = new StringContent($"An instance with ID '{instanceId}' already exists."),
};
}
}
Megjegyzés
Az előző C#-kód Durable Functions 2.x-hez készült. Az 1.x Durable Functions esetében attribútumot kell használnia OrchestrationClient az DurableClient attribútum helyett, és a DurableOrchestrationClient paramétertípust kell használnia a IDurableOrchestrationClienthelyett. A verziók közötti különbségekről a verziók Durable Functions című cikkben talál további információt.
const df = require("durable-functions");
module.exports = async function(context, req) {
const client = df.getClient(context);
const instanceId = req.params.instanceId;
const functionName = req.params.functionName;
// Check if an instance with the specified ID already exists or an existing one stopped running(completed/failed/terminated).
const existingInstance = await client.getStatus(instanceId);
if (!existingInstance
|| existingInstance.runtimeStatus == "Completed"
|| existingInstance.runtimeStatus == "Failed"
|| existingInstance.runtimeStatus == "Terminated") {
// An instance with the specified ID doesn't exist or an existing one stopped running, create one.
const eventData = req.body;
await client.startNew(functionName, instanceId, eventData);
context.log(`Started orchestration with ID = '${instanceId}'.`);
return client.createCheckStatusResponse(req, instanceId);
} else {
// An instance with the specified ID exists or an existing one still running, don't create one.
return {
status: 409,
body: `An instance with ID '${instanceId}' already exists.`,
};
}
};
import logging
import azure.functions as func
import azure.durable_functions as df
async def main(req: func.HttpRequest, starter: str) -> func.HttpResponse:
client = df.DurableOrchestrationClient(starter)
instance_id = req.route_params['instanceId']
function_name = req.route_params['functionName']
existing_instance = await client.get_status(instance_id)
if existing_instance.runtime_status in [df.OrchestrationRuntimeStatus.Completed, df.OrchestrationRuntimeStatus.Failed, df.OrchestrationRuntimeStatus.Terminated, None]:
event_data = req.get_body()
instance_id = await client.start_new(function_name, instance_id, event_data)
logging.info(f"Started orchestration with ID = '{instance_id}'.")
return client.create_check_status_response(req, instance_id)
else:
return {
'status': 409,
'body': f"An instance with ID '${existing_instance.instance_id}' already exists"
}
@FunctionName("HttpStartSingle")
public HttpResponseMessage runSingle(
@HttpTrigger(name = "req") HttpRequestMessage<?> req,
@DurableClientInput(name = "durableContext") DurableClientContext durableContext) {
String instanceID = "StaticID";
DurableTaskClient client = durableContext.getClient();
// Check to see if an instance with this ID is already running
OrchestrationMetadata metadata = client.getInstanceMetadata(instanceID, false);
if (metadata.isRunning()) {
return req.createResponseBuilder(HttpStatus.CONFLICT)
.body("An instance with ID '" + instanceID + "' already exists.")
.build();
}
// No such instance exists - create a new one. De-dupe is handled automatically
// in the storage layer if another function tries to also use this instance ID.
client.scheduleNewOrchestrationInstance("MyOrchestration", null, instanceID);
return durableContext.createCheckStatusResponse(req, instanceID);
}
Alapértelmezés szerint a példányazonosítók véletlenszerűen generált GUID azonosítók. Az előző példában azonban a példányazonosító az URL-címből származó útvonaladatokban lesz átadva. A kód ezután lekéri a vezénylési példány metaadatait annak ellenőrzéséhez, hogy a megadott azonosítóval rendelkező példány már fut-e. Ha nem fut ilyen példány, a rendszer létrehoz egy új példányt ezzel az azonosítóval.
Megjegyzés
Ebben a mintában lehetséges versenyhelyzet áll fenn. Ha a HttpStartSingle két példánya egyidejűleg fut, mindkét függvényhívás sikeres lesz, de valójában csak egy vezénylési példány indul el. A követelményektől függően ez nemkívánatos mellékhatásokat okozhat.
A vezénylőfüggvény implementációjának részletei valójában nem számítanak. Lehet egy reguláris vezénylési funkció, amely elindul és befejeződik, vagy egy örökké futó (azaz örökkévaló vezénylés). A lényeg az, hogy egyszerre csak egy példány fut.