라라벨 프레임워크 - 엘라스틱서치 사용 경험기 : 문서 관리 작업

저번 포스팅에서는 라라벨 프레임워크 - 엘라스틱서치 사용 경험기 1편을 통해 엘라스틱서치를 사용하는 데 필요한 초기 작업에 대해 알아봤다. 주로 라라벨 프레임워크와 엘라스틱서치의 연동 그리고 기존의 데이터를 엘라스틱서치의 문서로 색인하는 작업을 진행했는데 오늘은 1편에 이어서 엘라스틱서치를 사용하면서 필요한 문서 관리 작업 수행에 대한 포스팅을 작성하고자 한다. 목차는 다음과 같다.

목차

• 라라벨 프레임워크 - 엘라스틱서치 사용 경험기 : 초기 작업 수행
• 라라벨 프레임워크 - 엘라스틱서치 사용 경험기 : 문서 관리 작업 수행(현재)

문서 관리에 포함된 작업은 주로 다음과 같다.

문서 관리

데이터베이스에 새로운 데이터가 삽입, 수정, 삭제되면 엘라스틱서치의 문서도 색인, 수정, 삭제가 이루어져야 한다. 나는 라라벨 프레임워크의 옵저버를 활용해서 정의한 모델의 이벤트가 발생하면 작업을 수행하도록 정의했다.

옵저버 생성

문서 색인, 문서 수정, 문서 삭제를 수행하기 전 옵저버를 생성한다. 다음 명령어를 통해 옵저버를 생성할 수 있다.

1
$ php artisan make:observer BoardObserver --model=Board

아티즌 명령어를 통해서 옵저버를 생성했다면 App\Observers의 경로에 BoardObserver 파일이 생성되고 기본적인 코드도 생성해준다. 만약에 해당 경로가 존재하지 않는다면 아티즌은 해당 경로를 생성한다. 나는 공식 문서의 명령어를 뒤늦게 발견하는 바람에 수동 생성을 했다. 하지만 자동 생성 해주는 코드와 차이는 없다.

그리고 모델을 관찰하기 위해서 옵저버를 등록한다. Service provider의 boot method를 통해서 옵저버를 등록할 수 있다. 나는 아래와 같이 AppServiceProvider.php에 작성했다. 이 작업으로 인해서 BoardObserver는 Board 모델을 관찰한다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
your_project/app/Providers/AppServiceProvider.php
<?php
namespace App\Providers;
use App\Board;
use App\Http\Observer\BoardObserver;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        Board::observe(BoardObserver::class);
    }
    /**
     * Register any application services.
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

엘라스틱서치 설정 주입

다음은 문서 색인, 수정, 삭제를 하기 전에 라라벨 프레임워크와 엘라스틱서치 연결을 위한 설정을 주입해준다. 코드는 다음과 같다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?php
.
.
.
    protected $elasticsearchConfig;
    /**
     * BoardObserver constructor.
     * @param ElasticsearchConfig $elasticsearchConfig
     */
    public function __construct(ElasticsearchConfig $elasticsearchConfig)
    {
        $this->elasticsearchConfig = $elasticsearchConfig;
    }
.
.
.

다음은 문서 색인, 수정이다. 데이터가 삽입, 수정되면 수행할 코드를 작성한다.

문서 색인, 수정

옵저버를 통해서 Board 모델에 데이터가 삽입되면 관찰하고 있던 옵저버가 created 기능을 수행한다. 또한 Board 모델에 데이터가 수정되면 관찰하고 있던 옵저버가 updated 기능을 수행한다. 나는 Elasticsearch-php의 index api를 사용했다. index api는 형식화 된 JSON 문서를 특정 인덱스에 추가하거나 업데이트하여 검색 가능하게 한다. 코드는 다음과 같다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
    public function created(Board $board)
    {
        $params = [
            'index' => 'board',
            'type' => 'v1',
            'id' => $board['id'],
            'body' => $board
        ];
        return $this->elasticsearchConfig->getClient()->index($params);
    }
    public function updated(Board $board)
    {
        $params = [
            'index' => 'board',
            'type' => 'v1',
            'id' => $board['id'],
            'body' => $board
        ];
        return $this->elasticsearchConfig->getClient()->index($params);
    }

다음은 문서 삭제이다.

문서 삭제

옵저버를 통해서 Board 모델에 데이터가 삭제되면 관찰하고 있던 옵저버가 deleted 기능을 수행한다. 나는 Elasticsearch-php의 delete api를 사용했다. delete api는 당연한 것이지만 index api와 달리 id만 있으면 바로 삭제가 가능하다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
    public function deleted(Board $board)
    {
        $params = [
            'index' => 'board',
            'type' => 'v1',
            'id' => $board['id']
        ];
        if($this->elasticsearchConfig->getClient()->exists($params))
        {
            return $this->elasticsearchConfig->getClient()->delete($params);
        }else{
            return false;
        }
    }

전체 코드

완성된 BoardObserver.php의 전체 코드는 다음과 같다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<?php
namespace App\Http\Observer;
use App\Board;
use ElasticsearchConfig;
class BoardObserver
{
    protected $elasticsearchConfig;
    /**
     * BoardObserver constructor.
     * @param ElasticsearchConfig $elasticsearchConfig
     */
    public function __construct(ElasticsearchConfig $elasticsearchConfig)
    {
        $this->elasticsearchConfig = $elasticsearchConfig;
    }
    public function created(Board $board)
    {
        $params = [
            'index' => 'board',
            'type' => 'v1',
            'id' => $board['id'],
            'body' => $board
        ];
        return $this->elasticsearchConfig->getClient()->index($params);
    }
    public function updated(Board $board)
    {
        $params = [
            'index' => 'board',
            'type' => 'v1',
            'id' => $board['id'],
            'body' => $board
        ];
        return $this->elasticsearchConfig->getClient()->index($params);
    }
    public function deleted(Board $board)
    {
        $params = [
            'index' => 'board',
            'type' => 'v1',
            'id' => $board['id']
        ];
        if($this->elasticsearchConfig->getClient()->exists($params))
        {
            return $this->elasticsearchConfig->getClient()->delete($params);
        }
        else
        {
            return false;
        }
    }
}

이번 포스팅에서는 데이터의 삽입, 수정, 삭제가 발생할 때 엘라스틱서치 문서 색인, 수정, 삭제를 수행하는 문서 관리 작업에 대해서 알아봤다. 생각보다 너무 간단해서 작성하고 나서 보니 민망하다. 그럼에도 불구하고 많은 분들에게 도움이 됐으면 좋겠다. 완성된 코드는 아래에서 확인할 수 있다.

https://github.com/xotrs/laravel-elasticsearch-boilerplate