基于springboot整合了mybatis plus，lombok，log4j2并实现了全局异常处理及统一数据返回格式(code,msg,data)

1. 背景

由于微服务的流行，我们会动不动就建立一个新的项目作为一个服务，那么项目中的全局异常处理和统一数据格式是很重要的，如果设计不好，不仅开发时很乱，在查询日志时也会相当麻烦，所以我自己设计了一个简单的项目框架，个人感觉在小项目上会很好用，如果项目太大，可能需要再追求细节。

2. 项目的功能

2.1 整合了mybatis plus

2.2 整合了druid

2.3 整合了log4j2,并通过lombok，能更方便的打印日志

2.4 实现了统一数据返回格式（默认全部请求都是统一的返回格式）

2.5 实现了全局异常统一处理

2.6 利用aop打印了接口访问信息，如ip，接口访问时长等

3.功能详细讲解（由于某些文件内容过大，所以我就不在这里粘贴了，会在文章末尾提供一个项目下载地址的）

3.1 整合mybatis plus

由于本人喜欢用mybatis，所以就整合了mybatis plus作为简化mybatis操作的框架

3.1.1 安装mybatis plus

    com.baomidou
    mybatis-plus-boot-starter
    3.1.0

 建议安装3.1.0，因为大于该版本会有一个bug，那就是不能正确映射LocalDateTime类，会报错，当然如果你喜欢使用Date类，那就完全没问题，LocalDateTime是java8推出的时间类，从api的使用便捷性和性能上看比Date都要好一点，该bug可参考：https://mp.baomidou.com/guide/faq.html#error-attempting-to-get-column-create-time-from-result-set-cause-java-sql-sqlfeaturenotsupportedexception

3.1.2 在启动类上添加@MapperScan注解，并指定mapper文件夹位置

3.1.3 mybatis plus的自动填充功能

由于每张表基本上都会有created_time,updated_time等公共属性，并且我们又想在创建时自动设置时间，而不用我们在service层中手动设置时间属性,这就可以使用mybatis的自动填充功能呢。

首先创建一个MyBatisPlusConfig配置类，开启他的自动填充功能

@Configuration
public class MyBatisPlusConfig {

	/**
     *	 自动填充功能
     * @return
     */
    @Bean
    public GlobalConfig globalConfig() {
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setMetaObjectHandler(new MetaHandler());
        return globalConfig;
    }
}

 其次创建MetaHandler类，重写MetaObjectHandler接口中的方法即可，我的项目中有该文件，此处就不作展示了

3.2 整合druid

3.2.1 安装druid

    com.alibaba
    druid
    1.1.16

3.2.2 创建一个application-druid.yml文件，并添加配置

3.2.3 在application.yml添加application-druid.yml配置，使其生效

spring:
  profiles:
    active:
    - druid
    - dev

3.2.4 创建DruidConfig配置类

至此，druid的配置就结束了，可通过localhost:8080/druid 查看sql访问情况

3.3 整合log4j2

3.3.1 引入依赖

   
	 org.springframework.boot  
	 spring-boot-starter-log4j2  
 

3.3.2 去除springboot默认使用的logback

	org.springframework.boot
	    spring-boot-starter-web
		  
		     
		      org.springframework.boot  
		      spring-boot-starter-logging  
		  
      

3.3.3 创建log4j2-sit.xml文件，并放在src/main/resource的目录下

3.3.4 在application.yml中进行配置，使得springboot使用log4j2作为默认日志框架

logging:
  config: classpath:log4j2-sit.xml

3.3.5 整合lombok，使用log打印日志

	org.projectlombok
	lombok
	true

@Log4j2
public class TestService{
	public void insertUser() {
		log.info("aa");
	}
}

以往我们打印日志都需要先 Logger log = LoggerFactory.getLogger(xxx)一下，然后再使用，这种使用方式太麻烦，第一是各种框架获取logger对象的方法是不一样的，导致你使用前还要去看看以前代码，当然如果你记忆力好，那也没啥问题，第二是要传入当前类的class。而集成了lombok后

通过两步就可以很方便打印日志了，第一步，在class上添加@log4j2注解，这是lombok的注解，如果没有该注解，请检查下使用添加了lombok的依赖，第二部，直接log对象打印即可。

3.3.6 当你使用了lombok的@Data注解，会遇到一个问题，当你继承了一个父类时，会有警告，此时需要在/src/main/java目录下创建一个lombok.config文件：

config.stopBubbling=true
lombok.equalsAndHashCode.callSuper=call

3.4 统一数据返回格式

3.4.1 思路

我设计的思路：由于目前是前后端分离，所以现在的后端项目基本上返回的都是json，并不会进行页面跳转控制。我们规定所有返回给前端的数据格式均为{code,msg,data}这三个参数，报错另说。我添加了一个拦截器，该拦截器会拦截所有请求，并判断controller层的方法上是否有被ResponseNature注解修饰，该注解是自定义的注解，如果没有，那么就添加一个attr在request中做一个标记，如果有该注解就不添加该attr。并添加一个controllerAdvice增强器，在被@responseBody处理数据前，对数据进行自定义的处理，处理时判断是否有在拦截器中做的attr标记，如果有，那么就说明需要做同一格式，没有，就不做。所以写代码时，不用添加任何注解，默认就是将数据进行统一返回格式处理，如果你不想处理，就要返回原本的对象，那么就在方法或者类上添加@ResponseNature注解

3.4.2 创建ResponseResultInterceptor类

/**
 * 
 */
package com.rewa.test.interceptor;

import java.lang.reflect.Method;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import com.rewa.test.annotations.ResponseNature;
import com.rewa.test.util.DBConstants;
import com.rewa.test.util.RequestContextUtil;

@Component
public class ResponseResultInterceptor implements HandlerInterceptor {
	

	/**
	 * 拦截请求，默认给所有请求添加RESPONSE_RESULT标识，如果controller层的类或方法有被ResponseNature注解修饰，那么就不添加标识，即不进行统一数据返回
	 */
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
		RequestContextUtil.setRequestId();
		if (handler instanceof HandlerMethod) {
			final HandlerMethod handlerMethod = (HandlerMethod) handler;
			final Class clazz = handlerMethod.getBeanType();
			final Method method = handlerMethod.getMethod();
			if (clazz.isAnnotationPresent(ResponseNature.class) ||  method.isAnnotationPresent(ResponseNature.class)) {
				return true;
			}
			request.setAttribute(DBConstants.RESPONSE_RESULT,DBConstants.RESPONSE_RESULT);
		}
		return true;
	}

	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
	}

	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
	}
}

3.4.3 创建InterceptorConfig配置文件

package com.rewa.test.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import com.rewa.test.interceptor.ResponseResultInterceptor;

@Configuration
public class InterceptorConfig implements WebMvcConfigurer{

	public static String ALLPATH = "/**";
	@Autowired
	private ResponseResultInterceptor responseResultInterceptor;
	
	@Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 对所有的请求都要拦截
        registry.addInterceptor(responseResultInterceptor).addPathPatterns(ALLPATH);
    }
}

注意：有些人看别人的博客在开启拦截器时会添加@EnableWebMvc注解，该注解添加后会有非常多的问题，我个人不建议使用该注解，不添加该注解，拦截器也是可以正常工作的，具体有哪些坑，我遇到的一个是application.yml里面对json的配置失效了，即

spring:
  jackson:
    default-property-inclusion: non-null

具体有哪些坑，可以参考该文章：https://blog.csdn.net/zxc123e/article/details/84636521

通过以上配置，我们已经成功对request进行了标识，现在我们就要开始处理返回数据了

3.4.4 添加ResponseResultHandle类

package com.rewa.test.handle;

import javax.servlet.http.HttpServletRequest;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
import com.rewa.test.constants.DBConstants;
import com.rewa.test.msg.response.UnitiveResponse;
import com.rewa.test.util.JsonUtil;
import com.rewa.test.util.RequestContextUtil;

@ControllerAdvice
public class ResponseResultHandle implements ResponseBodyAdvice