基于Flask和Shelve的简易留言板开发实战

2025-07-01 18:10:13作者：魏侃纯Zoe

本文将详细介绍如何使用Python的Flask框架结合Shelve模块开发一个简易留言板系统。这个项目虽然简单，但涵盖了Web开发中的多个核心概念，非常适合初学者学习。

项目概述

这个留言板系统主要实现以下功能：

用户可以通过表单提交留言
系统会保存所有留言记录
留言按时间倒序排列显示
支持多行留言显示
提供美观的界面展示

技术栈选择

Flask框架

Flask是一个轻量级的Python Web框架，它简单易用但功能强大，非常适合快速开发小型Web应用。在本项目中，我们使用Flask处理HTTP请求、路由和模板渲染。

Shelve模块

Shelve是Python标准库中的一个简单持久化存储方案，它基于dbm模块，可以将Python对象序列化存储到文件中。相比数据库，Shelve更加轻量，适合小型应用的数据存储需求。

核心代码解析

应用初始化

application = Flask(__name__)
DATA_FILE = 'message.dat'

这里我们创建了Flask应用实例，并定义了数据存储文件名。

数据存储功能

def save_data(name, comment, create_at):
    database = shelve.open(DATA_FILE)
    
    if 'greeting_list' not in database:
        greeting_list=[]
    else:
        greeting_list=database['greeting_list']
    
    greeting_list.insert(0,{
        'name':name,
        'comment':comment,
        'create_at':create_at,
    })
    
    database['greeting_list'] = greeting_list
    database.close()

save_data函数负责将留言数据保存到Shelve文件中。这里有几个关键点：

使用shelve.open打开数据文件
检查是否存在留言列表，不存在则初始化
将新留言插入到列表开头（实现最新留言显示在最前面）
更新并关闭数据库

数据加载功能

def load_data():
    database = shelve.open(DATA_FILE)
    greeting_list = database.get('greeting_list',[])
    database.close()
    return greeting_list

load_data函数从Shelve文件中读取所有留言数据，如果文件不存在或没有数据，则返回空列表。

路由处理

@application.route('/')
def index():
    greeting_list = load_data()
    return render_template('index.html',greeting_list=greeting_list)

@application.route('/post',methods=['POST'])
def post():
    name = request.form.get('name')
    comment = request.form.get('comments')
    create_at = datetime.now()
    save_data(name, comment, create_at)
    return redirect('/')

这里定义了两个路由：

根路由/：显示留言板首页，加载并显示所有留言
/post路由：处理表单提交，保存留言后重定向到首页

模板过滤器

@application.template_filter('nl2br')
def nl2br_filters(s):
    return escape(s).replace('\n', Markup('</br>'))

@application.template_filter('datetime_fmt')
def datetime_fmt_filter(dt):
    return dt.strftime('%Y/%m/%d %H:%M:%S')

定义了两个模板过滤器：

nl2br：将换行符转换为HTML的<br>标签，解决多行留言显示问题
datetime_fmt：格式化日期时间显示

前端实现

HTML模板

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Message Board</title>
    <link rel="stylesheet" href="../static/main.css">
</head>
<body>
    <div id="main">
        <h1>Message Board</h1>
        <div id="form-area">
            <p>please comment here:</p>
            <form action="/post" method="POST">
                <!-- 表单内容 -->
            </form>
        </div>
        <div id="entries-area">
            <h2>the comments history</h2>
            <div class="entry">
                {% for greeting in greeting_list %}
                    <h3>{{ greeting.name }} commented at {{ greeting.create_at|datetime_fmt }}</h3>
                    <p>{{ greeting.comment|nl2br }}</p>
                {% endfor %}
            </div>
        </div>
    </div>
</body>
</html>

模板使用了Jinja2语法，主要特点：

循环显示所有留言
使用自定义过滤器格式化时间和留言内容
包含表单用于提交新留言

CSS样式

body {
    margin:0;
    padding: 0;
    color: #000E41;
    background-color: #004080;
}

#form-area {
    padding: 0.5em 2em;
    background-color: #78B8F8;
}

#entries-area {
    padding: 0.5em 2em;
    background-color: #FFFFFF;
}

.entry p {
    padding: 0.5em 1em;
    background-color: #DBDBFF;
}

CSS样式表定义了留言板的整体外观，包括：

页面背景色
表单区域样式
留言显示区域样式
单个留言的样式

项目结构

完整的项目结构如下：

.
├── message.dat.db        # Shelve数据文件
├── message_board.py      # 主程序文件
├── static
│   └── main.css          # 样式表文件
└── templates
    └── index.html        # HTML模板文件

运行与测试

启动服务

python message_board.py

服务默认运行在127.0.0.1:8000，开启debug模式方便开发调试。

测试留言

可以通过以下方式测试留言功能：

直接在网页表单提交
使用Python交互式环境导入数据：

import datetime
from message_board import save_data, load_data

# 添加测试留言
save_data('test', 'test_comment', datetime.datetime.now())

# 查看所有留言
print(load_data())