SpringBoot统一数据返回的方法实现_Java

一. 概念

其实统一数据返回是运用了aop（对某一类事情的集中处理）的思维，简单概括就是在我们进行前后端数据交互的时候，能够让后端的数据进行统一的打包封装，返回给前端，便于前后端的数据处理。

二.实现统一数据返回

其实统一数据返回非常简单，在实现时要加入类注解@controlleradvice(这是一个表示控制通知的注解，在接下来的统一异常处理也要运用到)，在添加类注解后还要在实现responsebodyadvice接口，然后重写接口的responseadvice接口和beforebodywriter方法即可实现。

添加类注解@controlleradvice，实现接口responsebodyadvice
重写responseadvice方法
重写beforebodywriter方法
特殊数据类型特殊处理（string）

2.1 重写responseadvice方法

responseadvice方法如下：

在这里插入图片描述

@override
public boolean supports(methodparameter returntype, class convertertype) {
	return true;
}

可以看到，重写该方法主要返回的是boolean数据类型，返回false表示不执行统一返回，返回true表示对于所有的数据类型都进行数据统一返回。

supports方法:判断是否要执行beforebodywrite方法.true为执行,false不执行.通过该方法可以
选择哪些类或哪些方法的response要进行处理,其他的不进行处理

2.2 重写beforebodywriter方法

beforebodywriter方法如下：

在这里插入图片描述

beforebodywrite方法:对response方法进行具体操作处理

其中的参数body最为重要，如果想要对统一后的数据进行格式的转换，直接转换body的格式就行，因为这里的body代指了所有的数据格式。

三. 特殊类型-string的处理

在经过多次不同的数据类型测试后发现，其它类型就可以顺利返回，而string类型却返回不正确。

对于string的数据类型如果想要返回，我们要先引入objectmapper，通过调用objecemapper的writevalueasstring()方法来把body的数据格式给转换成json格式，然后再次进行统一返回即可。

进行数据转换的代码如下：

private static objectmapper mapper = new objectmapper();

@override
public object beforebodywrite(object body, methodparameter returntype,mediatype selectedcontenttype, class selectedconvertertype,
 serverhttprequestrequest, serverhttpresponse response) {
 
	//如果返回结果为string类型, 使⽤springboot内置提供的jackson来实现信息的序列化
	if (body instanceof string){
		return mapper.writevalueasstring(result.success(body));
	}
	
}

四. 全部代码

import com.example.demo.model.result;
import com.fasterxml.jackson.databind.objectmapper;
import lombok.sneakythrows;
import lombok.extern.slf4j.slf4j;
import org.springframework.core.methodparameter;
import org.springframework.http.mediatype;
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;

@slf4j
@controlleradvice
public class responseadvice implements responsebodyadvice {
	
	private static objectmapper mapper = new objectmapper();
		
	@override
	public boolean supports(methodparameter returntype, class convertertype) {
		return true;
	}
	
	@sneakythrows
	@override
	public object beforebodywrite(object body, methodparameter returntype,mediatype selectedcontenttype, class selectedconvertertype, serverhttprequest
	request, serverhttpresponse response) {
	
		//返回结果更加灵活
		if (body instanceof result){
			return body;
		}
		
		//如果返回结果为string类型, 使⽤springboot内置提供的jackson来实现信息的序列化
		if (body instanceof string){
			return mapper.writevalueasstring(result.success(body));
		}
		
		return result.success(body);
	}
}