电商项目专题(五)-通用的的异常处理

1.场景预设

1.1.场景

加入我们做新增商品，需要接收下面的参数：

price：价格
name：名称

然后对数据做简单校验：

价格不能为空

新增时，自动生成 ID ，然后随商品对象一起返回

1.2.代码实现

项目结构：

实体类：

package com.yigou.item.pojo;

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

/**
 * @author bruceliu
 * @create 2019-09-01 12:36
 * @description
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Item {
    private Integer id;
    private String name;
    private Long price;
}

service：

package com.yigou.item.service;

import com.yigou.item.pojo.Item;
import org.springframework.stereotype.Service;

import java.util.Random;

/**
 * @author bruceliu
 * @create 2019-09-03 22:12
 * @description
 */
@Service
public class ItemService {

    public Item saveItem(Item item){
        // 商品新增
        int id = new Random().nextInt(100);
        item.setId(id);
        return item;
    }
}

controller：

package com.yigou.item.controller;

import com.yigou.item.pojo.Item;

import java.util.List;

import com.yigou.item.service.ItemService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author bruceliu
 * @create 2019-09-01 12:38
 * @description
 */
@RestController
@RequestMapping("item")
public class ItemController {

    @Autowired
    private ItemService itemService;

    @PostMapping
    public ResponseEntity<Item> saveItem(Item item){
        // 校验商品的价格
        if (item.getPrice() == null){
            return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(null);
        }
        Item item1 = itemService.saveItem(item);
        return ResponseEntity.status(HttpStatus.CREATED).body(item1);
    }
}

测试：

如果price为空：

改写Controller给出异常消息：

package com.yigou.item.controller;

import com.yigou.item.pojo.Item;

import java.util.List;

import com.yigou.item.service.ItemService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author bruceliu
 * @create 2019-09-01 12:38
 * @description
 */
@RestController
@RequestMapping("item")
public class ItemController {

    @Autowired
    private ItemService itemService;

    @PostMapping
    public ResponseEntity<Item> saveItem(Item item){
        // 校验商品的价格
        if (item.getPrice() == null){
            throw new RuntimeException("价格不能为空！");
        }
        Item item1 = itemService.saveItem(item);
        return ResponseEntity.status(HttpStatus.CREATED).body(item1);
    }

}

测试结果：

是SpringMvc处理的异常，但是500是服务器内部错误，而真正异常的原因是客户端引发的异常
上述异常是由 SpringMVC 处理的，而我们真正要的是自己处理！

2.通用的异常处理

放到 yigou-common 里面公共起来

ExceptionEnum：枚举 异常

package com.yigou.common.enums;

import lombok.*;

/**
 * @author bruceliu
 * @create 2019-09-03 22:35
 * @description
 */
@Getter
@NoArgsConstructor
@AllArgsConstructor
public enum ExceptionEnum {

    PRICE_CANNOT_BE_NULL(400, "价格不能为空！");
    private int code;
    private String msg;
}

ExceptionResult：异常结果 定义

package com.yigou.common.vo;

import com.yigou.common.enums.ExceptionEnum;
import lombok.Data;

/**
 * @author bruceliu
 * @create 2019-09-03 22:37
 * @description
 */
@Data
public class ExceptionResult {
    private int status;
    private String message;
    private Long timestamp;

    public ExceptionResult(ExceptionEnum em) {
        this.status = em.getCode();
        this.message = em.getMsg();
        this.timestamp = System.currentTimeMillis();
    }
}

YigouException：自定义 异常

package com.yigou.common.exception;

import com.yigou.common.enums.ExceptionEnum;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;

/**
 * @author bruceliu
 * @create 2019-09-03 22:40
 * @description
 */
@NoArgsConstructor
@AllArgsConstructor
@Getter
public class YigouException extends RuntimeException{

    private ExceptionEnum exceptionEnum;

}

CommonExceptionHandler：定义 通用的异常处理
添加依赖（不需要指定版本）

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
</dependency>

package com.yigou.common.advice;

import com.yigou.common.exception.YigouException;
import com.yigou.common.vo.ExceptionResult;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

/**
 * @author bruceliu
 * @create 2019-09-03 22:41
 * @description
 */
@ControllerAdvice
public class CommonExceptionHandler {

    @ExceptionHandler(YigouException.class)
    public ResponseEntity<ExceptionResult> handleException(YigouException e) {
        return ResponseEntity.status(e.getExceptionEnum().getCode())
                .body(new ExceptionResult(e.getExceptionEnum()));
    }

}

在 yigou-item-service 里面依赖 yigou-common ：

<dependency>
    <groupId>com.yigou.parent</groupId>
    <artifactId>yigou-common</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

改写 ItemController

package com.yigou.item.controller;

import com.yigou.common.enums.ExceptionEnum;
import com.yigou.common.exception.YigouException;
import com.yigou.item.pojo.Item;

import java.util.List;

import com.yigou.item.service.ItemService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author bruceliu
 * @create 2019-09-01 12:38
 * @description
 */
@RestController
@RequestMapping("item")
public class ItemController {

    @Autowired
    private ItemService itemService;

    @PostMapping
    public ResponseEntity<Item> saveItem(Item item){
        // 校验商品的价格
        if (item.getPrice() == null){
            throw new YigouException(ExceptionEnum.PRICE_CANNOT_BE_NULL);
        }
        Item item1 = itemService.saveItem(item);
        return ResponseEntity.status(HttpStatus.CREATED).body(item1);
    }

}

测试：