Použití Notification Hubs z PHP

Ke všem funkcím Notification Hubs můžete přistupovat z back-endu Java/PHP/Ruby pomocí rozhraní REST centra oznámení, jak je popsáno v tématu MSDN Notification HUBS REST API.

V tomto tématu si ukážeme, jak:

Rozhraní klienta

Hlavní klientské rozhraní může poskytovat stejné metody, které jsou k dispozici v sadě .net Notification HUBS SDK, což vám umožní přímo přeložit všechny kurzy a ukázky, které jsou aktuálně k dispozici na tomto webu, a přispívá komunitou na internetu.

Můžete najít veškerý kód dostupný v ukázce obálky php REST.

Například pro vytvoření klienta:

$hub = new NotificationHub("connection string", "hubname");

Odeslání nativního oznámení iOS:

$notification = new Notification("apple", '{"aps":{"alert": "Hello!"}}');
$hub->sendNotification($notification, null);

Implementace

Pokud jste to ještě neučinili, postupujte podle návodu [Začínáme] až do poslední části, kde je nutné implementovat back-end. Také Pokud chcete použít kód z ukázky obálky php REST a přejít přímo k části dokončení kurzu .

Všechny podrobnosti o implementaci úplné obálky REST najdete na webu MSDN. V této části popíšeme implementaci PHP hlavních kroků potřebných pro přístup k Notification Hubs koncovým bodům REST:

  1. Analýza připojovacího řetězce
  2. Generování autorizačního tokenu
  3. Provedení volání HTTP

Analýza připojovacího řetězce

Zde je hlavní třída implementující klienta, jehož konstruktor analyzuje připojovací řetězec:

class NotificationHub {
    const API_VERSION = "?api-version=2013-10";

    private $endpoint;
    private $hubPath;
    private $sasKeyName;
    private $sasKeyValue;

    function __construct($connectionString, $hubPath) {
        $this->hubPath = $hubPath;

        $this->parseConnectionString($connectionString);
    }

    private function parseConnectionString($connectionString) {
        $parts = explode(";", $connectionString);
        if (sizeof($parts) != 3) {
            throw new Exception("Error parsing connection string: " . $connectionString);
        }

        foreach ($parts as $part) {
            if (strpos($part, "Endpoint") === 0) {
                $this->endpoint = "https" . substr($part, 11);
            } else if (strpos($part, "SharedAccessKeyName") === 0) {
                $this->sasKeyName = substr($part, 20);
            } else if (strpos($part, "SharedAccessKey") === 0) {
                $this->sasKeyValue = substr($part, 16);
            }
        }
    }
}

Vytvoření tokenu zabezpečení

Informace o tom, jak vytvořit token zabezpečení SAS, najdete v dokumentaci k Azure.

generateSasTokenPřidejte do třídy metodu NotificationHub pro vytvoření tokenu na základě identifikátoru URI aktuální žádosti a přihlašovacích údajů extrahovaných z připojovacího řetězce.

private function generateSasToken($uri) {
    $targetUri = strtolower(rawurlencode(strtolower($uri)));

    $expires = time();
    $expiresInMins = 60;
    $expires = $expires + $expiresInMins * 60;
    $toSign = $targetUri . "\n" . $expires;

    $signature = rawurlencode(base64_encode(hash_hmac('sha256', $toSign, $this->sasKeyValue, TRUE)));

    $token = "SharedAccessSignature sr=" . $targetUri . "&sig="
                . $signature . "&se=" . $expires . "&skn=" . $this->sasKeyName;

    return $token;
}

Odeslat oznámení

Nejdřív můžeme definovat třídu reprezentující oznámení.

class Notification {
    public $format;
    public $payload;

    # array with keynames for headers
    # Note: Some headers are mandatory: Windows: X-WNS-Type, WindowsPhone: X-NotificationType
    # Note: For Apple you can set Expiry with header: ServiceBusNotification-ApnsExpiry in W3C DTF, YYYY-MM-DDThh:mmTZD (for example, 1997-07-16T19:20+01:00).
    public $headers;

    function __construct($format, $payload) {
        if (!in_array($format, ["template", "apple", "windows", "fcm", "windowsphone"])) {
            throw new Exception('Invalid format: ' . $format);
        }

        $this->format = $format;
        $this->payload = $payload;
    }
}

Tato třída je kontejnerem pro nativní tělo oznámení nebo sadu vlastností pro případ oznámení šablony a sadu hlaviček, která obsahuje formát (nativní platforma nebo šablona) a vlastnosti specifické pro platformu (například vlastnost vypršení platnosti Apple a hlavičky WNS).

Všechny dostupné možnosti najdete v dokumentaci k rozhraním REST API pro Notification Hubs a ve formátech konkrétních platforem oznámení.

V ozbrojení této třídy teď můžeme zapsat metody odeslání oznámení uvnitř NotificationHub třídy:

public function sendNotification($notification, $tagsOrTagExpression="") {
    if (is_array($tagsOrTagExpression)) {
        $tagExpression = implode(" || ", $tagsOrTagExpression);
    } else {
        $tagExpression = $tagsOrTagExpression;
    }

    # build uri
    $uri = $this->endpoint . $this->hubPath . "/messages" . NotificationHub::API_VERSION;
    $ch = curl_init($uri);

    if (in_array($notification->format, ["template", "apple", "fcm"])) {
        $contentType = "application/json";
    } else {
        $contentType = "application/xml";
    }

    $token = $this->generateSasToken($uri);

    $headers = [
        'Authorization: '.$token,
        'Content-Type: '.$contentType,
        'ServiceBusNotification-Format: '.$notification->format
    ];

    if ("" !== $tagExpression) {
        $headers[] = 'ServiceBusNotification-Tags: '.$tagExpression;
    }

    # add headers for other platforms
    if (is_array($notification->headers)) {
        $headers = array_merge($headers, $notification->headers);
    }

    curl_setopt_array($ch, array(
        CURLOPT_POST => TRUE,
        CURLOPT_RETURNTRANSFER => TRUE,
        CURLOPT_SSL_VERIFYPEER => FALSE,
        CURLOPT_HTTPHEADER => $headers,
        CURLOPT_POSTFIELDS => $notification->payload
    ));

    // Send the request
    $response = curl_exec($ch);

    // Check for errors
    if($response === FALSE){
        throw new Exception(curl_error($ch));
    }

    $info = curl_getinfo($ch);

    if ($info['http_code'] <> 201) {
        throw new Exception('Error sending notification: '. $info['http_code'] . ' msg: ' . $response);
    }
} 

Výše uvedené metody odesílají požadavek HTTP POST do /messages koncového bodu centra oznámení se správným textem a hlavičkou pro odeslání oznámení.

Dokončení kurzu

nyní můžete dokončit Začínáme kurzu odesláním oznámení z back-endu PHP.

Inicializujte klienta Notification Hubs (nahraďte připojovací řetězec a název centra podle pokynů v [Úvodní kurz]):

$hub = new NotificationHub("connection string", "hubname");

Pak přidejte kód pro odeslání v závislosti na cílové mobilní platformě.

Windows Store a Windows Phone 8,1 (ne Silverlight)

$toast = '<toast><visual><binding template="ToastText01"><text id="1">Hello from PHP!</text></binding></visual></toast>';
$notification = new Notification("windows", $toast);
$notification->headers[] = 'X-WNS-Type: wns/toast';
$hub->sendNotification($notification, null);

iOS

$alert = '{"aps":{"alert":"Hello from PHP!"}}';
$notification = new Notification("apple", $alert);
$hub->sendNotification($notification, null);

Android

$message = '{"data":{"msg":"Hello from PHP!"}}';
$notification = new Notification("fcm", $message);
$hub->sendNotification($notification, null);

Windows Phone 8,0 a 8,1 Silverlight

$toast = '<?xml version="1.0" encoding="utf-8"?>' .
            '<wp:Notification xmlns:wp="WPNotification">' .
               '<wp:Toast>' .
                    '<wp:Text1>Hello from PHP!</wp:Text1>' .
               '</wp:Toast> ' .
            '</wp:Notification>';
$notification = new Notification("windowsphone", $toast);
$notification->headers[] = 'X-WindowsPhone-Target : toast';
$notification->headers[] = 'X-NotificationClass : 2';
$hub->sendNotification($notification, null);

Kindle požár

$message = '{"data":{"msg":"Hello from PHP!"}}';
$notification = new Notification("adm", $message);
$hub->sendNotification($notification, null);

Spuštění kódu PHP by mělo nyní na cílovém zařízení zobrazovat oznámení.

Další kroky

V tomto tématu jsme ukázali, jak vytvořit jednoduchého klienta PHP REST pro Notification Hubs. Odsud můžete:

  • Stáhněte si úplnou ukázku obálky php REST, která obsahuje veškerý kód uvedený výše.
  • Pokračovat v učení o funkci označování Notification Hubs v [kurzu pro průlomové zprávy]
  • Přečtěte si o doručování oznámení jednotlivým uživatelům v [kurz pro oznamování uživatelů]

Další informace najdete v tématu také středisko pro vývojáře PHP.

Posílání nabízených oznámení do aplikací pro iOS pomocí Azure Notification Hubs