SpringBoot 后端接口规范

Fq琦琦

已于 2023-07-25 16:00:29 修改

阅读量158

点赞数

分类专栏： springboot 基础入门文章标签： spring boot 后端

于 2023-07-25 13:59:21 首次发布

本文链接：https://blog.csdn.net/weixin_40879055/article/details/131913382

版权

SpringBoot 后端接口规范

1.接口规范

一个后端接口大致分为四个部分组成：接口地址（url）、接口请求方式（get、post等）、请求数据（request）、响应数据（response）

2.环境依赖

后端接口，所以需要导入一个 spring-boot-starter-web 包，而 lombok 作用是简化类，前端显示则使用了 knife4j，具体使用在 Spring Boot 整合 knife4j 实现 API 文档已写明。另外从 springboot-2.3 开始，校验包被独立成了一个 starter 组件，所以需要引入如下依赖：

<dependency>
<!--新版框架没有自动引入需要手动引入-->
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <!--在引用时请在maven中央仓库搜索最新版本号-->
    <version>2.0.2</version>
</dependency>

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

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

3.参数校验

3.1 介绍

一个接口一般对参数（请求数据）都会进行安全校验，参数校验的重要性自然不必多说;
对参数进行校验, 一般来说有三种常见的校验方式，常用（最简洁的第三种方法）

业务层校验
Validator + BindResult 校验
Validator + 自动抛出异常

（1）业务层校验，即在 Java 的 Service 层进行数据校验判断。缺点：太繁琐了，光校验代码就会有很多。
（2）使用 Validator+ BindingResult 已经是非常方便实用的参数校验方式了，在实际开发中也有很多项目就是这么做的。缺点：每写一个接口都要添加一个 BindingResult 参数，然后再提取错误信息返回给前端（简单看一下）。

@PostMapping("/addUser")
public String addUser(@RequestBody @Validated User user, BindingResult bindingResult) {
   
    // 如果有参数校验失败，会将错误信息封装成对象组装在BindingResult里
    List<ObjectError> allErrors = bindingResult.getAllErrors();
    if(!allErrors.isEmpty()){
   
        return allErrors.stream()
            .map(o