Anvisningar: Exportera och ändra registreringar i grupp

Artikel
11/09/2015

Det finns scenarier där det krävs för att skapa eller ändra ett stort antal registreringar i en meddelandehubb. Några av dessa scenarier är tagguppdateringar efter batchberäkningar eller migrering av en befintlig push-implementering för att använda Notification Hubs.

Det här avsnittet beskriver hur du använder massstöd för Notification Hubs för att utföra ett stort antal åtgärder på en meddelandehubb eller för att exportera alla registreringar.

High-Level Flow

Batch-stöd är utformat för att stödja långvariga jobb som involverar miljontals registreringar. För att uppnå den här skalan använder batchstöd Azure Storage för att lagra jobbinformation och utdata. För massuppdateringsåtgärder måste användaren skapa en fil i en blobcontainer, vars innehåll är listan över registreringsåtgärder. När du startar jobbet tillhandahåller användaren en URL till indatabloben, tillsammans med en URL till en utdatakatalog (även i en blobcontainer). När jobbet har startat kan användaren kontrollera statusen genom att fråga en URL-plats som angavs vid jobbstarten. Observera att ett visst jobb bara kan utföra åtgärder av en viss typ (skapar, uppdaterar eller tar bort). Exportåtgärder utförs på samma sätt.

Importera

Installation

Det här avsnittet förutsätter att du har följande:

En etablerad meddelandehubb.
En Azure Storage blobcontainer.
Referenser till NuGet-paketen Azure Storage och Azure Service Bus.

Skapa en indatafil och lagra den i en blob

En indatafil innehåller en lista över registreringar som serialiserats i XML, en per rad. Med hjälp av Azure SDK visar följande kodexempel hur du serialiserar registreringarna och laddar upp dem till blobcontainern.

private static void SerializeToBlob(CloudBlobContainer container, RegistrationDescription[] descriptions)
{
    StringBuilder builder = new StringBuilder();
    foreach (var registrationDescription in descriptions)
    {
        builder.AppendLine(RegistrationDescription.Serialize());
    }

    var inputBlob = container.GetBlockBlobReference(INPUT_FILE_NAME);
    using (MemoryStream stream = new MemoryStream(Encoding.UTF8.GetBytes(builder.ToString())))
    {
        inputBlob.UploadFromStream(stream);
    }
}

Viktigt

Koden ovan serialiserar registreringarna i minnet och laddar sedan upp hela dataströmmen till en blob. Om du har laddat upp en fil på mer än bara några megabyte kan du läsa Azure Blob-vägledningen om hur du utför de här stegen. till exempel blockblobar.

Skapa URL-token

När indatafilen har laddats upp måste du generera url:erna som ska tillhandahållas till meddelandehubben för både indatafilen och utdatakatalogen. Observera att du kan använda två olika blobcontainrar för indata och utdata.

static Uri GetOutputDirectoryUrl(CloudBlobContainer container)
{
    SharedAccessBlobPolicy sasConstraints = new SharedAccessBlobPolicy
    {
        SharedAccessExpiryTime = DateTime.UtcNow.AddDays(1),
        Permissions = SharedAccessBlobPermissions.Write | SharedAccessBlobPermissions.List | SharedAccessBlobPermissions.Read
    };

    string sasContainerToken = container.GetSharedAccessSignature(sasConstraints);
    return new Uri(container.Uri + sasContainerToken);
}

static Uri GetInputFileUrl(CloudBlobContainer container, string filePath)
{
    SharedAccessBlobPolicy sasConstraints = new SharedAccessBlobPolicy
    {
        SharedAccessExpiryTime = DateTime.UtcNow.AddDays(1),
        Permissions = SharedAccessBlobPermissions.Read
    };
    string sasToken = container.GetBlockBlobReference(filePath).GetSharedAccessSignature(sasConstraints);
    return new Uri(container.Uri + "/" + filePath + sasToken);
}

Skicka jobbet

Med de två indata- och utdata-URL:erna kan vi nu starta batchjobbet.

NotificationHubClient client = NotificationHubClient.CreateClientFromConnectionString(CONNECTION_STRING, HUB_NAME);
var createTask = client.SubmitNotificationHubJobAsync(
new NotificationHubJob {
        JobType = NotificationHubJobType.ImportCreateRegistrations,
        OutputContainerUri = outputContainerSasUri,
        ImportFileUri = inputFileSasUri
    }
);
createTask.Wait();

var job = createTask.Result;
long i = 10;
while (i > 0 && job.Status != NotificationHubJobStatus.Completed)
{
    var getJobTask = client.GetNotificationHubJobAsync(job.JobId);
    getJobTask.Wait();
    job = getJobTask.Result;
    Thread.Sleep(1000);
    i--;
}

Förutom in- och utdata-URL:erna skapar det här exemplet ett NotificationHubJob objekt som innehåller ett JobType -objekt, vilket kan vara något av följande:

ImportCreateRegistrations
ImportUpdateRegistrations
ImportDeleteRegistrations

När anropet har slutförts fortsätter jobbet av meddelandehubben och du kan kontrollera dess status med anropet till GetNotificationHubJobAsync.

När jobbet har slutförts kan du granska resultaten genom att titta på följande filer i utdatakatalogen:

/<hub>/<jobid>/Failed.txt
/<hub>/<jobid>/Output.txt

Dessa filer innehåller en lista över lyckade och misslyckade åtgärder från batchen. Filformatet är .cvs, där varje rad har radnumret för den ursprungliga indatafilen och utdata för åtgärden (vanligtvis den skapade eller uppdaterade registreringsbeskrivningen).

Exportera

Export av registrering liknar importen, med följande skillnader:

Du behöver bara utdata-URL:en.
Du måste skapa ett NotificationHubJob av typen ExportRegistrations.

Fullständig exempelkod

Följande är ett fullständigt fungerande exempel som importerar registreringar till en meddelandehubb.

using Microsoft.ServiceBus.Notifications;
using Microsoft.WindowsAzure.Storage;
using Microsoft.WindowsAzure.Storage.Blob;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Runtime.Serialization;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Xml;

namespace ConsoleApplication1
{
    class Program
    {
        private static string CONNECTION_STRING = "---";
        private static string HUB_NAME = "---";
        private static string INPUT_FILE_NAME = "CreateFile.txt";
        private static string STORAGE_ACCOUNT = "---";
        private static string STORAGE_PASSWORD = "---";
        private static StorageUri STORAGE_ENDPOINT = new StorageUri(new Uri("---"));

        static void Main(string[] args)
        {
            var descriptions = new[]
            {
                new MpnsRegistrationDescription(@"http://dm2.notify.live.net/throttledthirdparty/01.00/12G9Ed13dLb5RbCii5fWzpFpAgAAAAADAQAAAAQUZm52OkJCMjg1QTg1QkZDMkUxREQFBlVTTkMwMQ"),
                new MpnsRegistrationDescription(@"http://dm2.notify.live.net/throttledthirdparty/01.00/12G9Ed13dLb5RbCii5fWzpFpAgAAAAADAQAAAAQUZm52OkJCMjg1QTg1QkZDMjUxREQFBlVTTkMwMQ"),
                new MpnsRegistrationDescription(@"http://dm2.notify.live.net/throttledthirdparty/01.00/12G9Ed13dLb5RbCii5fWzpFpAgAAAAADAQAAAAQUZm52OkJCMjg1QTg1QkZDMhUxREQFBlVTTkMwMQ"),
                new MpnsRegistrationDescription(@"http://dm2.notify.live.net/throttledthirdparty/01.00/12G9Ed13dLb5RbCii5fWzpFpAgAAAAADAQAAAAQUZm52OkJCMjg1QTg1QkZDMdUxREQFBlVTTkMwMQ"),
            };

            //write to blob store to create an input file
            var blobClient = new CloudBlobClient(STORAGE_ENDPOINT, new Microsoft.WindowsAzure.Storage.Auth.StorageCredentials(STORAGE_ACCOUNT, STORAGE_PASSWORD));
            var container = blobClient.GetContainerReference("testjobs");
            container.CreateIfNotExists();

            SerializeToBlob(container, descriptions);

            // TODO then create Sas
            var outputContainerSasUri = GetOutputDirectoryUrl(container);
            var inputFileSasUri = GetInputFileUrl(container, INPUT_FILE_NAME);


            //Lets import this file
            NotificationHubClient client = NotificationHubClient.CreateClientFromConnectionString(CONNECTION_STRING, HUB_NAME);
            var createTask = client.SubmitNotificationHubJobAsync(
                new NotificationHubJob {
                    JobType = NotificationHubJobType.ImportCreateRegistrations,
                    OutputContainerUri = outputContainerSasUri,
                    ImportFileUri = inputFileSasUri
                }
            );
            createTask.Wait();

            var job = createTask.Result;
            long i = 10;
            while (i > 0 && job.Status != NotificationHubJobStatus.Completed)
            {
                var getJobTask = client.GetNotificationHubJobAsync(job.JobId);
                getJobTask.Wait();
                job = getJobTask.Result;
                Thread.Sleep(1000);
                i--;
            }
        }

        private static void SerializeToBlob(CloudBlobContainer container, RegistrationDescription[] descriptions)
        {
            StringBuilder builder = new StringBuilder();
            foreach (var registrationDescription in descriptions)
            {
                builder.AppendLine(RegistrationDescription.Serialize());
            }

            var inputBlob = container.GetBlockBlobReference(INPUT_FILE_NAME);
            using (MemoryStream stream = new MemoryStream(Encoding.UTF8.GetBytes(builder.ToString())))
            {
                inputBlob.UploadFromStream(stream);
            }
        }

        static Uri GetOutputDirectoryUrl(CloudBlobContainer container)
        {
            //Set the expiry time and permissions for the container.
            //In this case no start time is specified, so the shared access signature becomes valid immediately.
            SharedAccessBlobPolicy sasConstraints = new SharedAccessBlobPolicy
            {
                SharedAccessExpiryTime = DateTime.UtcNow.AddHours(4),
                Permissions = SharedAccessBlobPermissions.Write | SharedAccessBlobPermissions.List | SharedAccessBlobPermissions.Read
            };

            //Generate the shared access signature on the container, setting the constraints directly on the signature.
            string sasContainerToken = container.GetSharedAccessSignature(sasConstraints);

            //Return the URI string for the container, including the SAS token.
            return new Uri(container.Uri + sasContainerToken);
        }

        static Uri GetInputFileUrl(CloudBlobContainer container, string filePath)
        {
            //Set the expiry time and permissions for the container.
            //In this case no start time is specified, so the shared access signature becomes valid immediately.
            SharedAccessBlobPolicy sasConstraints = new SharedAccessBlobPolicy
            {
                SharedAccessExpiryTime = DateTime.UtcNow.AddHours(4),
                Permissions = SharedAccessBlobPermissions.Read
            };

            //Generate the shared access signature on the container, setting the constraints directly on the signature.
            string sasToken = container.GetBlockBlobReference(filePath).GetSharedAccessSignature(sasConstraints);

            //Return the URI string for the container, including the SAS token.
            return new Uri(container.Uri + "/" + filePath + sasToken);
        }

        static string GetJobPath(string namespaceName, string notificationHubPath, string jobId)
        {
            return string.Format(CultureInfo.InvariantCulture, @"{0}//{1}/{2}/", namespaceName, notificationHubPath, jobId);
        }
    }
}

Dela via