springboot返回值实体的封装

自定义响应体与错误编码设计

最新推荐文章于 2024-09-28 20:00:53 发布

原创

最新推荐文章于 2024-09-28 20:00:53 发布 · 858 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring boot

该博客讨论了一个用于API响应的通用类`R<T>`的设计，它包含成功或失败的标志、消息和数据。同时，定义了`ErrorCode`接口来表示错误代码，以及`ErrorCodeEnum`枚举类来具体定义各种错误情况。此外，还引入了常量类`ResultEnums`来表示操作结果的状态。这些组件共同用于构建清晰、规范的API响应。


/**
 * 响应信息主体
 */
@ToString
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
@ApiModel(value = "响应信息主体")
public class R<T> implements Serializable {
	private static final long serialVersionUID = 1L;

	@Getter
	@Setter
	@ApiModelProperty(value = "返回标记：成功标记=0，失败标记=1")
	private Integer code;

	@Getter
	@Setter
	@ApiModelProperty(value = "返回信息")
	private String msg;

	@Getter
	@Setter
	@ApiModelProperty(value = "数据")
	private T data;

	@Getter
	@Setter
	@ApiModelProperty(value = "数据")
	private Map<String, Object> totals;

	public static <T> R<T> ok() {
		return restResult(null, CommonConstants.SUCCESS, "SUCCESS");
	}

	public static <T> R<T> ok(T data) {
		return restResult(data, CommonConstants.SUCCESS, "SUCCESS");
	}

	public static <T> R<T> ok(T data, String msg) {
		return restResult(data, CommonConstants.SUCCESS, msg);
	}

	public static <T> R<T> failed() {
		return restResult(null, CommonConstants.

最低0.47元/天解锁文章