레디스
시작하기
레디스 는 키-밸류 기반의 오픈소스 저장소 입니다. 레디스는 키에 문자열, 해쉬, 리스트, 세트, 그리고 정렬 세트를 사용할 수 있기 때문에 데이터 구조 서버로 자주 거론되고 있습니다.
라라벨에서 Redis를 사용하기 전에, PECL를 통하여 PhpRedis PHP extension를 설치하고 사용하는 것을 권장합니다. 이 PHP 확장(PHP Extension)은 설치가 좀 더 복잡하지만 Redis를 많이 사용하는 어플리케이션에 보다 나은 성능을 보여줍니다. 이미 Laravel Sail 을 이용하여 환경을 구성하였다면 도커 컨테이너 내에 이미 package가 설치되어 있습니다.
phpredis 확장을 설치할 수 없는 경우 Composer를 통해 predis/predis 패키지를 설치할 수 있습니다. predis는 PHP 로만 작성된 extension 이므로 추가적으로 다른 패키지가 요구 되지 않습니다.
composer require predis/predis설정하기
애플리케이션의 Redis 설정을 config/database.php 설정 파일을 통해서 설정할 수 있습니다. 이 파일 내부의 redis 배열이 애플리케이션에서 사용할 레디스 서버의 설정 정보를 담고 있습니다.
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'default' => [
'host' => env('REDIS_HOST', '127.0.0.1'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => env('REDIS_DB', 0),
],
'cache' => [
'host' => env('REDIS_HOST', '127.0.0.1'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => env('REDIS_CACHE_DB', 1),
],
],구성 파일에 정의 될때 각 Redis 서버의 설정은 name, host 및 port를 가져야 합니다. 만약 Redis 연결을 하나의 url로 연결 설정을 구성할땐 아래와 같이 설정합니다.
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'default' => [
'url' => 'tcp://127.0.0.1:6379?database=0',
],
'cache' => [
'url' => 'tls://user:[email protected]:6380?database=1',
],
],연결 스키마 설정
기본적으로 Redis 클라이언트는 Reids 서버에 연결할 때 tcp 체계를 사용합니다. 그러나 Redis 서버 설정 배열에서 scheme 구성 옵션을 지정하여 TLS / SSL 암호화를 사용할 수 있습니다.
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'default' => [
'scheme' => 'tls',
'host' => env('REDIS_HOST', '127.0.0.1'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => env('REDIS_DB', 0),
],
],클러스터 설정하기
애플리케이션이 Redis 서버 클러스터를 사용한다면, Redis 설정의 clusters 키 안에 클러스터를 정의해야 합니다. 이 설정은 기본적으로 작성되어 있지 않아, 어플리케이션의 config/database.php 에 따로 작성해주어야 합니다.
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'clusters' => [
'default' => [
[
'host' => env('REDIS_HOST', 'localhost'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => 0,
],
],
],
],기본적으로, 클러스터는 클라이언트-사이드 샤딩(분산 저장)을 수행하므로, 노드를 풀링하고 RAM을 가능한 많이 사용할 수 있도록 만듭니다. 하지만 클라이언트-사이드 샤딩은 페일 오버(Fail over)를 처리하지 않습니다. 따라서 다른 기본 데이터 저장소에서 사용할 수 있는 임시 캐시 데이터에 주로 적합합니다.
네이티브 Redis 클러스터링을 사용하려면, config/database.php의 redis 설정 안 options.cluster 키에 다음의 설정을 지정해야합니다.
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'options' => [
'cluster' => env('REDIS_CLUSTER', 'redis'),
],
'clusters' => [
// ...
],
],Predis
Predis 확장(extension)을 사용하려면 REDIS_CLIENT 환경 변수를 phpredis 에서 predis로 수정해야 합니다.
'redis' => [
'client' => env('REDIS_CLIENT', 'predis'),
// Rest of Redis configuration...
],host, port, database, 그리고 password 기본 서버 설정에 추가적으로, Predis 는 각각의 Redis 서버에 대해 정의할 수 있는 추가적인 커넥션 파라미터를 지원합니다. 이 추가적인 설정 옵션을 구성하려면, config/database.php 설정 파일에 해당 설정 옵션들을 Redis 서버 설정 부분에 추가하기만 하면 됩니다.
'default' => [
'host' => env('REDIS_HOST', 'localhost'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => 0,
'read_write_timeout' => 60,
],Redis Facade 별칭
Laravel의 config/app.php 구성 파일에는 프레임워크에 등록될 모든 클래스 별칭을 정의하는 aliases 배열이 포함되어 있습니다. 편의를 위해 Laravel에서 제공하는 facade마다 별칭 항목이 포함되어 있지만, Redis 별칭은 phpredis 확장자가 제공하는 Redis 클래스 이름과 충돌하므로 기본으로 포함되어 있지 않습니다. Predis 클라이언트를 사용하는 경우 이 별칭을 활성화하려면 응용 프로그램의 config/app.php 구성 파일에 별칭을 추가해주면 됩니다.
'aliases' => Facade::defaultAliases()->merge([
'Redis' => Illuminate\Support\Facades\Redis::class,
])->toArray(),PhpRedis
기본적으로 Laravel은 Redis와 통신하기 위해 phpredis 확장을 사용합니다. Laravel이 Redis와 통신하는 데 사용할 클라이언트는 일반적으로 REDIS_CLIENT 환경 변수의 값을 반영하는 redis.client 구성 옵션의 값에 의해 결정됩니다.
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
// Rest of Redis configuration...
],scheme, host, port, database, password 기본 서버 설정에 더하여, PhpRedis 는 다음의 추가적인 커넥션 파라미터를 지원합니다. name, persistent, prefix, read_timeout, timeout, context. config/database.php 설정 파일의 Redis 서버 설정에 이 옵션들을 추가할 수 있습니다.
'default' => [
'host' => env('REDIS_HOST', 'localhost'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => 0,
'read_timeout' => 60,
'context' => [
// 'auth' => ['username', 'secret'],
// 'stream' => ['verify_peer' => false],
],
],phpredis 직렬화 & 압축
phpredis extension 은 다양한 직렬화-serialization 및 압축 알고리즘을 사용하도록 설정할 수 있습니다. Redis 설정 파일에서 options 배열값을 알고리즘을 지정할 수 있습니다.
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'options' => [
'serializer' => Redis::SERIALIZER_MSGPACK,
'compression' => Redis::COMPRESSION_LZ4,
],
// Rest of Redis configuration...
],현재 지원되는 직렬화 알고리즘은 Redis::SERIALIZER_NONE(기본값), Redis::SERIALIZER_PHP, Redis::SERIALIZER_JSON, Redis::SERIALIZER_IGBINARY, Redis::SERIALIZER_MSGPACK입니다.
지원되는 압축 알고리즘은 Redis::COMPRESSION_NONE(기본값), Redis::COMPRESSION_LZF, Redis::COMPRESSION_ZSTD, Redis::COMPRESSION_LZ4입니다.
Redis와 상호작용하기
Redis 파사드를 통해서 다양한 메소드를 호출하여 Redis와 상호작용할 수 있습니다. Redis 파사드는 동적인 메소드를 지원하며, 이는 파사드에 Redis 명령어를 호출하면 Redis 에 직접 명령어가 전달된다는 것을 의미합니다. 예를 들어 Redis 파사드에 get 메소드를 호출하여 레디스 GET 명령어를 호출할 수 있습니다.
<?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 \Illuminate\Http\Response
*/
public function show($id)
{
return view('user.profile', [
'user' => Redis::get('user:profile:'.$id)
]);
}
}앞서 말한바와 같이 Redis 파사드에서 어떤 Redis 명령어라도 호출 할 수 있습니다. 라라벨은 매직 메소드를 사용하여 명령어를 Redis 서버에 전달합니다. Redis 명령어가 요구하는 인자를 각 명령어의 방법으로 전달해야 합니다.
Redis::set('name', 'Taylor');
$values = Redis::lrange('names', 5, 10);이렇게 하는 대신에, command 메소드의 첫번째 인자를 명령어의 이름으로 하고, 두번째 인자를 전달하는 값의 배열로 하여 명령어를 서버에 전달 할 수도 있습니다.
$values = Redis::command('lrange', ['name', 5, 10]);여러개의 Redis 커넥션 사용하기
config/database.php 설정 파일에 여러개의 Redis 연결(서버)를 설정 할 수 있습니다. Redis 파사드의 connection 메소드로 설정한 특정 레디스 인스턴스를 가져올 수 있습니다.
$redis = Redis::connection('connection-name');기본 레디스 연결 인스턴스를 가져오려면 connection 메소드에 추가 인자 없이 전달하면 됩니다.
$redis = Redis::connection();트랜잭션
Redis의 네이티브 MULTY 와 EXEC 명령어를 Redis 파사드의 transaction 메소드로 편리하게 제공한다. transaction 메소드는 closure 로 작성된 인자여야 합니다. closure 내에서 원하는 Redis 명령을 실행할수 있습니다. closure 내의 트랜잭션은 원자적으로 실행됩니다.
use Illuminate\Support\Facades\Redis;
Redis::transaction(function ($redis) {
$redis->incr('user_visits', 1);
$redis->incr('total_visits', 1);
});Warning 레디스 트랜젝션이 정의 되는 동안 Redis 에서 해당 값을 찾을수 없습니다. 모든 트랜잭션은 원자성이 보장되며 모든 클로저가 실행 될때까지 모든 명령은 실행되지 않음을 기억하세요.
Lua Scripts
eval 메소드는 여러 Redis 명령을 하나의 원자 연산으로 실행할 수 있는 또 다른 방법입니다. eval 메소드는 Redis 키 값과 상호 작용하고 검사할 수 있다는 장점이 있습니다. 레디스 스크립트는 Lua programming language로 작성됩니다.
처음에는 eval 메소드가 무서울 수 있으나, 해당 메소드가 조금 익숙해지기 위해 기본적인 예를 살펴보도록 하겠습니다. eval 메서드에는 여러 개의 인수가 필요합니다. 먼저 Lua 스크립트(문자열 처럼)를 메소드에 전달해야 합니다. 둘째, 스크립트가 상호 작용하는 키(정수형 인자 처럼)를 전달해야 합니다. 세 번째, 키의 이름을 넘겨야 합니다. 마지막으로 스크립트 내에서 액세스해야 하는 다른 추가 인수를 전달할 수 있습니다.
아래의 예제에서는 카운터를 증가시키고, 첫 번째 카운터의 값이 5보다 크면 두 번째 카운터를 증가시킵니다. 마지막으로 첫 번째 카운터의 값을 반환합니다.
$value = Redis::eval(<<<'LUA'
local counter = redis.call("incr", KEYS[1])
if counter > 5 then
redis.call("incr", KEYS[2])
end
return counter
LUA, 2, 'first-counter', 'second-counter');Warning 레디스 스크립팅에 자세한 내용은 Redis documentation 에서 확인하세요.
파이프라이닝 명령어
다수의 레디스 명령을 실행시켜야 할때 네트워크 연결을 줄이기 위해 pipeline 메소드를 활용할 수 있습니다. pipeline 메소드는 레디스 인스턴스를 받는 클로저 인자를 받습니다. Redis 인스턴스에 작성된 명령은 네트워크 연결을 줄이기 위해 한번에 레디스 서버에 전달됩니다. 명령은 작성한 순서대로 실행됩니다.
use Illuminate\Support\Facades\Redis;
Redis::pipeline(function ($pipe) {
for ($i = 0; $i < 1000; $i++) {
$pipe->set("key:$i", $i);
}
});Pub / Sub
라라벨은 Redis 의 publish 와 subscribe 명령에 대한 편리한 인터페이스를 제공합니니다. 이러한 Redis 명령들은 주어진 "채널"에서 메시지를 수신 할 수 있도록 해줍니다. 다른 애플리케이션에서 채널에 메세지를 전달하거나, 설령 다른 프로그래밍 언어를 사용하더라도 애플리케이션과 프로세스간의 통신을 쉽게 할 수 있습니다.
먼저 subscribe 메소드를 사용하여 채널에 리스너를 설정해 보겠습니다. subscribe 메소드는 긴 시간동안 실행되는 프로세스로 동작하기 때문에 이 메소드는 아티즌 명령어에서 호출하겠습니다.
<?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;
});
}
}이제 publish 메소드를 사용하여 채널에 메세지를 표시할 수 있습니다.
use Illuminate\Support\Facades\Redis;
Route::get('/publish', function () {
// ...
Redis::publish('test-channel', json_encode([
'name' => 'Adam Wathan'
]));
});와일드 카드 Subscriptions
psubscribe 메소드를 사용하여, 전체 채널에서 모든 메세지를 수신하는데 유용한 와일드 카드 채널을 subscribe 할 수 있습니다. $channel의 이름은 콜백 Closure 의 두번째 인자로 전달 될 것입니다.
Redis::psubscribe(['*'], function ($message, $channel) {
echo $message;
});
Redis::psubscribe(['users.*'], function ($message, $channel) {
echo $message;
});
