快捷導(dǎo)航

SpringBoot內(nèi)容協(xié)商快速入門(mén)

更新時(shí)間：2025年05月12日 11:04:47 作者：HBLOGA

本文主要介紹了SpringBoot內(nèi)容協(xié)商快速入門(mén),使用ContentNegotiation來(lái)實(shí)現(xiàn)根據(jù)客戶(hù)端請(qǐng)求自動(dòng)切換返回格式的功能,感興趣的可以了解一下

1.什么內(nèi)容協(xié)商

簡(jiǎn)單說(shuō)就是服務(wù)提供方根據(jù)客戶(hù)端所支持的格式來(lái)返回對(duì)應(yīng)的報(bào)文，在 Spring 中，REST API 基本上都是以 json 格式進(jìn)行返回，而如果需要一個(gè)接口即支持 json，又支持其他格式，開(kāi)發(fā)和維護(hù)多套代碼顯然是不合理的，而 Spring 又恰好提供了該功能，那便是ContentNegotiation 在 Spring 中，決定一個(gè)數(shù)據(jù)是以 jso還是xml 分別如下：

favorPathExtension 后綴模式，例如：xxx.json，xxx.xml
favorParameter format模式，例如：xxx?format=json,xxx?format=xml,
通過(guò)請(qǐng)求的 Accept 來(lái)決定返回的值

2.代碼工程

實(shí)驗(yàn)?zāi)繕?biāo)：根據(jù)請(qǐng)求參數(shù)不一樣自動(dòng)切換不同的格式的返回結(jié)果

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

以上只是一些關(guān)鍵代碼，所有代碼請(qǐng)參見(jiàn)下面代碼倉(cāng)庫(kù)

代碼倉(cāng)庫(kù)

https://github.com/Harries/springboot-demo

3.測(cè)試

favorParameter 方式

設(shè)置配置文件里面參數(shù)

spring.mvc.contentnegotiation.favor-parameter=true

啟動(dòng)springboot應(yīng)用，

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

返回不同格式的結(jié)果

請(qǐng)求的 Accept 來(lái)決定返回的值

設(shè)置配置文件里面參數(shù)

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

設(shè)置header里面Accept：application/xml 或者application/json

4.引用

http://www.liuhaihua.cn/archives/710402.html
https://segmentfault.com/a/1190000039805072

到此這篇關(guān)于SpringBoot內(nèi)容協(xié)商快速入門(mén)的文章就介紹到這了,更多相關(guān)SpringBoot 內(nèi)容協(xié)商入門(mén)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: