Flask 实现 Rest API (02) - 查询结果转换为 json 字符串

Rest API 以 json 格式对 Request 进行响应。结果集是如何转换成 json 呢？上一篇我们是这样做的：

# 首先得到一个 dict
items = [dict((curr.description[i][0], value) 
    for i, value in enumerate(row)) 
    for row in curr.fetchall()]

# 然后通过 flask 的 jsonify 转换成 json 格式
employees = emp.listAll()
return jsonify({'rows': employees}), 200;

这几句代码的信息量太大，我打算再用一篇文章来解释，顺便解决代码中存在的一个小问题。

获取字段名

Python 的 DB-API 规定，cursor 对象的 description 属性应该返回一个序列 (sequence)，这个序列包括下面的内容：

• name
• type_code
• display_size
• internal_size
• precision
• scale
• null_ok

第一个元素的 name 就是我们要的 column name。据此，可以编写一个函数得到 column name:

import pymysql

def get_connection():
    db = pymysql.connect('localhost', 'root', 'pwd', 'stonetest')
    return db

def get_column_names(sql):
    conn = get_connection()
    cur = conn.cursor()
    cur.execute(sql)

    col_names = []
    column_count = len(cur.description)
    for i in range(column_count):
        desc = cur.description[i]
        col_names.append(desc[0])

    return col_names

col_names = get_column_names('select * from users;')
print (col_names)

写的这么啰嗦是为了解释 column name 是如何获得的。通过调试可以发现，cur.description 根据 resultset 的每一列，创建了一个 7-item 的元组 (tuple), name 处在 index 为 0 的位置。然后所有列的元组再组合成一个元组，如下图所示：

所以我们用上面的方法，得到列名的集合，以 list 类型返回。get_column_names 函数用的是常规的循环方法，其实 Python 提供了很好的机制，让我们可以大大简化代码。需要用到 enumerate 函数和列表推导式。先 两个相关相关知识做一个简单说明。

enumerate 函数

enurmerate函数是 Python 的内置函数，enurmerate 作用于序列或者迭代器 (iterator)，返回一个新的迭代器，同时自动维护一个内部的计数器，从而简化循环的语句的编写。比如从 basic_colors 的列表中，遍历得到每一种颜色，为了循环，我们构造了一个计数器 i：

basic_colors = ['red', 'green', 'blue']
for i in range(len(basic_colors)):
    print (i, basic_colors[i])

使用 enumerate 函数后，代码可以简化为：

basic_colors = ['red', 'green', 'blue']
for i, item in enumerate(basic_colors):
    print (i, item)

列表推导式

列表推导式提供了一种简明的方法来创建列表。列表推导式在有些情况下特别方便，特别是当你需要使用 for 循环来生成一个新列表时。比如：

days = []
for i in range(1, 32):
    days.append(i)
print (days)

# output: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31]

可以使用列表推导式简化为：

days = [i for i in range(1, 32)]
print (days)

有了以上两个工具，get_column_names 函数可以简化为：

def get_column_names(sql):
    conn = get_connection()
    cur = conn.cursor()
    cur.execute(sql)

    column_names = [item[0] for counter, item in enumerate(cur.description) ]
    return column_names

现在应该理解了最刚开始的 items 语句：

items = [dict((curr.description[i][0], value) 
    for i, value in enumerate(row)) 
    for row in curr.fetchall()]

翻译一下，就是下面的代码：

def list_all():
    # ...

    rows = cur.fetchall()
    rows_list = []
    for row in rows:
        line_dict = dict()
        for i in range(len(row)):
            line_dict[cur.description[i][0]] = row[i]
        
        rows_list.append(line_dict)
    
    return rows_list

解决字段顺序问题

以上方法得到的 json 字符串，json 字符串中 key 的顺序与表中字段的顺序并不一致，原因有两点：

• dict 中 key 是没有顺序的，dict 使用 key 来查找，所以输出的顺序随机;
• flask 的 jsonfify() 方法在输出字段时，受 app.config['JSON_SORT_KEYS'] 控制，默认为 True，所以一般情况下 json 的输出是 key 的字母顺序输出的。jsonfiy() 方法会同时将 minetype 设置为 application/json。

知道问题的所在，解决办法也很简单：

• app.config['JSON_SORT_KEYS'] 设为 False
• listAll() 方法中，返回值用 dict 的子类 OrderedDict。改写后的 listAll() 方法如下：

    def listAll(self):
        conn = db.connect()
        curr = conn.cursor()

        curr.callproc('getEmployees')

        col_names = [desc[0] for desc in curr.description]
        result = []
        for row in curr.fetchall():
            dict_obj = OrderedDict()
            for i, v in enumerate(row): # index, value
                dict_obj[col_names[i]] = v
            result.append(dict_obj)

        curr.close()
        conn.close()

        return result

References

• get column names from query result using pymssql