SpringBoot全局Controller返回值格式统一

一、返回值格式统一

1.返回值介绍

在使用controller对外提供服务的时候，很多时候都需要统一返回值格式，例如

{
	"status": true,
	"message": null,
	"code": "200",
	"data": {
		"name": "json",
		"desc": "json返回值"
	}
}

如果不使用全局统一返回，就需要写一个工具类，然后controller返回对应的对象

@data
public class responsedata {
    private boolean status;
    private string message;
    private string code;
    private object data;
}

@requestmapping("/foo")
public responsedata foo() {
    // 或者使用工具类返回，根据业务设置值
    return new responsedata();
}

除了上述方法，可以对返回值进行统一处理，不需要对所有controller都使用一个返回值，controller只需要返回原始值，处理器会对返回值进行封装

同时也可以添加自定义注解，此注解用于忽略返回值封装，按照controller原始值返回

2.基础类功能

org.springframework.web.method.support.handlermethodreturnvaluehandler

• 使用不同策略处理从调用处理程序方法的返回值
• 策略处理顶层接口，自定义返回值格式需要实现此接口
• supportsreturntype：设置支持返回值类型
• handlereturnvalue：处理返回值基础参数

org.springframework.web.servlet.mvc.method.annotation.requestmappinghandleradapter

• 请求映射处理适配，包含了参数、返回值处理器等信息
• handlermethodreturnvaluehandlercomposite内部维护了handlermethodreturnvaluehandler列表

可以自定义注解，用于类或者方法级别忽略返回值封装

@target({elementtype.type, elementtype.method})
@retention(retentionpolicy.runtime)
@documented
public @interface ignoreresponsewrapper {

}

org.springframework.web.servlet.mvc.method.annotation.requestresponsebodymethodprocessor

• 属于handlermethodreturnvaluehandler子类
• 主要功能是对请求和响应体的做处理的方法
• 所有属于requestresponsebodymethodprocessor的子类都需要替换为自定义返回值处理

实现原理就是，在bean初始化的时候，获取到所有处理器数组，然后将所有是requestresponsebodymethodprocessor处理器子类对返回值处理的过程替换为自定义处理器

处理这样当调用对应返回值处理器时，将会使用到自定义的返回值处理器，也就是所有返回值都会按照规定的进行处理

3.基础实现

创建普通springboot项目，项目创建在此不做说明

创建类实现handlermethodreturnvaluehandler接口，主要用于实现自定义返回值内容，不需要注入容器

import com.codecoord.unifyreturn.annotation.ignoreresponsewrapper;
import com.codecoord.unifyreturn.domain.responsebase;
import org.springframework.core.methodparameter;
import org.springframework.web.context.request.nativewebrequest;
import org.springframework.web.method.support.handlermethodreturnvaluehandler;
import org.springframework.web.method.support.modelandviewcontainer;

public class responsebodywraphandler implements handlermethodreturnvaluehandler {
    private final handlermethodreturnvaluehandler delegate;

    public responsebodywraphandler(handlermethodreturnvaluehandler delegate) {
        this.delegate = delegate;
    }

    @override
    public boolean supportsreturntype(methodparameter returntype) {
        return delegate.supportsreturntype(returntype);
    }

    @override
    public void handlereturnvalue(object returnvalue,
                                  methodparameter returntype,
                                  modelandviewcontainer mavcontainer,
                                  nativewebrequest webrequest) throws exception {
        // 如果类或者方法含有不包装注解则忽略包装
        ignoreresponsewrapper wrapper = returntype.getdeclaringclass().getannotation(ignoreresponsewrapper.class);
        if (wrapper != null) {
            delegate.handlereturnvalue(returnvalue, returntype, mavcontainer, webrequest);
            return;
        }
        wrapper = returntype.getmethodannotation(ignoreresponsewrapper.class);
        if (wrapper != null) {
            delegate.handlereturnvalue(returnvalue, returntype, mavcontainer, webrequest);
            return;
        }
        
        // 自定义返回格式
        responsebase responsebase = new responsebase();
        responsebase.setstatus(true);
        responsebase.setcode("200");
        responsebase.setdata(returnvalue);
        delegate.handlereturnvalue(responsebase, returntype, mavcontainer, webrequest);
    }
}

创建类实现initializingbean，在初始化时调用，需要注入到容器中，否则spring无法管理

import java.util.arraylist;
import java.util.list;

@component
public class responsebodywrapfactorybean implements initializingbean {
    private final requestmappinghandleradapter adapter;

    @autowired
    public responsebodywrapfactorybean(requestmappinghandleradapter adapter) {
        this.adapter = adapter;
    }

    @override
    public void afterpropertiesset() throws exception {
        list<handlermethodreturnvaluehandler> returnvaluehandlers = adapter.getreturnvaluehandlers();
        if (returnvaluehandlers.size() > 0) {
        	// 将内置的返回值处理器进行替换
            list<handlermethodreturnvaluehandler> handlers = new arraylist<>(returnvaluehandlers);
            decoratehandlers(handlers);
            adapter.setreturnvaluehandlers(handlers);
        }
    }

    /** 
     * 将所有requestresponsebodymethodprocessor返回值处理器替换为自定义的返回值处理器
     *
     * @author [e-mail]
     * @since 2020/10/12
     */
    private void decoratehandlers(list<handlermethodreturnvaluehandler> handlers) {
        for (handlermethodreturnvaluehandler handler : handlers) {
            if (handler instanceof requestresponsebodymethodprocessor) {
            	// 替换为自定义返回值处理器
                responsebodywraphandler decorator = new responsebodywraphandler(handler);
                int index = handlers.indexof(handler);
                handlers.set(index, decorator);
                break;
            }
        }
    }
}

创建controller信息，例如此处map不需要封装，按照原来格式响应

@restcontroller
@requestmapping("/unify")
public class unifyreturnvaluecontroller {

    @requestmapping("string")
    public string stringhandler(){
        return "接收成功了";
    }

    @requestmapping("/json")
    public jsonobject jsonhandler(){
        jsonobject object = new jsonobject();
        object.put("name", "json");
        object.put("desc", "json返回值");
        return object;
    }

    @requestmapping("/map")
    @ignoreresponsewrapper
    public map<string, object> maphandler(){
        map<string, object> map = new hashmap<>(10);
        map.put("name", "map");
        map.put("desc", "map返回值");
        return map;
    }

    @requestmapping("/list")
    public list<object> listhandler(){
        list<object> data = new arraylist<>();
        data.add(100);
        data.add(95);
        data.add(99);
        return data;
    }
}

4.测试信息 测试json(有封装)

{
	"status": true,
	"message": null,
	"code": "200",
	"data": {
		"name": "json",
		"desc": "json返回值"
	}
}

测试map(无封装)

{
	"name": "map",
	"desc": "map返回值"
}

别的方法测试一样

二、附录说明

项目结构参考红框部分，别的忽略

除了对返回值进行全局统一，也可以对异常进行全局处理和按照统一格式返回

到此这篇关于springboot全局controller返回值格式统一的文章就介绍到这了,更多相关springboot返回值格式统一内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！