Jak używać usługi Notification Hubs w języku PHP
Dostęp do wszystkich funkcji usługi Notification Hubs można uzyskać z poziomu zaplecza Java/PHP/Ruby przy użyciu interfejsu REST centrum powiadomień zgodnie z opisem w temacie NOTIFICATION Hubs REST APIs w witrynie MSDN.
W tym temacie pokazano, jak:
- Tworzenie klienta REST dla funkcji usługi Notification Hubs w języku PHP;
- Postępuj zgodnie z instrukcjami wysyłanie powiadomień wypychanych do aplikacji systemu iOS przy użyciu usługi Azure Notification Hubs dla wybranej platformy mobilnej, wdrażając część zaplecza w języku PHP.
Interfejs klienta
Główny interfejs klienta może udostępniać te same metody, które są dostępne w zestawie SDK usługi .NET Notification Hubs, co umożliwia bezpośrednie tłumaczenie wszystkich samouczków i przykładów dostępnych obecnie w tej witrynie oraz współautorów przez społeczność w Internecie.
Cały kod dostępny w przykładzie otoki REST języka PHP można znaleźć.
Aby na przykład utworzyć klienta:
$hub = new NotificationHub("connection string", "hubname");
Aby wysłać powiadomienie natywne dla systemu iOS:
$notification = new Notification("apple", '{"aps":{"alert": "Hello!"}}');
$hub->sendNotification($notification, null);
Implementacja
Jeśli jeszcze tego nie zrobiono, postępuj zgodnie z instrukcjami [Samouczek rozpoczynania pracy] do ostatniej sekcji, w której musisz zaimplementować zaplecze. Ponadto jeśli chcesz użyć kodu z przykładu otoki REST języka PHP i przejść bezpośrednio do sekcji Ukończ samouczek .
Wszystkie szczegóły dotyczące implementowania pełnej otoki REST można znaleźć w witrynie MSDN. W tej sekcji opisano implementację języka PHP głównych kroków wymaganych do uzyskania dostępu do punktów końcowych REST usługi Notification Hubs:
- Analizowanie parametrów połączenia
- Generowanie tokenu autoryzacji
- Wykonywanie wywołania HTTP
Analizowanie parametrów połączenia
Oto główna klasa implementujący klienta, którego konstruktor analizuje parametry połączenia:
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);
}
}
}
}
Tworzenie tokenu zabezpieczającego
Zapoznaj się z dokumentacją platformy Azure, aby uzyskać informacje na temat tworzenia tokenu zabezpieczającego SAS.
Dodaj metodę generateSasToken do NotificationHub klasy, aby utworzyć token na podstawie identyfikatora URI bieżącego żądania i poświadczeń wyodrębnionych z parametrów połączenia.
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;
}
Wysyłanie powiadomienia
Najpierw zdefiniujmy klasę reprezentującą powiadomienie.
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;
}
}
Ta klasa jest kontenerem dla natywnej treści powiadomień lub zestawem właściwości w przypadku powiadomienia szablonu oraz zestawem nagłówków, które zawierają format (natywna platforma lub szablon) i właściwości specyficzne dla platformy (takie jak właściwość wygasania firmy Apple i nagłówki usługi WNS).
Zapoznaj się z dokumentacją interfejsów API REST usługi Notification Hubs i formatami określonych platform powiadomień, aby zapoznać się ze wszystkimi dostępnymi opcjami.
Uzbrojony w tę klasę możemy teraz napisać metody wysyłania powiadomień wewnątrz NotificationHub klasy :
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);
}
}
Powyższe metody wysyłają żądanie HTTP POST do /messages punktu końcowego centrum powiadomień z prawidłową treścią i nagłówkami w celu wysłania powiadomienia.
Ukończ samouczek
Teraz możesz ukończyć samouczek Wprowadzenie, wysyłając powiadomienie z zaplecza PHP.
Zainicjuj klienta usługi Notification Hubs (zastąp parametry połączenia i nazwę centrum zgodnie z instrukcjami w samouczku [Wprowadzenie]):
$hub = new NotificationHub("connection string", "hubname");
Następnie dodaj kod wysyłania w zależności od docelowej platformy mobilnej.
Sklep Windows i Windows Phone 8.1 (inne niż 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 i 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);
Uruchomienie kodu PHP powinno spowodować wyświetlenie teraz powiadomienia na urządzeniu docelowym.
Następne kroki
W tym temacie pokazano, jak utworzyć prostego klienta REST JĘZYKA PHP dla usługi Notification Hubs. W tym miejscu można wykonać następujące czynności:
- Pobierz pełny przykład otoki REST języka PHP, który zawiera cały powyższy kod.
- Kontynuuj naukę na temat funkcji tagowania w usłudze Notification Hubs w samouczku [Breaking News]
- Dowiedz się więcej o wypychaniu powiadomień do poszczególnych użytkowników w artykule [Samouczek powiadamiania użytkowników]
Aby uzyskać więcej informacji, zobacz również Centrum deweloperów JĘZYKA PHP.