JavaWeb-SpringBoot项目通用响应的设计

最新推荐文章于 2025-02-20 23:13:04 发布

Dylan、

最新推荐文章于 2025-02-20 23:13:04 发布

阅读量310

点赞数 1

CC 4.0 BY-SA版权

分类专栏： Java 文章标签： spring boot java 后端

此博客上带有原创标识的文章.图片.文件等，未经本人允许，不得用于商业用途以及传统媒体。网络媒体或个人转载请注明出处和链接，否则属于侵权行为。

本文链接：https://blog.youkuaiyun.com/younow22/article/details/120891831

Java 专栏收录该内容

42 篇文章

订阅专栏

本文介绍了如何利用Lombok库简化Java项目中响应对象`CommonResponse`的创建和使用。通过定义枚举`ResponseCode`来表示不同的响应状态，并提供了一系列静态工厂方法，使得创建成功或错误的响应变得非常便捷。同时，`CommonResponse`利用了`@Getter`和`@JsonInclude`注解以实现自动属性获取和JSON序列化。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

依赖：lombok

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

项目common结构：
在这里插入图片描述
CommonResponse写法

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.Getter;

import java.io.Serializable;

@Getter
@JsonInclude(JsonInclude.Include.NON_NULL)
public class CommonResponse<T> implements Serializable {

    private int status;
    private String msg;
    private T data;

    private CommonResponse(int status){
        this.status=status;
    }
    private CommonResponse(int status,String msg){
        this.status=status;
        this.msg=msg;
    }
    private CommonResponse(int status,String msg,T data){
        this.status=status;
        this.msg=msg;
        this.data=data;
    }
    private CommonResponse(int status,T data){
        this.status=status;
        this.data=data;
    }

    @JsonIgnore
    public boolean isSuccess(){
        return this.status == ResponseCode.SUCCESS.getCode();
    }
    public static <T> CommonResponse <T> createForSuccess(){
        return new CommonResponse<T>(ResponseCode.SUCCESS.getCode());
    }
    public static <T> CommonResponse <T> createForSuccess(T data){
        return new CommonResponse<T>(ResponseCode.SUCCESS.getCode(),data);
    }
    public static <T> CommonResponse <T> createForSuccessMessage(String msg){
        return new CommonResponse<T>(ResponseCode.SUCCESS.getCode(),msg);
    }
    public static <T> CommonResponse <T> createForSuccess(String msg,T data){
        return new CommonResponse<T>(ResponseCode.SUCCESS.getCode(),msg,data);
    }
    public static <T> CommonResponse <T> createForError(){
        return new CommonResponse<T>(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getDescription());
    }
    public static <T> CommonResponse <T> createForError(String msg){
        return new CommonResponse<T>(ResponseCode.ERROR.getCode(),msg);
    }
    public static <T> CommonResponse <T> createForError(int code,String msg){
        return new CommonResponse<T>(code,msg);
    }
}

ResponseCode(枚举)的写法

import lombok.Getter;

@Getter
public enum ResponseCode {
    SUCCESS(0,"SUCCESS"),
    ERROR(1,"ERROR"),
    NEED_LOGIN(10,"NEED_LOGIN"),
    ILLEGAL_ARGUMENT(2,"ILLEGAL_ARGUMENT");

    private final int code;
    private final String description;

    ResponseCode(int code,String description){
        this.code=code;
        this.description = description;
    }

}