Использование MongoDB в Catalyst. Часть 1. Примеры кода

Разработка панели администратора, для доступа к системе логов. Создание модели для работы с MongoDB в Catalyst. Создание контроллера и tt-шаблонов для панели администратора. Взаимодействие с MongoDB, выборка данных, сортировка, использование лимитов, поиск одной-единственной записи. Получение списка всех доступных баз данных Mongo. Использование Variable::Eject. Простые примеры кода.

Задача

MongoDB используется для хранения логов. Требуется создать панель администратора, заходя в которую, администратор сможет просматривать все записи таблицы (сорри за терминологию, просто так привычнее) с логами. Для начала можно создать всего две страницы:

первая - это таблица с записями, 20 записей на одной странице
вторая - это подробная исформация о каждой записи.

В данных примерах не рассматривается удаление записей и создание новых, хотя на основе изложенного, это не сложно сделать самостоятельно. Создание системы логирования в данной публикации так же не рассматривается.

Приведенный код строится на ранее созданной основе:

1. Создаем модель для работы с MongoDB

/lib/app/Model/MongoDB.pm :

package app::Model::MongoDB;

use strict;
use uni::perl ':dumper';.
use MooseX::Singleton;
use base qw/Catalyst::Model::MongoDB/;

__PACKAGE__->config(
    'host' => '127.0.0.1',
    'port' => '27017',
    'dbname' => 'app_db',
    'username' => 'app_user',
    'password' => 'app_pass',
);

1;

package app::Model::MongoDB;

use strict;

use uni::perl ':dumper';.

use MooseX::Singleton;

use base qw/Catalyst::Model::MongoDB/;

__PACKAGE__->config(

'host' => '127.0.0.1',

'port' => '27017',

'dbname' => 'app_db',

'username' => 'app_user',

'password' => 'app_pass',

);

Catalyst::Model::MongoDB используется в качестве базового класса для создания модели MongoDB. Требуется только задать параметры подключения к БД, и модель можно использовать.

2. Создаем контроллер

Контроллер будет заниматься обработкой двух страниц - вывод основного списка логов, и вывод информации о конкретной записи в логах. Так же, будет реализована возможность перехода по страницам, хотя в шаблоне tt визуально это пока никак не оформлено.

Возможно, создание страницы для отображения конкретной записи в данном примере не оправдано, т.к. там выводятся все те же данные, что и в основной таблице. Однако, в дальнейшем страница будет полезна для добавления на нее формы редактирования записей, полного списка полей (которых может быть намного больше, чем в приведенном примере), комментариев и дополнительной информации.

/lib/app/Controller/Log/ApiLog.pm :

package app::Controller::Log::ApiLog;

use uni::perl ':dumper';
use Moose;
use namespace::autoclean;

use app::Model::MongoDB;
use Variable::Eject;

BEGIN { extends 'Catalyst::Controller' }

sub index :Path('/log/api_log') :Args(0) {
    my ( $self, $c ) = @_;

    eject ($c->req->params, $page, $limit);
    $page ||= 0;
    $limit ||= 20;

    my $db = app::Model::MongoDB->instance;

    # узнаем список всех баз данных Mongo на сервере
    my @dbnames = $db->collnames;

    my $coll = $db->coll('network_log');
    my $logs = $coll->find->sort({'id' => 1})->limit(10)->skip($page * $limit);

    my @res;
    my $i = 1;
    my @headers;
    while (my $log = $logs->next) {

        if ($i==1){
            # простой способ узнать, какие столбцы есть в строке
            foreach my $key (keys %{$log}) {
                push @headers, $key;
            }
        $i++;
        }

        push @res, {
            id => $log->{'_id'},
            source_id => $log->{source_id},
            response => $log->{response},
            ctime => $log->{ctime},
        };
    }

    $c->stash->{dbnames} = \@dbnames;
    $c->stash->{logs} = \@res;
    $c->stash->{fields} = \@headers;

    $c->stash->{template} = 'log/api_log/index.tt';
}

sub element :Path('/log/api_log') :Args(1) {
    my ( $self, $c, $id ) = @_;

    $c->stash->{template} = 'log/api_log/element.tt';

    my $db = app::Model::MongoDB->instance;
    my $coll = $db->coll('network_log');

    my $row = $coll->find_one({_id => MongoDB::OID->new(value => $id)});
    $row->{id} = $row->{_id};

    $c->stash->{row} = $row;
    $c->stash->{template} = 'log/api_log/element.tt';
}

__PACKAGE__->meta->make_immutable;

1;

package app::Controller::Log::ApiLog;

use uni::perl ':dumper';

use Moose;

use namespace::autoclean;

use app::Model::MongoDB;

use Variable::Eject;

BEGIN { extends 'Catalyst::Controller' }

sub index :Path('/log/api_log') :Args(0) {

my ( $self, $c ) = @_;

eject ($c->req->params, $page, $limit);

$page ||= 0;

$limit ||= 20;

my $db = app::Model::MongoDB->instance;

# узнаем список всех баз данных Mongo на сервере

my @dbnames = $db->collnames;

my $coll = $db->coll('network_log');

my $logs = $coll->find->sort({'id' => 1})->limit(10)->skip($page * $limit);

my @res;

my $i = 1;

my @headers;

while (my $log = $logs->next) {

if ($i==1){

# простой способ узнать, какие столбцы есть в строке

foreach my $key (keys %{$log}) {

push @headers, $key;

}

$i++;

}

push @res, {

id => $log->{'_id'},

source_id => $log->{source_id},

response => $log->{response},

ctime => $log->{ctime},

};

}

$c->stash->{dbnames} = \@dbnames;

$c->stash->{logs} = \@res;

$c->stash->{fields} = \@headers;

$c->stash->{template} = 'log/api_log/index.tt';

}

sub element :Path('/log/api_log') :Args(1) {

my ( $self, $c, $id ) = @_;

$c->stash->{template} = 'log/api_log/element.tt';

my $db = app::Model::MongoDB->instance;

my $coll = $db->coll('network_log');

my $row = $coll->find_one({_id => MongoDB::OID->new(value => $id)});

$row->{id} = $row->{_id};

$c->stash->{row} = $row;

$c->stash->{template} = 'log/api_log/element.tt';

}

__PACKAGE__->meta->make_immutable;

Использование Variable::Eject

Variable::Eject - отличный модуль, который позволяет извлекать из указанного хеша значения для переменных. Предварительно объявлять переменные нет необходимости.

use Variable::Eject;

# из хеша с данными $c->req->params будут извлечены значения переданных 
# параметров page и limit, и присвоены одноименным переменным.
eject ($c->req->params, $page, $limit);

use Variable::Eject;

# из хеша с данными $c->req->params будут извлечены значения переданных

# параметров page и limit, и присвоены одноименным переменным.

eject ($c->req->params, $page, $limit);

3. Создаем шаблон для главной страницы со списком логов

/root/src/log/api_log/index.tt :

<html>
<head>
<link rel="stylesheet" type="text/css" href="/static/css/admin.css" />
</head>
<body>

Список всех БД на mongo:<br>
[% FOREACH name = dbnames %]
    [% name %]<br>
[% END %]
<br><br>

Полный список полей network_logs:<br>
[% FOREACH field = fields %]
    [% field %]<br>
[% END %]
<br><br>

<table border="1">

<tr>
<td>id</td>
<td>source_id</td>
<td>ctime</td>
<td>response</td>
</tr>

[% FOREACH row = logs %]
    <tr>
    <td><a href="/log/api_log/[% row.id %]">[% row.id %]</a></td>
    <td>[% row.source_id %]</td>
    <td>[% row.ctime %]</td>
    <td>[% row.response %]</td>
    </tr>

[% END %]
</table>
</body>
</html>

<html>

<head>

</head>

<body>

Список всех БД на mongo:<br>

[% FOREACH name = dbnames %]

[% name %]<br>

[% END %]

Полный список полей network_logs:<br>

[% FOREACH field = fields %]

[% field %]<br>

[% END %]

<tr>

<td>source_id</td>

<td>ctime</td>

<td>response</td>

</tr>

[% FOREACH row = logs %]

<tr>

<td>[% row.source_id %]</td>

<td>[% row.ctime %]</td>

<td>[% row.response %]</td>

</tr>

[% END %]

</table>

</body>

</html>

4. Создаем шаблон для странички с полным описанием одной записи из таблицы логов

/root/src/log/api_log/element.tt :

<html>
<head>
<link rel="stylesheet" type="text/css" href="/static/css/admin.css" />
</head>
<body>

<table border="1">

<tr><td>id</td><td>[% row.id %]>/td></tr>
<tr><td>source_id</td><td>[% row.source_id %]</td></tr>
<tr><td>ctime</td><td>[% row.ctime %]</td></tr>
<tr><td>response</td><td>[% row.response %]</td></tr>

</table>

</body>
</html>

<html>

<head>

</head>

<body>

<tr><td>source_id</td><td>[% row.source_id %]</td></tr>

<tr><td>ctime</td><td>[% row.ctime %]</td></tr>

<tr><td>response</td><td>[% row.response %]</td></tr>

</table>

</body>

</html>

5. Создаем файл css

Страницы панели администратора выглядят просто ужасно. Для того, чтобы облагородить их вид, можно использовать CSS. Я привела только начало файла (просто для того, чтобы обозначить появление данного файла в текущих доработках кода), остальное можно дописать по собственному усмотрению.

/root/static/css/admin.css :

body {
    margin: 0;
    padding: 10px;
    font-size: 12px;
    font-family: Verdana, Arial;
    color: #333;
    background: #fff;
}

a:link {
    color: #5b80b2;
    text-decoration: none;
}

a:hover {
    color: #003f6f;
}

body {

margin: 0;

padding: 10px;

font-size: 12px;

font-family: Verdana, Arial;

color: #333;

background: #fff;

}

a:link {

color: #5b80b2;

text-decoration: none;

}

a:hover {

color: #003f6f;

}

6. Запускаем сервер и проверяем работоспособность кода

Запуск сервера. Для разнообразия - под портом 3001.

perl script/app_server.pl --port 3001

1	perl script/app_server.pl --port 3001

Главная страница, которая содержить список из 20 последних записей в БД Mongo:

http://localhost:3001/log/api_log

1	http://localhost:3001/log/api_log

Использование параметров page и limit позволяет организовать постраничный просмотр. По-умолчанию, page имеет значение 0 и открывает первую страницу, а limit имеет значение 20.

http://localhost:3001/log/api_log?page=2&limit=30

1	http://localhost:3001/log/api_log?page=2&limit=30

Страница с подробным содержимым конкретной записи в БД. На эту же страницу можно добавить формы для редактирования данных.

http://localhost:3001/log/api_log/53330e8c3476bc2fe0000333

1	http://localhost:3001/log/api_log/53330e8c3476bc2fe0000333

Полезные ссылки по теме MongoDB и Catalyst

search.cpan.org: MongoDB

search.cpan.org: Catalyst::Model::MongoDB

search.cpan.org: MongoDB::MongoClient

search.cpan.org: MongoDB::Collection

search.cpan.org: MongoDB::OID

search.cpan.org: MongoDB::Cursor

search.cpan.org: Variable::Eject

The Little MongoDB Book (Маленькая книга о MongoDB) - на русском