不知道这些不要说玩转了Controller接口

2024年 5月 8日 37.2k 0

环境:SpringBoot3.2.5

1. 简介

在Spring Boot中,Controller接口是用于处理HTTP请求并返回响应的重要组件。对于Controller中映射的接口,Spring提供了多种匹配方式,以便开发者能够更灵活、更精确地定义请求与处理器方法之间的对应关系。

在平时的开发中,定义的接口路径通常会遵循RESTful API设计原则,并且会尽量保持清晰、简洁和具有描述性。接口路径可能会根据业务需求和资源模型进行组织,但一般都具有以下特点:

  • 使用名词表示资源,如/users、/products。
  • 使用HTTP方法(GET、POST、PUT、DELETE等)来表示对资源的操作。
  • 对于资源的子集或特定实例,使用路径参数,如/users/{userId}。
  • 在需要时,使用查询参数来过滤或排序结果,如/users?name=John&sort=asc。
  • 这样的接口路径设计有助于保持API的一致性和可读性,同时也方便前端开发者理解和使用。并且这种RESTful API接口返回值通常都是JSON格式,虽然JSON格式因其轻量级和易读性而广泛流行,但实际项目开发中确实可能出现对返回值格式的不同需求。这些需求可能包括返回JSON、XML,或者根据特定的业务场景需要自定义的数据格式。针对这种场景需求SpringMVC为我们提供默认提供了支持,如:JSON,XML,自定义格式,接下来将详细介绍如何一个接口支持不同的返回数据格式。

    2. 实战案例

    你需要一个接口支持不同格式的输出,我们可以通过以下3中方式来定义不同的输出格式。为了支持XML格式,我们需要引入下面依赖

    
      com.fasterxml.jackson.dataformat
      jackson-dataformat-xml
    

    2.1 请求Header

    这种方式是官方推荐的方式,根据请求的Accept header来指定你希望接收的数据格式

    @RestController
    @RequestMapping("/returnformat")
    public class RetrunFormatController {
      
      @GetMapping("")
      public User format() {
        User user = new User(666L, "张三") ;
        return user ; 
      }
    }

    通过postman指定请求的header Accept

    不知道这些不要说玩转了Controller接口-1图片

    指定返回XML格式

    不知道这些不要说玩转了Controller接口-2图片

    2.2 通过请求参数

    要想SpringMVC支持请求参数方式设置接收的数据格式,首先需要开启此功能

    spring:
      mvc:
        contentnegotiation:
          favor-parameter: true

    通过上面开启后我们就可以在请求参数中添加format参数即可,默认只支持json和xml两种格式:

    不知道这些不要说玩转了Controller接口-3图片

    指定返回XML格式

    不知道这些不要说玩转了Controller接口-4图片

    请求的参数名默认是format,我们还可以通过如下配置修改参数名

    spring:
      mvc:
        contentnegotiation:
          favor-parameter: true
          parameter-name: fmt

    不知道这些不要说玩转了Controller接口-5图片

    2.3 通过路径后缀

    该种方式已经不推荐使用了。从5.3开始,默认情况下,SpringMVC不再执行.*后缀模式匹配,其中映射到/person的控制器也隐式映射到/perse.*。因此,路径扩展不再用于解释响应的请求内容类型 — 例如/person.pdf、/person.xml等。要使用基于后缀的方式,在不同的版本中开启此功能的方式不一样,在5.3(包括)之前版本可以直接通过配置设置,从6.0开始只能通过自定义WebMvcConfigurer配置。

    5.3之前版本

    spring:
      mvc:
        contentnegotiation:
          favor-path-extension: true

    6.0版本

    @Configuration
    public class FavorPathConfigurer implements WebMvcConfigurer {
    
    
      @Override
      public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
        configurer.favorPathExtension(true) ;
      }
    }

    Controller接口定义

    @RestController
    @RequestMapping("/favors")
    public class FavorPathController {
      
      @GetMapping("/p.*")
      public User favor() {
        return new User(1L, "张三") ;
      }
    }

    分别指定不同的请求后缀

    不知道这些不要说玩转了Controller接口-6图片

    不知道这些不要说玩转了Controller接口-7图片

    2.4 自定义格式

    在Spring Boot环境下自定义消息格式非常的简单,你执行实现HttpMessageConverter接口即可。如下示例,自定义返回yaml格式的数据

    public class YamlHttpMessageConverter implements HttpMessageConverter {
      @Override
      public boolean canWrite(Class clazz, MediaType mediaType) {
        // 这里为了简单只做类型判断,你应该对MediaType做判断,否则其它格式将无法正确输出
        return User.class.isAssignableFrom(clazz)
      }
      @Override
      public List getSupportedMediaTypes() {
        return List.of(new MediaType("application", "yaml")) ;
      }
      @Override
      public void write(Object t, MediaType contentType, HttpOutputMessage outputMessage)
          throws IOException, HttpMessageNotWritableException {
        StreamUtils.copy(new org.yaml.snakeyaml.Yaml().dump(t), StandardCharsets.UTF_8, outputMessage.getBody()) ;
      }
    }

    配置文件中定义你自定义的格式

    spring:
      mvc:
        contentnegotiation:
          media-types:
            yaml: application/yaml

    以上就完成了自定义格式输出的所有准备,测试结果

    不知道这些不要说玩转了Controller接口-8图片

    输出yaml格式数据。你可以将输出的数据在通过Yaml类进行还原为User对象。

    相关文章

    JavaScript2024新功能:Object.groupBy、正则表达式v标志
    PHP trim 函数对多字节字符的使用和限制
    新函数 json_validate() 、randomizer 类扩展…20 个PHP 8.3 新特性全面解析
    使用HTMX为WordPress增效:如何在不使用复杂框架的情况下增强平台功能
    为React 19做准备:WordPress 6.6用户指南
    如何删除WordPress中的所有评论

    发布评论