Java前后端分离后台返回统一对象

最新推荐文章于 2022-12-10 18:20:47 发布
最新推荐文章于 2022-12-10 18:20:47 发布
阅读量251 收藏
点赞数
分类专栏： Java返回
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_54889617/article/details/119049085
版权

1:pom文件

 <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>
    <dependencies>
        <!--web依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--lombok依赖-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <!--mysql依赖-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

        <!--mybatis-plus依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.3.1.tmp</version>
        </dependency>


        <!--引入springAOP依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

        <!--swagger依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>

        <!--swaggerUI依赖-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

        <!--easypoi导入导出excel-->
        <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-spring-boot-starter</artifactId>
            <version>4.1.3</version>
        </dependency>

        <!--测试-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>

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

        <!--JJWT-->
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt</artifactId>
            <version>0.9.0</version>
        </dependency>

        <!-- redis依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

        <!--对象池-->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

        <!--谷歌登录验证码-->
        <dependency>
            <groupId>com.github.axet</groupId>
            <artifactId>kaptcha</artifactId>
            <version>0.0.9</version>
        </dependency>

        <!--使用阿里数据源-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.10</version>
        </dependency>

        <!-- RabbitMQ依赖 -->
        <dependency>
            <groupId>com.rabbitmq</groupId>
            <artifactId>amqp-client</artifactId>
        </dependency>

        <!--springboot整合RabbitMQ依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-amqp</artifactId>
        </dependency>

        <!-- valid校验注解 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

    </dependencies>
    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

2:IResultCode接口

package com.qycq.server.utils;


import io.swagger.annotations.ApiModel;

/**
 * @author 七月初七
 * @version 1.0
 * @date 2021/7/18 20:56
 */
@ApiModel(value = "获取状态码和消息")
public interface IResultCode {
    /**
     * 获取状态码
     *
     * @return
     */
    Integer getCode();

    /**
     * 获取消息
     *
     * @return
     */
    String getMessage();

}

3:返回信息枚举类

package com.qycq.server.enums;

import com.qycq.server.utils.IResultCode;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

/**
 * @author 七月初七
 * @version 1.0
 * @date 2021/7/18 20:58
 */
@ApiModel(value = "枚举类,用于返回异常信息")
public enum ResultEnum implements IResultCode {

    SUCCESS(200, "操作成功!"),
    ERROR_500(500, "服务器内部异常!"),
    ERROR_IO_500(500, "io异常!"),
    ERROR_SQL_500(500, "sql语句异常!"),
    ERROR_201(201, "数据重复,请检查!"),
    ERROR_401(401, "尚未登陆,请登录!"),
    ERROR_403(403, "权限不足,请联系管理员!"),
    ERROR_400(400, "参数错误!");

    @ApiModelProperty(value = "状态码")
    private final Integer code;

    @ApiModelProperty(value = "返回的消息")
    private final String message;

    /**
     * 构造方法
     *
     * @param code    状态码
     * @param message 消息
     */
    private ResultEnum(final Integer code, final String message) {
        this.code = code;
        this.message = message;
    }

    @Override
    public Integer getCode() {
        return this.code;
    }

    @Override
    public String getMessage() {
        return this.message;
    }
}

4:封装返回统一对象ResultBean

package com.qycq.server.encapsulation;

import com.qycq.server.enums.ResultEnum;
import com.qycq.server.utils.IResultCode;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;

import java.io.Serializable;

/**
 * @author 七月初七
 * @version 1.0
 * @date 2021/7/18 21:07
 */
@Data
@Slf4j
@ApiModel(value = "返回统一格式数据")
public class ResultBean<T> implements Serializable {
    /**
     * 返回数据的格式(成功返回): {
     * ”code“:"200",
     * "success":"true",
     * "data":{...},
     * "message":"操作成功!"
     * }
     * <p>
     * <p>
     * ==========================================
     * <p>
     * <p>
     * 返回数据的格式(失败返回): {
     * ”code“:"500",
     * "success":"false",
     * "data":null,
     * "message":"操作失败!"
     * }
     */

    @ApiModelProperty(value = "是否成功")
    private boolean isSuccess;

    @ApiModelProperty(value = "状态码")
    private Integer code;

    @ApiModelProperty(value = "承载数据")
    private T data;

    @ApiModelProperty(value = "返回的消息")
    private String message;

    /**
     * 私有的构造方法
     *
     * @param code
     * @param message
     * @param data
     */
    private ResultBean(Integer code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
        //如果状态码为200则返回true,不为200全是false
        this.isSuccess = this.code.equals(ResultEnum.SUCCESS.getCode());
    }

    /**
     * 多级重载
     */
    private ResultBean(IResultCode resultCode, String message, T data) {
        this(resultCode.getCode(), message, data);
    }

    private ResultBean(IResultCode resultCode) {
        this(resultCode.getCode(), resultCode.getMessage(), (T) null);
    }

    private ResultBean(IResultCode resultCode, String message) {
        this(resultCode.getCode(), message, (T) null);
    }

    private ResultBean(IResultCode resultCode, T data) {
        this(resultCode.getCode(), resultCode.getMessage(), data);
    }

    public static <T> ResultBean<T> data(T data) {
        return data(ResultEnum.SUCCESS.getMessage(), (T) data);
    }

    public static <T> ResultBean<T> data(String message, T data) {
        return data(ResultEnum.SUCCESS.getCode(), ResultEnum.SUCCESS.getMessage(), (T) data);
    }

    public static <T> ResultBean<T> data(Integer code, String message, T data) {
        return new ResultBean<T>(code, message, (T) data);
    }

    public static <T> ResultBean<T> success(String message) {
        return new ResultBean<T>(ResultEnum.SUCCESS.getCode(), message, (T) null);
    }

    public static <T> ResultBean<T> success(String message, T data) {
        return new ResultBean<T>(ResultEnum.SUCCESS.getCode(), message, (T) data);
    }

    public static <T> ResultBean<T> fail(String message) {
        return new ResultBean<T>(ResultEnum.ERROR_500.getCode(), message, (T) null);
    }

    public static <T> ResultBean<T> fail(String message, T data) {
        return new ResultBean<T>(ResultEnum.ERROR_500.getCode(), message, (T) data);
    }

    public static <T> ResultBean<T> fail(Integer code, String message) {
        return new ResultBean<T>(code, message, (T) null);
    }


    public static <T> ResultBean<T> status(boolean flag) {
        return flag ? success(ResultEnum.SUCCESS.getMessage()) : fail(ResultEnum.ERROR_500.getMessage());
    }
}

5:controller

/**
     * 用户退出
     *
     * @return
     */
    @GetMapping("/logout")
    @Log(type = LogEnum.LOGOUT)
    @ApiOperation(value = "退出方法")
    public ResultBean<String> logout() {
        return ResultBean.success("注销成功!");
    }

6测试:

在这里插入图片描述

꧁༺青༒竹༻ ꧂
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
前后端分离的返回数据的小流程
寒夜二十五
03-25 744
前后端分离: (后端的操作流程:)从定义上下文路径--->controller层--->json响应数据的实例类--->json响应数据实例类的封装--->自定义异常--->枚举(响应码和信息) 具体可参考改作者的文章,写的真的很好,循序渐进,感谢! https://www.jianshu.com/p/5e67b1d2f895 ...
json的使用 前后台统一以对象的方式编程 （转）
weixin_34150224的博客
10-09 61
前台插件的介绍 jquery.json 插件{jQuery插件} 主要方法: $.toJSON(json对象): 将json对象转化为字符串 $.evalJSON(str): 将字符串转化为json对象 插件下载: jquery.json-2.3.min.js   后台工具的介绍 json.net 主要方法: 将对象转为json字符串: view sourc...
前后端分离开发，后端返回前端json数据
lzycug的博客
07-13 5172
现阶段越来越多的项目采用前后端的分离开发模式，前端请求后台接口获取数据，后台返回结果，这时我们往往会定义好一种固定的数据格式来实现数据的传递，下面就本人在开发中常用的数据对象来做简单说明 我们在开发中定义后台接口时，后台返回数据可以定义为Result<T>，其中泛型T根据接口获取的不同数据根据情况而定，其中code为请求接口的状态码，msg为该次请求结果的提示信息（code和msg可一一对应，封装为枚举对象），data为返回数据，具体的代码如下 package com.lzycug.mail.
Java 处理对象的通用方法
Warms的博客
09-05 314
Java 处理对象的通用方法
统一对象消息编程（4）—对象消息编程框架3（基本模块类TLBaseModule）
tianlong117的博客
08-06 367
在前几章的基础上，我们开始介绍最重要的消息对象类模块TLBaseModule。TLBaseModule继承TLBaseObject。TLBaseModule可以说是个软件实现的CPU了，消息就是指令，它可以对指令检测、分析、执行、转发。从前面介绍的类关系图中看到TLBaseModule是最重要的类，所有其他的实用模块都继承它。对象消息编程框架基本就是这个类模板。 一、主要属性 ...
基于百度API实现的人脸识别demo-Java前后端分离实现
03-21
本资源是基于百度API实现的人脸识别小demo，包含人脸注册、人脸登录、人脸检测、人脸在线活体检测、人脸识别等，Java语言前后端分离实现，sql导入数据库，前后端启动即可验证
Java前后端分离博客系统源码.zip
05-15
本系统是前后端分离的博客系统，来源于b站的三更草堂、本人仅用于学习，并无其他用途，大家如果想学习更多内容，可以去关注这个优秀的up主 软件架构 软件架构说明 本系统不编写前端代码，只涉及后端技术，主要涉及...
驾校分期-众筹项目java前后端分离项目vue
06-14
可以idea直接打开，mysql数据库项目，前后端分离项目vue，分期可自动设置，自动换算金额
Java前后端分离的毕业论文/毕业设计管理系统.zip
05-03
Java前后端分离的毕业论文/毕业设计管理系统源码 基于：SpringBoot、MySQL、Redis、SSM Java前后端分离的毕业论文/毕业设计管理系统源码 基于：SpringBoot、MySQL、Redis、SSM Java前后端分离的毕业论文/毕业...
java前后端分离快速开发 代码生成器
11-29
java前后端分离，快速开发，代码生成器，nginx发布前端页面
统一对象消息编程（1）—对象的本质
tianlong117的博客
08-05 244
关于类、对象的概念我们不用多说什么了，基本所有对象编程的书籍、教材开始都介绍了，《java编程思想》说的稍微多了些。对象由方法、属性组成，对象编程就是抽象出一个对象（类）出来，对象之间互相调用对方的方法。但是我认为这种对对象的认识还比较粗浅，因为这个粗浅，导致了编程的复杂性，比如产生依赖、耦合，同样也失去了对象的标准性，每个人任意对一个对象设置各种方法。 我们观察...
SpringSecurity-OAuth2万文详解
weixin_68320784的博客
04-11 1万+
SpringSecurity-OAuth2万文详解 Oauth2.0是目前流行的授权机制，用于授权第三方应用，获取数据。Oauth协议为用户资源的授权提供一个安全、开放并且简易的规范标准。和以往授权不同的是Oauth不会使第三方触及到用户的账号信息(用户和密码)，也就是说第三方不需要使用用户的用户名和密码就可以获取到该用户的用户资源权限。 OAuth2设计的角色 资源所有者（Resource Owner）:通常是用户（User），如昵称、头像这些资源的拥有者(用户只是将这些资源放到服务提供商...
请求码（requestCode）与结果码（resultCode）解析
weixin_30482383的博客
04-22 2028
Android apk开发中经常需要在活动（Activity）之间穿梭，并实现活动之间的数据传递。为了启动一个新的活动并得到该活动的返回数据，需调用方法startActivityForResult()，该方法的原型为： void startActivityForResult (Intent intent, int requestCode) 同时在原活动中利用方法o...
Java前后端分离定义统一结果返回类
dedede001的博客
12-10 3381
项目中我们会将响应封装成json返回， 一般在项目中我们会将所有接口的数据格式统一， 使前端(iOS Android, Web)对数据的操作更一致、轻松。一般会包含状态码、返回消息、数据这几部分内容。
基于注解方式@ResponseResult实现前后端分离项目，接口统一类型的返回
扛麻袋的少年的博客
05-16 2183
  题外话：前后端的工作职责越来越明确，现在的前端都称之为大前端，技术栈以及生态圈都已经非常成熟；以前后端人员瞧不起前端人员，那现在后端人员要重新认识一下前端，前端已经很成体系了。 一般系统的大致整体架构图如下： 需要说明的是，有些小伙伴会回复说，这个架构太简单了吧，太 low 了，什么网关啊，缓存啊，消息中间件啊，都没有。 因为这篇我主要介绍的是 API 接口，所以我们聚焦点，其他的模块小伙伴们自行去补充。   接口交互   前端和后端进行交互，前端按照约定请求 URL 路径，并传入相关参数，后端服务器
requestCode和resultCode的区别
u013365312的专栏
01-03 1922
startActivityForResult(Intent intent, Int requestCode) intent 传给B的，不解释，看不懂你还是玩玩手机算了，别想开发的事情了 requestCode >=0就好，随便用于在onActivityResult()区别哪个子模块回传的数据，如果还有C.java ,D甚至E子模块的话，每个区分开不同的requestCode就好。 setResut
startActivityForResult() 中requestCode 和 resultCode 的作用
热门推荐
Lyndon的专栏
03-31 3万+
---------------------------------------------------------------------------------------------------------------------------------------------------- 以下转自：http://www.dewen.org/q/8896 由于本人初来乍到可能回答有些
前后端分离-统一返回给前端的json数据格式(RestApi)
天道酬勤
08-02 8443
package com.zhoujianpeng.project.response; public class RestResponse<T> { private int code; private String msg; private T data; /** * 分别提供返回成功和失败的不同的方法 * 也就是说返回的数据...
前后端分离：统一返回数据格式
qq_40664795的博客
04-17 2046
定义一个返回类 一般包含如下信息 状态码 提示信息 数据 /*** * 和前端接口交互的统一格式 */ public class ReturnResult<T> implements Serializable { private Integer code; // 异常码 private String message; // 提示信息 private T data; // ...
基于java不用前后端分离的后台管理系统
最新发布
05-10
如果你想搭建一个基于Java的后台管理系统而不使用前后端分离的方式，可以考虑使用一些流行的Java Web框架，如Spring MVC、Struts2、JSF等。这些框架可以帮助你快速构建Java Web应用程序，并提供一些基础的功能和工具...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值