仅支持有限数量的语言

Question

我的 API 使用 Jersey 2，现在我想支持国际化。我知道我的客户端应该指定接受语言参数，但我想了解如何正确处理它。

假设我的 API 应该只处理法语和英语语言。我知道我可以使用以下代码检索首选区域设置：

@GET
@Path("a-path")
public Response doSomething(@Context HttpServletRequest request) {
    Locale locale = request.getLocale();
    // ...
}

问题是当我的API不支持首选语言环境时。假设我的客户端向我发送Accept-Language： da， en-gb； q=0.8， en； q=0.7，根据w3c，它的基本意思是：“我更喜欢丹麦语，但会接受英国英语和其他类型的英语。”。由于首选语言环境只返回最期望的语言环境，有没有办法通过我的API选择第一个支持的语言？我想在一个地方（即在Filters中）处理它，而不是在每个资源中。

Answer 1

JAX-RS API允许您使用请求选择区域设置。选择变量（列表）方法。

在REST处理程序或CDI bean中尝试以下代码：

import javax.ws.rs.core.Variant;
import javax.ws.rs.core.Request;

    @Context
    private Request req;

    private Locale getResponseLocale(boolean throwIfNoneMatch) throws NotAcceptableException{
        // Put your supported languages here
        List<Variant> langVariants = Variant.languages(
                new Locale("da"), 
                new Locale("en-gb"), 
                Locale.getDefault()).build();

        Locale locale = Locale.getDefault();
        Variant selectVariant = this.req.selectVariant(langVariants);
        if (selectVariant != null) {
            locale = selectVariant.getLanguage();
        } else if (throwIfNoneMatch) {
            throw new NotAcceptableException(Response.notAcceptable(langVariants).build());
        }

        return locale;
    }

另请参阅Java EE教程：运行时内容协商。

Answer 2

获取语言环境的一种方法是使用HttpHeaders#getAcceptableLanguage ages（）。

获取响应可接受的语言列表。

如果未指定可接受的语言，则返回包含单个通配符区域设置实例（语言字段设置为“*”）的只读列表。

返回：可接受语言的只读列表，根据其q值排序，优先选择最高。

您可以使用@Context在几乎任何地方注入HttpHeaders

public Response doSomething(@Context HttpHeaders headers) {
    List<Locale> langs = headers.getAcceptableLanguages();

如果要在筛选器中获取列表，还可以从容器请求上下文中获取区域设置列表

@Override
public void filter(ContainerRequestContext requestContext) throw .. {
    List<Locales> langs = requestContext.getAcceptableLanguages();
}

如果您想在资源方法中使用Locale，但不想在方法中执行所有语言环境“解析”，您可以使用一些依赖注入，并创建一个Factory，您可以在其中注入heHttpHeaders并在那里解析语言环境

另请参阅：Jersey 2.0的依赖注入

下面是一个完整的测试用例示例，它结合了我提到的关于在工厂中使用筛选器和依赖项注入的最后两点，以便您可以将解析的区域设置注入到资源方法中。该示例使用仅允许英语的虚拟区域设置解析器。解析区域设置后，我们将其设置为请求上下文属性，并从工厂内部检索，以便我们可以将其注入到资源方法中

@GET
public String get(@Context Locale locale) {
   return locale.toString();
}

参见:如何将对象注入jersey请求上下文？

如果你想让我解释关于这个例子的其他事情，请告诉我。

import java.io.IOException;
import java.util.List;
import java.util.Locale;
import java.util.logging.Logger;
import javax.inject.Inject;
import javax.inject.Singleton;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.container.PreMatching;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.Provider;

import org.glassfish.hk2.api.Factory;
import org.glassfish.hk2.utilities.binding.AbstractBinder;
import org.glassfish.jersey.filter.LoggingFilter;
import org.glassfish.jersey.process.internal.RequestScoped;
import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Test;

import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertThat;

/**
 * Stack Overflow question https://stackoverflow.com/q/36871274/2587435
 * 
 * Run this like any other JUnit test. Only one required test dependency:
 * 
 *  <dependency>
 *      <groupId>org.glassfish.jersey.test-framework.providers</groupId>
 *      <artifactId>jersey-test-framework-provider-inmemory</artifactId>
 *      <version>${jersey2.version}</version>
 *  </dependency>
 *
 * @author Paul Samsotha
 */
public class AcceptLanguageTest extends JerseyTest {
    
    @Path("language")
    public static class TestResource {
       
        @GET
        public String get(@Context Locale locale) {
           return locale.toString();
        }
    }
    
    public static interface LocaleResolver {
        Locale resolveLocale(List<Locale> locales);
    }
    
    // Note: if you look in the javadoc for getAcceptableLanguages()
    // you will notice that it says if there is not acceptable language
    // specified, that there is a default single wildcard (*) locale.
    // So this implementation sucks, as it doesn't check for that.
    // You will want to make sure to do so!
    public static class DefaultLocaleResolver implements LocaleResolver {
        
        @Override
        public Locale resolveLocale(List<Locale> locales) {
            if (locales.contains(Locale.ENGLISH)) {
                return Locale.ENGLISH;
            }
            return null;
        }
    }
    
    @Provider
    @PreMatching
    public static class LocaleResolverFilter implements ContainerRequestFilter {
        
        static final String LOCALE_PROPERTY = "LocaleResolverFilter.localProperty";
        
        @Inject
        private LocaleResolver localeResolver;
        
        @Override
        public void filter(ContainerRequestContext context) throws IOException {
            List<Locale> locales = context.getAcceptableLanguages();
            Locale locale = localeResolver.resolveLocale(locales);
            if (locale == null) {
                context.abortWith(Response.status(Response.Status.NOT_ACCEPTABLE).build());
                return;
            }
            context.setProperty(LOCALE_PROPERTY, locale);
        }
    }
    
    public static class LocaleFactory implements Factory<Locale> {
        
        @Context
        private ContainerRequestContext context;

        @Override
        public Locale provide() {
            return (Locale) context.getProperty(LocaleResolverFilter.LOCALE_PROPERTY);
        }

        @Override
        public void dispose(Locale l) {} 
    }
    
    @Override
    public ResourceConfig configure() {
        return new ResourceConfig(TestResource.class)
                .register(LocaleResolverFilter.class)
                .register(new AbstractBinder() {
                    @Override
                    protected void configure() {
                        bindFactory(LocaleFactory.class)
                                .to(Locale.class).in(RequestScoped.class);
                        bind(DefaultLocaleResolver.class)
                                .to(LocaleResolver.class).in(Singleton.class);
                    }
                })
                .register(new LoggingFilter(Logger.getAnonymousLogger(), true));
    }
    
    @Test
    public void shouldReturnEnglish() {
        final String accept = "da, en-gb;q=0.8, en;q=0.7";
        final Response response = target("language").request()
                .acceptLanguage(accept)
                .get();
        assertThat(response.readEntity(String.class), is("en"));
    }
    
    @Test
    public void shouldReturnNotAcceptable() {
        final String accept = "da";
        final Response response = target("language").request()
                .acceptLanguage(accept)
                .get();
        assertThat(response.getStatus(), is(Response.Status.NOT_ACCEPTABLE.getStatusCode()));
    }
}