首页 星云 工具 资源 星选 资讯 热门工具
:

PDF转图片 完全免费 小红书视频下载 无水印 抖音视频下载 无水印 数字星空

如何优雅地处理返回值

编程知识
2024年09月17日 19:16

我们已经知道了如何优雅的校验传入的参数了,那么后端服务器如何实现把数据返回给前端呢?

返回格式

后端返回给前端我们一般用 JSON 体方式,定义如下:

{
    #返回状态码
    code:string,       
    #返回信息描述
    message:string,
    #返回值
    data:object
}

CODE 状态码

Code 返回状态码,一般是在开发的时候需要什么,就添加什么。

如接口要返回用户权限异常,我们加一个状态码为 101 吧,下一次又要加一个数据参数异常,就加一个 102 的状态码。这样虽然能够照常满足业务,但状态码太凌乱了。

这里可以参考 阿里巴巴开发手册 中前后端规约 以及 异常日志中的内容

U表示用户,后面4位数字编号为
#U1000~U1999 区间表示用户参数相关
#U2000~U2999 区间表示用户相关接口异常
...

这样前端开发人员在得到返回值后,根据状态码就可以知道,大概什么错误,再根据 Message 相关的信息描述,可以快速定位。

Message

这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和 Code 状态码一起设计,如:

@Data
public class Result {

    private String retCode;
    private String retMsg;
 
    //默认成功状态码
    public static final String SUCCESSCODE = "S0000";
    public static final String SUCCESSMSG = "成功";
    //默认失败状态码
    public static final String ERROR_CODE = "E2222";
    public static final String ERROR_MSG = "失败";

    public static final String COMMENT_CODE = "E3333";
    public static final String RUNNING_ERROR_MSG = "运行出错,请联系管理员";

    private Result() {
        this(SUCCESSCODE, SUCCESSMSG);
    }
}

再在枚举中定义,状态码:

@Getter
public enum UserResultConstants implements ResultConstats{

    NOT_ID("U1001","未正确输入用户id"),
    ADD_FAIL("U1002","新增用户失败"),
    UPDATE_FAIL("U1003","更新用户失败"),
    DELETE_FAIL("U1004","删除用户失败"),
    USERNAME_EXIST("U1005","用户名已存在"),
    USER_NOT_EXIST("U1006","用户不存在")
    ;

    private String code;
    private String message;

    private UserResultConstants(String code, String message){
        this.code = code;
        this.message = message;
    }

}

状态码和信息就会一一对应,比较好维护。

Data

返回数据体,JSON 格式,根据不同的业务又不同的 JSON 体。

我们要设计一个返回体类 Result:

@Data
public class Result {

    private String retCode;
    private String retMsg;
    private Object data;

    public static final String SUCCESSCODE = "0000";
    public static final String SUCCESSMSG = "成功";
    public static final String ERROR_CODE = "2222";
    public static final String ERROR_MSG = "失败";

    public static final String COMMENT_CODE = "3333";
    public static final String RUNNING_ERROR_MSG = "运行出错,请联系管理员";

    public Result() {
        this(SUCCESSCODE, SUCCESSMSG, null);
    }

    public Result(Object data) {
        this(SUCCESSCODE, SUCCESSMSG, data);
    }

    public Result(String retCode, String retMsg, Object data) {
        this.retCode = retCode;
        this.retMsg = retMsg;
        this.data = data;
    }

    public Result(String retCode, String retMsg) {
        this(retCode, retMsg, null);
    }
}

控制层 Controller

我们会在 Controller 层处理业务请求,并返回给前端,以 用户管理 为例:

@RestController
@RequestMapping("/user")
@Slf4j
@Validated
@RequiredArgsConstructor
public class UserController {

    private final UserService userService;

    /**
     * 查询所有用户信息
     *
     * @return 返回所有用户信息
     */
	@GetMapping(value = "/list")
    public Result userList() {
        List<UserVo> users = userService.selectUserList();
        Result result = new Result(users);
        log.info("userList查询的用户信息为:{}", JsonMapper.toJson(users));
        return result;
    }
}

我们看到在获得 users 对象之后,我们是用的 Result 构造方法进行包装赋值,然后进行返回。而@RestController注解是@Controller和@ResponseBody的合集,表示这是个控制器 bean,并且是将函数的返回值直接填入 HTTP 响应体中,是 REST 风格的控制器,更加适合目前前后端分离的架构下,返回 JSON 数据格式。

有没有发现,构造方法这样的包装是不是很麻烦,可以优化一下。

美观优化

我们可以在 Result 类中,加入静态方法,一看就懂:

@Data
public class Result {

    //...
    
    public static Result ok() {
        return new Result();
    }

    public static Result ok(Object data) {
        return new Result(data);
    }

    public static Result ok(String retCode, String retMsg) {
        return new Result(retCode, retMsg);
    }

    public static Result error(String retCode, String retMsg) {
        return new Result(retCode, retMsg);
    }

}

再改造一下 Controller:

@RestController
@RequestMapping("/user")
@Slf4j
@Validated
@RequiredArgsConstructor
public class UserController {

    private final UserService userService;

    /**
     * 查询所有用户信息
     *
     * @return 返回所有用户信息
     */
    @GetMapping(value = "/list")
    public Result userList() {
        List<UserVo> users = userService.selectUserList();
        log.info("userList查询的用户信息为:{}", JsonMapper.toJson(users));
        return Result.ok(users);
    }
}

代码是不是比较简洁了,也美观了。

优雅优化

上面我们看到在 Result 类中增加了静态方法,使得业务处理代码简洁了。

但大家有没有发现这样有几个问题:

  • 每个方法的返回都是 Result 封装对象,没有业务含义。
  • 在业务代码中,成功的时候我们调用 Result.success,异常错误调用 Result.error。是不是很多余。

我们最好的方式直接返回真实业务对象,最好不要改变之前的业务方式,如下:

@RestController
@RequestMapping("/user")
@Slf4j
@Validated
@RequiredArgsConstructor
public class UserController {

    private final UserService userService;

    /**
     * 查询所有用户信息
     *
     * @return 返回所有用户信息
     */
    @GetMapping(value = "/list")
    public List<UserVo> userList() {
        List<UserVo> users = userService.selectUserList();
        log.info("userList查询的用户信息为:{}", JsonMapper.toJson(users));
        return users;
    }
}

这个和我们平时的代码是一样的,非常直观,直接返回 user 对象,这样是不是很完美。

那实现方案是什么呢?

返回值优雅方案实现

要优化这段代码很简单,只需要借助SpringBoot提供的ResponseBodyAdvice即可。

ResponseBodyAdvice的作用:拦截Controller方法的返回值,统一处理返回值/响应体,一般用来统一返回格式,加解密,签名等等。

重写返回体

@RestControllerAdvice
@RequiredArgsConstructor
public class ResponseAdvice implements ResponseBodyAdvice<Object> {

    private final ObjectMapper objectMapper;

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        //如果Controller直接返回String的话,SpringBoot是直接返回,故我们需要手动转换成json。
        if (body instanceof String) {
            return objectMapper.writeValueAsString(Result.ok(body));
        }
        //如果已经封装成Result了,则不需要再次封装,否则就会导致出现多层
        if (body instanceof Result) {
            return body;
        }
        return Result.ok(body);
    }
}

上面代码就是判断是否需要返回值包装,如果需要就直接包装。这里我们只处理了正常成功的包装,如果方法体报异常怎么办?

异常问题处理

此时有个问题,由于没对异常进行处理,当调用的方法一旦出现异常,就会出现问题,此时就可以写全局异常,来通过全局异常返回同一格式的Result。

  • 定义异常类
public class UserException extends RuntimeException {
    public UserException(String message) {
        super(message);
    }
}
  • 全局异常类
@RestControllerAdvice
@Slf4j
@Order(value = Ordered.HIGHEST_PRECEDENCE)
public class GlobalExceptionHandler {

    @ExceptionHandler(value = UserException.class)
    public Result handlerUserException(UserException e, HttpServletRequest request) {
        String msg = e.getMessage();
        log.error("请求[ {} ] {} 的参数校验发生错误,错误信息:{}", request.getMethod(), request.getRequestURL(), msg, e);
        return Result.error(Result.COMMENT_CODE, msg);
    }
}

重写 Controller

@RestController
@RequestMapping("/user")
@Slf4j
@Validated
@RequiredArgsConstructor
public class UserController {

    private final UserService userService;

    /**
     * 根据用户id查询用户信息
     *
     * @param id 用户id
     * @return 成功则返回用户信息
     */
    @GetMapping("/selectById")
    public UserVo selectById(@RequestParam(required = false) Integer id) {
        UserVo user = userService.selectUserById(id);
        log.info("selectById根据id:{}执行查询,查询的用户信息为:{}", id, JsonMapper.toJson(user));
        if (user == null) {
            throw new UserException("查询的用户不存在");
        }
        return user;
    }
}

到此返回的同一格式的设计思路完成,是不是又简洁,又优雅。

关于作者

来自一线程序员Seven的探索与实践,持续学习迭代中~

本文已收录于我的个人博客:https://www.seven97.top

公众号:seven97,欢迎关注~

From:https://www.cnblogs.com/seven97-top/p/18417444
本文地址: http://www.shuzixingkong.net/article/2082
0评论
提交 加载更多评论
其他文章 C++面试题整理 2
8. C++11新特性又哪些 自动类型推导auto,智能指指针(share_ptr,unique_ptr等),for循环简化,线程相关的(std::thread/std::mutex),空指针nullptr,lambda表达式,等等 9. share_ptr是线程安全的吗 share_ptr里包含引
浮点数的比较
浮点数与&quot;零值&quot; 精度损失: 浮点值与实际值不等,可能偏大可能偏小,都属于精度损失 验证浮点数是否存在精度损失 验证浮点数的差值是否存在精度损失 浮点数直接比较验证 结论: 浮点数在进行比较时,绝对不能使用双等号==来进行比较. 浮点数本身有精度损失,进而导致结果可能有细微的差别
浮点数的比较 浮点数的比较 浮点数的比较
Blazor静态服务端呈现(静态SSR)身份认证
本文介绍 Blazor 静态服务端呈现(静态 SSR)模式下,用户登录身份认证是如何实现的。 1. SSR 简介 SSR 是服务器侧呈现,HTML 是由服务器上的 ASP.NET Core 运行时生成,通过网络发送到客户端,供客户端的浏览器显示。SSR 分两种类型: 静态 SSR:服务器生成静态 H
代码整洁之道--读书笔记(11)
代码整洁之道 简介: 本书是编程大师“Bob 大叔”40余年编程生涯的心得体会的总结,讲解要成为真正专业的程序员需要具备什么样的态度,需要遵循什么样的原则,需要采取什么样的行动。作者以自己以及身边的同事走过的弯路、犯过的错误为例,意在为后来者引路,助其职业生涯迈上更高台阶。 本书适合所有程序员阅读,
代码整洁之道--读书笔记(11) 代码整洁之道--读书笔记(11)
全面掌握 Jest:从零开始的测试指南(上篇)
随着JavaScript在前后端开发中的广泛应用,测试已成为保证代码质量的关键环节。 为什么需要单元测试 在我们的开发过程中,经常需要定义一些算法函数,例如将接口返回的数据转换成UI组件所需的格式。为了校验这些算法函数的健壮性,部分开发同学可能会手动定义几个输入样本进行初步校验,一旦校验通过便不再深
全面掌握 Jest:从零开始的测试指南(上篇) 全面掌握 Jest:从零开始的测试指南(上篇) 全面掌握 Jest:从零开始的测试指南(上篇)
Java 学习 day02
java day02 DtaaType 数据类型 Java是一门强类型的语言。 1、变量 变量:指的是在Java程序运行过程中,其值可以发生改变的量。 定义一个变量的语句定义格式: //数据类型 变量名 = 初始化值; 注意事项: 1、变量要进行初始化赋值,才可以进行使用 2、在同一作用域下,变量名
CSP初赛知识点:Linux 系统
CSP初赛知识点:Linux 系统 前言 近年 CSP 初赛几乎前 5 道选择题都有一两道有关 Linux 系统的使用,所以作为备战 CSP-J/S 2024 的资料,整理下来啦。 祝各位今年所有考试都能考出自己满意的成绩! 1、常用文件操作命令 以下设文件名均为 csp,需要复制或修改成的文件名均
开源项目dotnet/eshop 和 dotnet/eshopsupport
dotnet/eshop[1] 和 dotnet/eshopsupport[2] 是两个与 .NET 相关的开源项目,分别用于展示电子商务应用的不同方面。dotnet/eshop:功能与架构:dotnet/eshop 是一个基于 .NET Aspire 的参考电商应用,展示了服务架构在构建现代在线购
开源项目dotnet/eshop 和 dotnet/eshopsupport 开源项目dotnet/eshop 和 dotnet/eshopsupport