Symfony 3 перенаправляет все маршруты на текущую версию локали

У меня недостаточно репутации, чтобы добавить комментарий к правильному решению. Поэтому я добавляю новый ответ

Вы можете добавить «префикс: /{_locale}» в app/config/routing.yml следующим образом:

app:
    resource: "@AppBundle/Controller/"
    type:     annotation
    prefix:   /{_locale}

Поэтому вам не нужно добавлять его в каждый маршрут для каждого действия. Для следующих шагов. Спасибо большое все идеально.

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

Некоторые вещи, чтобы отметить, мое решение зависит от моей потребности. Что он делает, так это заставляет любой URL перейти к локализованной версии, если она существует.

Это требует соблюдения некоторых соглашений при создании маршрутов.

DefaultController.php

<?php

namespace AppBundle\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;

class DefaultController extends Controller
{

    /**
     * @Route("/{_locale}/", name="home_locale", requirements={"_locale" = "%app.locales%"})
     */
    public function indexAction(Request $request)
    {
        $translated = $this->get('translator')->trans('Symfony is great');

        // replace this example code with whatever you need
        return $this->render('default/index.html.twig', [
            'base_dir' => realpath($this->container->getParameter('kernel.root_dir').'/..'),
            'translated' => $translated
        ]);
    }

    /**
     * @Route("/{_locale}/admin", name="admin_locale", requirements={"_locale" = "%app.locales%"})
     */
    public function adminAction(Request $request)
    {
        $translated = $this->get('translator')->trans('Symfony is great');

        // replace this example code with whatever you need
        return $this->render('default/index.html.twig', [
            'base_dir' => realpath($this->container->getParameter('kernel.root_dir').'/..'),
            'translated' => $translated
        ]);
    }
}
?>

Обратите внимание, что оба маршрута всегда начинаются с «/{_locale}/». Чтобы это работало, каждый маршрут в вашем проекте должен иметь это. Вы просто указываете настоящее имя маршрута после этого. Для меня я был в порядке с этим сценарием. Вы можете легко изменить мое решение, чтобы оно соответствовало вашим потребностям.

Первым шагом является создание прослушивания на httpKernal для перехвата запросов до того, как они перейдут на маршрутизаторы для их обработки.

LocaleRewriteListener.php

<?php
//src/AppBundle/EventListener/LocaleRewriteListener.php
namespace AppBundle\EventListener;

use Symfony\Component\HttpFoundation\RedirectResponse;

use Symfony\Component\Routing\RouterInterface;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\Routing\RouteCollection;

class LocaleRewriteListener implements EventSubscriberInterface
{
    /**
     * @var Symfony\Component\Routing\RouterInterface
     */
    private $router;

    /**
    * @var routeCollection \Symfony\Component\Routing\RouteCollection
    */
    private $routeCollection;

    /**
     * @var string
     */
    private $defaultLocale;

    /**
     * @var array
     */
    private $supportedLocales;

    /**
     * @var string
     */
    private $localeRouteParam;

    public function __construct(RouterInterface $router, $defaultLocale = 'en', array $supportedLocales = array('en'), $localeRouteParam = '_locale')
    {
        $this->router = $router;
        $this->routeCollection = $router->getRouteCollection();
        $this->defaultLocale = $defaultLocale;
        $this->supportedLocales = $supportedLocales;
        $this->localeRouteParam = $localeRouteParam;
    }

    public function isLocaleSupported($locale) 
    {
        return in_array($locale, $this->supportedLocales);
    }

    public function onKernelRequest(GetResponseEvent $event)
    {
        //GOAL:
        // Redirect all incoming requests to their /locale/route equivlent as long as the route will exists when we do so.
        // Do nothing if it already has /locale/ in the route to prevent redirect loops

        $request = $event->getRequest();
        $path = $request->getPathInfo();

        $route_exists = false; //by default assume route does not exist.

        foreach($this->routeCollection as $routeObject){
            $routePath = $routeObject->getPath();
            if($routePath == "/{_locale}".$path){
                $route_exists = true;
                break;
            }
        }

        //If the route does indeed exist then lets redirect there.
        if($route_exists == true){
            //Get the locale from the users browser.
            $locale = $request->getPreferredLanguage();

            //If no locale from browser or locale not in list of known locales supported then set to defaultLocale set in config.yml
            if($locale==""  || $this->isLocaleSupported($locale)==false){
                $locale = $request->getDefaultLocale();
            }

            $event->setResponse(new RedirectResponse("/".$locale.$path));
        }

        //Otherwise do nothing and continue on~
    }

    public static function getSubscribedEvents()
    {
        return array(
            // must be registered before the default Locale listener
            KernelEvents::REQUEST => array(array('onKernelRequest', 17)),
        );
    }
}

Наконец, вы устанавливаете services.yml для запуска слушателя.

Services.yml

# Learn more about services, parameters and containers at
# http://symfony.com/doc/current/book/service_container.html
parameters:
#    parameter_name: value

services:
#    service_name:
#        class: AppBundle\Directory\ClassName
#        arguments: ["@another_service_name", "plain_value", "%parameter_name%"]
     appBundle.eventListeners.localeRewriteListener:
          class: AppBundle\EventListener\LocaleRewriteListener
          arguments: ["@router", "%kernel.default_locale%", "%locale_supported%"]
          tags:
            - { name: kernel.event_subscriber }

Также в config.yml вы захотите добавить следующие параметры:

config.yml

parameters:
    locale: en
    app.locales: en|es|zh
    locale_supported: ['en','es','zh']

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

app.locales используется в контроллере по умолчанию (requirements={"_locale" = "%app.locales%"}), а locale_supported используется в LocaleRewriteListener. Если он обнаружит языковой стандарт, которого нет в списке, он вернется к языковому стандарту по умолчанию, который в данном случае является значением locale:en.

app.locales хорош с командой требований, потому что она вызовет 404 для любых локалей, которые не совпадают.

Если вы используете формы и у вас есть логин, вам нужно будет сделать следующее с вашим security.yml

Security.yml

# To get started with security, check out the documentation:
# http://symfony.com/doc/current/book/security.html
security:
    encoders:
        Symfony\Component\Security\Core\User\User:
            algorithm: bcrypt
            cost: 12
        AppBundle\Entity\User:
            algorithm: bcrypt
            cost: 12

    role_hierarchy:
        ROLE_ADMIN:       ROLE_USER
        ROLE_SUPER_ADMIN: [ROLE_USER, ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH]

    providers:
        # http://symfony.com/doc/current/book/security.html#where-do-users-come-from-user-providers
         database:
              entity: { class: AppBundle:User }
                #property: username
                # if you're using multiple entity managers
                # manager_name: customer

    firewalls:
        # disables authentication for assets and the profiler, adapt it according to your needs
        dev:
            pattern: ^/(_(profiler|wdt)|css|images|js)/
            security: false
        main:
            pattern: ^/
            anonymous: true

            form_login:
                check_path: login_check
                login_path: login_route
                provider: database
                csrf_token_generator: security.csrf.token_manager

            remember_me:
                secret:   '%secret%'
                lifetime: 604800 # 1 week in seconds
                path:     /
                httponly: false
                #httponly false does make this vulnerable in XSS attack, but I will make sure that is not possible.
            logout:
                path:   /logout
                target: /

    access_control:
        # require ROLE_ADMIN for /admin*
        #- { path: ^/login, roles: ROLE_ADMIN }
        - { path: ^/login, roles: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: ^/(.*?)/login, roles: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: ^/, roles: ROLE_USER }

Важное изменение, на которое следует обратить внимание, заключается в том, что (.*?)/login будет проходить аутентификацию анонимно, чтобы ваши пользователи могли по-прежнему входить в систему. Это означает, что такие маршруты, как ..dogdoghere/login, могут срабатывать, но требования, которые я покажу вам в ближайшее время для маршрутов входа, предотвращают это и выдают ошибку 404. Мне нравится это решение с (.*?) по сравнению с [a-z]{2}, если вы хотите использовать локали типа en_US.

SecurityController.php

<?php
// src/AppBundle/Controller/SecurityController.php
namespace AppBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;

use Symfony\Component\HttpFoundation\Request;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

class SecurityController extends Controller
{
    /**
     * @Route("{_locale}/login", name="login_route", defaults={"_locale"="en"}, requirements={"_locale" = "%app.locales%"})
     */
    public function loginAction(Request $request)
    {
        $authenticationUtils = $this->get('security.authentication_utils');

        // get the login error if there is one
        $error = $authenticationUtils->getLastAuthenticationError();

        // last username entered by the user
        $lastUsername = $authenticationUtils->getLastUsername();

        return $this->render(
            'security/login.html.twig',
            array(
                // last username entered by the user
                'last_username' => $lastUsername,
                'error'         => $error,
            )
        );
    }

    /**
     * @Route("/{_locale}/login_check", name="login_check", defaults={"_locale"="en"}, requirements={"_locale" = "%app.locales%"})
     */
    public function loginCheckAction()
    {
        // this controller will not be executed,
        // as the route is handled by the Security system
    }

    /**
    * @Route("/logout", name="logout")
    */
    public function logoutAction()
    {
    }
}
?>

Обратите внимание, что даже эти пути используют {_locale} впереди. Однако мне это нравится, поэтому я могу создавать собственные логины для разных языков. Просто имейте это в виду. Единственный маршрут, для которого не нужна локаль, — это выход из системы, который отлично работает, поскольку на самом деле это всего лишь маршрут перехвата для системы безопасности. Также обратите внимание, что он использует требования, установленные в config.yml, поэтому вам нужно только отредактировать его в одном месте для всех маршрутов в ваших проектах.

Надеюсь, это поможет кому-то, пытающемуся сделать то, что я делал!

ПРИМЕЧАНИЕ.: Чтобы легко это проверить, я использую расширение «Quick Language Switcher» для Google Chrome, которое изменяет заголовок accept-language для всех запросов.

конечная функция smallResumeOfResearching($localeRewrite, $opinion = 'IMHO') :)

1. Метод, предоставленный г-ном. Джозеф прекрасно работает с такими маршрутами, как /{route_name} или /, но не с такими маршрутами, как /article/slug/other.

2. Если мы используем модифицированный метод мистера Джозефа, предоставленный https://stackoverflow.com/a/37168304/9451542, мы потеряет профилировщик и отладчик в режиме разработки.

3. Если нам нужно более гибкое решение, метод onKernelRequest можно изменить следующим образом (спасибо г-ну Джозефу, благодаря https://stackoverflow.com/a/37168304/9451542):

   public function onKernelRequest(GetResponseEvent $event)
   {
       $pathInfo = $event->getRequest()->getPathinfo();
       $baseUrl = $event->getRequest()->getBaseUrl();
       $checkLocale = explode('/', ltrim($pathInfo, '/'))[0];
   
       //Or some other logic to detect/provide locale
   
       if (($this->isLocaleSupported($checkLocale) == false) && ($this->defaultLocale !== $checkLocale)) {
           if ($this->isProfilerRoute($checkLocale) == false) {
               $locale = $this->defaultLocale;
               $event->setResponse(new RedirectResponse($baseUrl . '/' . $locale . $pathInfo));
       }
       /* Or with matcher:
       try {
            //Try to match the path with the locale prefix
            $this->matcher->match('/' . $locale . $pathInfo);
            //$event->setResponse(new RedirectResponse($baseUrl . '/' . $locale . $pathInfo));
       } catch (\Symfony\Component\Routing\Exception\ResourceNotFoundException $e) {
       } catch (\Symfony\Component\Routing\Exception\MethodNotAllowedException $e) {
       }
       */
       }
   }
   

   примечание: $this->profilerRoutes = array('_profiler', '_wdt', '_error');

4. Спасибо Susana Santos за указание на простой метод настройки :)

Небольшое улучшение для Symfony 3.4:

1. Убедитесь, что getSubscribedEvents() зарегистрирует LocaleRewriteListener ПЕРЕД RouterListener::onKernelRequest и ПЕРЕД LocaleListener::onKernelRequest. Целое число 17 должно быть больше приоритета RouterListener::onKernelRequest. В противном случае вы получите 404.

   bin/консоль отладки:диспетчер событий

2. Определение службы в services.yml должно быть (зависит от конфигурации Symfony):

   AppBundle\EventListener\LocaleRewriteListener: аргументы: ['@router', '%kernel.default_locale%', '%locale_supported%'] теги: - { name: kernel.event_subscriber, event: kernel.request }