RESTful прокси удаленных объектов с ProxyManager

Имя файла: src/RemoteProxy/UriResolver.php

 <?php namespace RemoteProxy; use Doctrine\Common\Annotations\AnnotationReader; use RemoteProxy\Annotation\Endpoint; class UriResolver { /** * Annotation reader instance * * @var Doctrine\Common\Annotation\AnnotationReader */ protected $annotationReader; /** * Instantiate the URI resolver */ public function __construct() { $this->annotationReader = new AnnotationReader(); } /** * Return an array of mapping information * * @param string $interface * * @return array */ public function getMappings($interface) { $mappings = []; $methods = (new \ReflectionClass($interface))->getMethods(); foreach ($methods as $method) { $annotations = $this->annotationReader->getMethodAnnotations($method); foreach ($annotations as $annotation) { if ($annotation instanceof Endpoint) { $mappings[$method->name] = ['path' => $annotation->path, 'method' => $annotation->method]; } } } return $mappings; } } 

В приведенном выше коде сначала мы создаем экземпляр Doctrine\Common\Annotation\AnnotationReader и сохраняем его в свойстве $annotationReader .

В getMappings() мы получаем все методы интерфейса, используя API отражения. Затем мы перебираем их для анализа DocBlocks. На каждой итерации мы проверяем, есть ли у метода аннотация конечной точки. Если это так, мы добавляем новый элемент в массив $mappings с именем метода в качестве ключа и path и method качестве значений.

Вот как мы используем этот новый класс:

Пример использования:

 <?php // ... use ProxyManager\Factory\RemoteObjectFactory; use RemoteProxy\Adapter\RestAdapter; $base_uri = 'http://localhost'; AnnotationRegistry::registerLoader('class_exists'); $factory = new RemoteObjectFactory( new RestAdapter( new \GuzzleHttp\Client([ 'base_uri' => $base_uri, ]), // Array (new UriResolver())->getMappings(RemoteProxy\LibraryInterface::class) ) ); // ... 

Вы можете быть удивлены вызовом AnnotationRegistry::registerLoader('class_exists') . Поскольку аннотации Doctrine не загружаются определенными автозагрузчиками PHP, нам нужно использовать встроенный механизм автоматической загрузки Doctrine:

 <?php AnnotationRegistry::registerLoader('class_exists'); 

Создание особой фабрики

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

Мы RestProxyFactory это RestProxyFactory src/RemoteProxy :

Имя файла : src/RemoteProxy/RestProxyFactory.php

 <?php namespace RemoteProxy; use Doctrine\Common\Annotations\AnnotationRegistry; use RemoteProxy\Adapter\RestAdapter; class RestProxyFactory { public static function create($interface, $base_uri) { // Registering a silent autoloader for the annotation AnnotationRegistry::registerLoader('class_exists'); $factory = new \ProxyManager\Factory\RemoteObjectFactory( new RestAdapter( new \GuzzleHttp\Client([ 'base_uri' => rtrim($base_uri, '/') . '/', ]), (new UriResolver())->getMappings($interface) ) ); return $factory->createProxy($interface); } } 

В вышеприведенном классе мы принимаем интерфейс и базовый URL API (нам это нужно для создания экземпляра Guzzle). Затем мы помещаем туда все предыдущие шаги инстанцирования.

использование

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

Чтобы протестировать прокси, давайте определим маршрут в нашем файле src/app.php :

 <?php // src/app.php // ... $app->get('test-proxy', function (Application $app) { $proxy = new RestProxyFactory(LibraryInterface::class, 'localhost:9000/api/v1'); return new JsonResponse([ 'books' => $proxy->getBooks(), ]); }); // ... 

В приведенном выше коде getBooks() $proxy сделает HTTP-запрос к http://localhost:9000/api/v1/books . В результате мы должны получить следующий ответ:

 { resp: "{"books":"List of books..."}" } 

Это все, что нужно сделать. Я надеюсь, вам понравилась эта статья. Полный код доступен на Github, если вы хотите попробовать его самостоятельно.

Если вы просто хотите использовать его в своем проекте, вы можете установить его с помощью composer:

 composer require lavary/rest-remote-proxy 

Завершение

Мы узнали, как работают удаленные прокси и как они взаимодействуют с разными удаленными субъектами с разными протоколами. Мы также создали адаптер, подходящий для RESTful API.

Проксиируя удаленные объекты, мы можем использовать их, даже не зная, что они находятся в другом адресном пространстве. Мы просто просим, ​​и прокси делает звонки. Это так просто.

Как вы используете прокси? Как вы думаете, этот подход может пригодиться в некоторых ваших собственных проектах?