Полный цикл в digital

BX.ajax.runComponentAction - функция для отправки аяксовых запросов в класс

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

На клиенте все довольно просто. Мы должны отправить обычный аякс запрос по адресу /bitrix/services/main/ajax.php.

В js библиотеке битрикса есть методы которые самостоятельно формируют запрос, запись получается слегка короче, чем при написании запроса другими способами. Я покажу примеры запросов на битриксовой библиотеке.

Запрос в компонент к файлу klass.php

Клиентская сторона

Приведу код и jsdoc битриксовой функции. Из jsdoc можно узнать параметры, которые эта функция ожидает:

/**
    *
    * @param {string} component
    * @param {string} action
    * @param {Object} config
    * @param {?string} [config.analyticsLabel]
    * @param {?string} [config.signedParameters]
    * @param {string} [config.method='POST']
    * @param {string} [config.mode='ajax'] Ajax or class.
    * @param {Object} [config.data]
    * @param {?array} [config.headers]
    * @param {?number} [config.timeout]
    * @param {Object} [config.navigation]
    */
BX.ajax.runComponentAction = function (component, action, config)
{
    config = prepareAjaxConfig(config);
    config.mode = config.mode || 'ajax';
    
    var getParameters = prepareAjaxGetParameters(config);
    getParameters.c = component;
    getParameters.action = action;
    
    var url = BX.util.add_url_param('/bitrix/services/main/ajax.php', getParameters);
    
    return buildAjaxPromiseToRestoreCsrf({
        method: config.method,
        dataType: 'json',
        url: url,
        data: config.data,
        timeout: config.timeout,
        preparePost: config.preparePost,
        headers: config.headers
    });
};

Немного сложностей вносит использование csrf. Если кратко, то это защита от вызова метода на сторонних сайтах. Если вы хотите защитить запрос, то вам придется воспользоваться методом BX.message('bitrix_sessid') в js (в объекте data). Либо каким то другим образом передать с бэкенда на фронт данные функции <?echo bitrix_sessid();?> и подставить эту строку в sessid.

Если же вы никакие сколько нибудь значимые данные в запросах не передаете, то проверку csrf можно будет отключить на бэкенде (для каждого аякс метода независимо, для каких-то можно и оставить) и отправлять запросы без sessid.

<script>
    function LazyBanner() {
            // делаем ajax запрос в компонент my_components:ajax к методу testAction()
            var request = BX.ajax.runComponentAction('my_components:ajax', 'test', {
                mode: 'class',
                data: {
                    param1: 'asd',
                    sessid: BX.message('bitrix_sessid')
                }
            });
            // промис в который прийдет ответ
            request.then(function (response) {
                console.log(response);
            });
        }
</script>

Серверная сторона

На серверной стороне генерировать ответ будет обычный компонент. Так как в примере выше мы отправляли запросы к компоненту my_components:ajax, то фактически будет выполняться метод testAction в классе из файла /local/components/my_components/ajax/class.php, название класса в файле не важно. Обращаю ваше внимание, на клиенте мы спрашиваем просто test, а по факту выполняется метод testAction.

В методе testAction есть два аргумента — $param2 и $param1. Я намеренно поставил их в обратном порядке, чтобы показать как происходит маппинг данных из запроса. Если вы вернетесь в описание клиентской части, то увидите, что там передается param1, а param2 не передается. Битрикс проверяет имена переменных через php reflection и передает в аргументы метода ajax данные с тем же типом и названием. То есть другими словами не нужно задумываться какой у вас там аргумент первый, какой второй, как это все придет из браузера, в каком порядке, достаточно просто называть переменные одинаково на сервере и на клиенте.

Пример класса со сброшенными фильтрами:

<?
/*
* Файл class.php
*/
if (!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED !== true) die();
// основной класс, является оболочкой компонента унаследованного от CBitrixComponent
class CIblocList extends CBitrixComponent implements \Bitrix\Main\Engine\Contract\Controllerable
{
    // обязательный метод предпроверки данных
    public function configureActions()
    {
        // сбрасываем фильтры по-умолчанию (Bitrix\Main\Engine\ActionFilter\Authentication() и Bitrix\Main\Engine\ActionFilter\HttpMethod() и Bitrix\Main\Engine\ActionFilter\Csrf()), предустановленные фильтры находятся в папке /bitrix/modules/main/lib/engine/actionfilter/
        return [
            'test' => [
                'prefilters' => [],
                'postfilters' => []
            ]
        ];
    }
    // основной метод исполнитель
    public function testAction($param2 = 'qwe', $param1 = '')
    {
        return [
        'asd' => $param1,
        'count' => 200
        ];
    }
}

Пример класса с фильтрами:

<?
/*
* Файл class.php
*/
if (!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED !== true) die();
// основной класс, является оболочкой компонента унаследованного от CBitrixComponent
class CIblocList extends CBitrixComponent implements \Bitrix\Main\Engine\Contract\Controllerable
{
    // обязательный метод предпроверки данных
    public function configureActions()
    {
        // устанавливаем фильтры (Bitrix\Main\Engine\ActionFilter\Authentication() и Bitrix\Main\Engine\ActionFilter\HttpMethod() и Bitrix\Main\Engine\ActionFilter\Csrf())
        return [
            'test' => [
                'prefilters' => [
                    new Bitrix\Main\Engine\ActionFilter\Authentication(),
                    new Bitrix\Main\Engine\ActionFilter\HttpMethod(array(Bitrix\Main\Engine\ActionFilter\HttpMethod::METHOD_GET, Bitrix\Main\Engine\ActionFilter\HttpMethod::METHOD_POST)),
                    new Bitrix\Main\Engine\ActionFilter\Csrf(),
                ],
                'postfilters' => []
            ]
        ];
    }
    // основной метод исполнитель
    public function testAction($param2 = 'qwe', $param1 = '')
    {
        return [
        'asd' => $param1,
        'count' => 200
        ];
    }
}

Метод configureActions описывает пре и постфильтры для запроса. В примере выше, чтобы запрос выполнился пользователь должен быть авторизован (префильтр new Bitrix\Main\Engine\ActionFilter\Authentication()), запрос должен идти методом GET или POST (префильтр new Bitrix\Main\Engine\ActionFilter\HttpMethod()) и если это POST запрос, то в запросе должна быть переменная sessid (префильтр new Bitrix\Main\Engine\ActionFilter\Csrf()). Это набор дефолтных префильтров. Если метод configureActions() ничего не будет возвращать, то именно эти префильтры по дефолту подставит битрикс. Если же метод возвращает массив, в одном из ключей которого есть описание метода test, то выполнятся именно пользовательские префильтры, а стандартные будут проигнорированы.

ActionFilter

В configureActions можно задать предпроверку данных, например, чтобы метод был доступен только для авторизованных пользователей или только PUT запросом:

public function configureActions()
{
    return [
        'test' => [
            'prefilters' => [
                new ActionFilter\Authentication,
                new ActionFilter\HttpMethod([
                    ActionFilter\HttpMethod::METHOD_PUT
                ])
            ],
        ],
    ];
}

можно убрать проверку csrf токена на бэкенде, это делается именно тут, в методе configureActions(). Чтобы csrf токен не проверялся нужно убрать ActionFilter\HttpMethod и ActionFilter\Csrf из возвращаемого массива для конкретного ajax метода, недостаточно убрать просто ActionFilter\Csrf, если в ActionFilter\HttpMethod разрешен POST, то префильтр ActionFilter\Csrf автоматически включается.

Фильтры - это обработчики, которые выполняются до или после Action. С их помощью можно отклонить выполнение действия, либо повлиять на результат действия. Существует два типа фильтров:

  • prefilter выполняется до запуска Action, может отклонить выполнения действия
  • postfilter выполняется после запуска Action, может изменить результат выполнения действия
\Bitrix\Main\Engine\ActionFilter\HttpMethod();
Метод Параметр и описание
__construct(
array $allowedMethods = [self::METHOD_GET]
)
Проверяет по какому http методу запускается действие и блокирует выполнение действия, если метод не был перечислен.
$allowedMethods {array}. Список допустимых http методов. По умолчанию GET
\Bitrix\Main\Engine\ActionFilter\Authentication();
Метод Параметр и описание
__construct(
$enableRedirect = false
)
Проверяет аутентифицирован ли пользователь и блокирует выполнение действия, если проверка не прошла, установив http status 401. Может выполнить редирект на страницу авторизации при необходимости.
$enableRedirect {bool}. Включает или отключает автоматический редирект на страницу авторизации, если проверка не прошла успешно. По умолчанию false.
\Bitrix\Main\Engine\ActionFilter\Csrf();
Метод Параметр и описание
__construct(
$enabled = true,
$tokenName = 'sessid',
$returnNew = true
)
Проверяет наличие и корректность csrf-токена и блокирует выполнение действия, если проверка не прошла.
  • $enabled {bool} Включает или отключает проверку на токен. По умолчанию true.
  • $tokenName {string} Имя, по которому передается значение токена. Используется для поиска в $_GET, $_POST. По умолчанию sessid.
  • $returnNew {bool} Сигнализирует нужно ли возвращать новое значение токена, если проверка прошла неуспешно. Заметим, что возврат осуществляется через \Bitrix\Main\Error::$customData. По умолчанию true.
\Bitrix\Main\Engine\ActionFilter\CloseSession();
Метод Параметр и описание
__construct(
$enabled = true
)
Выполнит session_write_close() перед выполнением действия. Будьте внимательны при использовании данного фильтра! Так как после закрытия сессии, все внесенные в неё изменения не будут сохранены. Для понимания работы сессий, стоит ознакомиться с документацией на php.net
$enabled {bool}. Включает или отключает работу фильтра. По умолчанию true
\Bitrix\Main\Engine\ActionFilter\Scope();
Метод Параметр и описание
__construct(
$scopes
)
Позволяет заблокировать определенные действия для указанного scope, например, можно открыть только определенные действия для rest, а все остальные будут доступны только для ajax.
$scopes {int} Перечисление допустимых scopes. Для проверки используются битовые маски. Доступные варианты можно найти в константах класса \Bitrix\Main\Engine\ActionFilter\Scope
\Bitrix\Main\Engine\ActionFilter\Cors();
Метод Параметр и описание
__construct(
string $origin = null,
bool $credentials = false
)
Устанавливает заголовки ответа для управления CORS.
  • $origin {string} Используется для установки заголовка Access-Control-Allow-Origin. По умолчанию null
  • $credentials {bool} Если true, то устанавливается заголовок Access-Control-Allow-Credentials. По умолчанию false
\Bitrix\Main\Engine\ActionFilter\ContentType();
Метод Параметр и описание
__construct(
array $allowedTypes
)
Фильтр разрешает выполнять действие, только в случае допустимых content-type в запросе. При работе с application/json будет автоматически зарегистрирован объект \Bitrix\Main\Engine\JsonPayload, который можно внедрять в параметры через параметры аякс-действия.
$allowedTypes {array}. Перечисление допустимых content-type. Например, ['application/json']
\Bitrix\Main\Engine\ActionFilter\PostDecode();
Параметр и описание
Фильтр перекодирует данные из POST-запроса, если внутренняя кодировка проекта отличается от utf-8

Запрос в компонент к файлу ajax.php

В примере выше в клиентском запросе мы указывали mode: 'class', если посмотреть jsdoc битриксовой функции, то оказывается, что она принимает еще и mode: 'ajax'. На самом деле это практически то же самое, только подключается не class.php из папка компонента, а файл ajax.php. Ну и сам класс нужно наследовать немного иначе.

Клиентская сторона

<script>
    function LazyBanner() {
            // делаем ajax запрос в компонент my_components:ajax к методу testAction()
            var request = BX.ajax.runComponentAction('my_components:ajax', 'test', {
                mode: 'ajax',
                data: {
                    param1: 'asd',
                    sessid: BX.message('bitrix_sessid')
                }
            });
            // промис в который прийдет ответ
            request.then(function (response) {
                console.log(response);
            });
        }
</script>

Серверная сторона

<?
/*
* Файл ajax.php
*/
if (!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED !== true) die();
// основной класс, является оболочкой компонента унаследованного от CBitrixComponent
class CustomAjaxController extends \Bitrix\Main\Engine\Controller
{
    // обязательный метод предпроверки данных
    public function configureActions()
    {
        // сбрасываем фильтры по-умолчанию (Bitrix\Main\Engine\ActionFilter\Authentication() и Bitrix\Main\Engine\ActionFilter\HttpMethod() и Bitrix\Main\Engine\ActionFilter\Csrf()), предустановленные фильтры находятся в папке /bitrix/modules/main/lib/engine/actionfilter/
        return [
            'test' => [
                'prefilters' => [],
                'postfilters' => []
            ]
        ];
    }
    // основной метод исполнитель
    public function testAction()
    {
        return 'Тест пройден';
    }
}
Заполните форму уже сегодня!
Для начала сотрудничества необходимо заполнить заявку или заказать обратный звонок. В ответ получите коммерческое предложение, которое будет содержать индивидуальную стратегию с учетом требований и поставленных задач
Работаем по будням с 9:00 до 18:00. Заявки, отправленные в выходные, обрабатываем в первый рабочий день до 12:00.
Спасибо, ваш запрос принят и будет обработан!
Эйч Маркетинг