
在企业协作平台Confluence中,数据常以结构化(如表格)或非结构化文本形式存在于页面中。对于需要将这些信息集成到其他系统或进行分析的用户而言,高效地提取数据至关重要。本教程将深入探讨两种主要的数据提取策略,并提供针对Python用户的实现建议。
Confluence API是Atlassian官方提供的一套标准接口,用于与Confluence实例进行程序化交互。它提供了一种安全、稳定且受支持的方式来获取页面内容,包括HTML格式的文本、附件等。对于大多数数据提取需求,尤其是针对云端Confluence或追求开发简便性的场景,API是首选方案。
使用Python从Confluence API提取数据通常涉及以下几个步骤:认证、获取页面内容、解析内容。推荐使用atlassian-python-api等第三方库来简化API调用。
步骤概述:
pip install atlassian-python-api beautifulsoup4
示例代码:
from atlassian import Confluence
from bs4 import BeautifulSoup
import pandas as pd
# 配置Confluence连接参数
CONFLUENCE_URL = "https://your-confluence-instance.com" # 替换为你的Confluence URL
USERNAME = "your_username" # 替换为你的用户名
API_TOKEN = "your_api_token" # 替换为你的API Token
# 初始化Confluence客户端
# 如果是云端Confluence,cloud参数设为True
confluence = Confluence(
url=CONFLUENCE_URL,
username=USERNAME,
password=API_TOKEN, # API Token作为密码使用
cloud=True # 根据你的Confluence类型设置
)
def extract_table_data_from_page(page_identifier, identifier_type='id'):
"""
从Confluence页面提取所有表格数据。
:param page_identifier: 页面ID或页面标题。
:param identifier_type: 'id' 或 'title'。
:return: 包含所有表格数据的列表,每个表格数据为DataFrame。
"""
try:
page_content = None
if identifier_type == 'id':
# 获取页面内容,expand='body.storage'确保获取完整的XHTML内容
page_content = confluence.get_page_by_id(page_identifier, expand='body.storage')
elif identifier_type == 'title':
# 需要提供空间键(space key)
# 例如:page_content = confluence.get_page_by_title('YOUR_SPACE_KEY', page_identifier, expand='body.storage')
print("通过标题获取页面需要提供空间键,请修改代码。")
return []
else:
print("无效的identifier_type,请使用'id'或'title'。")
return []
if not page_content or 'body' not in page_content or 'storage' not in page_content['body']:
print(f"未能获取页面 {page_identifier} 的内容或内容格式不正确。")
return []
html_content = page_content['body']['storage']['value']
# 使用BeautifulSoup解析HTML
soup = BeautifulSoup(html_content, 'html.parser')
tables = soup.find_all('table')
extracted_dfs = []
for i, table in enumerate(tables):
headers = []
rows = []
# 提取表头
header_row = table.find('tr')
if header_row:
headers = [th.get_text(strip=True) for th in header_row.find_all('th')]
# 提取所有行数据
for row_tag in table.find_all('tr'):
# 跳过表头行(如果已单独处理)
if row_tag == header_row and headers:
continue
cells = [cell.get_text(strip=True) for cell in row_tag.find_all(['td', 'th'])]
if cells: # 确保不是空行
rows.append(cells)
# 如果没有明确的表头,尝试将第一行作为表头
if not headers and rows:
headers = rows.pop(0)
# 创建DataFrame
if headers and rows:
try:
df = pd.DataFrame(rows, columns=headers)
extracted_dfs.append(df)
except ValueError as e:
print(f"处理表格 {i+1} 时发生错误: {e}")
print(f"Headers: {headers}")
print(f"Rows sample: {rows[:2]}") # 打印前两行数据辅助调试
elif rows: # 如果没有表头但有数据,则不带表头创建DataFrame
df = pd.DataFrame(rows)
extracted_dfs.append(df)
return extracted_dfs
except Exception as e:
print(f"提取数据时发生错误: {e}")
return []
# 示例:从页面ID为'1234567'的页面提取数据
page_id_to_extract = "1234567" # 替换为你要提取的Confluence页面ID
all_tables_data = extract_table_data_from_page(page_id_to_extract, identifier_type='id')
if all_tables_data:
for i, df in enumerate(all_tables_data):
print(f"\n--- 提取的表格 {i+1} ---")
print(df.head()) # 打印前几行数据
else:
print("未从指定页面提取到任何表格数据。")
直接连接Confluence后端数据库是一种更为底层和复杂的数据提取方法。它通常仅适用于自建Confluence实例,且在API无法满足极高性能需求或需要进行大规模、深层次数据分析时才会被考虑。
直接连接数据库的复杂性主要体现在以下几个方面:
尽管不推荐,但如果您必须采取此方法,可以参考以下官方文档来配置数据源和理解数据模型:
强烈建议: 除非您具备深厚的Java/Hibernate背景,且面对无法通过API解决的性能瓶颈,否则不推荐此方法。API是更安全、更高效且更易于维护的解决方案。
无论是使用API还是直接连接数据库,以下最佳实践都应牢记在心:
从Confluence页面提取数据,尤其是表格数据,最推荐且最便捷的方法是利用Confluence提供的REST API。它提供了标准化的接口,兼容云端和自建环境,并通过Python库(如atlassian-python-api结合BeautifulSoup)可以轻松实现。这种方法不仅安全稳定,而且易于维护,是大多数数据提取任务的首选。
直接连接Confluence后端数据库虽然理论可行,但因其复杂性、缺乏官方Schema文档支持、高维护成本以及潜在的系统风险,仅应在极少数、对性能有极致要求的自建Confluence场景下考虑,且需要深厚的专业知识。在绝大多数情况下,API是您实现Confluence数据提取的首选和最佳途径。遵循最佳实践,可以确保数据提取过程的效率、准确性和安全性。
以上就是Confluence 页面数据提取指南:API 与数据库直连方法解析的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号