A Notification Hubs használata PHP-ből

Cikk
06/01/2023

A Notification Hubs összes funkcióját elérheti egy Java/PHP/Ruby-háttérrendszerből a Notification Hub REST felületének használatával, az MSDN Notification Hubs REST API-k című témakörében leírtak szerint.

Ebben a témakörben a következőket mutatjuk be:

REST-ügyfél létrehozása a Notification Hubs funkcióihoz a PHP-ben;
Kövesse a Leküldéses értesítések küldése iOS-alkalmazásokba az Azure Notification Hubs használatával a választott mobilplatformhoz című témakört, és implementálja a háttérrendszer részét a PHP-ben.

Ügyféloldali felület

A fő ügyféloldali felület ugyanazokat a módszereket biztosítja, mint amelyek a .NET Notification Hubs SDK-ban is elérhetők, így közvetlenül lefordíthatja az ezen a webhelyen jelenleg elérhető összes oktatóanyagot és mintát, amelyeket a közösség az interneten is közzétett.

A PHP REST burkolómintában elérhető összes kód megtalálható.

Ügyfél létrehozása például:

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

Natív iOS-értesítés küldése:

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

Implementálás

Ha még nem tette meg, kövesse az [Első lépések oktatóanyag] részt az utolsó szakaszig, ahol implementálnia kell a háttérrendszert. Ha azt is szeretné, hogy a PHP REST burkolómintából származó kódot használja, lépjen közvetlenül az Oktatóanyag befejezése szakaszra.

A teljes REST-burkoló implementálásának minden részlete megtalálható az MSDN-ben. Ebben a szakaszban a Notification Hubs REST-végpontjainak eléréséhez szükséges fő lépések PHP-implementációját ismertetjük:

Kapcsolati sztring elemzése
Az engedélyezési jogkivonat létrehozása
HTTP-hívás végrehajtása

Kapcsolati sztring elemzése

Íme az ügyfelet megvalósító fő osztály, amelynek konstruktora elemzi a kapcsolati sztring:

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);
            }
        }
    }
}

Biztonsági jogkivonat létrehozása

Az SAS biztonsági jogkivonatok létrehozásával kapcsolatos információkért tekintse meg az Azure dokumentációját.

Adja hozzá a generateSasToken metódust a NotificationHub osztályhoz a jogkivonat létrehozásához az aktuális kérés URI-ja és a kapcsolati sztring kinyert hitelesítő adatai alapján.

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;
}

Értesítés küldése

Először határozzunk meg egy értesítésnek megfelelő osztályt.

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;
    }
}

Ez az osztály egy natív értesítési törzs tárolója, vagy egy sablonértesítés esetében a tulajdonságok készlete, valamint egy fejléckészlet, amely formátumot (natív platformot vagy sablont) és platformspecifikus tulajdonságokat (például Apple lejárati tulajdonságot és WNS-fejléceket) tartalmaz.

Az összes elérhető beállításhoz tekintse meg a Notification Hubs REST API-k dokumentációját és az egyes értesítési platformok formátumait.

Ezzel az osztálysal felvértezve most már megírhatjuk a küldési értesítési metódusokat az NotificationHub osztályon belül:

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);
    }
}

A fenti metódusok http POST kérést küldenek az /messages értesítési központ végpontjára, a megfelelő törzstel és fejlécekkel az értesítés elküldéséhez.

Az oktatóanyag befejezése

Most már elvégezheti az Első lépések oktatóanyagot úgy, hogy elküldi az értesítést egy PHP-háttérrendszerből.

Inicializálja a Notification Hubs-ügyfelet (helyettesítse be a kapcsolati sztring és a központ nevét az [Első lépések oktatóanyag] utasításai szerint):

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

Ezután adja hozzá a küldési kódot a cél mobilplatformtól függően.

Windows Áruház és Windows Phone-telefon 8.1 (nem 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-telefon 8.0 és 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 Fire

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

A PHP-kód futtatásával mostantól megjelenik egy értesítés a céleszközön.

Következő lépések

Ebben a témakörben bemutattuk, hogyan hozhat létre egyszerű PHP REST-ügyfelet a Notification Hubshoz. Ebből a menüből:

Töltse le a teljes PHP REST burkolómintát, amely tartalmazza a fenti kódot.
Folytassa a Notification Hubs címkézési funkciójának megismerését a [Breaking News oktatóanyagban]
További információ az értesítések egyes felhasználóknak való leküldéséről a [Felhasználók értesítése oktatóanyag] című oktatóanyagban

További információkért lásd még a PHP Fejlesztői központot.

Leküldéses értesítések küldése iOS-alkalmazásokba az Azure Notification Hubs használatával

Share via