Projects [SHOW]

6. Redis

Einführung

Redis ist ein quelloffener, fortschrittlicher Key-Value-Store. Er wird oft als Datenstruktur-Server bezeichnet, da Schlüssel strings, hashes, lists, sets und sorted sets enthalten können.

Bevor Sie Redis mit Laravel verwenden können, müssen Sie das Paket predis/prepredis über den Composer installieren:

composer require predis/predis

Alternativ können Sie die PHP-Erweiterung PhpRedis über PECL installieren. Die Erweiterung ist aufwendiger zu installieren, kann aber bei Anwendungen, die Redis stark beanspruchen, eine bessere Performance erzielen.

Configuration

Die Redis-Konfiguration für Ihre Anwendung finden Sie in der Konfigurationsdatei config/database.php. Innerhalb dieser Datei sehen Sie ein redis-Array mit den von Ihrer Anwendung verwendeten Redis-Servern:

'redis' => [

    'client' => 'predis',

    'default' => [
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'password' => env('REDIS_PASSWORD', null),
        'port' => env('REDIS_PORT', 6379),
        'database' => env('REDIS_DB', 0),
    ],

    'cache' => [
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'password' => env('REDIS_PASSWORD', null),
        'port' => env('REDIS_PORT', 6379),
        'database' => env('REDIS_CACHE_DB', 1),
    ],

],

Die Standard-Serverkonfiguration sollte für die Entwicklung ausreichen. Es steht Ihnen jedoch frei dieses Array basierend auf Ihrer Umgebung zu modifizieren. Jeder Redis Server, der in Ihrer Konfigurationsdatei definiert ist, muss einen Namen, einen Host und einen Port haben.

Configuring Clusters

Wenn Ihre Anwendung einen Cluster von Redis Servern nutzt, sollten Sie diese Cluster innerhalb eines clusters-Keys Ihrer Redis Konfiguration definieren:

'redis' => [

    'client' => 'predis',

    'clusters' => [
        'default' => [
            [
                'host' => env('REDIS_HOST', 'localhost'),
                'password' => env('REDIS_PASSWORD', null),
                'port' => env('REDIS_PORT', 6379),
                'database' => 0,
            ],
        ],
    ],

],

Standardmäßig führen Cluster ein clientseitiges Sharing über Ihre Knoten durch, wodurch Sie Knoten zusammenlegen und eine große Menge an verfügbarem RAM erzeugen können. Beachten Sie jedoch, dass das clientseitige Sharding kein Failover beherrscht und daher in erster Linie für zwischengespeicherte Daten geeignet ist, die von einem anderen primären Datenspeicher verfügbar sind. Wenn Sie natives Redis-Clustering verwenden möchten, sollten Sie dies im options-Key Ihrer Redis-Konfiguration angeben:

'redis' => [

    'client' => 'predis',

    'options' => [
        'cluster' => 'redis',
    ],

    'clusters' => [
        // ...
    ],

],

Predis

Zusätzlich zu den standardmäßigen host-, port-, database- und password-Server-Konfigurationsoptionen unterstützt Predis zusätzliche Verbindungsparameter, die für jeden Ihrer Redis-Server definiert werden können. Um diese zusätzlichen Konfigurationsoptionen zu nutzen, fügen Sie diese in der Konfigurationsdatei config/database.php zu Ihrer Redis Server Konfiguration hinzu:

'default' => [
    'host' => env('REDIS_HOST', 'localhost'),
    'password' => env('REDIS_PASSWORD', null),
    'port' => env('REDIS_PORT', 6379),
    'database' => 0,
    'read_write_timeout' => 60,
],

PhpRedis

Um die PhpRedis-Erweiterung zu nutzen, sollten Sie die client-Option Ihrer Redis-Konfiguration auf phpredis ändern. Diese Option finden Sie in Ihrer Konfigurationsdatei config/database.php:

'redis' => [

    'client' => 'predis',

    // Rest of Redis configuration...
],

Zusätzlich zu den Standard-Konfigurationsoptionen für host-, port-, database- und password-Server unterstützt PhpRedis die folgenden zusätzlichen Verbindungsparameter: persistent, prefix, read_timeout und timeout. Sie können jede dieser Optionen in der Konfigurationsdatei config/database.php zu Ihrer Redis Server Konfiguration hinzufügen:

'default' => [
    'host' => env('REDIS_HOST', 'localhost'),
    'password' => env('REDIS_PASSWORD', null),
    'port' => env('REDIS_PORT', 6379),
    'database' => 0,
    'read_timeout' => 60,
],

more themes about Database - Click for open

Interacting With Redis

Sie können mit Redis interagieren, indem Sie verschiedene Methoden auf der Redis-Fassade aufrufen. Die Redis-Fassade unterstützt dynamische Methoden, d.h. Sie können jeden beliebigen Redis-Befehl auf der Fassade aufrufen und der Befehl wird direkt an Redis übergeben. In diesem Beispiel wird der Redis GET-Befehl durch den Aufruf der get-Methode auf der Redis-Fassade aufgerufen:

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Redis;

class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     *
     * @param  int  $id
     * @return Response
     */
    public function showProfile($id)
    {
        $user = Redis::get('user:profile:'.$id);

        return view('user.profile', ['user' => $user]);
    }
}

Wie oben erwähnt, können Sie jeden der Redis-Befehle auf der Redis-Fassade aufrufen. Laravel verwendet magische Methoden, um die Befehle an den Redis-Server zu übergeben, also übergibt er die Argumente, die der Redis-Befehl erwartet:

Redis::set('name', 'Taylor');

$values = Redis::lrange('names', 5, 10);

Alternativ können Sie Befehle auch mit der command-Methode an den Server übergeben, die den Namen des Befehls als erstes Argument und ein Array mit Werten als zweites Argument akzeptiert:

$values = Redis::command('lrange', ['names', 5, 10]);

Using Multiple Redis Connections

Sie können eine Redis-Instanz erhalten, indem Sie die Redis::connection-Methode aufrufen:

$redis = Redis::connection();

Damit erhalten Sie eine Instanz des Standard-Redis-Servers. Sie können auch den Verbindungs- oder Clusternamen an die connection-Methode übergeben, um einen bestimmten Server oder Cluster, wie in Ihrer Redis-Konfiguration definiert, zu erhalten:

$redis = Redis::connection('my-connection');

Pipelining Commands

Pipelining sollte verwendet werden, wenn Sie viele Befehle in einem Arbeitsgang an den Server senden müssen. Die pipeline-Methode akzeptiert ein Argument: einen Closure, der eine Redis-Instanz empfängt. Sie können alle Ihre Befehle an diese Redis-Instanz senden und sie werden alle in einer einzigen Operation ausgeführt:

Redis::pipeline(function ($pipe) {
    for ($i = 0; $i < 1000; $i++) {
        $pipe->set("key:$i", $i);
    }
});

Pub / Sub

Laravel bietet eine komfortable Schnittstelle zu den Redis Publish und Subscribe Befehlen. Diese Redis-Kommandos erlauben es Ihnen, auf einem bestimmten "Kanal" nach Nachrichten zu lauschen. Sie können Nachrichten an den Kanal von einer anderen Anwendung oder sogar mit einer anderen Programmiersprache veröffentlichen, was eine einfache Kommunikation zwischen Anwendungen und Prozessen ermöglicht.

Zuerst richten wir einen Kanal-Listener mit der subscribe-Methode ein. Wir werden diesen Methodenaufruf innerhalb eines Artisan-Befehls platzieren, da der Aufruf der subscribe-Methode einen langwierigen Prozess beginnt:

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Redis;

class RedisSubscribe extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'redis:subscribe';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Subscribe to a Redis channel';

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        Redis::subscribe(['test-channel'], function ($message) {
            echo $message;
        });
    }
}

Jetzt können wir Nachrichten an den Kanal mit der publish-Methode veröffentlichen:

Route::get('publish', function () {
    // Route logic...

    Redis::publish('test-channel', json_encode(['foo' => 'bar']));
});

Wildcard Subscriptions

Mit der psubscribe-Methode können Sie einen Platzhalter-Kanal abonnieren, was nützlich sein kann, um alle Nachrichten auf allen Kanälen abzufangen. Der Name des $channels wird als zweites Argument an den bereitgestellten Callback Closure übergeben:

Redis::psubscribe(['*'], function ($message, $channel) {
    echo $message;
});

Redis::psubscribe(['users.*'], function ($message, $channel) {
    echo $message;
});

Projects [SHOW]

Laravel 5.8 Dokumentation

Home

Architecture Concepts

Basics

Frontend

Security

Digging Deeper

Database

Eloquent ORM

Official Packages

Testing

Sonstiges