Spring MVC JSON转换自定义注解

论坛 › 期权论坛 › 脚本     
匿名技术用户   2020-12-27 14:28   11   0

1.JSON转换

package cn.com.shopec.app.convert;  
  
import cn.com.shopec.app.common.Result;  
import com.alibaba.fastjson.JSON;  
import com.alibaba.fastjson.serializer.SerializeConfig;  
import com.alibaba.fastjson.serializer.SerializeFilter;  
import com.alibaba.fastjson.serializer.SerializerFeature;  
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;  
import org.apache.commons.logging.Log;  
import org.apache.commons.logging.LogFactory;  
  
import org.springframework.http.HttpOutputMessage;  
import org.springframework.http.converter.HttpMessageNotWritableException;  
  
import java.io.IOException;  
import java.io.OutputStream;  
  
  
/** 
 * Created by guanfeng.li on 2016/7/18. 
 */  
public class JSONHttpMessageConverter extends FastJsonHttpMessageConverter {  
  
    private Log log = LogFactory.getLog(JSONHttpMessageConverter.class);  
  
    //字符集  
    private String charset = "UTF-8";  
    //漂亮格式化  
    private boolean prettyFormat = false;  
    private boolean recordeResult = true;  
  
    @Override  
    protected void writeInternal(Object obj, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {  
        if(obj instanceof Result){  
//            writer(obj, outputMessage);  
            writerResult(obj, outputMessage);  
        }else{  
            super.writeInternal(obj, outputMessage);  
        }  
    }  
  
    /** 
     * Created by guanfeng.li   2016/7/19 
     * json转换 
     */  
    private void writerResult(Object obj, HttpOutputMessage outputMessage) throws IOException {  
        Result result = (Result) obj;  
        result.addSerializerFeature(SerializerFeature.SortField,SerializerFeature.DisableCircularReferenceDetect);  
        if(prettyFormat){  
            result.addSerializerFeature(SerializerFeature.PrettyFormat);  
        }  
        String json = result.toString();  
        OutputStream out = null;  
        try {  
            out = outputMessage.getBody();  
            out.write(json.getBytes(charset));  
            out.flush();  
        } finally {  
            out.close();  
        }  
        if(recordeResult){  
            log.info("JSON："+json);  
        }  
    }  
  
    //json转换  
    private void writer(Object obj, HttpOutputMessage outputMessage) throws IOException {  
        Result result = (Result) obj;  
        result.addSerializerFeature(SerializerFeature.SortField);  
        if(prettyFormat){  
            result.addSerializerFeature(SerializerFeature.PrettyFormat);  
        }  
        result.addSerializeFilter(Result.class,"jsonConfig,jsonFeatures,jsonFilter",false);  
  
        SerializerFeature[] features = new SerializerFeature[result.getJsonFeatures()==null?0:result.getJsonFeatures().size()];  
        if(result.getJsonFeatures()!=null){  
            result.getJsonFeatures().toArray(features);  
        }  
  
        SerializeFilter[] filters = new SerializeFilter[result.getJsonFilter()==null?0:result.getJsonFilter().size()];  
        if(result.getJsonFilter()!=null){  
            result.getJsonFilter().toArray(filters);  
        }  
        SerializeConfig jsonConfig = result.getJsonConfig();  
        String json ;  
        if(jsonConfig!=null){  
            json = JSON.toJSONString(obj,jsonConfig,filters,features);  
        }else{  
            json = JSON.toJSONString(obj,filters,features);  
        }  
        outputMessage.getBody().write(json.getBytes(charset));  
        log.info("返回JSON结果：\n"+json);  
    }  
  
    public void setCharset(String charset) {  
        this.charset = charset;  
    }  
  
    public void setPrettyFormat(boolean prettyFormat) {  
        this.prettyFormat = prettyFormat;  
    }  
  
    public void setRecordeResult(boolean recordeResult) {  
        this.recordeResult = recordeResult;  
    }  
}

2.自定义注解

package cn.com.shopec.app.mvc.annotation;  
  
import java.lang.annotation.*;  
  
/** 
 * Created by guanfeng.li on 2016/8/26. 
 */  
@Target({ElementType.PARAMETER})  
@Retention(RetentionPolicy.RUNTIME)  
@Documented  
public @interface RequestAttribute {  
  
    String value() default "";  
  
}  
package cn.com.shopec.app.mvc.support;  
  
import cn.com.shopec.app.mvc.annotation.RequestAttribute;  
import org.apache.commons.lang3.StringUtils;  
import org.springframework.core.MethodParameter;  
import org.springframework.web.bind.support.WebDataBinderFactory;  
import org.springframework.web.context.request.NativeWebRequest;  
import org.springframework.web.method.support.HandlerMethodArgumentResolver;  
import org.springframework.web.method.support.ModelAndViewContainer;  
  
import javax.servlet.http.HttpServletRequest;  
  
/** 
 * Created by guanfeng.li on 2016/8/26. 
 */  
public class RequestAttributeHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver {  
    @Override  
    public boolean supportsParameter(MethodParameter parameter) {  
        RequestAttribute requestAttribute = parameter.getParameterAnnotation(RequestAttribute.class);  
        if(requestAttribute!=null){  
            return true;  
        }  
        return false;  
    }  
  
    @Override  
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {  
        HttpServletRequest req = webRequest.getNativeRequest(HttpServletRequest.class);  
        if(req!=null){  
            RequestAttribute requestAttribute = parameter.getParameterAnnotation(RequestAttribute.class);  
            String value = requestAttribute.value();  
            if(StringUtils.isNotEmpty(value)){  
                return req.getAttribute(value);  
            }  
  
            if(StringUtils.isEmpty(value)){  
                String parameterName = parameter.getParameterName();  
                return req.getAttribute(parameterName);  
            }  
        }  
        return null;  
    }  
}

3.Spring MVC配置文件

<?xml version="1.0" encoding="UTF-8"?>  
<beans xmlns="http://www.springframework.org/schema/beans"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xmlns:p="http://www.springframework.org/schema/p"  
    xmlns:context="http://www.springframework.org/schema/context"  
    xmlns:mvc="http://www.springframework.org/schema/mvc"  
    xmlns:tx="http://www.springframework.org/schema/tx"  
    xmlns:ehcache="http://ehcache-spring-annotations.googlecode.com/svn/schema/ehcache-spring"  
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd  
    http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd  
    http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd  
    http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd  
    http://ehcache-spring-annotations.googlecode.com/svn/schema/ehcache-spring http://ehcache-spring-annotations.googlecode.com/svn/schema/ehcache-spring/ehcache-spring-1.1.xsd">  
  
    <bean  
        class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">  
        <property name="locations" value="classpath:*.properties" />  
    </bean>  
  
    <!-- 视图解析器 -->  
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">  
        <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />  
        <property name="prefix" value="/"></property>  
        <property name="suffix" value=".jsp"></property>  
    </bean>  
  
  
    <mvc:default-servlet-handler/>  
  
    <mvc:annotation-driven>  
        <mvc:message-converters register-defaults="false">  
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">  
                <constructor-arg value="UTF-8"/>  
            </bean>  
            <bean id="fastJsonHttpMessageConverter" class="cn.com.shopec.app.convert.JSONHttpMessageConverter">  
                <property name="supportedMediaTypes">  
                    <list>  
                        <value>text/plain;charset=UTF-8</value>  
                    </list>  
                </property>  
                <!--是否漂亮格式化JSON结果-->  
                <property name="prettyFormat" value="false"></property>  
                <!--是否记录JSON返回结果-->  
                <property name="recordeResult" value="false"></property>  
            </bean>  
        </mvc:message-converters>  
        <mvc:argument-resolvers>  
            <bean class="cn.com.shopec.app.mvc.support.RequestAttributeHandlerMethodArgumentResolver"></bean>  
        </mvc:argument-resolvers>  
    </mvc:annotation-driven>  
  
    <!-- 自动扫描controller包下的所有类，使其认为spring mvc的控制器 -->  
    <context:component-scan base-package="cn.com.shopec.app.controller" >  
    </context:component-scan>  
    <!-- 默认的注解映射的支持 -->  
    <mvc:annotation-driven />  
  
    <!-- 对静态资源文件的访问 -->  
    <!--<mvc:resources mapping="/res/**" location="/res/" />-->  
  
    <bean id="multipartResolver"  
        class="org.springframework.web.multipart.commons.CommonsMultipartResolver">  
        <property name="defaultEncoding">  
            <value>UTF-8</value>  
        </property>  
        <property name="maxUploadSize">  
            <value>32505856</value><!-- 上传文件大小限制为31M，31*1024*1024 -->  
        </property>  
        <property name="maxInMemorySize">  
            <value>4096</value>  
        </property>  
    </bean>  
  
  
    <!--统一异常处理-->  
    <bean id="exceptionHandler" class="cn.com.shopec.app.exception.ExceptionHandler"/>  
  
    <!-- 系统错误转发配置[并记录错误日志] -->  
    <bean id="exceptionResolver"  
          class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">  
        <!--<property name="defaultErrorView" value="error"></property>   &lt;!&ndash; 默认为500，系统错误(error.jsp) &ndash;&gt;-->  
        <property name="exceptionMappings">  
            <props>  
                <prop key="cn.com.shopec.app.exception.ExceptionHandler">error</prop>  
            </props>  
        </property>  
    </bean>  
  
    <mvc:interceptors>  
        <mvc:interceptor>  
            <mvc:mapping path="/public/api/**"/>  
            <mvc:mapping path="/app/api/**"/>  
            <bean class="cn.com.shopec.app.intercept.CommonIntercept"/>  
        </mvc:interceptor>  
        <mvc:interceptor>  
            <mvc:mapping path="/app/api/**"/>  
            <mvc:mapping path="/api/**"/>  
            <bean class="cn.com.shopec.app.intercept.TokenIntercept"/>  
        </mvc:interceptor>  
        <!--<mvc:interceptor>-->  
            <!--<mvc:mapping path="/wechat/**"/>-->  
            <!--<mvc:exclude-mapping path="/wechat/index"/>-->  
            <!--<bean class="cn.com.shopec.app.intercept.WechatIntercept"/>-->  
        <!--</mvc:interceptor>-->  
    </mvc:interceptors>  
  
  
</beans>

4.接口消息实体类

package cn.com.shopec.app.common;  
  
  
import cn.com.shopec.core.common.PageFinder;  
import cn.com.shopec.core.common.Query;  
  
import com.alibaba.fastjson.JSON;  
import com.alibaba.fastjson.serializer.*;  
  
import java.io.Serializable;  
import java.lang.reflect.Type;  
import java.util.*;  
  
/** 
 * Created by guanfeng.li on 2016/7/8. 
 * APP接口返回实体类 
 */  
public class Result implements Serializable {  
  
    //状态码  
    private String status = "200";  
    //消息提示  
    private String msg = "";  
    //响应数据  
    private Object data;  
    //分页  
    private PageFinder page;  
  
    //json格式化  
    private SerializeConfig jsonConfig;  
    //json 特性配置  
    private Set<SerializerFeature> jsonFeatures;  
    //json 属性过滤  
    private Set<SerializeFilter> jsonFilter;  
  
    public Result() {  
  
    }  
  
    public Result(Object data, Query query, long rowCount) {  
        this.data = data;  
        this.page = new PageFinder<>(query.getPageNo(), query.getPageSize(), rowCount);  
    }  
  
    public Result(String status, String msg, Object data) {  
        this.status = status;  
        this.msg = msg;  
        this.data = data;  
    }  
  
    public Result(Object data) {  
        this.data = data;  
    }  
  
    public Result(Object data,PageFinder page) {  
        this.data = data;  
        this.page = page;  
    }  
  
    /** 
     * Created by guanfeng.li   2016/7/19 
     * 特性配置 
     */  
    public Result addSerializerFeature(SerializerFeature... serializerFeatures) {  
        addSerializerFeature(3, serializerFeatures);  
        return this;  
    }  
  
    /** 
     * Created by guanfeng.li   2016/7/19 
     * 特性配置 
     */  
    public Result addSerializerFeature(int size, SerializerFeature... serializerFeatures) {  
        if (jsonFeatures == null) {  
            jsonFeatures = new HashSet<>(size);  
        }  
        for (SerializerFeature item : serializerFeatures) {  
            jsonFeatures.add(item);  
        }  
        return this;  
    }  
  
    /** 
     * Created by guanfeng.li   2016/7/19 
     * json 属性过滤 
     */  
    public Result addSerializeFilter(Class<?> clazz, String properties) {  
        addSerializeFilter(3, clazz, properties, true);  
        return this;  
    }  
  
    /** 
     * Created by guanfeng.li   2016/7/19 
     * json 属性过滤 
     */  
    public Result addSerializeFilter(Class<?> clazz, String properties, boolean isinclude) {  
        addSerializeFilter(3, clazz, properties, isinclude);  
        return this;  
    }  
  
    /** 
     * Created by guanfeng.li   2016/7/19 
     * json 属性过滤 
     */  
    public Result addSerializeFilter(int size, Class<?> clazz, String properties, boolean isinclude) {  
        if (jsonFilter == null) {  
            jsonFilter = new HashSet<>();  
        }  
        if(clazz!=null && properties==null){  
            jsonFilter.add(new SimplePropertyPreFilter(clazz));  
            return this;  
        }  
        if(clazz==null && properties!=null){  
            jsonFilter.add(new SimplePropertyPreFilter(properties.split(",")));  
            return this;  
        }  
        if (!isinclude) {  
            SimplePropertyPreFilter filter = new SimplePropertyPreFilter(clazz);  
            filter.getExcludes().addAll(Arrays.asList(properties.split(",")));  
            jsonFilter.add(filter);  
        } else {  
            jsonFilter.add(new SimplePropertyPreFilter(clazz, properties.split(",")));  
        }  
        return this;  
    }  
  
    /** 
     * Created by guanfeng.li   2016/7/19 
     * 过滤分页信息 
     */  
    public Result filterPage(){  
        addSerializeFilter(this.getClass(),"page",false);  
        return  this;  
    }  
  
    /** 
     * Created by guanfeng.li   2016/7/19 
     * json格式化 
     */  
    public Result putSerializeConfig(Class cls, ObjectSerializer value) {  
        putSerializeConfig(3, cls, value);  
        return this;  
    }  
  
    /** 
     * Created by guanfeng.li   2016/7/19 
     * json格式化 
     */  
    public Result putSerializeConfig(int size, Class cls, ObjectSerializer value) {  
        if (jsonConfig == null) {  
            jsonConfig = new SerializeConfig(size);  
        }  
        jsonConfig.put(cls, value);  
        return this;  
    }  
  
    /** 
     * Created by guanfeng.li   2016/7/19 
     * 空字符串显示 “” 
     * 空集合 [] 
     * 空Map {} 
     * Number 0 
     */  
    public Result writeNullStringNumberListAsEmpty() {  
        addSerializerFeature(5, SerializerFeature.WriteMapNullValue, SerializerFeature.WriteNullStringAsEmpty,  
                SerializerFeature.WriteNullNumberAsZero, SerializerFeature.WriteNullListAsEmpty);  
        return this;  
    }  
  
    public Result writeNullStringAsEmpty() {  
        addSerializerFeature(2, SerializerFeature.WriteMapNullValue, SerializerFeature.WriteNullStringAsEmpty);  
        return this;  
    }  
  
    public Result writeNullListAsEmpty() {  
        addSerializerFeature(2, SerializerFeature.WriteMapNullValue, SerializerFeature.WriteNullListAsEmpty);  
        return this;  
    }  
  
    public Result writeNullNumberAsZero() {  
        addSerializerFeature(2, SerializerFeature.WriteMapNullValue, SerializerFeature.WriteNullNumberAsZero);  
        return this;  
    }  
  
    /** 
     * Created by guanfeng.li   2016/7/19 
     * 漂亮格式化 
     */  
    public Result prettyFormat() {  
        addSerializerFeature(SerializerFeature.PrettyFormat);  
        return this;  
    }  
  
    //添加返回结果  
    public Result put(String key, Object value) {  
        if (data == null) {  
            data = new HashMap();  
        } else {  
            if (!(data instanceof Map)) {  
                return this;  
            }  
        }  
  
        ((Map) data).put(key, value);  
        return this;  
    }  
  
    public String getStatus() {  
        return status;  
    }  
  
    public Result setStatus(String status) {  
        this.status = status;  
        return this;  
    }  
  
    public String getMsg() {  
        return msg;  
    }  
  
    public Result setMsg(String msg) {  
        this.msg = msg;  
        return this;  
    }  
  
    public Object getData() {  
        return data;  
    }  
  
    public void setData(Object data) {  
        this.data = data;  
    }  
  
    public PageFinder getPage() {  
        return page;  
    }  
  
    public Result setPage(PageFinder page) {  
        this.page = page;  
        return this;  
    }  
  
    public SerializeConfig getJsonConfig() {  
        return jsonConfig;  
    }  
  
    public Set<SerializerFeature> getJsonFeatures() {  
        return jsonFeatures;  
    }  
  
    public Set<SerializeFilter> getJsonFilter() {  
        return jsonFilter;  
    }  
  
    @Override  
    public String toString() {  
        if (jsonFilter != null || jsonFeatures != null || jsonConfig != null) {  
            addSerializeFilter(Result.class, "jsonConfig,jsonFeatures,jsonFilter", false);  
        }  
        SerializerFeature[] features = new SerializerFeature[jsonFeatures == null ? 0 : jsonFeatures.size()];  
        if (jsonFeatures != null) {  
            jsonFeatures.toArray(features);  
        }  
  
        SerializeFilter[] filters = new SerializeFilter[jsonFilter == null ? 0 : jsonFilter.size()];  
        if (jsonFilter != null) {  
            jsonFilter.toArray(filters);  
        }  
        String json;  
        if (jsonConfig != null) {  
            json = JSON.toJSONString(this, jsonConfig, filters, features);  
        } else {  
            json = JSON.toJSONString(this, filters, features);  
        }  
        return json;  
    }  
}

回复
分享到 :
0 人收藏
返回列表
高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

16级独孤
匿名技术用户

积分:7942463
帖子:1588486
精华:0
+ 关注 私信
期权论坛 期权论坛
期权网络科技版权所有
关于我们
联系我们
加入我们
反馈问题
免责声明
积分充值
统一社会信用代码
积分规则
网站地图
爱文库
下属网站
官方
新浪微博
微信公众号
◆
下载
表情包
App下载
期权论坛 期权论坛

QQ咨询|关于我们|Archiver|手机版|小黑屋|( 辽ICP备15012455号-4 ) Powered by 期权论坛 X3.2 © 2001-2016 期权工具网&期权论坛 Inc.

发布
内容

下载期权论坛手机APP