手写一个json格式化 api

最近写的一个东西需要对json字符串进行格式化然后显示在网页上面。

我就想去网上找找有没有这样的api可以直接调用。百度 json api ，搜索结果都是那种只能在网页上进行校验的工具，没有api。

那只有自己去实现一个json 格式化工具。

仔细分析，实现起来并不是很困难，至少思路很清晰。

 

需要解决的几个问题：

1. 对json的校验：主要是符号的匹配；
2. 格式化预处理：去除键值对之间的空白字符；
3. 格式化：主要是缩进的问题，要符合json通常展示的格式。

 

解决的办法：

1. 针对A问题：

可以采用栈去匹配符号，大括号、中括号、双引号等。

2. 针对B问题：

可以用fastjson的JSONObject.toString()方法实现，自动去除键值对之间的空白字符。

3. 针对C问题：

在需要换行的地方追加\n，缩进的地方追加\t。通过控制追加的\t的个数从而控制缩进量。如：

"{"、"[" 后面追加 \n，并且\t在上次数量上加一；

"}"、"]" 追加\n，\t在上次的数量上减一；

","： 追加\n和上次相同数量的\t。

 

 

具体实现：

 

package com.lm.algorithm.json;

import com.alibaba.fastjson.JSONException;
import com.alibaba.fastjson.JSONObject;

/**
 * Created by LiuMian on 2015/12/17.
 * 将json字符串添加 换行符和制表符使其能够直接在网页上按照通常的json格式显示
 */
public class JSONFormat {

    private String src;
    private int TABLength = 0;

    private final String BRACKET_LEFT = "[";
    private final String BRACKET_RIGHT = "]";
    private final String BRACE_LEFT = "{";
    private final String BRACE_RIGHT = "}";
    private final String COMMA = ",";
    private final String LINE_BREAK = "\n";
    private final String TAB = "\t";


    public JSONFormat(String src){
        this.src = src;
    }

    public String format() throws JSONException{
        try{
            JSONObject json = JSONObject.parseObject(src);
        }catch (JSONException e){
            //对json进行简单的校验，如果不符合格式那么jsonobject在解析的时候会报错
            throw e;
        }
        return format(src);
    }

    private String format(String src) {
        StringBuffer result = new StringBuffer();
        char[] srcArray = src.toCharArray();
        for (int index = 0; index < src.length(); index++) {
            result.append(srcArray[index]);

            if (BRACE_LEFT.equals(String.valueOf(srcArray[index])))  //{
                result.append(appendLINE_BREAKAndTAB(++TABLength));

            if (BRACE_RIGHT.equals(String.valueOf(srcArray[index]))) //}
                result.insert(result.length() - 1, appendLINE_BREAKAndTAB(--TABLength));

            if (BRACKET_LEFT.equals(String.valueOf(srcArray[index])))    //[
                result.append(appendLINE_BREAKAndTAB(++TABLength));

            if (BRACKET_RIGHT.equals(String.valueOf(srcArray[index])))   //]
                result.insert(result.length() - 1, appendLINE_BREAKAndTAB(--TABLength));

            if (COMMA.equals(String.valueOf(srcArray[index])))   //,
                result.append(appendLINE_BREAKAndTAB(TABLength));
        }
        return result.toString();
    }

    //追加换行符和   确定长度的制表符
    private String appendLINE_BREAKAndTAB(int TABTimes) {
        StringBuffer temp = new StringBuffer();
        temp.append(appendLINE_BREAK());
        temp.append(appendTAB(TABTimes));
        return temp.toString();
    }

    private String appendLINE_BREAK() {
        return LINE_BREAK;
    }

    private String appendTAB(int TABTimes) {
        StringBuffer temp = new StringBuffer();
        for (int i = 0; i < TABTimes; i++) {
            temp.append(TAB);
        }
        return temp.toString();
    }

    public static void main(String[] args) {
        String toFormat = "{\"status\": \"3\",\"message\": \"\",\"errCode\": \"0\",\"data\": [{\"time\": \"2013-02-26 16:47\",\"context\": \"客户 同事收发家人 已签收 派件员 张xx\"},{\"time\": \"2013-02-26 07:33\",\"context\": \"吉林省xx市xx公司 的派件员 张金达 派件中 派件员电话15xxx73xx87\"},{\"time\": \"2013-02-26 06:02\",\"context\": \"xx省xx市xx公司 已收入\"},{\"time\": \"2013-02-25 15:42\",\"context\": \"xx省xx转运中心公司已发出\"},{\"time\":\"2013-02-25 14:59\",\"context\":\"xx省xx转运中心公司已拆包\"},{\"time\": \"2013-02-24 18:11\",\"context\":\"辽宁省大连市中山区四部公司 已收件\"},{\"time\": \"2013-02-24 17:59\",\"context\":\"辽宁省大连市公司 已收入\"},{\"time\":\"2013-02-23 17:10\",\"context\":\"辽宁省大连市中山区xxxx公司 的收件员 王xx 已收件\" }],\"html\":\"\",\"mailNo\":\"71xxxxx624\",\"expTextName\":\"圆通快递\",\"expSpellName\":\"yuantong\",\"update\":\"1375155719\",\"cache\":\"33196560\",\"ord\":\"DESC\"}";
        JSONFormat jsonFormat = new JSONFormat(toFormat);
        System.out.println(jsonFormat.format());
    }

}

 

 

效果图：

{
    "status": "3",
    "message": "",
    "errCode": "0",
    "data": [
        {
            "time": "2013-02-26 16:47",
            "context": "客户 同事收发家人 已签收 派件员 张xx"
        },
        {
            "time": "2013-02-26 07:33",
            "context": "吉林省xx市xx公司 的派件员 张金达 派件中 派件员电话15xxx73xx87"
        },
        {
            "time": "2013-02-26 06:02",
            "context": "xx省xx市xx公司 已收入"
        },
        {
            "time": "2013-02-25 15:42",
            "context": "xx省xx转运中心公司已发出"
        },
        {
            "time":"2013-02-25 14:59",
            "context":"xx省xx转运中心公司已拆包"
        },
        {
            "time": "2013-02-24 18:11",
            "context":"辽宁省大连市中山区四部公司 已收件"
        },
        {
            "time": "2013-02-24 17:59",
            "context":"辽宁省大连市公司 已收入"
        },
        {
            "time":"2013-02-23 17:10",
            "context":"辽宁省大连市中山区xxxx公司 的收件员 王xx 已收件" 
        }
    ],
    "html":"",
    "mailNo":"71xxxxx624",
    "expTextName":"圆通快递",
    "expSpellName":"yuantong",
    "update":"1375155719",
    "cache":"33196560",
    "ord":"DESC"
}

 

如果把这个放在web项目里面，然后别人就可以根据api协议以Get或者Post请求的方式来调用你的json格式化工具啦~~

 

不足：没有对A问题进行实现，只是简单的借用了fastjson的JSONObject.parseObject()方法。

　　　这样做虽然简单，但是有明显的缺陷：如果某一行不符合json格式要求你只能通过抛出一个异常的方式告知调用者，而不能准确的定位在某一行。

　　　这个格式化工具最难的地方也是在这里，需要用栈来匹配符号，这就要求对json有比较清晰地了解。

 

大家有好的思路或者想法，欢迎一起交流~