使用spring HttpMessageConverter 构造一个通用返回结构数据结构全局配置

曾几何时,被所有的业务代码的通用返回数据接口格式粗暴而简单的虐待过之后,不知道大家有没有想过去改造一下这些controller的接口,定义的接口纯粹一些,不需要使用controller 再包装一层返回结果

@GetMapping
public ReponseDTO doSomething(String param){
    ...
    Object rtv  = service.doSomething(param)
    ...
    
    ResponseDTO rsp = new ResponseDTO();
    rsp.setData(rvt)
    
    return rsp;
    
}

上面的代码通常就是业务中需要返回给前端的统一格式,基本上全部接口都是以约定好的格式返回给前端渲染。在这里,我们可以改造一下,使得统一的返回格式,交给系统框架统一去处理,不需要在每个方法中做重复的东西。(程序员都讨厌做重复的东西,对吧)

那么应该如何去处理这个问题呢?

笔者一开始对于这个问题的想法是在AOP 上面去动手,例如写如下的代码:

public class MyBodyAdvice implements ResponseBodyAdvice {
    
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        ....
        
        ResponseDTO rsp  = doSomeThingWithBody(body);
        
        return rsp;
    }
    
}

但是后来测试发现,并不可行,因为在调用链中,这个方法的返回值必须要跟传过来的body 类型保持一致。所以上面的代码会抛出 Cast Exception

方案

后面想到springMVC 中支持的HttpMessageConverter,这个是可以在请求前和请求结果返回后 进行动手的地方,于是就开启下面的代码发掘之路了。

第一步,笔者开始看下converter中注入的方法,如果大家熟悉springboot 的话,都应该知道,可以在代码中直接配置一个converter bean,然后springboot就会自动加入到HttpMessageConverter List中了。

第二步,下面的问题是,我们怎么定义自己需要的HttpMessageConverter?

下面是接口的定义:

    public interface HttpMessageConverter<T> {
        
        boolean canRead(Class<?> clazz, MediaType mediaType);
    
    
        boolean canWrite(Class<?> clazz, MediaType mediaType);
    
        
        List<MediaType> getSupportedMediaTypes();
    
        T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
                throws IOException, HttpMessageNotReadableException;
    
        void write(T t, MediaType contentType, HttpOutputMessage outputMessage)
                throws IOException, HttpMessageNotWritableException;

}

对于有现成的优秀产品,我们不需要重复造轮子,有一个大家经常用到的Converter,Jackson2HttpMessageConverter,观察之后,我们可以继承这个,然后实现我们需要的功能即可。面向对象的优势体现出来了 :)

于是笔者就先继承了这个类

public  class MyResponseConverter extends AbstractJackson2HttpMessageConverter 

首先这里需要注意的是,对于注册到Converter List 中的converter, 每次被调用的时候,spring需要判断是否这个converter能被使用,所以 看到上面的接口定义就可以看出,有一些地方是我们需要了解的。第一,canRead(),canWrite(), getSupportedMediaTypes()。

对于 AbstractJackson2HttpMessageConverter 的构造函数,我们需要指明支持的MediaType,这里默认支持json 格式,可以同时支持多种格式。

 protected MyResponseConverter( ObjectMapper objectMapper) {
    super(objectMapper, MediaType.APPLICATION_JSON);

}

然后继续追踪代码,在AbstractHttpMessageConverter 类中,实际执行write 操作的是 writeInternal

@Override
    public final void write(final T t, MediaType contentType, HttpOutputMessage outputMessage)
            throws IOException, HttpMessageNotWritableException {

        final HttpHeaders headers = outputMessage.getHeaders();
        addDefaultHeaders(headers, t, contentType);

        if (outputMessage instanceof StreamingHttpOutputMessage) {
            StreamingHttpOutputMessage streamingOutputMessage =
                    (StreamingHttpOutputMessage) outputMessage;
            streamingOutputMessage.setBody(new StreamingHttpOutputMessage.Body() {
                @Override
                public void writeTo(final OutputStream outputStream) throws IOException {
                    writeInternal(t, new HttpOutputMessage() {
                        @Override
                        public OutputStream getBody() throws IOException {
                            return outputStream;
                        }
                        @Override
                        public HttpHeaders getHeaders() {
                            return headers;
                        }
                    });
                }
            });
        }
        else {
            writeInternal(t, outputMessage);
            outputMessage.getBody().flush();
        }
    }

所以我们只要重写这个方法,就可以偷偷干掉原来的放回值了哈哈,不说了,直接看代码

@Override
protected void writeInternal(Object originalOutputValue, Type originalType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
    boolean toConvert = //这里根据自己的业务区定义是否转换
    if (toConvert) {
        ResponseDTO rsp  = doSomeThingWithBody(body);
        super.writeInternal(rsp, ResponseDTO.class, outputMessage);
        return;

    }

    super.writeInternal(originalOutputValue, originalType, outputMessage);

}

写到这里就差不多,大家可以根据自己的想法,利用这个做更多有趣的事

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容