把JSON数据格式转换为Python的类对象

JOSN字符串转换为自定义类实例对象

有时候咱们有这种需求就是把一个JSON字符串转换为一个具体的Python类的实例，好比你接收到这样一个JSON字符串以下：

{"Name": "Tom", "Sex": "Male", "BloodType": "A", "Hobbies": ["篮球", "足球"]}

我须要把这个转换为具体的一个Person类的实例，经过对象的方式来进行操做。在Java中有不少实现好比Gson或者FastJosn。以下代码所示（这里不是所有代码，值标识最主要的部分）：

import com.alibaba.fastjson.JSONObject;
import com.example.demo.entity.Product;


String a = "{\"gmtCreate\":1559009853000,\"dataFormat\":1,\"deviceCount\":1,\"nodeType\":0,\"productKey\":\"a1U85pSQrAz\",\"productName\":\"温度计\"}";

//JSON字符串反序列化为一个Product对象
Product product = JSONObject.parseObject(a, Product.class);

上述这种需求通常发生在前段传递过来JSON字符串或者其余系统进行RPC通讯的时候也发送过来JSON字符串，做为接收端须要反序列化成对象来进行处理，并且Fastjson里还有一个JSONArray.parseArray方法能够转换为对象列表。但是在Python没有像Java中这么方便的东西。固然在Django的RESTframework框架中有这种进行序列化和反序列化的功能可使用。这里只是对一个问题的思考，若是遇到这种状况本身怎么解决。

从网上论坛中也看到过一些，不过不少都是效果有可是使用起来麻烦，因此我这里也来讲一下个人思路。

方式1：经过josn.loads来实现

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import sys
import json


class Person:
    def __init__(self, data=None):
        self._name = "1"
        self._sex = ""
        self._blood_type = "O"
        self._hobbies = []

        self._date_of_birth = "1900/1/1"

        if data:
            self.__dict__ = data

    # 经过属性的方式来获取和设置实例变量的值，若是不这样那么就只能经过set或者get方法来作
    @property
    def date_of_brith(self):
        return self._date_of_birth

    @date_of_brith.setter
    def date_of_brith(self, date_of_brith):
        self._date_of_birth = date_of_brith


def main():
    try:
        str1 = '{"name": "Tom", "sex": "male", "blood_type": "A", "hobbies": ["篮球", "足球"]}'
        person1 = json.loads(str1, object_hook=Person)
        print(isinstance(person1, Person))
        # 这里你会发现没有date_of_brith这个内容
        print(person1.__dict__)
        # 获取date_of_brith属性值报错，由于JSON字符串不包含这个键，可是类中的实例变量有这个，正常来说你应该能够获取默认值，可是因为
        # 替换了__dict__，因此就没有了，由于__dict__本来就是实例变量的字典形式，你替换了天然也就找不到原来的了。
        # print(person.date_of_brith)

        # 下面咱们经过正常的方式实例化一个对象
        person2 = Person()
        print(person2.__dict__)
        print(person2.date_of_brith)

    except Exception as err:
        print(err)

if __name__ == "__main__":
    try:
        main()
    finally:
        sys.exit()

object_hook的含义是，默认json.loads()返回的是dict，你可使用object_hook来让其返回其余类型的值，它这里实现的原理就是把你传递进来的JSON字符串传递给了object_hook指定的方法或者类（若是是类的话则会执行__init__方法，其实就是实例化），这时候在类的__init方法中咱们经过赋值给self.dict__，其实这就等于对Person类的实例变量作了替换，除非你的JSON字符串的键和实例变量的名称以及数量一致不然你没法经过你在类里定义的实例变量名称获取经过JSON字符串传递进去的值。以下图：

因此经过上面能够看出来，这个过程不是为实例变量赋值的过程而是一个替换的过程，Python是动态语言这一点和JAVA不一样。若是你在程序中用单下划线标识变量为私有（只是规范而不是真正的私有）那么你传递的JSON字符串的键也须要有下划线，这样你经过实例的方法才能获取。既然额外增长下划线不太现实，那么有没有其余办法呢？看方式2

方式2：经过反射机制来实现

先看一下类的定义

#!/usr/bin/env python
# -*- coding: utf-8 -*-


class Person:
    def __init__(self):
        self._name = "1"
        self._sex = ""
        self._blood_type = "O"
        self._hobbies = []
        self._date_of_birth = "1900/1/1"

    def __str__(self):
        """
        输出实例的类名字，而不是一个地址
        :return: 该实例的类名字
        """
        return self.__class__.__name__

    # 当一个方法加上这个装饰器以后，hasattr()中的属性要写成这个方法的名称，而不是实例变量的名称。
    # 若是不加这个装饰器，那么hasattr()中的属性名称要和实例变量的名称保持一致
    @property
    def Name(self):
        return self._name

    @Name.setter
    def Name(self, name):
        self._name = name

    @property
    def Sex(self):
        return self._sex

    @Sex.setter
    def Sex(self, sex):
        self._sex = sex

    @property
    def BloodType(self):
        return self._blood_type

    @BloodType.setter
    def BloodType(self, blood_type):
        self._blood_type = blood_type

    @property
    def Hobbies(self):
        return self._hobbies

    @Hobbies.setter
    def Hobbies(self, hobbies):
        self._hobbies = hobbies

    @property
    def date_of_brith(self):
        return self._date_of_birth

    @date_of_brith.setter
    def date_of_brith(self, date_of_brith):
        self._date_of_birth = date_of_brith

下面看看转换的方法

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import sys
import json
import importlib


def get_instance(str_stream, class_full_path=None):
    """
    :param str_stream: json的字符串形式 '{"Name": "Tom", "Sex": "Male", "BloodType": "A"}'
    :param class_full_path: package.module.class
    :return:
    """
    try:
        json_obj = json.loads(str_stream)
    except Exception as err:
        print("输入的字符串不符合JSON格式，请检查。")
        return None

    if class_full_path is None:
        return json_obj
    else:
        try:
            # 获取模块路径
            module_path = ".".join(class_full_path.split(".")[0:-1])
            # 获取类名称
            class_name = class_full_path.split(".")[-1]
            # 经过模块名加载模块
            CC = importlib.import_module(module_path)

            # 判断是否有class_name所表明的属性
            if hasattr(CC, class_name):
                # 获取模块中属性
                temp_obj = getattr(CC, class_name)
                # 实例化对象
                obj = temp_obj()

                for key in json_obj.keys():
                    obj.__setattr__(key,  json_obj[key])

                return obj
            else:
                pass
        except Exception as err:
            print(err)
            return None


def main():
    try:
        str1 = '{"Name": "Tom", "Sex": "Male", "BloodType": "A", "Hobbies": ["篮球", "足球"]}'
        person1 = get_instance(str1, class_full_path="AAA.Classes.Person")
        # 查看类型
        print(type(person1))
        # 查看属性
        print(person1.__dict__)
        # 查看指定属性
        print(person1.Name)

    except Exception as err:
        print(err)

if __name__ == "__main__":
    try:
        main()
    finally:
        sys.exit()

__import__() 有2个参数，第一个是类，第二个是fromlist，若是不写fromlist，则按照下面的写法会只导入AAA包，若是fromlist有值则会导入AAA下面的Classes模块cc = __import__("AAA.Classes", fromlist=True)不写fromlist 至关于 import AAA ,若是写了就至关因而from AAA import Classes编程时若是使用动态加载建议使用importlib.import_module()，而不是__import__()。

下面看一下效果：

能够看到，这样操做以后就是给实例变量赋值而不是像以前那样的替换，并且保留了类中实例变量的私有规范。不过须要说明的是JSON字符串中的键名称要和类里面定义的属性名称同样，也就是键名称要和类中@property装饰的方法同名。咱们也能够看到这种使用方式也有默认JSONObject.parseObject的意思。

不过这只是一个简单的实现，只能经过单一JSON字符串生成对象不能生成对象列表。固然有兴趣的朋友能够本身根据这个思路进行扩展。

另外既然不管是loads仍是我本身的方法搜须要保证JSON字符串的键和变量名称一致你们就不要纠结于名称一致的问题，可是个人方法作到了保持实例变量命名、操做实例属性时候的规范，同时对类也没有过多的入侵性而不像loads方法中还须要在类的init方法里面增长没必要要的内容。在我这个方法中若是能实现忽略大小写通用性就更好了。欢迎你们来提供思路。