使用SpringBoot开发一个POST接口

使用,springboot,开发,一个,post,接口 · 浏览次数 : 85

小编点评

**标题:Spring Boot 响应 XML 请求** **概述:** 文章展示了如何使用 Spring Boot 响应 XML 请求。通过创建 Service 和 Controller,并使用 CreateNumberService 类来处理请求体,将 XML 数据转换为响应报文并返回给客户端。 **代码:** **Service:CreateNumberService.java** ```java @Servicepublic class CreateNumberService { private static final String XML_HEAD = ...; public String createService(ProjectNumberRequest request) { // ... } } ``` **Controller:CreateNumberController.java** ```java @RestController @RequestMapping("/api/") public class CreateNumberController { @Resource private CreateNumberService numberService; @PostMapping(value = "/number", produces = MediaType.APPLICATION_XML_VALUE) public String createNumber(@RequestBody ProjectNumberRequest request) { return numberService.createService(request); } } ``` **文章内容:** * 文章介绍了 Spring Boot 响应 XML 请求。 * 它展示了如何创建 Service 和 Controller,并使用 CreateNumberService 类来处理请求体。 * 文章还展示了如何将 XML 数据转换为响应报文并返回给客户端。 * 文章提供了代码示例,包括 Service 和 Controller 的代码。 * 文章还提供了文章中的代码的总结。 **结论:** 文章展示了如何使用 Spring Boot 响应 XML 请求。通过创建 Service 和 Controller,并使用 CreateNumberService 类来处理请求体,将 XML 数据转换为响应报文并返回给客户端。

正文

SpringBoot项目的分层

SpringBoot框架项目一般分为五层:

  • View层:向用户展示页面

  • Controller层:前后端交互层,接收前端请求,调用Service层中的方法,接收Service层返回的数据并将其返回到前端。

  • Service层:存放业务处理的逻辑,以及一些操作数据库的接口

  • Mapper层:也可以成为DAO层,是数据库CRUD的接口,只有方法名,具体实现在mapper.xml文件中,对数据库进行数据持久化操作

  • Entity层:存放实体类,与数据库中的属性基本保持一致。

实现一个最简单的POST接口

一个最简单的POST接口,只需要在Controller层中声明一个RestController类,随后在类中使用PostMapping注解,表明这是一个POST接口,并填写相关方法即可,如下所示:

@RestController
@RequestMapping("/api")
public class CreateNumberController {
    @PostMapping("/number")
    public String createNumber(@RequestParam String param1, @RequestParam int param2) {
        // 处理POST请求的代码
        return "success";
    }
}

运行程序后,使用Postman向http://localhost:8000/api/number发送POST请求,输入相应请求参数,得到接口响应:

基础接口响应

将接口连接事务处理逻辑函数

实际业务中的接口肯定不仅仅是如同上面的示例那么简单的一个函数,程序内部对于接收到的数据会有一定的逻辑处理。

接下来列出一个实际的业务场景:

需求

现在需要一个接口用于按照一定规则为项目赋予项目编码,项目请求内容为xml报文,例如:

<?xml version="1.0" encoding="UTF-8"?>
<name>Example Project</name>
<operate>01</operate>
<source>A</source>
<status>01</status>

当请求参数operate是1时为新增项目编码,请求参数source是A、B、C时,项目编码为Axxxx,“xxxx”为四位包含「09的10个阿拉伯数字」和「AZ的26个大写英文字母」共同组成的流水码次序为:0/1/2/3/4/5/6/7/8/9/A/B/C/D~/X/Y/Z,增加2条约束:

①第5位、第4位与第3位从000开始取值,第2位从B开始取值,即初始编码为:AB000;第5位至第2位,每一位的取值范围为「09的10个阿拉伯数字」和「AZ的24个大写英文字母(26个字母中去除I和O)」的34个字符,顺序依次为0/1/2/3/4/5/6/7/8/9/A/B/C/D~/X/Y/Z,此时“xxxx”为34进制的4位数。第5位0至Z循环一周期后即向第4位进1,第4位循环一周期后即向第3位进1,第3位循环一周期后向第2位进1。

②第2位除了I和O之外,A、C、Z也不可取,循环取值从B开始至A结束,依次为B/D…G/H/J/K…M/N/P…X/Y/0/1…9共计31个字符。

要求返回值为xml报文,形式为:

<?xml version="1.0" encoding="UTF-8"?>
<number>AB000</number>
<status>01</status>

由于暂未规定如何校验重复编码(这个需要用到数据库查询,在接下来的部分继续补充),因此可以将需求简单理解为:接收一个xml报文,按照规则生成一个编码,返回编码。

这时接口的输入和输出都是xml报文,仅仅依靠简单的Controller已经不能满足需求了,需要将输入报文进行处理拆分对应的参数,依靠Service对输入数据进行处理,使用函数生成符合要求的输出,并最终封装成xml报文返回。

POST接口接收XML报文

通常来说,在进行接口设计时思考问题是自顶向下的,即“接口可以接收并解析请求体→调用Service使用请求体中的数据运行业务逻辑→将得到的结果封装完成响应”。但实际的开发步骤是:根据需求明确请求体和响应体包括哪些属性以及这些属性的数据类型,构造请求类与响应类→新增Service类编写请求类的处理逻辑和响应类的生成逻辑→新增Controller类添加POST接口可以接收XML报文并在经过Service处理后返回XML报文。

导入相关依赖

处理xml报文需要Gradle导入jackson-dataformat-xml依赖,为保证项目的可迁移性与可复用性,放弃引入Lombok。

在Maven仓库(例如https://mvnrepository.com/)中搜索jackson-dataformat-xml依赖,选择Gradle,将下面这行复制进build.gradle的dependencies部分:

implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-xml:2.15.2'

Jackson库会自动将XML元素映射到同名的Java属性。

导入到Gradle

创建Request类和Response类

根据请求报文,在Controller文件夹中新增ProjectNumberRequest类和ProjectNumberResponse类,分别如下:

ProjectNumberRequest.java

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;

public class ProjectNumberRequest {
    private String name;
    private String operate;
    private String source;
    private String status;
    
    //get方法
    public String getName() {
        return this.name;
    }
    public String getOperate() {
        return this.operate;
    }
    public String getSource() {
        return this.source;
    }
    public String getStatus() {
        return this.status;
    }
    
    //set方法
    public void setName(String projectName) {
        this.name = projectName;
    }
    public void setOperate(String projectOperate) {
        this.operate = projectOperate;
    }
    public void setSource(String projectSource) {
        this.source = projectSource;
    }
    public void setStatus(String projectStatus) {
        this.status = projectStatus;
    }
}

ProjectNumberResponse.java

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;

@JacksonXmlRootElement(localName = "response")
public class ProjectNumberResponse {
    private String number;
    private String status;

    //get方法
    public String getNumber() {
        return this.number;
    }
    public String getStatus() {
        return this.status;
    }

    //set方法
    public void setNumber(String number) {
        this.number = number;
    }
    public void setStatus(String projectStatus) {
        this.status = projectStatus;
    }
}

注意:诸如@JacksonXmlRootElement(localName = "response")的注解可以将XML的根节点重命名为response,如果不添加注解则XML文件根节点名称默认使用类名。

编写业务逻辑

在Service文件夹下新增CreateNumberService类,用于处理请求报文的请求体,并按照一定规则生成项目编码和项目状态这两个属性,将其转换为XML文件,组成响应报文的响应体。

CreateNumberService包括两部分,第一部分是response对象生成函数,用于创建响应体对象,第二部分是XML对象生成函数,用于将response对象封装成XML对象。

CreateNumberService.java

import com.fasterxml.jackson.dataformat.xml.XmlMapper;
import org.springframework.stereotype.Service;
import studio.tsukistar.demo.Controller.ProjectNumberRequest;
import studio.tsukistar.demo.Controller.ProjectNumberResponse;

import java.util.Objects;
@Service
public class CreateNumberService {
    private static final String XML_HEAD = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n";
    
    public String createService(ProjectNumberRequest request) { //构建response对象
        ProjectNumberResponse response = new ProjectNumberResponse();
        response.setNumber( "AB000" );
        response.setStatus(request.getStatus());
        return javaBeanToXml (response);
    }
    
    public static String javaBeanToXml(Object obj) { //将Object转换为xml形式
        String xml= "";
        if (Objects.isNull(obj)) {
            return xml;
        }
        
        try {
            XmlMapper xmlMapper = new XmlMapper();
            xml = xmlMapper.writeValueAsString(obj);
        } catch (Exception e) {
            return "";
        }
        
        return XML_HEAD + xml;
    }
}

编写控制器

在Controller文件夹下新增CreateNumberController类,设置请求体传入类型为XML格式,返回经过CreateNumberService处理请求体后得到的响应报文。

CreateNumberController.java

import jakarta.annotation.Resource;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import studio.tsukistar.demo.Service.CreateNumberService;

@RestController
@RequestMapping("/api")
public class CreateNumberController {
    @Resource
    private CreateNumberService numberService;

    @PostMapping(value="/number", produces = MediaType.APPLICATION_XML_VALUE)
    public String createNumber(@RequestBody ProjectNumberRequest request) { // 处理POST请求的代码
        return numberService.createService(request);
    }
}

运行测试

运行程序后,使用Postman向http://localhost:8000/api/number发送POST请求,在“Body”中选择“raw-XML”,填入请求体:

<?xml version="1.0" encoding="UTF-8" ?>
<request>
    <name>测试</name>
    <operate>01</operate>
    <source>A</source>
    <status>01</status>
</request>

点击“Send”可以得到接口的响应报文,如下图所示:

测试结果

总结

相较于上次,这段时间新学习了POST接口的开发方式、项目分层、各层之间的交互等内容,对SpringBoot框架也有了更深入的了解(也许?希望不要误入歧途)。代码也一并传到了github仓库中,向前迈进了一大步。

本文多数开发知识来源于Bing AI,若有错误之处请各位dalao多多赐教,不胜感激!

参考文章

与使用SpringBoot开发一个POST接口相似的内容:

使用SpringBoot开发一个POST接口

接着上一篇,开始根据需求开发一个POST接口。

在deepin上使用Fleet开发SpringBoot 3.0.0项目

出于对新工具和新技术的好奇,我开始尝试在deepin上用Fleet开发一个SpringBoot 3.0.0项目,继续我的SpringBoot学习。

6步带你用Spring Boot开发出商城高并发秒杀系统

摘要:本博客将介绍如何使用 Spring Boot 实现一个简单的商城秒杀系统,并通过使用 Redis 和 MySQL 来增强其性能和可靠性。 本文分享自华为云社区《Spring Boot实现商城高并发秒杀案例》,作者:林欣。 随着经济的发展和人们消费观念的转变,电子商务逐渐成为人们购物的主要方式之

使用SpringBoot+React搭建一个Excel报表平台

> 摘要:本文由葡萄城技术团队于博客园原创并首发。转载请注明出处:[葡萄城官网](https://www.grapecity.com.cn/),葡萄城为开发者提供专业的开发工具、解决方案和服务,赋能开发者。 # 前言 Excel报表平台是一款功能强大、操作简单的系统平台,可以帮助用户上传、编辑和分析

3分钟带你搞定Spring Boot中Schedule

一、背景介绍 在实际的业务开发过程中,我们经常会需要定时任务来帮助我们完成一些工作,例如每天早上 6 点生成销售报表、每晚 23 点清理脏数据等等。 如果你当前使用的是 SpringBoot 来开发项目,那么完成这些任务会非常容易! SpringBoot 默认已经帮我们完成了相关定时任务组件的配置,

[转帖]springboot中使用skywalking实现日志追踪

文章目录 SkyWalking分布式追踪系统介绍主要架构 环境引入依赖配置Log4j2下载编译好的8.7.0版本包使用探针实现日志追踪启动脚本启动Java服务访问服务 使用UI切换存储方式 SkyWalking分布式追踪系统 介绍 Skywalking是一个国产的开源框架,2015年有吴晟个人开源,

SpringBoot内置tomcat启动过程及原理

作者:李岩科 1 背景 SpringBoot 是一个框架,一种全新的编程规范,他的产生简化了框架的使用,同时也提供了很多便捷的功能,比如内置 tomcat 就是其中一项,他让我们省去了搭建 tomcat 容器,生成 war,部署,启动 tomcat。因为内置了启动容器,应用程序可以直接通过 Mave

springboot升级过程中踩坑定位分析记录 | 京东云技术团队

因所负责的系统使用的spring框架版本5.1.5.RELEASE在线上出过一个偶发的小事故,最后定位为spring-context中的一个bug导致的。

SpringBoot+mail 轻松实现各类邮件自动推送

一、简介 在实际的项目开发过程中,经常需要用到邮件通知功能。例如,通过邮箱注册,邮箱找回密码,邮箱推送报表等等,实际的应用场景非常的多。 早期的时候,为了能实现邮件的自动发送功能,通常会使用 JavaMail 相关的 api 来完成。后来 Spring 推出的 JavaMailSender 工具,进

一站式统一返回值封装、异常处理、异常错误码解决方案—最强的Sping Boot接口优雅响应处理器

Graceful Response是一个Spring Boot体系下的优雅响应处理器,提供一站式统一返回值封装、异常处理、异常错误码等功能。使用Graceful Response进行web接口开发不仅可以节省大量的时间,还可以提高代码质量,使代码逻辑更清晰。