net.sohelp.boot.demo.core.magic.provider

类 CustomJsonValueProvider

java.lang.Object

net.sohelp.boot.demo.core.magic.provider.CustomJsonValueProvider

所有已实现的接口:

org.ssssssss.magicapi.core.interceptor.ResultProvider

@Component
 @Order(value=1)
public class CustomJsonValueProvider
extends Object
implements org.ssssssss.magicapi.core.interceptor.ResultProvider

自定义JSON结果 https://ssssssss.org/guide/custom/json.html

另请参阅:

ResultProvider

字段概要

从接口继承的字段 org.ssssssss.magicapi.core.interceptor.ResultProvider

logger

构造器概要

构造器

构造器和说明
CustomJsonValueProvider()

方法概要

限定符和类型	方法和说明
Object	buildException(org.ssssssss.magicapi.core.context.RequestEntity requestEntity, Throwable throwable) 构建异常响应对象。
Object	buildPageResult(org.ssssssss.magicapi.core.context.RequestEntity requestEntity, org.ssssssss.magicapi.modules.db.model.Page page, long total, List<Map<String,Object>> data) 构建分页查询结果。
Object	buildResult(org.ssssssss.magicapi.core.context.RequestEntity requestEntity, int code, String message, Object data) 构建标准API响应结果。

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.ssssssss.magicapi.core.interceptor.ResultProvider

buildResult, buildResult, buildResult

构造器详细资料

CustomJsonValueProvider

public CustomJsonValueProvider()

方法详细资料

buildException

public Object buildException(org.ssssssss.magicapi.core.context.RequestEntity requestEntity,
                             Throwable throwable)

构建异常响应对象。

根据抛出的异常类型判断是否属于业务相关异常，并返回对应的错误信息； 若不属于已知业务异常，则记录日志并返回通用错误提示。

指定者:

buildException 在接口中 org.ssssssss.magicapi.core.interceptor.ResultProvider

参数:

requestEntity - 请求实体，包含请求上下文信息

throwable - 抛出的异常对象

返回:

返回封装后的ApiResult对象，表示接口调用失败的结果

buildResult

public Object buildResult(org.ssssssss.magicapi.core.context.RequestEntity requestEntity,
                          int code,
                          String message,
                          Object data)

构建标准API响应结果。

判断当前响应的内容类型是否为HTML文本，如果是则直接返回原始数据； 否则将数据包装成统一格式的ApiResult对象后返回。

指定者:

buildResult 在接口中 org.ssssssss.magicapi.core.interceptor.ResultProvider

参数:

requestEntity - 请求实体，用于获取请求相关信息

code - 响应状态码

message - 响应消息描述

data - 实际响应的数据内容

返回:

封装好的响应对象或原始数据

buildPageResult

public Object buildPageResult(org.ssssssss.magicapi.core.context.RequestEntity requestEntity,
                              org.ssssssss.magicapi.modules.db.model.Page page,
                              long total,
                              List<Map<String,Object>> data)

构建分页查询结果。

提取请求中的分页参数（如页码、每页数量），计算总页数等信息， 并以Map形式组织分页结构体返回。

指定者:

buildPageResult 在接口中 org.ssssssss.magicapi.core.interceptor.ResultProvider

参数:

requestEntity - 请求实体，用于提取分页参数

page - 分页模型对象，提供默认限制值

total - 总记录数

data - 当前页的实际数据列表

返回:

包含分页信息和数据的Map对象