Web应用开发大作业项目记录（2）接口规范的制定与通用类的设计

最新推荐文章于 2024-09-05 14:56:55 发布

Noelle Mu

最新推荐文章于 2024-09-05 14:56:55 发布

阅读量232

点赞数

本文链接：https://blog.csdn.net/weixin_43887447/article/details/109605829

版权

本文介绍了在Web应用开发中，如何制定接口规范，包括统一的返回对象和异常定义。同时，讨论了抽象VO的使用，分页查询的通用类设计，以及统一返回对象创建的工具类和全局异常处理的方法。这些实践有助于提升项目的可维护性和前后端交互的效率。

摘要由CSDN通过智能技术生成

Web应用开发大作业项目记录（2）接口规范的制定与通用类的设计

本文同时也发表在我的个人网站：www.wendev.site，欢迎前往我的个人网站阅读。

Reference

这次使用的很多项目搭建方法都参考了这篇文章：一份Spring Boot项目搭建模板，作者真的是太强了，感谢作者的无私奉献。

接口规范：统一返回对象

因为是半前后端分离的项目，页面中几乎所有的数据都是走接口的，所以需要有一个统一的返回格式以便前端进行调用。这里因为后面要做对这个对象的统一创建的工具类，所以没有使用泛型：

package site.wendev.qikebao.common;

import lombok.Data;
import lombok.experimental.Accessors;

/**
 * @author 江文
 * @since 2020/10/28 8:52 下午
 */
@Data
@Accessors(chain = true)
public class Response {
   
    /** 错误码，为0则成功 */
    private Integer code;

    /** 提示信息 */
    private String message;

    /** 返回数据 */
    private Object data;
}

接口规范：统一异常定义

Web应用中少不了异常，对异常也进行统一的处理是很重要的。我们使用枚举定义一些可能发生的异常种类及其所对应的错误码，以便在发生异常的时候可以方便地返回具体的异常信息：

package site.wendev.qikebao.enums;

import lombok.Getter;

/**
 * 错误码枚举类
 *
 * @author 江文
 * @since 2020/10/29 8:06 下午
 */
@Getter
public enum ErrorEnum {
   
    // 没有登录
    AUTH_FAILURE(-2),
    // 参数校验失败
    CHECK_FAILURE(-1),
    // 添加数据失败
    ADD_ERROR(1),
    // 更新数据失败
    UPDATE_ERROR(2),
    // 查找数据失败
    GET_ERROR(3),
    // 删除失败
    DELETE_ERROR(4),
    // 未知异常
    UNKNOWN_EXCEPTION(99);