【个人博客项目 4】自定义全局返回类型模板、自定义全局异常，并以json形式返回在页面

最新推荐文章于 2022-06-02 21:08:38 发布

swyee

最新推荐文章于 2022-06-02 21:08:38 发布

阅读量1.4k

点赞数

分类专栏：实战项目 ssm 文章标签： java spring json

本文链接：https://blog.csdn.net/qq_44433261/article/details/107889046

版权

实战项目同时被 2 个专栏收录

5 篇文章 0 订阅

订阅专栏

ssm

5 篇文章 0 订阅

订阅专栏

文章目录

首先添加全局的信息返回格式

自定义一个全局的返回格式，使返回结果更加规范化，前后端联调的时候能够更加轻松

在model新增实体类AllResultMessage

package com.swyee01.model;

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

/**
 * @author Swyee
 * @Program job
 * @date 2020/8/9  0:38
 **/
@Data 
@AllArgsConstructor
@NoArgsConstructor
public class AllResultMessage<T> {
        private String code;
        private String msg;
        private T data;

}
//注解式通过lombok实现的，如果没有安装插件，手动添加get set和构造方法

输出展示

返回代码写法

package com.swyee01.controller;

import com.swyee01.model.AllResultMessage;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author swyee
 * @Program Blog
 * @Description:
 * @date 2020/8/9  1:59
 **/
@Controller //加上注解可以被springMvc管理
@ResponseBody //返回json形式
// 上面两个注解可以简写成 @RestController
@RequestMapping(value = "test") //需要在url拼接的路径
public class TestController {

    @RequestMapping(value = "aa")//同样是配置路径拼接，加上上面的配置，路径为 test/aa.do  因为我们在web的配置，我们只会处理以.do结尾的请求
    public AllResultMessage<String> test(){

        return new AllResultMessage<>("SUCCESS","结果返回成功了","这是数据，可以返回任何类型值");
    }
}

运行 http://localhost:8880/test/aa.do

自定义全局异常

新建一个package Exception 专门用来存自定义异常
新建异常类 CustomException

package com.swyee01.Exception;

import lombok.Data;

/**
 * @author Swyee
 * @Program Blog
 * @Description:
 * @date 2020/8/9  1:14
 **/
@Data
public class CustomException extends RuntimeException { //运行时异常
    private String code;
    private String msg;

    public CustomException(String code, String msg) {
        super(msg);
        this.code = code;
        this.msg = msg;
    }
}

全局异常处理新建 CustomExceptionHandler 对CustomException 进行监视

package com.swyee01.Exception;

import com.swyee01.model.AllResultMessage;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @author Swyee
 * @Program Blog
 * @Description:
 * @date 2020/8/9  1:16
 **/
@ControllerAdvice//这个注解可以对全局进行处理
public class CustomExceptionHandler {
    @ExceptionHandler(value = CustomException.class)
    @ResponseBody
    public AllResultMessage<Object> handle(CustomException e) {
        return new AllResultMessage<>(e.getCode(), e.getMsg(), null);//返回AllResultMessage形式的异常
    }
}

异常展示

controller

package com.swyee01.controller;

import com.swyee01.Exception.CustomException;
import com.swyee01.model.AllResultMessage;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author swyee
 * @Program Blog
 * @Description:
 * @date 2020/8/9  1:59
 **/
@Controller //加上注解可以被springMvc管理
@ResponseBody //返回json形式
// 上面两个注解可以简写成 @RestController
@RequestMapping(value = "test") //需要在url拼接的路径
public class TestController {

    @RequestMapping(value = "aa")//同样是配置路径拼接，加上上面的配置，路径为 test/aa.do  因为我们在web的配置，我们只会处理以.do结尾的请求
    public AllResultMessage<String> test(){
        throw new CustomException("error","发生异常了");
        //return new AllResultMessage<>("SUCCESS","结果返回成功了","这是数据，可以返回任何值");
    }
}