首页 / JSON / 用一个切面来统一返回前端的JSON格式

用一个切面来统一返回前端的JSON格式

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了用一个切面来统一返回前端的JSON格式，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含5154字，纯文字阅读大概需要8分钟。

内容图文

新项目使用Spring MVC + MyBatis架构来做，这套框架自己应该比较得心应手，这里来写一下这两天做的一些设计。

首先是静态资源的处理，关于这个之前有写文章单独讲过，这里不再重复写，不太清楚的童鞋可以移步查看

接着需要统一JSON的返回格式，和前端工程师约定，对于字符串类型和日期类型都返回字符串，而对于普通数字类型的话都返回数字，金额类数字都返回格式化好的保留一位小数的字符串（比如”10.0”），另外数字和金额的默认值为0，而字符串的默认值为字符串空(“”)，并且对于返回的格式也有规范，所有的JSON返回必须形如：

            {
    "status": 1,
    "data": data,
    "msg": ""}

其中：

status代表了该请求的成功与否，若为1表示成功，若为0表示失败，此时msg中将包含显示给用户的错误信息
data代表了返回给前端的数据，可以是一个复杂的数据结构
msg前面提到了，一般放异常信息。

下面，我们首先需要对默认的Jackson的序列化规则做出修改，这里自定义一个ObjectMapper：

            
                /**
 * 自定义jackson解析器
 * @author Zhu
 * @date 2015-5-14
 * @version 0.0.1
 * @description
 */
                @Component
                public
                
                    class
                    CustomerObjectMapper
                    extends
                    ObjectMapper {
                /**
     * 
     */
                private
                static
                final
                long serialVersionUID = 1L;

    /**
     * 
     */publicCustomerObjectMapper() {

        super();
//      this.setSerializationInclusion(Include.NON_NULL);// 允许单引号//        this.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true);// 字段和值都加引号//        this.configure(JsonParser.Feature.ALLOW_UNQUOTED_FIELD_NAMES, true);// 数字也加引号//        this.configure(JsonGenerator.Feature.WRITE_NUMBERS_AS_STRINGS, true);//        this.configure(JsonGenerator.Feature.QUOTE_NON_NUMERIC_NUMBERS, true);this.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>(){
            @Overridepublicvoidserialize(Object value, JsonGenerator generator,
                    SerializerProvider provider) throws IOException,
                    JsonProcessingException {
                generator.writeString("");
            }
        });
    }

}

然后将我们自定义的ObjectMapper注入到MappingJackson2HttpMessageConverter中去并重新配置Spring MVC中的message converter

            
                <beanid="mappingJackson2HttpMessageConverter"class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
                <propertyname="objectMapper"ref="customerObjectMapper">
                </property>
                </bean>
                <mvc:annotation-driven>
                <mvc:message-converters>
                <refbean="mappingJackson2HttpMessageConverter"/>
                </mvc:message-converters>
                </mvc:annotation-driven>

接下来，我们可以在Controller方法上添加@ResponseBody注解来返回JSON（这里需要说一句，classpath下需要有jackson的jar包，这是前提），但是这就要求我们在每个Controller方法中都进行一些重复的工作，比如：

                public ModelMap getUserList(){
        ModelMap modelMap = new ModelMap();
        try {
            modelMap.put("status", 1);
            modelMap.put("data", userSerivce.getUserList());
            modelMap.put("", "");
        } catch (Exception e) {
            modelMap.put("status", 0);
            modelMap.put("data", "");
            modelMap.put("msg", e.getMessage());
            logger.error("getUserList occurs error:", e);
        }
    }

这样的重复代码在项目中不建议出现，我们其实只需要关心其中的data就可以了，所以我打算将其统一写到一个方法中，并且这也有利于以后对于公共结构的更改。下面就是一个切面来统一处理所有的接口：

            
                /**
 * 其中ResponseBase类和注解类CustomResponseBody都是自己写的
 */
                /**
 * @author Zhu
 * @date 2015-5-18
 * @version 0.0.1
 * @description 负责将返回转换成统一消息格式
 * 序列化为的格式如下:
 * {
    "status": 1,
    "data": data,
    "msg": ""
    }
    其中被注解的方法只需要关心data的内容即可
 */
                @Aspect
                @Component
                public
                
                    class
                    ResponseAspect {
                @Resource
                private MappingJackson2HttpMessageConverter converter;

    privatefinal Logger logger = LoggerFactory.getLogger(getClass());


    /**
     * 拦截所有@ResponseBody
     * @author Zhu
     * @date 2015-5-18上午11:32:26
     * @description
     */@Pointcut("execution(* com.xxx.*.web.controller.*.*(..)) && @annotation(com.xxx.common.annotation.CustomResponseBody)")
    publicvoidresponseBodyPointCut() {

    }

    /**
     * @author Zhu
     * @date 2015-5-18上午11:35:42
     * @description 
     * @param pjp
     * @throws Throwable 
     */@Around(value = "responseBodyPointCut()")
    @ResponseBodypublicvoidformatResult2JSON(ProceedingJoinPoint pjp) throws Throwable {
        Object ret = pjp.proceed();
        ResponseBase responseBase = new ResponseBase();
        responseBase.setData(ret);

        HttpServletResponse response = ((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getResponse();
        HttpOutputMessage outputMessage = new ServletServerHttpResponse(response);
        converter.write(responseBase, MediaType.APPLICATION_JSON, outputMessage);
        shutdownResponse(response);
    }

    /**
     * 
     * @author Zhu
     * @date 2015-5-18下午6:01:46
     * @description 
     * @param jp
     * @param error
     * @throws Throwable
     */@AfterThrowing(pointcut = "responseBodyPointCut()", throwing = "error")
    publicvoidhandleForException(JoinPoint jp, Throwable error) throws Throwable{
        ResponseBase responseBase = new ResponseBase();
        responseBase.setStatus(0);
        responseBase.setMsg(error.getMessage());
        HttpServletResponse response = ((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getResponse();
        logger.error(jp.getSignature().getName() + "-error!", error);
        HttpOutputMessage outputMessage = new ServletServerHttpResponse(response);
        converter.write(responseBase, MediaType.APPLICATION_JSON, outputMessage);
        shutdownResponse(response);
    }

    privatevoidshutdownResponse(HttpServletResponse response) throws IOException{
        response.getOutputStream().close();
    }
}

当然这里有几个关键点，需要提一下：

这也就提到了一个如何在Spring中手动使用配置好的Jackson来序列化输出，这里我注入MappingJackson2HttpMessageConverter，因为这里想要统一项目的JSON序列化都交由Jackson来做
由于是对Controller的代理，而一般Controller是不实现接口的，那么就无法使用JDK自带的动态代理，需要用到cglib来做
关于上下文的问题，这里我在做的时候，由于碰到了两个上下文，即一般所说的rootContext和webContext。。。。
在自己返回json的情况下，需要shutdownResponse，即将Response关掉，不然可能会在这里输出json后还会再次输出一些内容

其余的内容后续再写吧，现在手头上项目太多，需要整理的东西也太多了~

原文：http://blog.csdn.net/u012345283/article/details/45850117

内容总结

以上是互联网集市为您收集整理的用一个切面来统一返回前端的JSON格式全部内容，希望文章能够帮你解决用一个切面来统一返回前端的JSON格式所遇到的程序开发问题。如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/1123665.html

来源：【匿名】

【上一篇】python使用正则+jsonpath处理接口依赖【下一篇】浅析php中json_encode()和json_decode()

更多 ►

【用一个切面来统一返回前端的JSON格式】教程文章相关的互联网学习教程文章

mybatis plus实体类中字段映射mysql中的json格式【图】

1.实体类中有个属性是其他对象，或者是List；在数据库中存储时使用的是mysql的json格式，此时可以用mybatis plus的一个注解@TableField(typeHandler = JacksonTypeHandler.class)这样在存入是就可以把对象自动转换为json格式，2.那么取出时怎么进行映射呢，有分为两种情况? a:当没有使用到xml时：? b:当使用了xml文件时：原文：https://www.cnblogs.com/changchangchang/p/13121407.html

JavaBean,List,Map转成json格式【图】

Java代码 public class User { private String username; private String password; public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getPassword() { return password; } public void setPassword(String password) { this.password =...

.net core读取json格式的配置文件【代码】【图】

在.Net Framework中，配置文件一般采用的是XML格式的，.NET Framework提供了专门的ConfigurationManager来读取配置文件的内容，.net core中推荐使用json格式的配置文件，那么在.net core中该如何读取json文件呢？1、在Startup类中读取json配置文件1、使用Configuration直接读取看下面的代码：public IConfiguration Configuration { get; } Configuration属性就是.net core中提供的用来读取json文件。例如：publicvoid Configure(I...

通过js，修改所有form表单，提交JSON格式的数据【代码】

直接上代码 <script>$(function(){//获取网页中所有的form表单$("form").each(function(){//注册表单的提交事件$(this).submit(function(event) {//屏蔽表单的注册event.preventDefault();//获取urlvar url = $(this).attr("action");request(url, ‘POST‘,JSON.stringify($(this).serializeObject()), function(){alert(‘123‘);}, null);});});}); //将$.ajax函数转化成一个简单的接口 function request(url, method, param,...

一个Excel转换为Json格式的Python脚本

项目路径：https://code.csdn.net/langresser/excel2json一个Python脚本，自动转换Excel里面的配置到Json格式。1、这个是为Unity准备的，不过稍作修改可运行于任何环境2、Excel内容要求为键值对的形式，具体可以参考脚本内的说明。 3、读取代码里面限制了读取配置的路径为Resources/config，即所有的配置都要放在这个目录下 4、运行前需要先安装xlrd：在xlrd目录执行python.exe setup install 5、在脚本最开始有定义几个关键目录：...

JSON格式日期的转换

扒来的链接：https://blog.csdn.net/zhang33565417/article/details/99676975感谢这位哥们儿的分享！原文：https://www.cnblogs.com/htq29study/p/11615697.html

android实现json数据的解析和把数据转换成json格式的字符串【代码】

利用android sdk里面的JSONObject和JSONArray把集合或者普通数据，转换成json格式的字符串JSONObject和JSONArray解析json格式的字符串为集合或者一般数据package com.hck.test;import java.util.ArrayList; import java.util.List;import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject;import android.app.Activity; import android.os.Bundle; import android.util.Log; import android.view.V...

springmvc 后台向页面EasyUI的Datagrid传递数据（JSon格式）【图】

===============EasyUIDatagrid 分页====================EasyUIDatagrid 需要提供的JSon格式为：total和rows，所以我们只需要在后台中返回一个JSon格式为total和rows //定义一个EasyUIDatagridResult 类来包装JSon数据public class EasyUIDatagridResult { private long total; //返回JSon中的total值 private List<?> rows; //返回JSon中的rows值 public long getTotal() { return total; } public void setTotal(long total)...

Object转换为JSON格式字符串【代码】

简介：把JS的Object转换为Json字符串。代码：function (object) {// Object转换为josnvar json = "";switch (jQuery.type(object)) {case "array":json = "[";$.each(object, function (i, item) {json += $.sinopec.ObjectToJson(item) + ",";});if (json != "[" && json.length > 0) json = json.substr(0, json.length - 1);json += "]";break;case "object":json = "{";$.each(object, function (key, value) {if (jQuery.type...

JSON格式对接过程随笔【代码】【图】

if (dr.Table.Columns[j].DataType.ToString() == "System.DateTime") {if (dr[dr.Table.Columns[j].ColumnName.ToString()] != DBNull.Value){result += AddDoubleYH(Convert.ToDateTime(dr[dr.Table.Columns[j].ColumnName.ToString()]).ToString("yyyy-MM-dd HH:mm:ss"));//result += JsonConvert.SerializeObject(dr[dr.Table.Columns[j].ColumnName.ToString()]);} } result_memo":"RuntimeException: com.fasterxml.jackson...

Spring MVC 学习笔记 json格式的输入和输出【代码】

Spring mvc处理json需要使用jackson的类库，因此为支持json格式的输入输出需要先修改pom.xml增加jackson包的引用<dependency><groupId>org.codehaus.jackson</groupId><artifactId>jackson-core-lgpl</artifactId><version>1.8.1</version></dependency><dependency><groupId>org.codehaus.jackson</groupId><artifactId>jackson-mapper-lgpl</artifactId><version>1.8.1</version></dependency>先修改之前的hellowor...

Django 组织json格式【代码】

@api_view([‘GET‘, ‘POST‘]) def api_test(request):classes = Classes.objects.all()# classes_data = Classes_data(classes, many=True)# userlist = Userinfo.objects.all()# userlist_data = Userinfo_data(userlist, many=True)# # data = {# ‘classes‘: classes_data.data,# ‘userlist‘: userlist_data.data,# }data = {‘classes‘: [],}for c in classes:data_item = {‘id‘: c.id,‘text‘: c.text,‘us...

配置iis支持.json格式的文件

一、IIS 61． MIME设置：在IIS的站点属性的HTTP头设置里，选MIME 映射中点击”文件类型”-”新类型”，添加一个文件类型：关联扩展名：*.json内容类型(MIME)：application/x-javascript2． Script Map Handler设置：还是在IIS的站点属性里，”主目录”-”应用程序设置”-”配置”-”映射”-”添加”，会打开”添加/编辑应用程序扩展名映射”的设置页面扩展名：.json运行文件：C:\WINDOWS\system32\inetsrv\asp.dll动作：GET,POST3....

总结的一些json格式和对象/String/Map/List等的互转工具类

总结的一些json格式和对象/String/Map/List等的互转工具类，有需要的可以看看,需要引入jackson-core-asl-1.7.1.jar、jackson-jaxrs-1.7.1.jar、jackson-mapper-asl-1.7.1.jar这三个jar包package com.zuidaima.util.json; import java.io.InputStream; import java.io.OutputStream; import java.io.Reader; import java.io.Writer; import java.net.URL; import java.util.ArrayList; import java.util.Date; import java....

Json格式的字符串转换为正常显示的日期格式

//返回自定义格式日期： 2015-07-17 13:53:37function ChangeDateFormat(jsondate) { jsondate = jsondate.replace("/Date(", "").replace(")/", ""); if (jsondate.indexOf("+") > 0) { jsondate = jsondate.substring(0, jsondate.indexOf("+")); } else if (jsondate.indexOf("-") > 0) { jsondate = jsondate.substring(0, jsondate.indexOf("-")); } var date = new Date(parseInt(jsondate, 10...

JSON格式 - 相关标签

json格式 json格式化

JSON - 最热教程

demjsonpython如何安装？简介dem指标的...基于JSON格式数据的简单jQuery幻灯片插...如何处理JSON中的特殊字符 node将geojson转shp返回给前端的实现方...nodejs更新package.json中的dependenci...怎样使用js实现前后台传输Json JavaScript使用两种方法实现url解析为j...php获取通过url的json数据，返回的是空...php判断json格式是否正确的方法 python 正则表达式与JSON-JSON

首页 / JSON / 用一个切面来统一返回前端的JSON格式

用一个切面来统一返回前端的JSON格式

内容导读

内容图文

内容总结

内容备注

内容手机端

【用一个切面来统一返回前端的JSON格式】教程文章相关的互联网学习教程文章

JSON格式 - 相关标签

JSON - 最新教程

JSON - 最热教程