java接口怎样给json加密 json接口怎么写

转载

编程梦想翱翔者 2024-06-24 05:47:08

文章标签 java接口怎样给json加密 XML JSON xml 文章分类 Java 后端开发

APP接口开发基本上是每一个web应用或者移动端应用都所需要的，那么如何进行APP接口开发呢？

APP接口，主要是从客户端接收数据，然后再将客户端所需要的数据返回给客户端，一般来说返回给客户端的数据有两种格式的数据，分别是：json与xml。

接下来我们来看看json数据格式

JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。

{
    "programmers": [{
        "firstName": "Brett",
        "lastName": "McLaughlin",
        "email": "aaaa"
    }, {
        "firstName": "Jason",
        "lastName": "Hunter",
        "email": "bbbb"
    }, {
        "firstName": "Elliotte",
        "lastName": "Harold",
        "email": "cccc"
    }],
    "authors": [{
        "firstName": "Isaac",
        "lastName": "Asimov",
        "genre": "sciencefiction"
    }, {
        "firstName": "Tad",
        "lastName": "Williams",
        "genre": "fantasy"
    }, {
        "firstName": "Frank",
        "lastName": "Peretti",
        "genre": "christianfiction"
    }],
    "musicians": [{
        "firstName": "Eric",
        "lastName": "Clapton",
        "instrument": "guitar"
    }, {
        "firstName": "Sergei",
        "lastName": "Rachmaninoff",
        "instrument": "piano"
    }]
}

然后是xml

XML (Extensible Markup Language) 中文学名：可扩展标记语言

<?xml version="1.0" encoding="UTF-8"  ?>
<note>
    <to>George</to>
    <from>John</from>
    <heading>Reminder</heading>
    <body>Don't forget the meeting!</body>
</note>

这样的格式就是XML的
通过以上对比我们可以比较出两者优劣

XML的优缺点
<1>.XML的优点
　　A.格式统一，符合标准；
　　B.容易与其他系统进行远程交互，数据共享比较方便。
<2>.XML的缺点
　　A.XML文件庞大，文件格式复杂，传输占带宽；
　　B.服务器端和客户端都需要花费大量代码来解析XML，导致服务器端和客户端代码变得异常复杂且不易维护；
　　C.客户端不同浏览器之间解析XML的方式不一致，需要重复编写很多代码；
　　D.服务器端和客户端解析XML花费较多的资源和时间。

JSON的优缺点
<1>.JSON的优点：
　　A.数据格式比较简单，易于读写，格式都是压缩的，占用带宽小；
　　B.易于解析，客户端JavaScript可以简单的通过eval（)进行JSON数据的读取；
　　C.支持多种语言，包括ActionScript, C, C#, ColdFusion, Java, JavaScript, Perl, PHP, Python, Ruby等服务器端语言，便于服务器端的解析；
　　D.在PHP世界，已经有PHP-JSON和JSON-PHP出现了，偏于PHP序列化后的程序直接调用，PHP服务器端的对象、数组等能直接生成JSON格式，便于客户端的访问提取；
　　E.因为JSON格式能直接为服务器端代码使用，大大简化了服务器端和客户端的代码开发量，且完成任务不变，并且易于维护。
<2>.JSON的缺点
　　A.没有XML格式这么推广的深入人心和喜用广泛，没有XML那么通用性；
　　B.JSON格式目前在Web Service中推广还属于初级阶段。

XML和JSON的优缺点对比

(1).可读性方面。
JSON和XML的数据可读性基本相同，JSON和XML的可读性可谓不相上下，一边是建议的语法，一边是规范的标签形式，XML可读性较好些。
(2).可扩展性方面。
XML天生有很好的扩展性，JSON当然也有，没有什么是XML能扩展，JSON不能的。
(3).编码难度方面。
XML有丰富的编码工具，比如Dom4j、JDom等，JSON也有json.org提供的工具，但是JSON的编码明显比XML容易许多，即使不借助工具也能写出JSON的代码，可是要写好XML就不太容易了。
(4).解码难度方面。
XML的解析得考虑子节点父节点，让人头昏眼花，而JSON的解析难度几乎为0。这一点XML输的真是没话说。
(5).流行度方面。
XML已经被业界广泛的使用，而JSON才刚刚开始，但是在Ajax这个特定的领域，未来的发展一定是XML让位于JSON。到时Ajax应该变成Ajaj(Asynchronous Javascript and JSON)了。
(6).解析手段方面。
JSON和XML同样拥有丰富的解析手段。
(7).数据体积方面。
JSON相对于XML来讲，数据的体积小，传递的速度更快些。
(8).数据交互方面。
JSON与JavaScript的交互更加方便，更容易解析处理，更好的数据交互。
(9).数据描述方面。
JSON对数据的描述性比XML较差。
(10).传输速度方面。
JSON的速度要远远快于XML。

XML与JSON数据格式比较

(1).关于轻量级和重量级
轻量级和重量级是相对来说的，那么XML相对于JSON的重量级体现在哪呢?应该体现在解析上，XML目前设计了两种解析方式：DOM和 SAX。
<1>.DOM
DOM是把一个数据交换格式XML看成一个DOM对象，需要把XML文件整个读入内存，这一点上JSON和XML的原理是一样的，但是XML要考虑父节点和子节点，这一点上JSON的解析难度要小很多，因为JSON构建于两种结构：key/value，键值对的集合;值的有序集合，可理解为数组；
<2>.SAX
SAX不需要整个读入文档就可以对解析出的内容进行处理，是一种逐步解析的方法。程序也可以随时终止解析。这样，一个大的文档就可以逐步的、一点一点的展现出来，所以SAX适合于大规模的解析。这一点，JSON目前是做不到得。
所以，JSON和XML的轻/重量级的区别在于：
JSON只提供整体解析方案，而这种方法只在解析较少的数据时才能起到良好的效果；
XML提供了对大规模数据的逐步解析方案，这种方案很适合于对大量数据的处理。

(2).关于数据格式编码及解析难度
<1>.在编码方面。
虽然XML和JSON都有各自的编码工具，但是JSON的编码要比XML简单，即使不借助工具，也可以写出JSON代码，但要写出好的XML代码就有点困难;与XML一样，JSON也是基于文本的，且它们都使用Unicode编码，且其与数据交换格式XML一样具有可读性。
主观上来看，JSON更为清晰且冗余更少些。JSON网站提供了对JSON语法的严格描述，只是描述较简短。从总体来看，XML比较适合于标记文档，而JSON却更适于进行数据交换处理。
<2>.在解析方面。
在普通的web应用领域，开发者经常为XML的解析伤脑筋，无论是服务器端生成或处理XML，还是客户端用 JavaScript 解析XML，都常常导致复杂的代码，极低的开发效率。
实际上，对于大多数Web应用来说，他们根本不需要复杂的XML来传输数据，XML宣称的扩展性在此就很少具有优势,许多Ajax应用甚至直接返回HTML片段来构建动态Web页面。和返回XML并解析它相比，返回HTML片段大大降低了系统的复杂性，但同时缺少了一定的灵活性。同XML或 HTML片段相比，数据交换格式JSON 提供了更好的简单性和灵活性。在Web Serivice应用中，至少就目前来说XML仍有不可动摇的地位。

基于上面的分析我们要开发接口的时候兼容性一定要同时兼容xml和json 两种数据格式

那么php最常用的数据格式是array()
如何将数组转化成json呢

public static function jsonEncode($code, $message = '', $data = '')
    {
        if(!is_numeric( $code )) {
            return '';
        }

        $result = array(
                'code' => $code,
                'message' => $message,
                'data' => $data,
            );

        header("Content-type:text/json;chaset=utf-8");

        return json_encode($result);

    }

这里我们来把方法直接归属为类就是static方法这样我们不用实例化对象就可以调用他的方法还有一般接口一定会有一些错误信息或者错误码code 我们也以形参的方式加入到这个方法里来最后将header有改为json 用一个php自带函数 json_encode()来将数组转换为json格式的数据

那么json转换成功之后我们再来转换一下xml格式的数据
xml格式可能相对复杂

public static function xmlEncode($code, $message, $data = array())
    {
        if(!is_numeric( $code )) {
            return '';
        }

        $result = array(
                'code' => $code,
                'message' => $message,
                'data' => $data,
            );

        header("Content-type:text/xml;chaset=utf-8");
        $xml = "<?xml version='1.0' encoding='utf-8'  ?>\n";
        $xml .= "<root>\n";
        $xml .= self::xmlToEncode($result);
        $xml .=    "</root>\n";

        return $xml;

    }


    public static function xmlToEncode( $data )
    {
        if(empty($data)) {
            return '';
        }

        $xml = $attr = '';

        foreach ($data as $key => $value) {

            if(is_numeric( $key )) {   
                $attr = "id='{$key}'";
                $key = "item";
            }

            $xml .= "<{$key} {$attr}>";
            $xml .= is_array($value) ? self::xmlToEncode($value) : $value ;
            $xml .= "</{$key}>\n";

        }

        return $xml;
    }

这里用到了一个递归函数就是函数本身调用自己将多维数组递归转换为xml标签来进行数据展示

最后我们把类公开一个调用的方法所有请求都从这个方法里去调用
只要输入一个数据类型我们就调用相对应的转换数据的方法

public static function show($code, $message = '', $data = '', $type = 'json', $callback = '') 
    {

        if($type == 'json') {
            echo    self::jsonEncode($code,$message,$data);
        } elseif($type == 'xml') {
            echo    self::xmlEncode($code,$message,$data);
        } elseif($type == 'jsonp') {
            echo    $callback.'('.self::jsonEncode($code,$message,$data).')';
        }

    }

这样再将这四个方法封装为一个Responce类这样我们简单的接口就写好了在进行业务逻辑处理的时候我们直接调用这些方法就可以更简便的完成我们的工作！

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。