[Java知识库]SpringBoot-Jackson引擎和BasicErrorController全局异常

本文将会介绍SpringBoot中Jackson引擎以及BasicErrorController全局异常。

一、SpringBoot-Jackson引擎

1、HttpMessageConvertersAutoConfiguration自动配置类

??这个是SpringBoot的消息转化器，默认支持三种JSON框架@Import({JacksonHttpMessageConvertersConfiguration.class, GsonHttpMessageConvertersConfiguration.class, JsonbHttpMessageConvertersConfiguration.class}) :

• Jackson：SpringBoot默认开启的JSON框架，简单易用，所用的依赖相对较少，性能相对较高。但是对复杂的转化会出现问题。
• Gson：Gson是目前功能最全的JSON解析解析器，基本无依赖，功能上面无可挑剔。
• Jsonb：Jsonb在功能上和性能上有好多缺陷，依赖的第三方jar包较多，对复杂的转化会出现问题。

@Configuration 
@ConditionalOnClass({HttpMessageConverter.class}) 
@AutoConfigureAfter({GsonAutoConfiguration.class, JacksonAutoConfiguration.class, JsonbAutoConfiguration.class}) 
@Import({JacksonHttpMessageConvertersConfiguration.class, GsonHttpMessageConvertersConfiguration.class, JsonbHttpMessageConvertersConfiguration.class}) 
public class HttpMessageConvertersAutoConfiguration { 
	…………省略其他代码……………… 
}

2、jackson常用注解使用

??jackson的这些注解可以配合org.springframework.validation.annotation做参数校验，@Validated通过建立分组来区分不同场景下参数校验规则，基本上可以满足大部分需求。

• @JsonProperty(“userName”)：给属性设置别名
• @JsonInclude(JsonInclude.Include.NON_NULL)：该属性不为空的时候，才包含这个属性
• @JsonIgnore：忽略这个属性，返回给客户端的时候不包含这个字段。
• @JsonFormat(pattern = “yyyy-mm-dd HH:MM:ss”)：时间格式化。

// 使用前，请导入以下依赖
<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

public class User { 
	@JsonProperty("userName")
    private String name;

    @NotBlank(groups = Add.class, message = "性别不能为空字符串")
    @NotNull(groups = Add.class, message = "性别不能为空值")
    private String sex;

    @JsonIgnore
    private int age;

    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String phone;

    @JsonFormat(pattern = "yyyy-mm-dd HH:MM:ss")
    @NotNull(groups = Add.class, message = "出生日期不能为空")
    private Date birthday = new Date();
}

访问后，User转化结果如下：
请求参数：

返回参数：

3、JSON序列化和反序列化
??jackson的@JsonComponent注解可以帮助我们定制自己的序列化规则，SpringBoot提供了已经分装好的序列化类JsonObjectSerializer和反序列化JsonObjectDeserializer类。
注意：使用序列化和反序列化的时候，实体类上的Jsckson就会失效。

@JsonComponent
public class UserJsonConsumer {
	 public static class Serializer extends JsonObjectSerializer<User> {
      
      @Override
        protected void serializeObject(User user, JsonGenerator jgen, SerializerProvider provider) throws IOException {
            // 返回客户端的时候。只返回userName属性
            jgen.writeObjectField("userName", user.getName());
            jgen.writeObjectField("age", user.getAge());
            /**
             * 这里可以序列化其他的字段。当然这里也可以做一些其他的业务逻辑处理。
             * 比如：根据用户的角色，返回部分字段，例如admin用户可以查看所有字段，
             * 而ordinary用户只可以查看部分字段。
             **/
        }
    }
    
    public static class DSerializer extends JsonObjectDeserializer<User> {
        @Override
        protected User deserializeObject(JsonParser jsonParser, DeserializationContext context, ObjectCodec codec,JsonNode tree) throws IOException {
        	// 从客户端接受参数后，之反序列化userName、sex属性的值，也就说只处理这两个属性的值
            User user = new User();
            user.setName(tree.findValue("userName").asText());
            user.setAge(tree.findValue("age").asInt());
            return user;
        }
    }
}

结果，如果使用了序列化和反序列化，那实体上的Jackson就会失效，比如，年龄我们是加了 @JsonIgnore，但是在返回参数中包含了：
请求参数：

返回参数：

二、SpringBoot-BasicErrorController全局异常

1、ErrorMvcAutoConfiguration自动配置类

??这个是SpringBoot全局异常自动配置类。ErrorMvcAutoConfiguration配置类中注入了DefaultErrorAttributes和BasicErrorController的两个Bean。

@Configuration
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class })
// Load before the main WebMvcAutoConfiguration so that the error View is available
@AutoConfigureBefore(WebMvcAutoConfiguration.class)
@EnableConfigurationProperties({ ServerProperties.class, ResourceProperties.class, WebMvcProperties.class })
public class ErrorMvcAutoConfiguration {
   private final ServerProperties serverProperties;
    
   @Bean
   @ConditionalOnMissingBean(value = ErrorAttributes.class, search = SearchStrategy.CURRENT)
   public DefaultErrorAttributes errorAttributes() {
      return new DefaultErrorAttributes(this.serverProperties.getError().isIncludeException());
   }
    
   @Bean
   @ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
   public BasicErrorController basicErrorController(ErrorAttributes errorAttributes) {
      return new BasicErrorController(errorAttributes, this.serverProperties.getError(), this.errorViewResolvers);
   }
}

1.1、BasicErrorController Bean

??BasicErrorController 实际上就是一个全局异常的控制器。

@Controller
// 如果自定义了异常映射那么就使用自定义的异常映射，默认/error注解，
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {
    // 如果是页面请求produces = MediaType.TEXT_HTML_VALUE，则返回一个默认的ModelAndView视图模板。
    @RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
	public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
        // 这里获取的就是Http请求的状态码
		HttpStatus status = getStatus(request);
		Map<String, Object> model = Collections
				.unmodifiableMap(getErrorAttributes(request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
		response.setStatus(status.value());
		ModelAndView modelAndView = resolveErrorView(request, response, status, model);
		return (modelAnmadView != null) ? modelAndView : new ModelAndView("error", model);
	}

    // 如果是其他请求方式（Ajax请求），就返回封装的JSON数据。
	@RequestMapping
	public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
		Map<String, Object> body = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.ALL));
		HttpStatus status = getStatus(request);
		return new ResponseEntity<>(body, status);
	}
}

• getErrorAttributes()：实际上就是调用了DefaultErrorAttributes 的getErrorAttributes方法，返回了异常需要的各种属性。

@Override 
public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) { 
	Map<String, Object> errorAttributes = new LinkedHashMap<>(); 
	errorAttributes.put("timestamp", new Date()); // 时间戳 
	addStatus(errorAttributes, webRequest); // 错误状态
	 // 错误详情，可以控制是否允许堆栈信息返回 includeStackTrace为false可不反回堆栈信息
	addErrorDetails(errorAttributes, webRequest, includeStackTrace);
	addPath(errorAttributes, webRequest); // 错误请求的路劲 
	return errorAttributes;
 }

• resolveErrorView()：查找错误视图处理器，默认委派给ErrorViewResolver视图处理器处理，也就是DefaultErrorViewResolver处理。实际上也就是调用了DefaultErrorViewResolver的resolveErrorView()方法。该方法根据状态码去/error下寻找xxx.html，如果我们没有配置，那么直接返回一个null。最终errorHtml()就会帮我们new ModelAndView(“error”, model)返回到客户端，而error()会帮我们直接将错误信息封装到ResponseEntity响应实体中返回。

@Override 
public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<String, Object> model) { 
	ModelAndView modelAndView = resolve(String.valueOf(status.value()), model); 
	if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {
	 		modelAndView = resolve(SERIES_VIEWS.get(status.series()), model); 
	} 
	return modelAndView; 
} 

1.2、DefaultErrorAttributes Bean

??DefaultErrorAttributes 实际上是封装了ServerProperties里面的部分配置内容，ErrorAttributes的默认实现。尽可能提供以下属性：

• timestamp - The time that the errors were extracted
• status - The status code
• error - The error reason
• exception - The class name of the root exception (if configured）
• message - The exception message
• errors - Any ObjectErrors from a BindingResult exception
• trace - The exception stack trace
• path - The URL path when the exception was raised

1.3、DefaultErrorViewResolverConfiguration Bean

??DefaultErrorViewResolverConfiguration 里面创建了一个DefaultErrorViewResolver Bean，后续在出现异常的情况下，默认就是调用了DefaultErrorViewResolver的resolveErrorView()方法去构建错误页面。

1.4、DefaultErrorViewResolver

??尝试使用已知约定解析错误视图，是默认ErrorViewResolver实现。将使用状态代码和状态系列搜索“/error”下的模板和静态资源。
例如，HTTP 404将搜索（按特定顺序）：
‘//error/404.’
‘//error/404.html’
‘//error/4xx.’
‘//error/4xx.html’

2、定制全局配置错误处理

2.1 、浏览器请求，返回错误页面定制（一） （不重要）

??了解了上述的全局错误配置原理之后，那么我们可以自己定制自己的错误页面或者返回信息。在SpringBoot静态资源加载原理中我们提到，SpringBoot默认情况下会在classpath:[/META-INF/resources/,/resources/, /static/, /public/]下查找静态资源，那么我们可以将自己定制的错误页面比如404.html直接放在/static/error/目录中，这样，在出现异常的是情况下，就去加载我们自己的错误页面。

2.2、浏览器请求，返回错误页面定制（二） （不重要）

??BasicErrorController是全局异常处理的控制层，它上边有一个@ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)的注释，这就说明，当我们自己定义一个ErrorController的时候，BasicErrorController就会失效。那么我们就可以自定义ConsumerErrorController实现ErrorController接口，重写它的errorHtml方法就可以实现错误页面定制的功能。

@Controller 
public class ConsumerErrorController implements ErrorController { 
	// 自定义errorHtml方法，去找自定义的错误页面 
	@RequestMapping(produces = MediaType.TEXT_HTML_VALUE) 
	public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) throws IOException { 
	 	Resource resource = resourceLoader.getResource("classpath:/static/"); 
	 	// 这里如果能动态获取到请求状态码，那么就可以根据不同的状态码返回不同的错误错误页面，前提是在/error目录下放不同状态码的html文件。 
	  	Integer statusCode = 404; 
	  try { 
	  	HttpStatus.valueOf(statusCode); 
	  } catch (Exception ex) { 
	  	statusCode = HttpStatus.INTERNAL_SERVER_ERROR.value(); 
	  } 
	  String errorViewName = "error/" + statusCode; 
	  resource = resource.createRelative(errorViewName + ".html"); 
	  if (resource.exists()) { 
	  	return new ModelAndView(new HtmlResourceView(resource));
	  } 
	   return new ModelAndView();
 	}

    private static class HtmlResourceView implements View {
        private Resource resource;
        HtmlResourceView(Resource resource) {
            this.resource = resource;
        }

        @Override
        public String getContentType() {
            return MediaType.TEXT_HTML_VALUE;
        }

        @Override
        public void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response)
            throws Exception {
            response.setContentType(getContentType());
            FileCopyUtils.copy(this.resource.getInputStream(), response.getOutputStream());
        }
    }
    ………省略其他代码………
}

2.3、定制全局错误JSON格式(一)（熟悉）

??BasicErrorController是全局异常处理的控制层，它上边有一个@ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)的注释，这就说明，当我们自己定义一个ErrorController的时候，BasicErrorController就会失效。那么我们就可以自定义ConsumerErrorController实现ErrorController接口，重写它的error方法就可以实现错误JSON格式定制的功能。

@Controller 
public class UserErrorConsumer implements ErrorController { @RequestMapping @ResponseBody 
public ResultDto error(HttpServletRequest request) { 
	ResultDto resultDto = new ResultDto();
	 resultDto.setMessage("这是测试页面！"); 
	 return resultDto; 
	 } 
	 ………省略其他代码……… 
}

public class ResultDto<T> {
    private String status;
    private String message;
    private String code;
    private T data;
    ………省略getter和setter方法………
}

2.4、定制全局错误JSON格式(二) （推荐）

??Spring Boot中提供了@ControllerAdvice注解，这个注解可以用来定制全局异常处理。

@ControllerAdvice 
public class GlobalException extends Throwable {
    @ResponseBody
    @ExceptionHandler
    public ResultDto exceptionHandle(Exception e, HttpServletRequest request, HttpServletResponse response) {
        ResultDto resultVo = new ResultDto<>();

        if (e instanceof NullPointerException) {
            resultVo.setMessage("空指针异常");
            resultVo.setCode("401");
        } else if (e instanceof SQLException) {
            resultVo.setMessage("SQL异常");
            resultVo.setCode("402");
        } else if (e instanceof MethodArgumentNotValidException) {
         	resultVo.setMessage(Objects.requireNonNull(((MethodArgumentNotValidException) e).getFieldError()).getDefaultMessage());
            resultVo.setCode("500");
        } else {
            resultVo.setMessage("服务器内部异常");
            resultVo.setCode("501");
        }
        return resultVo;
    }
}

结果：
请求参数：

返回结果：

总结

本文介绍了SpringBoot中Jackson引擎以及BasicErrorController全局异常，解读了部分源码内容，大致讲解了SpringBoot中Jackson的使用，以及全局异常处理的具体实现。