Локали как часть URL-адреса в Spring MVC

Ответ 1

Я реализовал нечто очень похожее, используя комбинацию Filter и Interceptor.

Фильтр извлекает первую переменную пути и, если она является допустимой локалью, она устанавливает ее как атрибут запроса, удаляет ее с начала запрошенного URI и перенаправляет запрос на новый URI.

public class PathVariableLocaleFilter extends OncePerRequestFilter {
private static final Logger LOG = LoggerFactory.getLogger(PathVariableLocaleFilter.class);

@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
        throws ServletException, IOException {
    String url = defaultString(request.getRequestURI().substring(request.getContextPath().length()));
    String[] variables = url.split("/");

    if (variables.length > 1 && isLocale(variables[1])) {
        LOG.debug("Found locale {}", variables[1]);
        request.setAttribute(LOCALE_ATTRIBUTE_NAME, variables[1]);
        String newUrl = StringUtils.removeStart(url, '/' + variables[1]);
        LOG.trace("Dispatching to new url \'{}\'", newUrl);
        RequestDispatcher dispatcher = request.getRequestDispatcher(newUrl);
        dispatcher.forward(request, response);
    } else {
        filterChain.doFilter(request, response);
    }
}

private boolean isLocale(String locale) {
    //validate the string here against an accepted list of locales or whatever
    try {
        LocaleUtils.toLocale(locale);
        return true;
    } catch (IllegalArgumentException e) {
        LOG.trace("Variable \'{}\' is not a Locale", locale);
    }
    return false;
}
}

Перехватчик очень похож на LocaleChangeInterceptor, он пытается получить локаль из атрибута request и, если локаль найдена, она устанавливает ее в LocaleResolver.

public class LocaleAttributeChangeInterceptor extends HandlerInterceptorAdapter {
public static final String LOCALE_ATTRIBUTE_NAME = LocaleAttributeChangeInterceptor.class.getName() + ".LOCALE";

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {

    Object newLocale = request.getAttribute(LOCALE_ATTRIBUTE_NAME);
    if (newLocale != null) {
        LocaleResolver localeResolver = RequestContextUtils.getLocaleResolver(request);
        if (localeResolver == null) {
            throw new IllegalStateException("No LocaleResolver found: not in a DispatcherServlet request?");
        }
        localeResolver.setLocale(request, response, StringUtils.parseLocaleString(newLocale.toString()));
    }
    // Proceed in any case.
    return true;
}
}

После того, как вы их установили, вам нужно настроить Spring на использование перехватчика и LocaleResolver.

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new LocaleAttributeChangeInterceptor());
}

@Bean(name = "localeResolver")
public LocaleResolver getLocaleResolver() {
    return new CookieLocaleResolver();
}

И добавьте фильтр в AbstractAnnotationConfigDispatcherServletInitializer.

@Override
protected Filter[] getServletFilters() {
    return new Filter[] { new PathVariableLocaleFilter() };
}

Я не тестировал его полностью, но кажется, что он работает до сих пор, и вам не нужно прикасаться к вашим контроллерам, чтобы принять переменную пути {locale}, она должна просто работать из коробки. Возможно, в будущем у нас будет автоматическое решение "locale as path variable/subfolder" Spring, так как кажется, что все больше и больше веб-сайтов принимают его и, по мнению некоторых, способ пойти.

Ответ 2

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

Сначала установите фильтр в web.xml:

<filter>
    <filter-name>LocaleFilter</filter-name>
    <filter-class>yourCompleteRouteToTheFilter.LocaleUrlFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>LocaleFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

В LocaleUrlFilter.java мы используем регулярное выражение для:

• добавьте два атрибута (код страны и код языка) в запрос, который мы будем записывать позже в LocaleResolver:

• удалите язык из URL

  import java.io.IOException;
  import java.util.regex.Matcher;
  import java.util.regex.Pattern;
  
  import javax.servlet.Filter;
  import javax.servlet.FilterChain;
  import javax.servlet.FilterConfig;
  import javax.servlet.ServletException;
  import javax.servlet.ServletRequest;
  import javax.servlet.ServletResponse;
  import javax.servlet.http.HttpServletRequest;
  
  public class LocaleUrlFilter implements Filter{
  
      private static final Pattern localePattern = Pattern.compile("^/([a-z]{2})(?:/([a-z]{2}))?(/.*)?");
      public static final String COUNTRY_CODE_ATTRIBUTE_NAME = LocaleUrlFilter.class.getName() + ".country";
      public static final String LANGUAGE_CODE_ATTRIBUTE_NAME = LocaleUrlFilter.class.getName() + ".language";
  
      @Override
      public void init(FilterConfig arg0) throws ServletException {}  
  
      @Override
      public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
          HttpServletRequest request = (HttpServletRequest) servletRequest;
          String url = request.getRequestURI().substring(request.getContextPath().length());
          Matcher matcher = localePattern.matcher(url);
          if (matcher.matches()) {
              // Set the language attributes that we will use in LocaleResolver and strip the language from the url
              request.setAttribute(COUNTRY_CODE_ATTRIBUTE_NAME, matcher.group(1));
              request.setAttribute(LANGUAGE_CODE_ATTRIBUTE_NAME, matcher.group(2));
              request.getRequestDispatcher(matcher.group(3) == null ? "/" : matcher.group(3)).forward(servletRequest, servletResponse);
          }
          else filterChain.doFilter(servletRequest, servletResponse);     
      }
  
      @Override
      public void destroy() {}
  }
  

Теперь фильтр ввел в запрос два атрибута, которые мы будем использовать для формирования Locale, и лишил язык из URL-адреса, чтобы правильно обрабатывать наши запросы. Теперь мы определим LocaleResolver, чтобы изменить локаль. Для этого сначала мы модифицируем наш файл servlet.xml:

<!-- locale Resolver configuration-->
<bean id="localeResolver" class="yourCompleteRouteToTheResolver.CustomLocaleResolver"></bean>

И в CustomLocaleResolver.java мы устанавливаем соответствующий язык. Если в URL-адресе нет языка, мы будем использовать метод getLocale для запроса:

import java.util.Locale;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.LocaleResolver;

/*
* Set the Locale defined in the LocaleUrlFiltes. If none is defined (in the url) return the request locale.
*/
public class CustomLocaleResolver implements LocaleResolver{

    @Override
    public Locale resolveLocale(HttpServletRequest servletRequest) {
        final String countryCode = (String)servletRequest.getAttribute(LocaleUrlFilter.COUNTRY_CODE_ATTRIBUTE_NAME);
        if (countryCode != null) {
            String languageCode = (String)servletRequest.getAttribute(LocaleUrlFilter.LANGUAGE_CODE_ATTRIBUTE_NAME);
            if (languageCode == null) {
                return new Locale(countryCode);
            }
            return new Locale(languageCode, countryCode);
        }
        return servletRequest.getLocale();
    }

    @Override
    public void setLocale(final HttpServletRequest servletRequest, final HttpServletResponse servletResponse, final Locale locale) {
        throw new UnsupportedOperationException();
    }

}

Для этого вам не нужно ничего менять в своих контроллерах, а посещение "/en/home" будет таким же, как посещение "/home" и использование файла language_en.properties. Надеюсь, что это поможет.

Ответ 3

Недавно я столкнулся с такой же проблемой. Таким образом, я хотел бы иметь язык без учета состояния без зависимости от сеанса или файла cookie или всего остального, чем просто URL.

Я попробовал решения filter/interceptor/localeResolver, предложенные в предыдущих ответах, однако они не удовлетворяли моим потребностям, как у меня:

• статический контент (изображения и т.д.)
• части страницы, не зависящие от локали (панель администратора)
• RestController внутри того же приложения
• многопользовательский файловый загрузчик

Я также хотел избежать дублирования контента по причинам SEO (в частности, я не хочу, чтобы мой английский контент был доступен с обоих путей:/landingPage и /en/landingPage ).

Решение, наиболее подходящее для меня, заключалось в том, чтобы создать LanguageAwareController и затем наследовать его во всех контроллерах, которые я хотел бы поддерживать несколькими локалями.

@Controller
@RequestMapping(path = "/{lang}")
public class LanguageAwareController {
    @Autowired
    LocaleResolver localeResolver;

    @ModelAttribute(name = "locale")
    Locale getLocale(@PathVariable(name = "lang") String lang, HttpServletRequest request,
                 HttpServletResponse response){
        Locale effectiveLocale = Arrays.stream(Locale.getAvailableLocales())
            .filter(locale -> locale.getLanguage().equals(lang))
            .findFirst()
            .orElseGet(Locale::getDefault);
        localeResolver.setLocale(request, response, effectiveLocale);
        return effectiveLocale;
    }
}

Использование в одном из контроллеров:

@Controller
public class LandingPageController extends LanguageAwareController{

    private Log log = LogFactory.getLog(LandingPageController.class);

    @GetMapping("/")
    public String welcomePage(Locale locale, @PathVariable(name = "lang") String lang ){
        log.info(lang);
        log.info(locale);
        return "landing";
    }
}

Ответ 4

В spring 3.0 вы можете сказать своим контроллерам искать переменные пути . например.

@RequestMapping("/{locale}/action")
public void action(@PathVariable String locale) {
    ...
}