Python Flask静态文件服务器：支持自动JSON扩展名补全的智能文件服务

Flask静态文件服务器：支持自动JSON扩展名补全的智能文件服务

摘要

本文将详细介绍一个使用Flask构建的智能静态文件服务器，该服务器具有自动识别和处理JSON文件的功能。当请求没有扩展名的文件时，服务器会自动尝试添加.json扩展名并返回JSON格式的数据，为前端开发提供便利。

1. 项目简介

这是一个基于Flask的静态文件服务器，主要特点包括：

支持常见的静态文件类型（HTML、CSS、JS、图片等）
智能处理无扩展名的JSON文件
自动识别文件MIME类型
支持GET和POST请求

2. 代码实现

python 复制代码

from flask import Flask, send_file, jsonify, abort
import os
import json
import magic
# pip install Flask python-magic


app = Flask(__name__, static_folder='')


# 你支持的已知扩展名（不会自动加 .json）
KNOWN_EXTENSIONS = {
    '.html', '.js', '.css', '.png', '.jpg', '.jpeg', '.gif',
    '.svg', '.ico', '.wav', '.mp3', '.mp4', '.webp', '.ttf', '.woff', '.woff2'
}


def has_known_extension(filename):
    _, ext = os.path.splitext(filename)
    return ext.lower() in KNOWN_EXTENSIONS


def is_valid_json_file(file_path):
    if not os.path.isfile(file_path):
        return False
    try:
        with open(file_path, 'r', encoding='utf-8') as f:
            json.load(f)
        return True
    except Exception:
        return False


def get_mime_type(file_path):
    if is_valid_json_file(file_path):
        return 'application/json'
    mime = magic.Magic(mime=True)
    return mime.from_file(file_path)


@app.route('/', defaults={'req_path': 'index.html'})
@app.route('/<path:req_path>', methods=['GET', 'POST'])
def serve_file(req_path):
    full_path = os.path.join(app.static_folder, req_path)


    # 情况 1: 请求的是存在的实际文件
    if os.path.isfile(full_path):
        mime_type = get_mime_type(full_path)
        if mime_type == 'application/json':
            with open(full_path, 'r', encoding='utf-8') as f:
                return jsonify(json.load(f))
        return send_file(full_path, mimetype=mime_type)


    # 情况 2: 无已知扩展名，尝试加 `.json`
    if not has_known_extension(req_path):
        json_path = full_path + '.json'
        if os.path.isfile(json_path) and is_valid_json_file(json_path):
            with open(json_path, 'r', encoding='utf-8') as f:
                return jsonify(json.load(f))


    # 情况 3: 都没有命中
    abort(404)


if __name__ == '__main__':
    app.run(debug=True)

3. 功能详解

3.1 已知扩展名集合

python 复制代码

KNOWN_EXTENSIONS = {
    '.html', '.js', '.css', '.png', '.jpg', '.jpeg', '.gif',
    '.svg', '.ico', '.wav', '.mp3', '.mp4', '.webp', '.ttf', '.woff', '.woff2'
}

定义了一个包含常见静态文件扩展名的集合，服务器会根据这个集合判断文件是否具有已知扩展名。

3.2 扩展名检查函数

python 复制代码

def has_known_extension(filename):
    _, ext = os.path.splitext(filename)
    return ext.lower() in KNOWN_EXTENSIONS

该函数检查文件名是否包含已知的扩展名。

3.3 JSON文件验证函数

python 复制代码

def is_valid_json_file(file_path):
    if not os.path.isfile(file_path):
        return False
    try:
        with open(file_path, 'r', encoding='utf-8') as f:
            json.load(f)
        return True
    except Exception:
        return False

该函数验证文件是否为有效的JSON文件。

3.4 MIME类型获取函数

python 复制代码

def get_mime_type(file_path):
    if is_valid_json_file(file_path):
        return 'application/json'
    mime = magic.Magic(mime=True)
    return mime.from_file(file_path)

该函数获取文件的MIME类型，如果是JSON文件则返回application/json，否则使用python-magic库自动识别。

3.5 文件服务路由

python 复制代码

@app.route('/', defaults={'req_path': 'index.html'})
@app.route('/<path:req_path>', methods=['GET', 'POST'])
def serve_file(req_path):
    # ... 实现逻辑

路由函数支持GET和POST请求，并实现以下逻辑：

如果请求的文件存在，直接返回该文件
如果文件不存在且没有已知扩展名，尝试添加.json扩展名
如果仍然找不到文件，返回404错误

4. 使用方法

安装依赖：

bash 复制代码

pip install Flask python-magic

将文件保存为app.py并运行：

bash 复制代码

python app.py

将静态文件放置在与app.py同级的目录中

5. 请求处理逻辑

服务器按照以下顺序处理请求：

直接文件匹配：如果请求的路径对应一个实际存在的文件，直接返回该文件
JSON扩展名补全 ：如果请求的文件没有已知扩展名，服务器会尝试添加.json扩展名并返回JSON格式数据
404错误：如果以上两种情况都不满足，返回404错误

6. 应用场景

这个服务器特别适用于以下场景：

前端开发中需要提供静态文件服务
API模拟，返回JSON数据
静态网站托管
原型开发和快速演示

7. 总结

这个Flask静态文件服务器通过智能的文件处理逻辑，为开发者提供了便利的静态文件服务。其核心优势在于能够自动处理无扩展名的JSON文件，使前端开发更加高效。通过简单的配置和扩展，可以满足大多数静态文件服务的需求。

服务器具有良好的扩展性，可以根据实际需要添加更多功能，如缓存控制、跨域支持等。