springmvc-自定義消息轉換器

最近的項目沒有用到這個，先把自己自學跑通的例子先帖出來，供自己以后參考吧！

如有不對地方望指出！

一、自定義類實現AbstractHttpMessageConverter

package com.dzf.converter;

import java.io.IOException;
import java.nio.charset.Charset;

import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.AbstractHttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import org.springframework.util.StreamUtils;

import com.alibaba.fastjson.JSONObject;
import com.dzf.vo.ResultInfo;
/**
 * 自定義消息轉換器
 * @author dingzf
 * @date 2018年1月20日
 * @time 19:26:39
 */
public class MyMessageConverter extends AbstractHttpMessageConverter<ResultInfo> {

        
    public MyMessageConverter(){
        super(Charset.forName("utf-8"),new MediaType("application","x-result"));//application/x-result 自己定義的媒體數據類型
    }
    
    //所映射的model
    @Override
    protected boolean supports(Class<?> clazz) {
        return ResultInfo.class.isAssignableFrom(clazz);
    }

    @Override
    protected ResultInfo readInternal(Class<? extends ResultInfo> clazz, HttpInputMessage inputMessage)
            throws IOException, HttpMessageNotReadableException {
        String copyToString = StreamUtils.copyToString(inputMessage.getBody(), Charset.forName("utf-8"));//傳輸為json類型的數據
        ResultInfo result = (ResultInfo)JSONObject.parse(copyToString);//轉換為自己想要的數據類型  按需編寫
        return result;
    }

    @Override
    protected void writeInternal(ResultInfo t, HttpOutputMessage outputMessage)
            throws IOException, HttpMessageNotWritableException {
        String str = t.getCode()+"-"+t.getDesc();//返回到前台的數據
        outputMessage.getBody().write(str.getBytes());
    }

}

二、在springmvc的配置文件中加入我們自定義的消息轉換器

<!-- 
        打開springmvc的注解模式
    mvc 請求映射 處理器與適配器配置 -->
    <mvc:annotation-driven >
        <mvc:message-converters register-defaults="true">
            <bean class="org.springframework.http.converter.StringHttpMessageConverter" ><!--字符串轉換器-->
            <property name = "supportedMediaTypes">
                <list>
                    <value>application/json;charset=utf-8</value>
                    <value>text/html;charset=utf-8</value>
                </list>
            </property>
            </bean>
            <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter" /><!--json轉換器-->
            <bean class ="com.dzf.converter.MyMessageConverter"> <!--自己定義的消息轉換器-->
            <property name = "supportedMediaTypes">
                <list>
                    <value>application/json;charset=utf-8</value>
                    <value>application/x-result;charset=utf-8</value>
                    <value>text/html;charset=utf-8</value>
                </list>
            </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

三、在前台指定發送數據的格式

function test6(){
    $.ajax({
        type:'post',
        url:'json/test6',
        contentType:'application/x-result',
        data:{code:"200",desc:"我是丁振鋒"},
        success:function(text){
            alert(text);
        },
        error:function(data){
            alert("后台異常！")
        },
        asyn:false,
        cache:false
    });
}

四、服務器端指定返回的數據格式

/**
     * 測試自定義消息轉換器
     * 在請求頭上必須加上produces="application/x-result;charset=utf-8"
     * @param request
     * @param response
     * @return
     */
    @RequestMapping(value="/test6",produces="application/x-result;charset=utf-8")
    @ResponseBody
    public ResultInfo test6(HttpServletRequest request,HttpServletResponse response){
        ResultInfo result = new ResultInfo();
        result.setCode("200");
        result.setDesc("請求成功！");
        Map<String,String> map = new HashMap<String,String>();
        map.put("name", "紅霞");
        map.put("age","22");
        result.setData(map);
        return result;
    }

到這里，基本上就結束了！

注意點：

1.請求頭的contentType必須要設值你自定義的數據格式

2.返回數據格式如果需要使用你自定義的數據格式，加上路由設置。即：produces="application/x-result;charset=utf-8"