Python使用Flask构建智能的静态文件服务器
<div id="navCategory"><h5 class="catalogue">目录</h5><ul class="first_class_ul"><li><a href="#_label0">摘要</a></li><li><a href="#_label1">1. 项目简介</a></li><li><a href="#_label2">2. 代码实现</a></li><li><a href="#_label3">3. 功能详解</a></li><ul class="second_class_ul"><li><a href="#_lab2_3_0">3.1 已知扩展名集合</a></li><li><a href="#_lab2_3_1">3.2 扩展名检查函数</a></li><li><a href="#_lab2_3_2">3.3 JSON文件验证函数</a></li><li><a href="#_lab2_3_3">3.4 MIME类型获取函数</a></li><li><a href="#_lab2_3_4">3.5 文件服务路由</a></li></ul><li><a href="#_label4">4. 使用方法</a></li><ul class="second_class_ul"></ul><li><a href="#_label5">5. 请求处理逻辑</a></li><ul class="second_class_ul"></ul><li><a href="#_label6">6. 应用场景</a></li><ul class="second_class_ul"></ul><li><a href="#_label7">7. 总结</a></li><ul class="second_class_ul"></ul></ul></div><p class="maodian"><a name="_label0"></a></p><h2>摘要</h2><p>本文将详细介绍一个使用Flask构建的智能静态文件服务器，该服务器具有自动识别和处理JSON文件的功能。当请求没有扩展名的文件时，服务器会自动尝试添加<code>.json</code>扩展名并返回JSON格式的数据，为前端开发提供便利。</p>
<p class="maodian"><a name="_label1"></a></p><h2>1. 项目简介</h2>
<p>这是一个基于Flask的静态文件服务器，主要特点包括：</p>
<ul><li>支持常见的静态文件类型（HTML、CSS、JS、图片等）</li><li>智能处理无扩展名的JSON文件</li><li>自动识别文件MIME类型</li><li>支持GET和POST请求</li></ul>
<p class="maodian"><a name="_label2"></a></p><h2>2. 代码实现</h2>
<div class="jb51code"><pre class="brush:py;">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)
</pre></div>
<p class="maodian"><a name="_label3"></a></p><h2>3. 功能详解</h2>
<p class="maodian"><a name="_lab2_3_0"></a></p><h3>3.1 已知扩展名集合</h3>
<div class="jb51code"><pre class="brush:py;">KNOWN_EXTENSIONS = {
'.html', '.js', '.css', '.png', '.jpg', '.jpeg', '.gif',
'.svg', '.ico', '.wav', '.mp3', '.mp4', '.webp', '.ttf', '.woff', '.woff2'
}
</pre></div>
<p>定义了一个包含常见静态文件扩展名的集合，服务器会根据这个集合判断文件是否具有已知扩展名。</p>
<p class="maodian"><a name="_lab2_3_1"></a></p><h3>3.2 扩展名检查函数</h3>
<div class="jb51code"><pre class="brush:py;">def has_known_extension(filename):
_, ext = os.path.splitext(filename)
return ext.lower() in KNOWN_EXTENSIONS
</pre></div>
<p>该函数检查文件名是否包含已知的扩展名。</p>
<p class="maodian"><a name="_lab2_3_2"></a></p><h3>3.3 JSON文件验证函数</h3>
<div class="jb51code"><pre class="brush:py;">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
</pre></div>
<p>该函数验证文件是否为有效的JSON文件。</p>
<p class="maodian"><a name="_lab2_3_3"></a></p><h3>3.4 MIME类型获取函数</h3>
<div class="jb51code"><pre class="brush:py;">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)
</pre></div>
<p>该函数获取文件的MIME类型，如果是JSON文件则返回<code>application/json</code>，否则使用python-magic库自动识别。</p>
<p class="maodian"><a name="_lab2_3_4"></a></p><h3>3.5 文件服务路由</h3>
<div class="jb51code"><pre class="brush:py;">@app.route('/', defaults={'req_path': 'index.html'})
@app.route('/<path:req_path>', methods=['GET', 'POST'])
def serve_file(req_path):
# ... 实现逻辑
</pre></div>
<p>路由函数支持GET和POST请求，并实现以下逻辑：</p>
<ul><li>如果请求的文件存在，直接返回该文件</li><li>如果文件不存在且没有已知扩展名，尝试添加<code>.json</code>扩展名</li><li>如果仍然找不到文件，返回404错误</li></ul>
<p class="maodian"><a name="_label4"></a></p><h2>4. 使用方法</h2>
<p>安装依赖：</p>
<div class="jb51code"><pre class="brush:bash;">pip install Flask python-magic
</pre></div>
<p>将文件保存为<code>app.py</code>并运行：</p>
<div class="jb51code"><pre class="brush:bash;">python app.py
</pre></div>
<p>将静态文件放置在与<code>app.py</code>同级的目录中</p>
<p class="maodian"><a name="_label5"></a></p><h2>5. 请求处理逻辑</h2>
<p>服务器按照以下顺序处理请求：</p>
<ul><li><strong>直接文件匹配</strong>：如果请求的路径对应一个实际存在的文件，直接返回该文件</li><li><strong>JSON扩展名补全</strong>：如果请求的文件没有已知扩展名，服务器会尝试添加<code>.json</code>扩展名并返回JSON格式数据</li><li><strong>404错误</strong>：如果以上两种情况都不满足，返回404错误</li></ul>
<p class="maodian"><a name="_label6"></a></p><h2>6. 应用场景</h2>
<p>这个服务器特别适用于以下场景：</p>
<ul><li>前端开发中需要提供静态文件服务</li><li>API模拟，返回JSON数据</li><li>静态网站托管</li><li>原型开发和快速演示</li></ul>
<p class="maodian"><a name="_label7"></a></p><h2>7. 总结</h2>
<p>这个Flask静态文件服务器通过智能的文件处理逻辑，为开发者提供了便利的静态文件服务。其核心优势在于能够自动处理无扩展名的JSON文件，使前端开发更加高效。通过简单的配置和扩展，可以满足大多数静态文件服务的需求。</p>
<p>服务器具有良好的扩展性，可以根据实际需要添加更多功能，如缓存控制、跨域支持等。</p>
頁:
[1]