Eseguire Symfony 5 con il proxy inverso nella sottodirectory
Mi piace eseguire un'applicazione Symfony 5 dietro un proxy inverso che fornisce il seguente endpoint:
https://my.domain/service1/
La configurazione del proxy è fondamentalmente questa:
ProxyPass /marketsy/ http://internal.service1/
Sul server a cui si connette il proxy inverso, utilizzo la seguente regola Apache per servire la mia applicazione Symfony:
<VirtualHost *:80>
ServerName internal.service1
DocumentRoot /webroot/service1/public
<FilesMatch \.php$> SetHandler proxy:unix:/run/php/php7.2-fpm-ui.sock|fcgi://localhost SetEnvIfNoCase ^Authorization$ "(.+)" HTTP_AUTHORIZATION=$1
SetEnv HTTP_X_FORWARDED_PROTO "https"
</FilesMatch>
<Directory /webroot/service1/public>
AllowOverride None
Require all granted
FallbackResource /index.php
</Directory>
<Directory /webroot/service1/public/bundles>
FallbackResource disabled
</Directory>
</VirtualHost>
L'applicazione stessa è esigibile, ma Symfony non può gestire il prefisso del percorso "service1".
Ad esempio, cerca di accedere al profiler sotto https://my.domain/_wdt/8e3926 invece di https://my.domain/service1/_wdt/8e3926 e accanto al percorso di root tutto il routing non funziona:
Ad esempio: quando provo ad accedere https://my.domain/service1/my/page verrò reindirizzato a https://my.domain/my/page
Ora la mia domanda è, come posso configurare Symfony per conoscere il prefisso del percorso "service1" quando gli URL di generazione vengono eseguiti.
Risposte
Modo corretto di farlo (esempio):
Creare src/Controller/BarController.php
<?php
namespace App\Controller;
use Symfony\Component\HttpFoundation\Response;
class BarController
{
public function index()
{
return new Response('<p>Bar controler response</p>');
}
}
e src/Controller/FooController.php
<?php
namespace App\Controller;
use Symfony\Component\HttpFoundation\Response;
class FooController
{
public function index()
{
return new Response('<p>Foo controler response</p>');
}
}
Creare config/routes/prefix-routes.yaml
index:
path: /
controller: App\Controller\DefaultController::index
bar:
path: /bar
controller: App\Controller\BarController::index
foo:
path: /foo
controller: App\Controller\FooController::index
e modifica il routing config/routes.yaml
: elimina il suo contenuto e inserisci:
prefixed:
resource: "routes/prefix-routes.yaml"
prefix: service1
tutti i controller sono ora disponibili su URL:
http://localhost/service1/ for DefaultController.php
http://localhost/service1/bar for BarController.php
http://localhost/service1/foo for FooController.php
Se vuoi che il tuo profiler funzioni anche con il service1
prefisso, modifica in config/routes/dev/web_profiler.yaml
questo modo:
web_profiler_wdt:
resource: '@WebProfilerBundle/Resources/config/routing/wdt.xml'
prefix: service1/_wdt
web_profiler_profiler:
resource: '@WebProfilerBundle/Resources/config/routing/profiler.xml'
prefix: service1/_profiler
ora dovrebbero essere disponibili su:
http://localhost/service1/_wdt... for wdt
http://localhost/service1/_profiler for profiler
Aggiunta del prefisso per le annotazioni:
Crea controller src/Controller/AnnoController.php
:
<?php
namespace App\Controller;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
class AnnoController extends AbstractController
{
/**
* @Route("/anno", name="anno")
*/
public function index()
{
return new Response('<p>Anno controler response</p>');
}
}
modifica config/routes/annotations.yaml
e aggiungi prefix: service1
:
controllers:
resource: ../../src/Controller/
type: annotation
prefix: service1
kernel:
resource: ../../src/Kernel.php
type: annotation
Ora il prefisso viene aggiunto alle rotte eseguite tramite annotazione:
http://localhost/service1/anno for AnnoController.php
Alcuni riferimenti:
Prefisso di
Symfony Routing Chiavi di configurazione del routing di Symfony
Aggiunta di una soluzione rapida e sporca per aggiungere prefisso service1
a tutto il routing (non consigliato).
Invece di cambiare il percorso come sopra, basta modificare src/Kernel.php
protected function configureRoutes
e cambia ogni $routes->import
riga aggiungendo ->prefix('service1')
alla fine in questo modo:
protected function configureRoutes(RoutingConfigurator $routes): void
{
$routes->import('../config/{routes}/'.$this->environment.'/*.yaml')->prefix('service1');
$routes->import('../config/{routes}/*.yaml')->prefix('service1'); if (is_file(\dirname(__DIR__).'/config/routes.yaml')) { $routes->import('../config/{routes}.yaml')->prefix('service1');
} elseif (is_file($path = \dirname(__DIR__).'/config/routes.php')) { (require $path)($routes->withPath($path), $this);
}
}
tutti i controller sono ora disponibili su URL:
http://localhost/service1/ for DefaultController.php
http://localhost/service1/bar for BarController.php
http://localhost/service1/foo for FooController.php
così come il profiler:
http://localhost/service1/_wdt... for wdt
http://localhost/service1/_profiler for profiler
Oltre alla soluzione fornita da @Jimmix, ho dovuto scrivere un abbonato per aggiungere un prefisso al percorso della mia richiesta:
<?php namespace My\Bundle\EventSubscriber;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\KernelEvents;
class AppPrefixSubscriber implements EventSubscriberInterface {
/** @var string */
private $appPrefix; public function __construct(?string $appPrefix) {
$this->appPrefix = $appPrefix;
}
/**
* Returns events to subscribe to
*
* @return array
*/
public static function getSubscribedEvents() {
return [
KernelEvents::REQUEST => [
['onKernelRequest', 3000]
]
];
}
/**
* Adds base url to request based on environment var
*
* @param RequestEvent $event */ public function onKernelRequest(RequestEvent $event) {
if (!$event->isMasterRequest()) { return; } if ($this->appPrefix) {
$request = $event->getRequest();
$newUri = $this->appPrefix .
$request->server->get('REQUEST_URI'); $event->getRequest()->server->set('REQUEST_URI', $newUri); $request->initialize(
$request->query->all(), $request->request->all(),
$request->attributes->all(), $request->cookies->all(),
$request->files->all(), $request->server->all(),
$request->getContent()
);
}
}
}