安全获取Python中嵌套JSON数据中的URL字符串

DDD

发布时间：2025-11-17 10:14:08

688人浏览过

来源于php中文网

原创

安全获取Python中嵌套JSON数据中的URL字符串

本教程详细介绍了如何在python中从嵌套的json数据（通常是api响应转换成的字典）中安全地提取特定值，特别是url字符串。文章强调了使用`dict.get()`方法来避免`keyerror`的风险，并通过提供默认值增强代码的健壮性，确保即使在数据结构不完全符合预期时，程序也能稳定运行。

Python中安全提取嵌套字典值：以API响应为例

在处理Web API响应时，我们经常会遇到嵌套的JSON数据结构。这些数据在Python中通常被解析为字典的嵌套结构。直接访问这些嵌套字典的键可能会导致KeyError，尤其是在API响应结构不一致或缺少某些键时。本教程将以一个实际案例为例，演示如何安全、高效地从复杂的JSON数据中提取所需的URL字符串。

1. 理解JSON数据结构与API交互

首先，我们通过一个示例来模拟从API获取数据并将其解析为Python字典的过程。假设我们有一个Character类，它负责从一个角色服务API获取角色数据。

import requests
import json # 仅用于展示数据结构，实际API调用中通常直接使用req.json()

class Character:
    def __init__(self, character_id):
        self.character_id = character_id
        self.character_data = self.get_character_data()
        if self.character_data:
            print(f"Character ID: {self.character_data.get('id')}")
        else:
            print("Failed to load character data.")

    def get_character_data(self):
        # 实际API请求，这里使用一个示例URL
        req = requests.get(f"https://character-service.dndbeyond.com/character/v5/character/{self.character_id}")

        if req.status_code != 200:
            print(f"Error: API returned status code {req.status_code}")
            return None
        try:
            j = req.json()
            # 验证API响应是否包含预期的'success'和'data'键
            if not j.get("success") or not j.get("data"):
                print("API response missing 'success' or 'data' key.")
                return None
            return j["data"]
        except json.JSONDecodeError: # 捕获JSON解析错误
            print("Error: Could not decode JSON response.")
            return None
        except Exception as e:
            print(f"An unexpected error occurred: {e}")
            return None

# 假设我们获取到的character_data['data']部分结构如下：
# （为简洁起见，这里只展示关键部分）
sample_character_data = {
    'id': 108291017,
    'userId': 118256620,
    'username': 'sethirya',
    'decorations': {
        'avatarUrl': 'https://www.dndbeyond.com/avatars/21222/111/637708177497566513.jpeg?width=150&height=150&fit=crop&quality=95&auto=webp',
        'frameAvatarUrl': 'https://www.dndbeyond.com/avatars/7169/957/637042612736861450.png',
        # ... 其他装饰信息
    },
    'name': 'Raine',
    # ... 其他角色信息
}

我们的目标是从sample_character_data中提取decorations字典下的avatarUrl字符串。

2. 直接访问与潜在问题

最直观的方法是使用方括号[]来层层访问嵌套字典的键：

立即学习“Python免费学习笔记（深入）”；

# 假设 character_instance.character_data 已经包含了上述 sample_character_data
# avatar_url = character_instance.character_data["decorations"]["avatarUrl"] 
# print(avatar_url)

# 使用示例数据演示
avatar_url_direct = sample_character_data["decorations"]["avatarUrl"]
print(f"直接访问获取的URL: {avatar_url_direct}")

这种方法在数据结构完全符合预期时工作良好。然而，如果decorations键不存在于sample_character_data中，或者avatarUrl键不存在于decorations字典中，程序将抛出KeyError，导致程序崩溃。

3. 使用 dict.get() 进行安全访问

为了避免KeyError，Python字典提供了get()方法。get()方法接受两个参数：要查找的键和当键不存在时返回的默认值。

阿里妈妈·创意中心

阿里妈妈营销创意中心

下载

语法: dictionary.get(key, default_value)

利用get()方法，我们可以链式地安全访问嵌套字典：

# 假设 character_instance.character_data 已经包含了上述 sample_character_data
# avatar_url_safe = character_instance.character_data.get("decorations", {}).get("avatarUrl", "")
# print(avatar_url_safe)

# 使用示例数据演示
# 第一步：获取 'decorations' 字典。如果不存在，则返回一个空字典 {}
decorations_data = sample_character_data.get("decorations", {})

# 第二步：从 decorations_data 中获取 'avatarUrl'。如果不存在，则返回一个空字符串 ""
avatar_url_safe = decorations_data.get("avatarUrl", "")

print(f"安全访问获取的URL: {avatar_url_safe}")

代码解释：

sample_character_data.get("decorations", {}): 尝试从sample_character_data中获取decorations键对应的值。
- 如果decorations键存在，它将返回其对应的字典。
- 如果decorations键不存在，它将返回我们提供的默认值——一个空字典{}。这确保了后续的.get("avatarUrl", "")操作总是在一个字典对象上执行，即使它是一个空的字典。
.get("avatarUrl", ""): 接着，在第一步返回的对象（可能是实际的decorations字典或空字典）上，尝试获取avatarUrl键对应的值。
- 如果avatarUrl键存在，它将返回其对应的URL字符串。
- 如果avatarUrl键不存在（或在第一步返回的是空字典），它将返回我们提供的默认值——一个空字符串""。

通过这种方式，无论decorations或avatarUrl键是否存在，代码都不会抛出KeyError，而是返回一个预设的默认值（在本例中是空字符串），从而大大提高了程序的健壮性。

4. 完整示例与应用

结合上述方法，我们可以在Character类中添加一个方法来安全地获取avatarUrl：

import requests
import json

class Character:
    def __init__(self, character_id):
        self.character_id = character_id
        self.character_data = self.get_character_data()
        if self.character_data:
            print(f"Character ID: {self.character_data.get('id')}")
        else:
            print("Failed to load character data.")

    def get_character_data(self):
        req = requests.get(f"https://character-service.dndbeyond.com/character/v5/character/{self.character_id}")

        if req.status_code != 200:
            print(f"Error: API returned status code {req.status_code}")
            return None
        try:
            j = req.json()
            if not j.get("success") or not j.get("data"):
                print("API response missing 'success' or 'data' key.")
                return None
            return j["data"]
        except json.JSONDecodeError:
            print("Error: Could not decode JSON response.")
            return None
        except Exception as e:
            print(f"An unexpected error occurred: {e}")
            return None

    def get_avatar_url(self):
        """
        安全地从角色数据中提取头像URL。
        """
        if not self.character_data:
            return "" # 如果角色数据未加载，直接返回空字符串

        # 使用链式get()方法安全访问嵌套字典
        avatar_url = self.character_data.get("decorations", {}).get("avatarUrl", "")
        return avatar_url

# 实例化并测试
# 注意：以下 character_id 仅为示例，实际使用请替换为有效的ID
# character = Character(108291017) # 假设这是一个有效的角色ID
# avatar_url = character.get_avatar_url()
# print(f"角色头像URL: {avatar_url}")

# 为了演示，我们直接使用上面定义的 sample_character_data
# 模拟 character_data 已经加载
temp_char_obj = Character(0) # 传入0作为占位符，不进行实际API调用
temp_char_obj.character_data = sample_character_data # 注入示例数据

avatar_url_from_obj = temp_char_obj.get_avatar_url()
print(f"从模拟对象中获取的角色头像URL: {avatar_url_from_obj}")

# 假设一个没有 'decorations' 键的数据
no_decorations_data = {'id': 123, 'name': 'Test Character'}
temp_char_obj.character_data = no_decorations_data
avatar_url_no_decorations = temp_char_obj.get_avatar_url()
print(f"没有'decorations'键时获取的URL: '{avatar_url_no_decorations}' (预期为空字符串)")

# 假设 'decorations' 键存在但没有 'avatarUrl' 键
decorations_no_avatar_data = {'id': 456, 'name': 'Another Test', 'decorations': {'frameUrl': 'some_frame.png'}}
temp_char_obj.character_data = decorations_no_avatar_data
avatar_url_no_avatar = temp_char_obj.get_avatar_url()
print(f"有'decorations'但没有'avatarUrl'键时获取的URL: '{avatar_url_no_avatar}' (预期为空字符串)")

5. 注意事项与最佳实践

默认值的选择： get()方法的默认值选择至关重要。对于嵌套字典，通常传递一个空字典{}作为默认值，以便可以继续链式调用。对于最终期望的字符串、数字或布尔值，应选择一个能表示“无”或“未知”状态的默认值（如空字符串""、None、0或False）。
API响应验证： 在解析JSON数据之前，始终检查HTTP响应状态码（req.status_code）以确保请求成功。此外，对JSON响应本身进行基本验证（如检查顶层success或data键的存在）也是一个好习惯。
错误处理： 使用try-except块来捕获json.JSONDecodeError（如果响应不是有效的JSON）以及其他潜在的运行时错误。
代码可读性： 尽管链式调用get()很简洁，但在嵌套层级非常深时，可以考虑将其拆分为多行或使用辅助函数来提高可读性。

总结

通过本教程，我们学习了如何利用Python字典的get()方法来安全地从嵌套JSON数据中提取特定信息，特别是URL字符串。这种方法通过提供默认值，有效避免了KeyError，使代码更加健壮和可靠，尤其适用于处理来自外部API的不可预测数据。在实际开发中，始终优先考虑使用get()方法来访问字典键，以编写更具防御性的代码。

Python DataFrame 去重：基于时间戳保留每篇文章的最新操作记录

Python中使用try语句写入文件时内容未保存的解决方案

Python 中使用 try 语句写入文件失败的常见原因及最佳实践

Python 中基于时间戳保留每篇文章最新操作记录的去重方法

Python 中按时间戳保留每篇文章最新操作记录的去重方法