内容协商机制以及举例

徒步高手

于 2023-12-08 04:24:23 发布

阅读量130

点赞数

CC 4.0 BY-SA版权

分类专栏： SpringMVC 文章标签： spring

本文链接：https://blog.youkuaiyun.com/wsbnwzy/article/details/134868676

SpringMVC 专栏收录该内容

3 篇文章

订阅专栏

内容协商（Content Negotiation）是一种机制，它允许客户端和服务器就响应的内容类型（如JSON、XML等）达成一致。在Spring MVC中，内容协商可以自动处理，而不需要在每个控制器方法上显式地使用produces或consumes属性。这使得你的控制器更加灵活，能够根据请求的Accept头部返回不同格式的响应。

使用内容协商

当启用内容协商时，Spring会查看请求的Accept头部，并尝试生成匹配该媒体类型的响应。例如，如果客户端请求Accept: application/json，Spring会尝试返回JSON格式的响应；如果请求Accept: application/xml，则尝试返回XML格式的响应。

要启用内容协商，你可以在Spring MVC配置中添加一些配置。这可以通过Java配置或XML配置来完成。

Java配置示例

在Java配置中，你可以使用ContentNegotiationConfigurer：

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
        configurer.favorParameter(false)
                  .favorPathExtension(false)
                  .ignoreAcceptHeader(false)
                  .defaultContentType(MediaType.APPLICATION_JSON)
                  .mediaType("json", MediaType.APPLICATION_JSON)
                  .mediaType("xml", MediaType.APPLICATION_XML);
    }
}

这个配置做了以下几点：

favorParameter(false) 和 favorPathExtension(false) 表示不通过URL参数或路径扩展名来确定响应类型。
ignoreAcceptHeader(false) 表示不忽略请求的Accept头部。
defaultContentType(MediaType.APPLICATION_JSON) 设置默认的响应类型为JSON。
mediaType(...) 定义了可接受的响应类型映射。

控制器示例

在控制器中，你不需要指定produces属性，因为内容类型将由内容协商机制确定：

@RestController
@RequestMapping("/api/items")
public class ItemController {

    @GetMapping("/{id}")
    public Item getItem(@PathVariable Long id) {
        // 返回Item实例，响应格式由内容协商决定
    }
}

在这个例子中，根据请求的Accept头部，getItem方法可以返回JSON或XML格式的Item实例。

演示

当然，让我们通过一个简单的Spring MVC应用程序示例来展示内容协商的应用。假设我们有一个API，它可以根据客户端请求的Accept头部返回JSON或XML格式的用户信息。

1. 创建一个用户模型

首先，定义一个简单的用户模型：

public class User {
    private Long id;
    private String name;
    private String email;

    // 构造函数、Getter和Setter省略
}

2. 创建用户控制器

然后，创建一个控制器来处理用户相关的请求：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @GetMapping("/user/{id}")
    public User getUser(@PathVariable Long id) {
        // 模拟从数据库或服务获取用户信息
        return new User(id, "John Doe", "john@example.com");
    }
}

在这个控制器中，getUser方法返回一个User对象。注意，我们没有在@GetMapping注解中指定produces属性，因为我们将依赖于内容协商来确定响应的格式。

3. 配置内容协商

在Spring配置中，启用并配置内容协商。这可以在一个配置类中完成：

import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
        configurer.favorParameter(false)
                  .favorPathExtension(false)
                  .ignoreAcceptHeader(false)
                  .defaultContentType(MediaType.APPLICATION_JSON)
                  .mediaType("json", MediaType.APPLICATION_JSON)
                  .mediaType("xml", MediaType.APPLICATION_XML);
    }
}