Flask flash()显示JSON格式字符串而非消息文本问题排查

可能成因 #

• 自定义flash函数或上下文处理器搞的鬼
  检查项目里有没有重写过*flash函数，或者上下文处理器对get_flashed_messages()*的返回值做了额外处理——比如有人会封装flash，但错误地把消息和类别打包成字典再返回，导致前端拿到的是序列化后的结构字符串。
• 模板输出逻辑有隐藏问题
  哪怕你说模板符合规范，再仔细核对：是不是直接把message对象整个输出了，而没提取里面的文本内容？比如如果*get_flashed_messages()*返回的是字典，你却写{{ message }}，自然会打印出字典的字符串形式。正确的写法如果带分类，应该是{% for category, msg in get_flashed_messages(with_categories=true) %}，然后输出{{ msg }}。
• 会话序列化或存储出问题
  Flask默认用Cookie存会话数据，要是你自定义了会话后端（比如Redis），或者改了会话的序列化方式（比如用JSON代替默认的Pickle），可能会导致flash消息被错误序列化，前端拿到的就是原始的序列化结构。
• 第三方扩展/中间件篡改数据
  看看有没有用处理请求响应的中间件，或者Flask-Security、Flask-Login这类扩展——有些扩展会对flash消息做封装，改变了原本的存储格式，导致取出后结构不对。

排查步骤 #

• 直接调试get_flashed_messages()的返回值
  在视图函数里调用*get_flashed_messages(with_categories=True)*，打印看看返回的是什么结构。如果是字典列表而非元组/字符串列表，那问题肯定出在消息存储阶段。
• 死磕模板代码细节
  把模板里处理flash的代码拿出来核对：是不是写了{% for msg in get_flashed_messages() %}但实际每个msg是个字典？有没有不小心用了{{ message|tojson }}这类过滤器，把对象转成了JSON字符串？
• 禁用扩展和中间件排查
  临时注释掉非核心的扩展、自定义中间件，重启应用测试。如果恢复正常，再逐个启用，找出哪个家伙搞的破坏。
• 检查自定义的flash相关代码
  全局搜项目里的*flash*函数，看有没有被重定义——比如def flash(message, category='info'):这种自定义实现，是不是错误地把消息打包成字典存入会话了。
• 查看会话原始数据
  要是用的Cookie会话，打开浏览器开发者工具看session Cookie的值，解码后看看flash消息的存储结构。正常情况下，flash消息应该是列表，每个元素是带类别和文本的元组或字符串。

内容的提问来源于stack exchange，提问作者Hima