关于java:一个成熟的Java项目如何优雅地处理异常

(一)概述

异样解决是一个零碎最重要的环节,当一个我的项目变得很大的时候,异样解决和日志零碎能让你疾速定位到问题。对于用户或者接口调用者而言,优雅的异样解决能够让调用者疾速晓得问题所在。本文将介绍如何优雅地解决异样。

(二)应用通用的返回体

咱们心愿所有的谬误都以Json的形式返回给客户,因而拿出上次写的通用返回体,新建一个类CommonResult记录返回体。

@Data
@AllArgsConstructor
@NoArgsConstructor
public class CommonResult {
    private int code;
    private String message;
    private Object data;
}
复制代码

新建一个枚举类ResponseCode集成code和message。

public enum ResponseCode {

    // 零碎模块
    SUCCESS(0, "操作胜利"),
    ERROR(1, "操作失败"),
    SERVER_ERROR(500, "服务器异样"),

    // 通用模块 1xxxx
    ILLEGAL_ARGUMENT(10000, "参数不非法"),
    REPETITIVE_OPERATION(10001, "请勿反复操作"),
    ACCESS_LIMIT(10002, "申请太频繁, 请稍后再试"),
    MAIL_SEND_SUCCESS(10003, "邮件发送胜利"),

    // 用户模块 2xxxx
    NEED_LOGIN(20001, "登录生效"),
    USERNAME_OR_PASSWORD_EMPTY(20002, "用户名或明码不能为空"),
    USERNAME_OR_PASSWORD_WRONG(20003, "用户名或明码谬误"),
    USER_NOT_EXISTS(20004, "用户不存在"),
    WRONG_PASSWORD(20005, "明码谬误"),
    ;

    ResponseCode(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    private Integer code;
    private String msg;
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}
复制代码

(三)自定义运行时异样

自定义一个运行时异样类,构造方法传入异样参数即可。

public class MyException extends RuntimeException{
    private String msg;

    public MyException(String msg) {
        super(msg);
    }
}
复制代码

(四)编写一个对立的异样解决类

异样解决类是整个异样解决外围,SpringBoot中提供了ControllerAdvice注解来拦挡异样,应用RestControllerAdvice注解保障了返回Json格局。

如果拦挡到的异样属于MyException,则按Json格局返回谬误后果。

@RestControllerAdvice
public class ExceptionController {

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(value = Exception.class)
    public CommonResult exceptionHandler(Exception e){
        //如果抛出的异样属于自定义异样,就以JSON格局返回
        if (e instanceof MyException){
            return new CommonResult(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getMsg(),"自定义的谬误为:"+e.getMessage());
        }
        //如果都不是就打印出异样的信息
        return new CommonResult(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getMsg(),"谬误的信息为:"+e.getMessage());
    }
}
复制代码

(五)测试

为了看初成果,这里手动抛出一个异样来测试,新建IndexController,手动抛出异样

@RestController
public class IndexController {

    @RequestMapping(value = "/index",method = RequestMethod.GET)
    public String index(){
        throw new MyException("测试");
    }
}
复制代码

查看调用后果:

(六)对实体类的校验

有这样一个场景,登陆注册时用户名和明码有长度限度,手机号有格局限度,如果不满足要求就无奈注册。这个性能前端能够限度,然而对于后端接口而言,也须要进行限度,万一前端没有限制住呢。

导入两个校验依赖包:

<!--校验-->
<!-- https://mvnrepository.com/artifact/javax.validation/validation-api -->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.hibernate/hibernate-validator -->
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.1.0.Final</version>
</dependency>
复制代码

编写实体类,在每个属性上加上校验包的验证参数。

@Data
public class Register {

    @Length(max = 20,min = 4,message = "用户名长度须要在4到20个字符之间")
    @NotBlank(message = "用户名不能为空")
    private String username;

    @NotBlank(message = "手机号不能为空")
    @Pattern(regexp = "^1[3|4|5|8][0-9]d{8}$",message = "电话号码格局不正确")
    private String phone;

    @Length(max = 20,min = 4,message = "明码长度须要在4到20个字符之间")
    @NotBlank(message = "明码不能为空")
    private String password;
}
复制代码

咱们在须要应用的办法中减少@Valid注解进行校验,比方这个post申请中我要校验。

@PostMapping("/register")
public CommonResult register(@Valid @RequestBody Register register){
    //一连串注册的业务
    userService.registerUser(register);
    return new CommonResult(ResponseCode.SUCCESS.getCode(),ResponseCode.SUCCESS.getMsg(),"");
}
复制代码

@Valid在校验失败的状况下会报出参数不非法的异样,还是在对立的异样解决类中捕捉异样,如果是MethodArgumentNotValidException,就取出对应的message数据。

@RestControllerAdvice
public class ExceptionController {

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(value = Exception.class)
    public CommonResult exceptionHandler(Exception e){
        //如果属于参数校验异样,就抛出校验的谬误
        if (e instanceof MethodArgumentNotValidException){
            MethodArgumentNotValidException methodArgumentNotValidException= (MethodArgumentNotValidException) e;
            return new CommonResult(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getMsg(),
                    "校验谬误:"+methodArgumentNotValidException.getBindingResult().getFieldError().getDefaultMessage());
        }//如果是自定义的异样,就给出具体的异样起因
        else if (e instanceof MyException){
            return new CommonResult(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getMsg(),"自定义的谬误为:"+e.getMessage());
        }
        //如果都不是就打印出异样的信息
        return new CommonResult(ResponseCode.ERROR.getCode(),ResponseCode.ERROR.getMsg(),"谬误的信息为:"+e.getMessage());
    }
}
复制代码

(七)测试校验

接下来就能够测试校验的性能了,通过postman拜访

如果输出参数不满足之前的设置,就会给出具体的错误信息。而不是抛出让人无奈接管的报错:

(八)总结

许多人写代码时最不思考的就是异样解决,简略地实现需求就好了,所以才会导致许多不可预估的bug呈现。

参考:《2020最新Java根底精讲视频教程和学习路线!》

链接:https://juejin.cn/post/691981…

【腾讯云】云产品限时秒杀,爆款1核2G云服务器,首年50元

阿里云限时活动-2核2G-5M带宽-60G SSD-1000G月流量 ,特惠价99元/年(原价1234.2元/年,可以直接买3年),速抢

本文由乐趣区整理发布,转载请注明出处,谢谢。

您可能还喜欢...

发表回复

您的电子邮箱地址不会被公开。

此站点使用Akismet来减少垃圾评论。了解我们如何处理您的评论数据