当前位置: 开发笔记 > 编程语言 > 正文

javarestful接口开发_SpringBootrestfulapi接口设计,全局JOSN格式交互

作者：小小号号-- | 来源：互联网 | 2023-10-11 11:44

SpringBootrestfulapi接口设计以及统一响应JSON格式包含所有错误的JSON，统一异常不使用切面RESTfulAPI最佳实践作为一个java后端开发

SpringBoot restful api接口设计以及统一响应JSON格式包含所有错误的JSON&＃xff0c;统一异常不使用切面

RESTful API 最佳实践作为一个 java后端开发人员&＃xff0c;前后端分离的时代&＃xff0c;我更专注于后端的开发&＃xff1b;专业的人做专业的事

前后端分离&＃xff0c;也需要前后端人员相互联调&＃xff0c;为了更好的交互&＃xff0c;统一一个设计规范&＃xff1b;

1、Http的常用请求方法MethodGET 一搬用于获取数据

POST 用于提交数据

PUT 用于修改数据

DELETE 用于删除数据

2、Restful api 常用的几个注解&＃64;RestController 一般用于Controoler类上

&＃64;ResponseBody 用了这个 RestController 就没有必要 ResponseBody

&＃64;GetMapping 方法上

&＃64;PostMapping 方法上

&＃64;PutMapping 方法上

&＃64;DeleteMapping 方法上

比如一个Controller 的简单增删改查四个接口

&＃64;RestController

&＃64;RequestMapping("/oftenReciver")

public class OftenReciverController extends BaseController {

&＃64;Autowired

IOftenReciverService thisService;

&＃64;Autowired

AppAuthTokenHandler tokenHandler;

&＃64;GetMapping

public R list()

{

return success(thisService.findList(page(new OrderBy(OrderBy.Direction.DESC,"rec.update_time")), tokenHandler.getAppUserId()));

}

&＃64;PostMapping

public R insertSave(OftenReciver entity){

return result(thisService.save(entity));

}

&＃64;PutMapping

public R editSave(OftenReciver entity){

return result(thisService.updateById(entity));

}

&＃64;GetMapping("/selectById/{id}")

public R selectById(&＃64;PathVariable("id") String id){

return success(thisService.getById(id));

}

&＃64;DeleteMapping("remove/{ids}")

public R delete(&＃64;PathVariable("id") List ids)

{

return result(thisService.removeByIds(ids));

}

这就是简单的 restful 风格的api了&＃xff0c;但是restful风格的api,还不够&＃xff0c;我们前后端分离开发的&＃xff0c;都要统一一个规范&＃xff0c;也就是数据格式&＃xff0c;为了更方便的前后端的数据对接&＃xff0c;减少前后端干架的可能性

3、设计固定数据JSON格式:

所以我们得设计一个固定的数据格式&＃xff1a;比如这个样的

JSON 格式:

{

code:0,

msg:&＃39;操作成功&＃39;,

data:null

}

{

code:1,

msg:&＃39;系统异常&＃39;,

data:null

}

{

code:2,

msg:&＃39;参数绑定失败&＃39;,

data:null

}

{

code:404,

msg:&＃39;路径不存在&＃39;,

data:null

}

{

code:401,

msg:&＃39;用户未登陆&＃39;,

data:null

}

........

那么我们定义一个类做封装

R.java:

&＃64;Data

public class R

{

private static final int SUCCESS_CODE &＃61; 0;

private static final int ERROR_CODE &＃61; 1;

private static final String SUCCESS_R &＃61; "操作成功&＃xff01;";

private static final String ERROR_R &＃61; "操作失败&＃xff01;";

private int code;

private String msg;

private Object data;

public R() {}

public static R success()

{

R r &＃61; new R();

r.setCode(SUCCESS_CODE);

r.setMsg(SUCCESS_R);

return r;

}

public static R success(Object data)

{

R r &＃61; new R();

r.setCode(SUCCESS_CODE);

r.setMsg(SUCCESS_R);

r.setData(data);

return r;

}

public static R success(String msg)

{

R r &＃61; new R();

r.setCode(SUCCESS_CODE);

r.setMsg(msg);

return r;

}

// public static R error()

// {

// R r &＃61; new R();

// r.setCode(ERROR_CODE);

// r.setMsg(ERROR_R);

// return r;

// }

public static R error(Error error, String tip)

{

if (StringUtils.isNotBlank(tip) || StringUtils.isNotNull(tip))

{

tip &＃61; "&＃xff0c;" &＃43; tip;

}

else

{

tip &＃61; "";

}

return error(error.getCode(), error.getErrMsg() &＃43; tip);

}

public static R error(Error error)

{

return error(error, null);

}

public static R error(int code, String msg)

{

R r &＃61; new R();

r.setCode(code);

r.setMsg(msg);

return r;

}

4、定义错误枚举

为了更加规范接口&＃xff0c;我又定义了一个错误的枚举&＃xff0c;主要是为了统一错误类型&＃xff0c;让前端更好做判断

长这样的 Error.java:

public enum Error

{

操作失败(-1, "操作失败"),

系统异常(1, "系统异常"),

参数为空异常(2, "参数为空异常"),

参数异常(14, "参数异常"),

参数绑定异常(3, "参数绑定异常"),

文件上传异常(4, "文件上传异常"),

请求方式错误(5, "请求方式不支持"),

请求路径异常(6, "请检查url是否正确"),

权限异常(7, "权限不足"),

未登陆异常(9, "尚未登陆"),

微信接口异常(10, "微信接口异常"),

数据解析异常(11, "数据解析异常"),

Http接口响应异常(12, "数据解析异常"),

请求凭证有误(13, "请求凭证有误");

private int code;

private String errMsg;

public int getCode()

{

return code;

}

public void setCode(int code)

{

this.code &＃61; code;

}

public String getErrMsg()

{

return errMsg;

}

public void setErrMsg(String errMsg)

{

this.errMsg &＃61; errMsg;

}

Error(int code, String errMsg)

{

this.code &＃61; code;

this.errMsg &＃61; errMsg;

}

这样子在controller 就能固定的响应错误的类型以及我们设定好的 code与类型对应了

例如这样子的&＃xff1a;

&＃64;PostMapping("/takePro")

public R takePro(&＃64;RequestParam("commodityId") Integer id)

{

Commodity commodity &＃61; thisService.getById(id);

isNull(Error.参数异常);

int code &＃61; 0;

if (StringUtils.isNull(commodity.getTakeCode()))

{

code &＃61; (int) ((Math.random() * 9 &＃43; 1) * 1000);

commodity.setTakeCode(code);

commodity.setTakeUserId(getCurrentUserId());

thisService.updateById(commodity);

}else {

return error(Error.操作失败,"已被领取");

}

return success(getMap(Constanst.TAKE_CODE, code));

}

5、自定义全局异常响应统一格式数据

GlobalExceptionHandler.java:

/**

* &＃64;author 永健

* &＃64;since 2019-05-23 19:32

&＃64;RestControllerAdvice

public class GlobalExceptionHandler extends BaseException

{

private static final Logger logger &＃61; LoggerFactory.getLogger(GlobalExceptionHandler.class);

/**

* 参数绑定错误

&＃64;ExceptionHandler(MissingServletRequestParameterException.class)

public R handleRRException(MissingServletRequestParameterException e)

{

return R.error(Error.参数绑定异常,"参数绑定失败&＃xff0c;请求参数异常");

}

/**

* GET,POST 等方法

&＃64;ExceptionHandler(HttpRequestMethodNotSupportedException.class)

public R handleRRException(HttpRequestMethodNotSupportedException e)

{

return R.error(Error.请求方式错误,"请求方式不对&＃xff0c;换个姿势再来&＃xff01;&＃64;_&＃64; ,试试 /GET/POST/PUT...");

}

/**

* 处理自定义异常

&＃64;ExceptionHandler(MyException.class)

public R handleRRException(MyException e)

{

return R.error(e.getCode(), e.getMsg());

}

/**

* 处理自定义异常

&＃64;ExceptionHandler(Exception.class)

public R handleException(Exception e)

{

e.printStackTrace();

return R.error(Error.系统异常,"服务器错误");

}

&＃64;ExceptionHandler(NoHandlerFoundException.class)

public R handlerNoFoundException(Exception e)

{

e.printStackTrace();

logger.error(e.getMessage(), e);

return R.error(Error.请求路径异常, "路径不存在&＃xff0c;请检查路径是否正确");

}

&＃64;ExceptionHandler(DataIntegrityViolationException.class)

public R handleDuplicateKeyException(DataIntegrityViolationException e)

{

e.printStackTrace();

logger.error(e.getMessage(), e);

return R.error(Error.系统异常,"操作数据库出现异常&＃xff1a;字段重复、有外键关联等");

}

/**

* 权限异常

&＃64;ExceptionHandler({UnauthorizedException.class, AuthorizationException.class})

public R unauthorizedException(UnauthorizedException e)

{

e.printStackTrace();

logger.error(e.getMessage(), e);

return R.error(Error.权限异常);

}

这货我们也统一用封装的&＃96;R.java来处理&＃96; 这样子自定义异常以及所有的异常都能统一拦截处理响应了

6、自定义异常类封装

&＃96;MyException.java&＃96;:

/**

* &＃64;author 永健

* &＃64;since 2019-05-23 19:32

public class MyException extends RuntimeException

{

private static final long serialVersionUID &＃61; 1L;

private String msg;

private Error error;

private int code &＃61; 1;

public MyException(Error error)

{

super(error.getErrMsg());

this.code &＃61; error.getCode();

this.msg &＃61; error.getErrMsg();

}

public MyException(Error error, String msg)

{

super(msg);

this.code &＃61; error.getCode();

this.msg &＃61; error.getErrMsg() &＃43; "," &＃43; msg;

}

public String getMsg()

{

return msg;

}

public MyException setMsg(String msg)

{

this.msg &＃61; msg;

return this;

}

public int getCode()

{

return code;

}

public MyException setCode(int code)

{

this.code &＃61; code;

return this;

}

public Error getError()

{

return error;

}

public void setError(Error error)

{

this.code &＃61; error.getCode();

this.msg &＃61; error.getErrMsg();

this.error &＃61; error;

}

自定义异常类&＃xff0c;的参数也只限定自定义的Error.java 这样子自定义的异常抛出 &＃xff0c;在GlobalExceptionHandler.java中处理&＃xff0c;转换成 R.java的数据格式&＃xff0c;这样子就达到了统一处理了&＃xff0c;其它的异常都可以在这里拦截

7、404 异常配置

&＃96;1.application.yml 配置&＃xff1a;&＃96;

spring:

mvc:

### 让mvc直接抛出异常&＃xff0c;在全局异常类&＃xff0c;捕获404 异常的类 NoHandlerFoundException.class

throw-exception-if-no-handler-found: true

### 关闭资源映射

resources:

add-mappings: false

在全局异常类&＃xff0c;捕获404 异常的类 NoHandlerFoundException.class,然后写上我们异常的数据&＃xff0c;这样子前端更简洁明了了。

8、写一个BaseControoler 来放置一些常用的函数

public abstract class BaseController

{

/**

* 返回成功

protected R success()

{

return R.success();

}

/**

* 返回失败消息

protected R error(Error error)

{

return R.error(error);

}

protected R error()

{

return R.error(Error.操作失败);

}

/**

* 返回失败消息

protected R error(Error error, String msg)

{

return R.error(error, msg);

}

/**

* 返回成功消息

protected R successMsg(String message)

{

return R.success(message);

}

/**

* 返回成功消息

protected R success(Object data)

{

return R.success(data);

}

/**

* 根据修改搜影响的行数返回结果

protected R result(boolean flag)

{

return flag &＃61;&＃61; true ? success() : error(Error.操作失败);

}

protected R result(boolean flag, String msg)

{

return flag &＃61;&＃61; true ? successMsg(msg) : error(Error.操作失败);

}

protected R result(int row)

{

return row > 0 ? success() : error(Error.操作失败);

}

protected R result(int row, String msg)

{

return row > 0 ? successMsg(msg) : error(Error.操作失败);

}

/**

* 分页数据默认使用更新时间降序

protected Page page(OrderBy orderBy)

{

return getPage(orderBy);

}

protected Page page(OrderBy orderBy, int current, int size)

{

Page page &＃61; getPage(orderBy);

page.setSize(size);

page.setCurrent(current);

return page;

}

/**

* 自定义分页数据默认使用更新时间降序

protected Page page()

{

return getPage(new OrderBy(OrderBy.Direction.DESC, "update_time"));

}

/**

* 自定义分页条件

private Page getPage(OrderBy orderBy)

{

Integer size &＃61; ServletUtils.getParamInteger("size");

if (size !&＃61; null && size &＃61;&＃61; -1)

{

size &＃61; Integer.MAX_VALUE;

}

Integer pageNum &＃61; ServletUtils.getParamInteger("current");

Page page &＃61; new Page<>(pageNum &＃61;&＃61; null ? 0 : pageNum, size &＃61;&＃61; null ? 15 : size);

if (orderBy.getDirection().isAscending())

{

page.setAsc(orderBy.getColumns());

}

else

{

page.setDesc(orderBy.getColumns());

}

return page;

}

/**

* 设置查询参数

protected Wrapper setParams(T t)

{

return new QueryWrapper().lambda().setEntity(t);

}

protected void out(String str, HttpServletResponse response)

{

ServletOutputStream outputStream &＃61; null;

try

{

outputStream &＃61; response.getOutputStream();

outputStream.write(str.getBytes());

outputStream.flush();

}

catch (IOException e)

{

e.printStackTrace();

}

finally

{

try

{

if (outputStream !&＃61; null)

{

outputStream.close();

}

catch (IOException e)

{

e.printStackTrace();

}

protected Map getMap()

{

return new HashMap(8);

}

protected Map getMap(Object key, Object val)

{

Map map &＃61; new HashMap(8);

map.put(key, val);

return map;

}

protected AppAuthTokenHandler tokenHandler(){

return BeanTool.getInstance(AppAuthTokenHandler.class);

}

protected User getCurrentUser(){

return tokenHandler().getUser();

}

protected Integer getCurrentUserId(){

return tokenHandler().getUserId();

}

比如我们的 Mybastis-plus 的分页封装可以放在这里用&＃xff0c;

map 的获取&＃xff0c;当前登陆的用户信息等等

**这样子我们可以不使用切面也一样可以捕获所有的异常哦**

推荐阅读

io
Django Token 认证详解与 HTTP 401、403 状态码的区别

本文详细介绍了如何在 Django 中配置和使用 Token 认证，并解释了 HTTP 401 和 HTTP 403 状态码的区别。通过具体的代码示例，帮助开发者理解认证机制及权限控制。 ... [详细]

蜡笔小新 2024-12-20 15:43:37
io
Python + Pytest 接口自动化测试中 Token 关联登录的实现方法

本文将深入探讨 Python 和 Pytest 在接口自动化测试中如何实现 Token 关联登录，内容详尽、逻辑清晰，旨在帮助读者掌握这一关键技能。 ... [详细]

蜡笔小新 2024-12-21 14:48:49
io
SpringMVC RestTemplate的几种请求调用(转)

SpringMVCRestTemplate的几种请求调用(转),Go语言社区,Golang程序员人脉社 ... [详细]

蜡笔小新 2024-12-20 19:05:12
go
理解远程过程调用 (RPC) 的概念与演变

远程过程调用（RPC）是一种允许客户端通过网络请求服务器执行特定功能的技术。它简化了分布式系统的交互，使开发者可以像调用本地函数一样调用远程服务，并获得返回结果。本文将深入探讨RPC的工作原理、发展历程及其在现代技术中的应用。 ... [详细]

蜡笔小新 2024-12-20 15:12:33
io
优化C++项目中的JSON处理：选择高性能的RapidJSON库

在高并发需求的C++项目中，我们最初选择了JsonCpp进行JSON解析和序列化。然而，在处理大数据量时，JsonCpp频繁抛出异常，尤其是在多线程环境下问题更为突出。通过分析发现，旧版本的JsonCpp存在多线程安全性和性能瓶颈。经过评估，我们最终选择了RapidJSON作为替代方案，并实现了显著的性能提升。 ... [详细]

蜡笔小新 2024-12-21 18:13:59
io
yikesnews第11期：微软Office两个0day和一个提权0day

点击阅读原文可点击链接根据法国大选被黑客干扰，发送了带漏洞的文档Trumps_Attack_on_Syria_English.docx而此漏洞与ESET&FireEy ... [详细]

蜡笔小新 2024-12-21 16:24:32
io
ElasticSearch 集群监控与优化

本文详细介绍了如何有效地监控 ElasticSearch 集群，涵盖了关键性能指标、集群健康状况、统计信息以及内存和垃圾回收的监控方法。 ... [详细]

蜡笔小新 2024-12-21 13:43:04
io
初探七牛云存储：实现多服务器图片共享

为了解决不同服务器间共享图片的需求，我们最初考虑建立一个FTP图片服务器。然而，考虑到项目是一个简单的CMS系统，为了简化流程，团队决定探索七牛云存储的解决方案。本文将详细介绍使用七牛云存储的过程和心得。 ... [详细]

蜡笔小新 2024-12-21 13:15:50
io
ssm 框架整合及工程分层

ssm框架整合及工程分层1.先创建一个新的project1.1配置pom.xml ... [详细]

蜡笔小新 2024-12-21 12:56:58
io
深入解析RDMA中的队列对（Queue Pair）

本文将详细探讨RDMA架构中的关键组件——队列对（Queue Pair，简称QP），包括其基本概念、硬件与软件实现、QPC的作用、QPN的分配机制以及用户接口和状态机。通过这些内容，读者可以更全面地理解QP在RDMA通信中的重要性和工作原理。 ... [详细]

蜡笔小新 2024-12-21 11:16:36
io
Sinatra与Ramaze：选择轻量级Ruby框架时的考量

在寻找轻量级Ruby Web框架的过程中，您可能会遇到Sinatra和Ramaze。两者都以简洁、轻便著称，但它们之间存在一些关键区别。本文将探讨这些差异，并提供详细的分析，帮助您做出最佳选择。 ... [详细]

蜡笔小新 2024-12-20 11:00:15
io
全国天气预报API，提供五天天气数据的JSON接口

近期我们开发了一款包含天气预报功能的万年历应用，为了满足这一需求，团队花费数日时间精心打造并测试了一个稳定可靠的天气API接口，现正式对外开放。 ... [详细]

蜡笔小新 2024-12-19 17:40:09
io
解决 addStringBody 方法失效问题

探讨在使用 Fast-Android-Networking 库时遇到的 addStringBody 方法无法正常工作的问题及其解决方案。 ... [详细]

蜡笔小新 2024-12-19 11:20:38
io
Feign远程调用请求头丢失问题分析与解决方案

本文详细探讨了在微服务架构中，使用Feign进行远程调用时出现的请求头丢失问题，并提供了具体的解决方案。重点讨论了单线程和异步调用两种场景下的处理方法。 ... [详细]

蜡笔小新 2024-12-19 10:17:16
io
Spring Cloud学习指南：深入理解微服务架构

本文介绍了微服务架构的基本概念及其在Spring Cloud中的实现。讨论了微服务架构的主要优势，如简化开发和维护、快速启动、灵活的技术栈选择以及按需扩展的能力。同时，也探讨了微服务架构面临的挑战，包括较高的运维要求、分布式系统的复杂性、接口调整的成本等问题。最后，文章提出了实施微服务时应遵循的设计原则。 ... [详细]

蜡笔小新 2024-12-19 09:25:36

小小号号--

这个家伙很懒，什么也没留下！

Tags | 热门标签

RankList | 热门文章