Django连接SQL Server实例：解决主机名转义与配置优化

本文详细介绍了在django应用中连接sql server命名实例时遇到的主机名转义问题及其解决方案。核心在于当使用server_name\instance_name格式作为host配置时，可能导致连接失败。文章提供了一种通过指定ip地址和实例监听端口（ip_address,port格式），并清空port字段的优化配置方法，确保django应用能够稳定连接sql server。同时，文中也涵盖了相关的docker环境配置和必要的依赖项安装。

在开发Django应用并将其与Microsoft SQL Server数据库集成时，正确配置数据库连接至关重要。特别是当SQL Server以命名实例（例如 SERVER_NAME\INSTANCE_NAME）的形式存在时，在Django的DATABASES配置中直接使用这种主机名格式，可能会遇到连接问题，最常见的错误是Login timeout expired。这通常不是因为Python的字符串转义特性直接在HOST值中添加了额外的反斜杠，而是因为底层ODBC驱动程序在解析包含反斜杠的主机名时，可能无法正确识别或解析命名实例，或者命名实例的动态端口解析失败。

问题描述

当尝试使用以下Django数据库配置连接SQL Server命名实例时：

DATABASES = {
    'default': {
        'ENGINE': 'mssql',
        'NAME': "reporting",
        'HOST': 'DESKTOP-RC52TD0\\SQL2025', # 示例中的问题配置
        'PORT': 1433,
        'USER': "sa",
        'PASSWORD': "Root_1421",
        'OPTIONS': {
            'driver': 'ODBC Driver 17 for SQL Server',
        },
    }
}

即使尝试了原始字符串（r'...'）或双反斜杠（'\\'）等多种转义方法，仍可能收到django.db.utils.OperationalError: ('HYT00', '[HYT00] [Microsoft][ODBC Driver 17 for SQL Server]Login timeout expired (0) (SQLDriverConnect)')这样的错误。这表明ODBC驱动无法在指定的主机和端口上建立连接，可能的原因是无法正确解析命名实例的主机名，或者实例监听的端口并非默认的1433，且无法通过命名实例解析服务找到。

解决方案：使用IP地址和精确端口

最稳定和推荐的解决方案是绕过命名实例的解析机制，直接指定SQL Server主机的IP地址和该实例正在监听的精确端口。这种方法消除了命名实例解析可能带来的歧义和问题。

修改后的DATABASES配置应如下所示：

DATABASES = {
    'default': {
        'ENGINE': 'mssql',
        'NAME': 'reporting',
        'HOST': '192.168.211.225,56985', # 使用IP地址和端口，以逗号分隔
        'PORT': '', # 将PORT字段留空
        'USER': 'your_username',
        'PASSWORD': 'your_password',
        'OPTIONS': {
            'driver': 'ODBC Driver 17 for SQL Server',
        },
    }
}

关键点：

HOST字段格式： 使用IP_ADDRESS,PORT的格式。例如，如果SQL Server主机的IP是192.168.211.225，且该命名实例监听在56985端口，则HOST应设置为'192.168.211.225,56985'。
PORT字段： 当HOST字段中已经包含了端口信息时，DATABASES配置中的PORT字段应留空（''）。这是因为mssql-django后端会将HOST字段解析为server,port的形式，如果PORT字段也设置了值，可能会导致冲突或错误。

Docker环境下的配置

如果您的Django应用运行在Docker容器中，并且通过环境变量传递数据库配置，那么在docker-compose.yml文件中也需要相应地更新DB_HOST环境变量：

version: '3'

services:
  web:
    image: landsoft/reporting-api
    network_mode: host # 注意：生产环境通常不推荐使用host网络模式，应使用bridge网络并正确配置服务发现
    build:
      context: ./app
    command: >
      sh -c "python manage.py migrate &&
             python manage.py runserver 0.0.0.0:8000"
    volumes:
      - ./app:/code
    ports:
      - "8000:8000"
    environment:
      - DB_HOST="192.168.211.225,56985" # 更新为IP地址和端口
      - DB_NAME=reporting
      - DB_USER=sa
      - DB_PASSWORD=Root_1421
      - DB_PORT="" # 如果通过环境变量传递，也应留空

在Django settings.py 中，您可以使用django-environ等库来从环境变量读取这些配置：

import environ

env = environ.Env(
    # 定义默认值和类型
    DB_HOST=(str, '127.0.0.1'),
    DB_PORT=(str, ''), # 确保这里也是字符串类型
    # ... 其他数据库相关变量
)
environ.Env.read_env() # 读取.env文件

DATABASES = {
    'default': {
        'ENGINE': 'mssql',
        'NAME': env('DB_NAME'),
        'HOST': env('DB_HOST'),
        'PORT': env('DB_PORT'), # 从环境变量读取，此时应为空字符串
        'USER': env('DB_USER'),
        'PASSWORD': env('DB_PASSWORD'),
        'OPTIONS': {
            'driver': 'ODBC Driver 17 for SQL Server',
        },
    }
}

依赖与环境准备

为了确保Django应用能够成功连接SQL Server，还需要在运行环境中安装必要的Python包和ODBC驱动。

requirements.txt

Django==3.2.23
mssql-django==1.3
djangorestframework>=3.12.4,<=3.13
drf-spectacular>=0.15.1,<=0.16
Pillow>=8.2.0,<=8.3.0
django-environ>=0.11.2,<=0.12

其中，mssql-django是Django连接SQL Server的关键后端。

Dockerfile中的ODBC驱动安装

在Docker容器中，需要安装Microsoft ODBC Driver for SQL Server以及相关的依赖。以下是一个Dockerfile示例：

FROM ubuntu:18.04
ENV PYTHONUNBUFFERED 1
ENV DEBIAN_FRONTEND noninteractive

# 更新apt源并安装基本工具和Python
RUN apt-get update && apt-get install -y curl apt-transport-https python3 python3-pip python3-venv python-dev locales nano gnupg2

# 添加Microsoft APT源
RUN curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
RUN curl https://packages.microsoft.com/config/ubuntu/18.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
RUN apt-get update

# 安装ODBC Driver 17 for SQL Server及其依赖
ENV ACCEPT_EULA=Y
RUN apt-get -y install msodbcsql17 freetds-dev tdsodbc unixodbc-dev

# 安装SQL Server命令行工具 (可选，但推荐用于调试)
RUN apt-get install mssql-tools
RUN echo 'export PATH="$PATH:/opt/mssql-tools/bin"' >> ~/.bashrc
RUN /bin/bash -c "source ~/.bashrc"

# 设置工作目录和Python虚拟环境
RUN mkdir /code
WORKDIR /code
ADD requirements.txt /code/

RUN python3 -m venv /venv
ENV PATH="/venv/bin:$PATH"
RUN /venv/bin/python -m pip install --upgrade pip && \
    /venv/bin/pip install -r requirements.txt -v

ADD . /code/

# 设置语言环境
RUN echo "en_US.UTF-8 UTF-8" > /etc/locale.gen
RUN locale-gen

此Dockerfile确保了：

安装了Python 3及其虚拟环境。
添加了Microsoft的APT源。
安装了msodbcsql17（ODBC Driver 17 for SQL Server）以及freetds-dev、tdsodbc和unixodbc-dev等必要依赖。
安装了mssql-tools，方便在容器内进行SQL Server连接测试。
在虚拟环境中安装了requirements.txt中列出的Python包。