Giter Club home page Giter Club logo

bx.router's Introduction

Роутер для bitrix (PSR-7, PSR-15, PSR-17 implementation)

Установка

composer require beta/bx.router

Пример инициализации приложения:

use BX\Router\RestApplication;
use BX\Router\Middlewares\Logger;
use BX\Router\Middlewares\UseBitrixCookies;
use BX\Router\Middlewares\HttpException;

$app = new RestApplication();
$router = $app->getRouter();

$defaultMiddleware = new UseBitrixCookies(); // подставляет куки из bitrix в запрос
$defaultMiddleware->addMiddleware(new HttpException($app->getFactory())); // добавляем обработчик ошибок

$app->registerMiddleware($defaultMiddleware); // регистрируем цепочку middleware 

$app->setResponseHandler(new CustomResponseHandler);    // Устанавливаем собственный обработчик ответа
$app->setService('jwt', new UserTokenService());        // Регистрируем внешний сервис для доступа из контроллера

$logger = new Logger();
$router->get('/api/v1/catalog/', new CatalogController)->registerMiddleware($logger);
$router->get('/api/v1/some/{test}/', new SomeController)->registerMiddleware($logger);
$router->get('/api/v1/pages/main/', new MainPageConroller)
    ->useCache(3600, 'main_page')       // Кешируем ответ, ключ не обязателен, работает только c GET методами
    ->registerMiddleware($logger);
$router->default(new DefaultController) // Контроллер по-умолчанию
    ->registerMiddleware($logger); 

$app->run();

Пример контроллера c вызовом компонента:

use BX\Router\Interfaces\BitrixServiceInterface;
use BX\Router\Interfaces\AppFactoryInterface;
use BX\Router\Interfaces\ContainerGetterInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;
use BX\Router\BaseController;

class CatalogController extends BaseController
{
    /**
    * @var BitrixServiceInterface
     */
    protected $bitrixService;
    /**
    * @var AppFactoryInterface
     */
    protected $appFactory;
    /**
    * @var ContainerGetterInterface
     */
    protected $containerGetter;
    
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $component = $this->appFactory->createComponentWrapper('api:catlog.list'); // Создаем обертку компонента
        $component->setContainer($this->containerGetter);
        $component->setAppFactory($this->appFactory);
        $component->setBitrixService($this->bitrixService);
        
        return $component->handle($request);    // Возвращаем ответ с данными из массива $arResult
    }
}

Пример простого контроллера:

use BX\Router\Interfaces\BitrixServiceInterface;
use BX\Router\Interfaces\AppFactoryInterface;
use BX\Router\Interfaces\ContainerGetterInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;
use BX\Router\BaseController;

class MainPageConroller extends BaseController
{
    /**
    * @var BitrixServiceInterface
     */
    protected $bitrixService;
    /**
    * @var AppFactoryInterface
     */
    protected $appFactory;
    /**
    * @var ContainerGetterInterface
     */
    protected $containerGetter;
    
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $this->containerGetter->has('jwt'); // проверяем внешний сервис
        $jwt = $this->containerGetter->get('jwt');
        if (!($jwt instanceof UserTokenService)) {
            throw new \Exception('Что-то пошло не так...');
        }

        $request->getAttribute('test'); // атрибут из адресной строки
        $request->getAttributes();      // список атрибутов из адресной строки
        
        $jwtToken = trim(str_replace('Bearer', $request->getHeader('Authorization')));
        $userContext = $jwt->getUserContext($jwtToken);
        $user = $userContext->getUser();
        
        $data = $user->toArray();
        $response = $this->appFactory->createResponse();
        $response->getBody()->write(json_encode($data));
        
        return $response;
    }
}

Пример контроллера с выборкой атрибутов из адресной строки:

use BX\Router\Interfaces\BitrixServiceInterface;
use BX\Router\Interfaces\AppFactoryInterface;
use BX\Router\Interfaces\ContainerGetterInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;
use BX\Router\BaseController;

class SomeController extends BaseController
{
    /**
    * @var BitrixServiceInterface
     */
    protected $bitrixService;
    /**
    * @var AppFactoryInterface
     */
    protected $appFactory;
    /**
    * @var ContainerGetterInterface
     */
    protected $containerGetter;
    
    public function handle(ServerRequestInterface $request): ResponseInterface
    {
        $testAttribute = $request->getAttribute('test'); // атрибут из адресной строки
        $attributes = $request->getAttributes();         // список атрибутов из адресной строки
        
        $response = $this->appFactory->createResponse();
        $response->getBody()->write(json_encode($attributes));
        
        return $response;
    }
}

bx.router's People

Contributors

alex19pov31 avatar nnagornyy avatar kotovaz avatar kys avatar

Stargazers

Antony Bondarenko avatar Sergey Zhak avatar Goldin Evgeny avatar Roman Troitsky avatar Gleb Mikheev avatar

Watchers

 avatar  avatar James Cloos avatar Gleb Mikheev avatar

bx.router's Issues

Фоновые задачи выполняются не в фоне, т.к. сервер не отдаёт ответ

$this->bitrixService->getBxApplication()->terminate();

Почему здесь не используется $this->bitrixService->getBxApplication()->end(); ? внутри него и так вызывается terminate, но помимо этого происходит ещё один важный момент - отсылается ответ на запрос (внутри используется fastcgi_finish_request), в результате чего background jobs, запускаемые в terminate, запускаются действительно в фоновом режиме и не влияют на длительность формирования ответа на запрос.
Сейчас же ответ сервера формируется после окончания работы php-скрипта и его формирование может занимать в разы больше времени (например, если в background jobs у нас есть запросы к сторонним сервисам и ожидание ответов от них или долгие операции с БД), чем если бы использовался end, а не terminate.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.