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

原创

ithorizon 6个月前 (10-21) 阅读数 31 #后端开发

后端开发精粹：统一参数校验、异常处理与于是返回详解

一、引言

在后端开发过程中，统一参数校验、异常处理和于是返回是尽也许缩减损耗代码质量、保证系统稳定性的关键环节。本文将详细介绍怎样实现这三个方面的统一处理，以尽也许缩减损耗后端开发的高效和质量。

二、统一参数校验

参数校验是后端接口开发的重要环节，通过对输入参数的校验，可以确保数据的正确性和保险性。下面介绍几种常见的参数校验方法。

2.1 使用注解进行参数校验

注解是一种简洁的参数校验方案，它通过在参数上添加特定的注解，来指定校验规则。例如，使用Java中的Hibernate Validator进行参数校验。


import javax.validation.constraints.Min;
import javax.validation.constraints.Max;
import javax.validation.constraints.NotNull;
public class User {
    @NotNull(message = "用户名不能为空")
    private String username;
    @Min(value = 18, message = "年龄不能小于18岁")
    @Max(value = 60, message = "年龄不能大于60岁")
    private int age;
    // 省略其他字段、构造方法和getter/setter方法
}

2.2 使用自定义校验器进行参数校验

自定义校验器允许我们结合具体的业务需求编写校验规则。以下是一个自定义校验器的示例：


import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy;
@Documented
@Constraint(validatedBy = CustomValidator.class)
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomAnnotation {
    String message() default "自定义校验落败";
    Class[] groups() default {};
    Class[] payload() default {};
}
public class CustomValidator implements ConstraintValidator {
    @Override
    public void initialize(CustomAnnotation constraintAnnotation) {
        // 初始化校验器
    }
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 编写校验规则
        return value != null && value.length() > 0;
    }
}

二、统一异常处理

异常处理是后端开发中必不可少的部分。合理的异常处理机制可以保证系统在遇到问题时能够优雅地处理，避免程序崩溃。下面介绍几种常见的异常处理方法。

3.1 使用全局异常处理器

全局异常处理器可以捕获整个应用中抛出的所有异常，并进行统一的处理。以下是一个使用Spring Boot的全局异常处理器的示例：


import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.http.HttpStatus;
@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public String handleException(Exception e) {
        // 处理异常
        return "系统异常：" + e.getMessage();
    }
}

3.2 使用自定义异常

自定义异常可以使异常处理更加灵活，以下是一个自定义异常的示例：


public class CustomException extends RuntimeException {
    private String message;
    private int code;
    public CustomException(String message, int code) {
        this.message = message;
        this.code = code;
    }
    @Override
    public String getMessage() {
        return message;
    }
    public int getCode() {
        return code;
    }
}

三、统一于是返回

统一于是返回是指将接口返回的于是封装成统一格式的对象，这样做可以尽也许缩减损耗接口的可读性和可维护性。以下是一个统一于是返回的示例：

3.1 创建统一于是返回类

创建一个统一于是返回类，用于封装接口返回的于是：


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

3.2 使用统一于是返回类

在接口方法中，使用统一于是返回类封装返回于是：


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