SpringBoot内容协商快速入门

 更新时间:2025年05月12日 11:04:47   作者:HBLOGA  
本文主要介绍了SpringBoot内容协商快速入门,使用ContentNegotiation来实现根据客户端请求自动切换返回格式的功能,感兴趣的可以了解一下

1.什么内容协商

简单说就是服务提供方根据客户端所支持的格式来返回对应的报文,在 Spring 中,REST API 基本上都是以 json 格式进行返回,而如果需要一个接口即支持 json,又支持其他格式,开发和维护多套代码显然是不合理的,而 Spring 又恰好提供了该功能,那便是ContentNegotiation 在 Spring 中,决定一个数据是以 jso还是xml 分别如下:

  • favorPathExtension 后缀模式,例如:xxx.json,xxx.xml

  • favorParameter format模式,例如:xxx?format=json,xxx?format=xml,

  • 通过请求的 Accept 来决定返回的值

2.代码工程

实验目标:根据请求参数不一样自动切换不同的格式的返回结果

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springboot-demo</artifactId>
        <groupId>com.et</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>


    <artifactId>ContentNegotiation</artifactId>


    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
    <dependencies>


        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>


        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.dataformat</groupId>
            <artifactId>jackson-dataformat-xml</artifactId>
        </dependency>
    </dependencies>
</project>

controller

package com.et.contentnegotiation.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;
import java.util.Map;
@Controller
public class HelloWorldController {
    @RequestMapping("/hello")
    @ResponseBody
    public Map<String, Object> showHelloWorld(){
        Map<String, Object> map = new HashMap<>();
        map.put("msg", "HelloWorld");
        return map;
    }
}

DemoApplication.java

package com.et.contentnegotiation;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {


   public static void main(String[] args) {
      SpringApplication.run(DemoApplication.class, args);
   }
}

application.yaml

server:
  port: 8088
spring:
  mvc:
    contentnegotiation:
      #favor-path-extension: true  # header accept
      favor-parameter: true   # url ?format=xml or format=json
      media-types:
        json: application/json

以上只是一些关键代码,所有代码请参见下面代码仓库

代码仓库

3.测试

favorParameter 方式

设置配置文件里面参数

spring.mvc.contentnegotiation.favor-parameter=true

启动springboot应用,

http://127.0.0.1:8088/hello?format=xml
http://127.0.0.1:8088/hello?format=json

返回不同格式的结果

请求的 Accept 来决定返回的值

设置配置文件里面参数

spring.mvc.contentnegotiation.favor-path-extension=true

设置header里面Accept:application/xml 或者application/json

c270d67cbdbff3ed510afde3128f7f67.png

4.引用

到此这篇关于SpringBoot内容协商快速入门的文章就介绍到这了,更多相关SpringBoot 内容协商入门内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家! 

相关文章

  • Mybatis报Type interface *.*Mapper is not known to the MapperRegis

    Mybatis报Type interface *.*Mapper is not&

    本文主要介绍了Mybatis报Type interface *.*Mapper is not known to the MapperRegis,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-07-07
  • Spring Aop+Redis实现优雅记录接口调用情况

    Spring Aop+Redis实现优雅记录接口调用情况

    通常情况下,开发完一个接口,无论是在测试阶段还是生产上线,我们都需要对接口的执行情况做一个监控,所以本文为大家整理了Spring统计接口调用的多种方法,希望对大家有所帮助
    2023-06-06
  • Java Socket编程实例(三)- TCP服务端线程池

    Java Socket编程实例(三)- TCP服务端线程池

    这篇文章主要讲解Java Socket编程中TCP服务端线程池的实例,希望能给大家做一个参考。
    2016-06-06
  • Java结构型设计模式之装饰模式详解

    Java结构型设计模式之装饰模式详解

    装饰模式(Decorator Pattern)允许向一个现有的对象添加新的功能,同时又不改变其结构。这种类型的设计模式属于结构型模式,它是作为现有类的一个包装。这种模式创建了一个装饰类,用来包装原有的类,并在保持类方法签名完整性的前提下,提供了额外的功能
    2023-03-03
  • Java并发工具Fork/Join原理

    Java并发工具Fork/Join原理

    这篇文章主要为大家介绍了Java并发工具Fork/Join原理,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-06-06
  • SpringBoot实现HTTPS加密通信的详细指南

    SpringBoot实现HTTPS加密通信的详细指南

    这篇文章主要为大家详细介绍了Spring Boot中HTTPS的实现方案与实战避坑指南,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2025-06-06
  • java反射获取一个object属性值代码解析

    java反射获取一个object属性值代码解析

    这篇文章主要介绍了java反射获取一个object属性值代码解析,具有一定借鉴价值,需要的朋友可以参考下。
    2017-12-12
  • SpringBoot使用thymeleaf实现一个前端表格方法详解

    SpringBoot使用thymeleaf实现一个前端表格方法详解

    Thymeleaf是一个现代的服务器端 Java 模板引擎,适用于 Web 和独立环境。Thymeleaf 的主要目标是为您的开发工作流程带来优雅的自然模板,本文就来用它实现一个前端表格,感兴趣的可以了解一下
    2022-10-10
  • 浅谈cookie和session(小结)

    浅谈cookie和session(小结)

    这篇文章主要介绍了浅谈cookie和session(小结),cookie和session在java web开发中扮演了十分重要的作用,本篇文章对其中的重要知识点做一些探究和总结
    2018-11-11
  • Java线程的6种状态及切换教程

    Java线程的6种状态及切换教程

    这篇文章主要给大家介绍了关于Java线程的6种状态及切换教程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12

最新评论