深入解析JAX-RS中的请求与响应头处理

在JAX-RS API中，请求和响应头的处理是构建RESTful服务时不可或缺的一部分。本文将通过一系列实例，带您深入了解如何访问请求头、设置响应头，以及如何利用不同类型的Java对象与请求头进行绑定。

访问请求头

通过HttpHeaders接口，我们可以访问所有的请求头。以下是一个简单的实例，展示了如何注入HttpHeaders并获取所有的请求头信息：

@Path("/")
public class TestResource {
    @GET
    @Path("allHeaders")
    public String allHeaders(@Context HttpHeaders headers) {
        MultivaluedMap<String, String> rh = headers.getRequestHeaders();
        String str = rh.entrySet()
                      .stream()
                      .map(e -> e.getKey() + ": " + e.getValue())
                      .collect(Collectors.joining("\n"));
        return str;
    }
}

使用@HeaderParam注解

@HeaderParam注解可以将请求头的值绑定到资源方法的参数上。例如，获取Host请求头的值：

@Path("/")
public class TestResource {
    @GET
    @Path("hostHeader")
    public String getHostHeader(@HeaderParam(HttpHeaders.HOST) String host) {
        return "Host header value: " + host;
    }
}

自动类型绑定

JAX-RS能够将请求头字符串隐式绑定到合适的Java类型。例如，将请求头anInt绑定到int类型：

@Path("/")
public class TestResource {
    @GET
    @Path("intHeader")
    public String getIntHeader(@HeaderParam("anInt") int anInteger) {
        return "The 'anInt' header value: " + anInteger;
    }
}

绑定到具有String接受者构造函数的Java类型

如果Java类型具有接受String的构造函数，JAX-RS可以自动初始化这个类型。例如，java.util.Date：

@Path("/")
public class TestResource {
    @GET
    @Path("dateHeader")
    public String getDateHeader(@HeaderParam("aDate") Date date) {
        return "The 'aDate' header value: " + date;
    }
}

绑定到具有valueOf(String)方法的类型

如果类型T具有public static T valueOf(String s)方法，JAX-RS也可以使用它。例如，自定义类型DateInfo：

public class DateInfo {
    private Date date;
    public static DateInfo valueOf(String dateStr) {
        // Initialization logic
    }
}

@Path("/")
public class TestResource {
    @GET
    @Path("valueOfTest")
    public String valueOfTest(@HeaderParam("aDate") DateInfo dateInfo) {
        return "Converted LocalDateTime: " + dateInfo.asLocalDateTime();
    }
}

绑定到实现了ParamConverter接口的类型

实现ParamConverter接口可以自定义HTTP消息属性到Java类型的绑定。例如，直接将请求头转换为LocalDateTime：

public class MyDateConverter implements ParamConverter<LocalDateTime> {
    public LocalDateTime fromString(String value) {
        // Conversion logic
    }
}

@Path("/")
public class TestResource {
    @GET
    @Path("paramConverterTest")
    public String paramConverterTest(@HeaderParam("aDate") LocalDateTime date) {
        return "Converted by MyDateConverter: " + date;
    }
}

返回响应头

使用ResponseBuilder类可以方便地创建包含响应头的Response实例：

@Path("/")
public class TestResource {
    @GET
    @Path("responseHeaderTest")
    public Response addResponseHeader() {
        return Response.ok("Test response")
                .header("X-Custom-Header", "Value")
                .build();
    }
}

使用JAX-RS客户端发送请求头

JAX-RS客户端API允许我们发送带有请求头的请求：

public class MyClient {
    public static void main(String[] args) {
        Client client = ClientBuilder.newClient();
        WebTarget target = client.target("http://localhost:8080/resource");
        String response = target.request()
                .header("My-Header", "Value")
                .get(String.class);
        System.out.println(response);
        client.close();
    }
}

示例项目

本教程使用的依赖和技术包括：

• jersey-container-servlet 2.25.1: Jersey核心Servlet 3.x实现。
• JDK 1.8
• Maven 3.3.9

通过这些示例，我们可以看到JAX-RS提供了丰富的方式来处理HTTP请求和响应头，无论是直接访问、自动类型绑定还是自定义转换器，都能满足我们在构建RESTful服务时的需求。