JSON和全局异常处理

一. JSON

现在的开发中,几乎都是前后端分离的形式,越来越多的请求使用Ajax的异步请求,而不再是传统的跳转,使用Ajax异步请求之后,我们后端处理结果大多以JSON的形式进行响应,响应给前端,前端得到响应结果后,进行处理和渲染。在SpringMVC中,使用JSON非常的简单,SpringMVC中可以将集合等数据自动的转换成JSON数据格式,当然我们需要加入JSON相关的依赖。
 

二、JSON数据格式 

JSON数据就是一段字符串而已,只不过有不同意义的分隔符将其分割开来而已,我们看上面的符号,里面有[] ,{}等符号。

1、[]中括号代表的是一个数组 

 [{"name":"胡小威" , "age":20 , "male":true},{"name":"赵小亮" , "age":22 , "male":false}]

2、{}大括号代表的是一个对象  

        {"name":"胡小威" , "age":20 , "male":true}           

3、混合 

     {'total':80,'rows':10,[{'bookNane':'三资金','price':100},{'bookName':'金刚经','price':200}]

双引号""表示的是属性值
冒号:代表的是前后之间的关系,冒号前面是属性的名称,后面是属性的值,这个值可以是基本数据类型,也可以是引用数据类型
 

三、返回JSON配置步骤 

1、首先导入JSON的相关依赖
在pom.xml中配置


    
      com.fasterxml.jackson.core
      jackson-databind
      ${jackson.version}
    
    
      com.fasterxml.jackson.core
      jackson-core
      ${jackson.version}
    
    
      com.fasterxml.jackson.core
      jackson-annotations
      ${jackson.version}
    

2、在springmvc.xml文件中配置JSON的消息转换器


        
            
                
            
        
    
    
        
        
            
                text/html;charset=UTF-8
                text/json;charset=UTF-8
                application/json;charset=UTF-8
            
        
    

3、在控制层使用@ResponseBody注解标记请求处理方法

        被该注解所标记的请求处理方法将返回JSON格式的数据,绕开视图解析器

注:开启注解式开发使用

四、返回JSON数据格式

1、返回List泛型格式的JSON数据

@RequestMapping("/queryListBooks")
    @ResponseBody
    public List queryListBooks(Book book,HttpServletRequest request){
        PageBean pageBean=new PageBean();
        pageBean.setRequest(request);
        List books = bookService.queryBookPager(book, pageBean);
        return   books;
    };

JSON和全局异常处理_第1张图片

 2、返回实体类型的JSON数据

@RequestMapping("/querySingleBook")
    @ResponseBody
    public Book querySingleBook(Integer bookId){
        Book book = bookService.selectByPrimaryKey(bookId);
        book.setDate(new Date());
        return book;
    }

在实体类属性中使用@JsonIgnore  

此注解代表在返回JSON数据时会忽略此字段 只在返回实体类时有效

在实体类属性中使用@JsonProperty

在返回实体类的JSON数据格式时,给此字段取别名 只在返回实体类时有效

在实体类中的时间类型的属性使用@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone = "GMT+8")

在返回实体类的JSON数据格式时,给此字段转换类型为pattern属性,因为时区的问题,还需要加上八小时,为东八区。

 3、返回Map类型的JSON数据

 @RequestMapping("/querySingleMap")
    @ResponseBody
    public Map querySingleMap(Integer bookId){
        return  bookService.querySingleMap(bookId);
    }

在此类型中如要时间类型转换,就得去mapper.xml文件中的sql语句用函数转换

4、查询返回List类型的JSON数据

@RequestMapping("/queryMapList")
    @ResponseBody
    public List> queryMapList( ){
           return bookService.queryBookAll();
    }

JSON和全局异常处理_第2张图片

 5、返回混合类型的JSON数据

@RequestMapping("/queryhybridBooks")
    @ResponseBody
    public Map queryhybridBooks(Book book,HttpServletRequest request){
        PageBean pageBean=new PageBean();
        pageBean.setRequest(request);
        List books = bookService.queryBookPager(book, pageBean);
        Map json=new HashMap<>();
        json.put("total", pageBean.getTotal());
        json.put("rows", books);
        return json;
    };

JSON和全局异常处理_第3张图片

 6、返回String类型的JSON数据类型

@RequestMapping("/queryString")
    @ResponseBody
    public String queryString(){
        return "book/bookList";
    }

五、Spring MVC异常处理机制 

我们知道,系统中异常包括:编译时异常和运行时异常RuntimeException,前者通过捕获异常从而获取异常信息,后者主要通过规范代码开发、测试通过手段减少运行时异常的发生。在开发中,不管是(dao/mapper)层、service层还是controller层,都有可能抛出异常。

而在Spring MVC中提供了一个通用的异常处理机制,它提供了一个成熟、简洁并且清晰的异常处理方案。当使用Spring MVC开发Web应用时,利用这套现成的机制进行异常处理也更加自然并且高效。
 

六、SpringMVC异常处理

1、异常处理机制流程图

系统中异常包括两类:

预期异常 通过捕获异常从而获取异常信息

运行时异常

RuntimeException

主要通过规范代码开发、测试等手段减少运行时异常的发生

系统的Dao(mapper)、Service、Controller出现都通过throws Exception向上抛出,最后SpringMVC前端控制器交由异常处理器进行异常处理,如下图:

JSON和全局异常处理_第4张图片

 2、异常处理的三种方式

1)使用Spring MVC提供的简单异常处理器SimpleMappingExceptionResolver; 
2)实现Spring的异常处理接口HandlerExceptionResolver自定义自己的异常处理器;
3)使用@ControllerAdvice + @ExceptionHandler

1、简单异常处理器SimpleMappingExceptionResolver

SpringMVC中自带了一个异常处理器叫SimpleMappingExceptionResolver,该处理器实现了HandlerExceptionResolver 接口,全局异常处理器都需要实现该接口

配置SpringMVC的简单的异常处理器


       
       
        
       
        
       
                   
               error
           
           
       
    

方法中抛出此异常

@RequestMapping("/querySingleBook")
    @ResponseBody
    public Book querySingleBook(Integer bookId){
        Book book = bookService.selectByPrimaryKey(bookId);
        if(bookId>100)
            throw new RuntimeException("书本编号大于100,异常抛出!!!");
        book.setDate(new Date());
        return book;
    }

2、实现接口HandlerExceptionResolver自定义自己的异常处理器

package com.zking.ssm.book.exception;
 
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
 
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
/**
 * SpingMVC提供的第二种全局异常处理方式  ,实现HandlerExceptionResolver接口
 */
@Component
public class GlobalException implements HandlerExceptionResolver {
    /**
     *
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o 异常处理的目标
     * @param e 异常处理的类型
     * @return
     */
    @Override
    public ModelAndView resolveException(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) {
        ModelAndView mv=new ModelAndView();
        mv.setViewName("error");
        //判断异常的分类
        if(e instanceof RuntimeException){
                RuntimeException ex=(RuntimeException)e;
                System.out.println(ex.getMessage());
                mv.addObject("msg",ex.getMessage());
        }
        return mv;
    }
}

创建异常类

package com.zking.ssm.book.exception;
 
 
public class BusinessException extends RuntimeException {
   
    public BusinessException() {
    }
 
    public BusinessException(String message) {
        super(message);
    }
 
    public BusinessException(String message, Throwable cause) {
        super(message, cause);
    }
 
    public BusinessException(Throwable cause) {
        super(cause);
    }
 
   
}
@RequestMapping("/querySingleBook")
    @ResponseBody
    public Book querySingleBook(Integer bookId){
        Book book = bookService.selectByPrimaryKey(bookId);
        if(bookId>100)
            throw new BusinessException("书本编号大于100,异常抛出!!!");
        book.setDate(new Date());
        return book;
    }

3、使用@ControllerAdvice + @ExceptionHandler

package com.zking.ssm.book.exception;
 
 
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.view.json.MappingJackson2JsonView;
 
import java.util.HashMap;
import java.util.Map;
 
 
/**
 * SpingMVC提供的第三种种全局异常处理方式
 * 1)@ControllerAdvice +@ExceptionHandler
 * 2)@RestControllerAdvice +@ExceptionHandler
 *      @RestControllerAdvice ==@Controller +@ResponseBody 返回JSON的数据格式,绕开视图解析器
 */
@ControllerAdvice
public class GlobalException2{
        @ExceptionHandler
        public ModelAndView exceptionHandler(Exception e){
            ModelAndView mv=new ModelAndView();
            //设置错误页面
            mv.setViewName("error");
            //判断异常类型
            if(e instanceof BusinessException){
            BusinessException ex=(BusinessException)e;
                mv.addObject("msg","系统繁忙,请稍后再试.......");
            }
 
            mv.setView(new MappingJackson2JsonView());
            return mv;
        }
 
}

返回JSON格式

package com.zking.ssm.book.exception;
 
 
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.view.json.MappingJackson2JsonView;
 
import java.util.HashMap;
import java.util.Map;
 
 
/**
 * SpingMVC提供的第三种种全局异常处理方式
 * 1)@ControllerAdvice +@ExceptionHandler
 * 2)@RestControllerAdvice +@ExceptionHandler
 *      @RestControllerAdvice ==@Controller +@ResponseBody 返回JSON的数据格式,绕开视图解析器
 */
@RestControllerAdvice
public class GlobalException2{
        @ExceptionHandler
        public ModelAndView exceptionHandler(Exception e){
            ModelAndView mv=new ModelAndView();
            mv.setViewName("error");
            //判断异常类型
            if(e instanceof BusinessException){
            BusinessException ex=(BusinessException)e;
                mv.addObject("msg","系统繁忙,请稍后再试.......");
            }
 
            //强制更换视图解析器  不跳页面!!!
            mv.setView(new MappingJackson2JsonView());
            return mv;
        }
 
       
}

返回异常信息和状态码

package com.zking.ssm.book.exception;
 
 
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.view.json.MappingJackson2JsonView;
 
import java.util.HashMap;
import java.util.Map;
 
 
/**
 * SpingMVC提供的第三种种全局异常处理方式
 * 1)@ControllerAdvice +@ExceptionHandler
 * 2)@RestControllerAdvice +@ExceptionHandler
 *      @RestControllerAdvice ==@Controller +@ResponseBody 返回JSON的数据格式,绕开视图解析器
 */
@RestControllerAdvice
public class GlobalException2{
 
        @ExceptionHandler
        public Map exceptionHandler(Exception e){
            Map json=new HashMap();
            //判断异常类型
            if(e instanceof BusinessException){
                json.put("msg","系统繁忙,请稍后再试.......");
                json.put("code",500);
            }
 
            return json;
        }
}

至此,JSON和全局异常处理介绍完毕,由于作者水平有限难免有疏漏,欢迎留言纠错。

你可能感兴趣的:(java,spring)