Django SQL Explorer 配置详解：安全与功能全面指南-CSDN博客

Django SQL Explorer 配置详解：安全与功能全面指南

前言

Django SQL Explorer 是一个强大的数据库查询工具，允许开发者通过Web界面直接执行SQL查询并查看结果。本文将全面解析该项目的配置选项，帮助开发者根据实际需求进行定制化配置。

安全配置

SQL黑名单机制

SQL黑名单是防止执行危险操作的第一道防线。默认配置中包含了三类禁止执行的SQL语句：

EXPLORER_SQL_BLACKLIST = (
    # 数据操作语言(DML)
    'COMMIT', 'DELETE', 'INSERT', 'MERGE', 'REPLACE', 
    'ROLLBACK', 'SET', 'START', 'UPDATE', 'UPSERT',
    
    # 数据定义语言(DDL)
    'ALTER', 'CREATE', 'DROP', 'RENAME', 'TRUNCATE',
    
    # 数据控制语言(DCL)
    'GRANT', 'REVOKE',
)

技术建议：在生产环境中，建议保持默认配置不变。如需调整，应确保数据库连接使用只读权限账号。

权限控制

系统提供两级权限控制：

# 查看和执行查询的权限
EXPLORER_PERMISSION_VIEW = lambda r: r.user.is_staff

# 增删改查询的权限
EXPLORER_PERMISSION_CHANGE = lambda r: r.user.is_staff

最佳实践：可以根据企业RBAC系统自定义这些lambda函数，实现更细粒度的权限控制。

数据库连接配置

默认连接设置

EXPLORER_DEFAULT_CONNECTION = None  # 必须设置为有效的数据库连接名

重要提示：此配置必须设置，否则应用无法正常工作。建议使用只读权限的数据库连接。

多数据库支持

EXPLORER_CONNECTIONS = {
    '生产只读': 'prod_readonly',
    '测试环境': 'test_db'
}

技术说明：字典键为显示名称，值为Django数据库配置中的别名。

查询界面配置

默认显示行数

EXPLORER_DEFAULT_ROWS = 1000

优化建议：对于大型数据库，可适当减少此值以提高性能。

数据库结构展示

表前缀过滤

# 包含特定前缀的表
EXPLORER_SCHEMA_INCLUDE_TABLE_PREFIXES = None

# 排除特定前缀的表
EXPLORER_SCHEMA_EXCLUDE_TABLE_PREFIXES = (
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.admin'
)

使用场景：当数据库包含大量系统表时，可通过排除配置简化界面。

视图包含选项

EXPLORER_SCHEMA_INCLUDE_VIEWS = False

设置为True可包含数据库视图在结构展示中。

异步处理配置

Celery集成

EXPLORER_TASKS_ENABLED = False
EXPLORER_ASYNC_SCHEMA = False

技术前提：启用异步功能需要正确配置Celery服务。

数据导出选项

EXPLORER_DATA_EXPORTERS = [
    ('csv', 'explorer.exporters.CSVExporter'),
    ('excel', 'explorer.exporters.ExcelExporter'),
    ('json', 'explorer.exporters.JSONExporter')
]

注意：Excel导出需要额外安装xlsxwriter包。

S3存储集成

基本配置

EXPLORER_S3_ACCESS_KEY = None
EXPLORER_S3_SECRET_KEY = None
EXPLORER_S3_BUCKET = None
EXPLORER_S3_REGION = 'us-east-1'

高级配置

# 自定义端点URL
EXPLORER_S3_ENDPOINT_URL = 'https://custom.endpoint.com'

# 存储路径
EXPLORER_S3_DESTINATION = 'explorer/query'

# 链接有效期(秒)
EXPLORER_S3_LINK_EXPIRATION = 3600

# 签名版本
EXPLORER_S3_SIGNATURE_VERSION = 's3v4'

安全建议：使用S3存储时，务必设置适当的链接有效期和签名版本。

其他重要配置

令牌认证

EXPLORER_TOKEN_AUTH_ENABLED = False
EXPLORER_TOKEN = "CHANGEME"

安全警告：启用令牌认证时，务必修改默认令牌值。

用户界面渲染

EXPLORER_UNSAFE_RENDERING = False

安全提示：除非绝对必要，否则不应启用不安全渲染，以防止XSS攻击。

AI辅助功能

EXPLORER_AI_API_KEY = None
EXPLORER_ASSISTANT_BASE_URL = "https://api.openai.com/v1"
EXPLORER_ASSISTANT_MODEL = "gpt-3.5-turbo"

使用说明：配置AI API密钥可启用SQL编写辅助功能。