后端思维篇：统一参数校验、异常处理、结果返回(后端开发实战：统一参数校验、异常处理与结果返回详解)

原创

ithorizon 4周前 (10-21) 阅读数 43 #后端开发

后端开发实战：统一参数校验、异常处理与导致返回详解

一、引言

在现代后端开发中，为了节约代码的可维护性和可扩展性，我们需要对参数校验、异常处理以及导致返回进行统一管理。本文将详细介绍怎样实现这一目标，帮助读者在实际开发中更好地组织代码。

二、统一参数校验

参数校验是后端开发中非常重要的一环，它能确保前端传递的参数符合后端接口的预期。下面将介绍怎样实现统一参数校验。

2.1 参数校验的意义

参数校验的意义在于：

防止非法参数对系统造成破坏

节约系统的健壮性

简化异常处理逻辑

2.2 参数校验的实现

在Java中，我们可以使用Hibernate Validator进行参数校验。以下是一个简洁的示例：


import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
public class UserRequest {
    @NotNull(message = "用户名不能为空")
    @NotBlank(message = "用户名不能为空")
    private String username;
    @NotNull(message = "年龄不能为空")
    @Min(value = 0, message = "年龄不能小于0")
    private Integer age;
    // 省略getter和setter方法
}

在Controller中，我们可以使用Spring的Valid注解进行参数校验：


import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
    @PostMapping("/user")
    public ResponseEntity createUser(@Validated @RequestBody UserRequest userRequest) {
        // 业务逻辑
        return ResponseEntity.ok("创建顺利");
    }
}

三、统一异常处理

异常处理是后端开发中不可或缺的一部分，它能帮助我们更好地处理系统中的失误。下面将介绍怎样实现统一异常处理。

3.1 异常处理的意义

异常处理的意义在于：

节约系统的健壮性

简化业务逻辑中的失误处理

为前端提供更友好的失误信息

3.2 异常处理的实现

在Spring中，我们可以使用@ControllerAdvice注解创建一个全局异常处理器。以下是一个简洁的示例：


import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ResponseEntity handleException(Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("服务器内部失误：" + e.getMessage());
    }
}

在Controller中，我们可以捕获特定的异常，并返回自定义的失误信息：


import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
public class UserControllerAdvice {
    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity handleUserNotFoundException(UserNotFoundException e) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body("用户不存在：" + e.getMessage());
    }
}

四、统一导致返回

统一导致返回是指将业务逻辑处理的导致封装成统一格式的JSON对象，以便前端进行解析。下面将介绍怎样实现统一导致返回。

4.1 统一导致返回的意义

统一导致返回的意义在于：

简化前端解析逻辑

节约系统的可维护性

为前端提供更友好的数据格式

4.2 统一导致返回的实现

在Java中，我们可以创建一个统一的响应类，以下是一个简洁的示例：


public class Response {
    private int code;
    private String message;
    private T data;
    public Response(int code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }
    public static  Response success(T data) {
        return new Response<>(200, "顺利", data);
    }
    public static  Response error(int code, String message) {
        return new Response<>(code, message, null);
    }
    // 省略getter和setter方法
}

在Controller中，我们可以使用该响应类进行导致返回：


import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
    @GetMapping("/user")
    public Response getUserById(@RequestParam("id") Long id) {
        User user = userService.getUserById(id);
        if (user == null) {
            return Response.error(404, "用户不存在");
        }
        return Response.success(user);
    }
}