项目统一异常处理

项目中可能存在不可预知的各种异常，如：空指针，数组越界等。针对这类异常，可以直接在异常处理器中统一处理；

还有一类是可预知的错误，如图片不合法，验证码错误等等。这类错误也可以理解为业务异常，可以通过自定义异常类来处理；

一、异常处理代码实现

1.1为了方便操作，将一些常见的业务错误封装到ErrorResult对象中

package com.tanhua.model.vo;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

//为了方便操作，将一些常见的业务错误封装到ErrorResult对象中
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class ErrorResult {

    private String errCode = "999999";
    private String errMessage;

    public static ErrorResult error() {
        return ErrorResult.builder().errCode("999999").errMessage("系统异常稍后再试").build();
    }

    public static ErrorResult fail() {
        return ErrorResult.builder().errCode("000001").errMessage("发送验证码失败").build();
    }

    public static ErrorResult loginError() {
        return ErrorResult.builder().errCode("000002").errMessage("验证码失效").build();
    }

    public static ErrorResult faceError() {
        return ErrorResult.builder().errCode("000003").errMessage("图片非人像，请重新上传!").build();
    }

    public static ErrorResult mobileError() {
        return ErrorResult.builder().errCode("000004").errMessage("手机号码已注册").build();
    }

    public static ErrorResult contentError() {
        return ErrorResult.builder().errCode("000005").errMessage("动态内容为空").build();
    }

    public static ErrorResult likeError() {
        return ErrorResult.builder().errCode("000006").errMessage("用户已点赞").build();
    }

    public static ErrorResult disLikeError() {
        return ErrorResult.builder().errCode("000007").errMessage("用户未点赞").build();
    }

    public static ErrorResult loveError() {
        return ErrorResult.builder().errCode("000008").errMessage("用户已喜欢").build();
    }

    public static ErrorResult disloveError() {
        return ErrorResult.builder().errCode("000009").errMessage("用户未喜欢").build();
    }
}

2.自定义业务异常对象，通过构造方法的方式把ErrorResult注入进去

package com.tanhua.server.exception;

import com.tanhua.model.vo.ErrorResult;
import lombok.Data;

//自定义业务异常类
@Data
public class BusinessException extends RuntimeException{

    private ErrorResult errorResult;
    //通过构造方法把errorResult注入进来
    public BusinessException(ErrorResult errorResult) {
        super(errorResult.getErrMessage());
        this.errorResult = errorResult;
    }
}

1.3在业务逻辑处抛出，然后在表现层try catch捕捉异常

以手机验证码登录示例

 /**
     * 登录的业务层接口业务逻辑
     * @param phone
     * @param code
     * @return
     */
    public Map loginVerification(String phone, String code) {
        //1.从Redis缓存中获取验证码
        String redisCode = redisTemplate.opsForValue().get("CHECK_CODE_" + phone);
        //2.判断用户输入的验证码与下发的手机验证码是否一致
        //不一致则抛出一个异常
        if(StringUtils.isEmpty(code) || ! redisCode.equals(code)){
            //验证码无效
            throw new BusinessException(ErrorResult.loginError());
        }
        //3.删除Redis中缓存的验证码
        redisTemplate.delete("CHECK_CODE_" + phone);

        //4.用dubbo远程调用UserApi,根据手机号码查询用户
        User user = userApi.selectByPhoneNumber(phone);

        boolean isNew =  false;

        //5.如果user为空，证明是新用户，把它存进数据库表
        if(user == null){
            user =new User();
            user.setMobile(phone);
//            user.setCreated(new Date());
//            user.setUpdated(new Date());
            user.setPassword(DigestUtils.md5Hex("123456"));
            Long userId = userApi.addNewUser(user);
            user.setId(userId);
            isNew =true;
        }
        //6.生成token(存入id和手机号码)
        Map userToken = new HashMap();
        userToken.put("id", user.getId());
        userToken.put("phone",phone);

        String token = JwtUtils.getToken(userToken);

        //7.构造返回值
        Map resultMap = new HashMap();

        resultMap.put("token", token);
        resultMap.put("isNew", isNew);

        return resultMap;
    }

1.4捕捉

也以手机验证码登录为例

/**
     * 用户登录
     * 1.请求路径：/user/loginVerification
     * 2.请求参数：phone(String),verificationCode(String)用map集合封装
     * 3.返回结果：token，isNew(封装到map集合返回)
     */
    @PostMapping("/loginVerification")
    public ResponseEntity loginVerification(@RequestBody Map map){

        try {
            //1.接收参数
            String phone = (String) map.get("phone");
            String code = (String) map.get("verificationCode");

            //2.调用userServi
            //返回结果用map封装
            Map result = userService.loginVerification(phone, code);

            return ResponseEntity.ok(result);
        } catch (BusinessException be) {
            ErrorResult errorResult = be.getErrorResult();
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorResult);

        }catch (Exception e){
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(ErrorResult.error());
        }

二、异常处理代码优化

代码实现：

package com.tanhua.server.exception;

import com.tanhua.model.vo.ErrorResult;
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 GobalExceptionAdvice {

    
    //1.通过@ControllerAdvice声明是全局异常处理器类
    //2.在类中编写方法，方法的参数是要处理的异常类型，方法上通过 @ExceptionHandler声明处理的类型
    //3.
    
    
    //处理业务异常
         @ExceptionHandler(BusinessException.class)
         public ResponseEntity handleException(BusinessException be){
             be.printStackTrace();
             ErrorResult errorResult = be.getErrorResult();
             return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorResult);
         }

    //处理不可预知的异常
       @ExceptionHandler(Exception.class)
       public ResponseEntity handleException2(Exception e){
             e.printStackTrace();
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(ErrorResult.error());
       }

}