经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » 程序设计 » Python3 » 查看文章
分页查询及其拓展应用案例
来源：cnblogs　　作者：顾平安　　时间：2024/7/13 18:23:22　　对本文有异议

分页查询

分页查询是处理大量数据时常用的技术，通过分页可以将数据分成多个小部分，方便用户逐页查看。SQLAlchemy 提供了简单易用的方法来实现分页查询。

本篇我们也会在最终实现这样的分页效果：

page

1. 什么是分页查询

分页查询是将查询结果按照一定数量分成多页展示，每页显示固定数量的记录。分页查询通常使用两个参数：

  • limit：每页显示的记录数量。
  • offset：跳过的记录数量。

例如，要查询第二页，每页显示 10 条记录：

  • limit：10
  • offset：10

2. 使用 SQLAlchemy 实现分页查询

基本查询

首先，我们需要一个基本的查询来获取数据：

  1. import db
  2. from model import Student
  4. def basic_query():
  5.     students = db.session.query(Student).all()
  6.     for stu in students:
  7.         print(stu.to_dict())

使用 limit 和 offset

前文中，我们已经了解到 SQLAlchemy 提供了 limit 和 offset 方法来实现分页查询。limit 限制返回的记录数量，offset 跳过指定数量的记录。

  1. import db
  2. from model import Student
  4. def paginated_query(page, per_page):
  5.     q = db.select(Student).limit(per_page).offset((page - 1) * per_page)
  6.     students = db.session.execute(q).scalars()
  7.     for stu in students:
  8.         print(stu.to_dict())

例如，要获取第 2 页，每页显示 10 条记录：

  1. paginated_query(2, 10)

对应的 SQL 语句：

  1. SELECT * FROM tb_student LIMIT 10 OFFSET 10;

3. 前后端实现分页功能

后端分页

在后端实现分页功能时，可以创建一个函数来处理分页逻辑。这个函数接受 page 和 per_page 参数，并返回当前页的数据和总页数。

  1. import db
  2. from model import Student
  4. def get_paginated_students(page, per_page):
  5.     total = db.session.query(Student).count()
  6.     q = db.select(Student).limit(per_page).offset((page - 1) * per_page)
  7.     students = db.session.execute(q).scalars()
  8.     
  9.     return {
  10.         'total': total,
  11.         'page': page,
  12.         'per_page': per_page,
  13.         'pages': (total + per_page - 1) // per_page,
  14.         'data': [stu.to_dict() for stu in students]
  15.     }

前端分页

在前端实现分页时，可以使用后端提供的分页数据来渲染页面：

  1. {
  2.     "total": 100,
  3.     "page": 2,
  4.     "per_page": 10,
  5.     "pages": 10,
  6.     "data": [
  7.         {"id": 11, "name": "Student 11", ...},
  8.         {"id": 12, "name": "Student 12", ...},
  9.         ...
  10.     ]
  11. }

前端可以根据这些数据渲染分页控件和当前页的数据。

[拓展] Flask 分页演示

下面是一个前后端不分离的 Flask 项目，代码文件比较多，你需要自行理一下。同时也要保证 Flask 、 Flask-SQLAlchemy 与 Flask-MysqlDB 的安装。

  1. pip install flask
  2. pip install flask-sqlalchemy  # 兼容 Flask 的 SQLAlchemy 框架，提供 ORM 功能
  3. pip install flask-mysqldb  # 为 Flask-SQLAlchemy 提供 MySQL 驱动

Flask 项目目录如下：

  1. flask_app/  # 项目目录
  2. ├── templates/  # 模板目录
  3. │   └── list.html  # 模板文件
  4. ├── config.py  # Flask 配置文件
  5. ├── db.py  # 数据库核心文件，包含重要操作
  6. ├── manage.py  # Flask 路由和业务视图文件
  7. └── models.py  # 数据库模型文件

首先看一下配置文件 config.py：

  1. class Config:
  2.     SQLALCHEMY_DATABASE_URI = 'mysql://root:0908@localhost:3306/db_flask_demo_school?charset=utf8mb4'  # 数据库连接。自行替换数据库用户名称和密码以及实际数据库名
  3.     SQLALCHEMY_ECHO = False  # 是否打印执行的 SQL 语句及其耗时
  4.     DEBUG = True  # 是否启用调试模式

db.py

  1. """
  2. Create database:
  3.     > create database db_flask_demo_school charset=utf8mb4
  4. """
  5. from flask_sqlalchemy import SQLAlchemy
  6. from sqlalchemy import *
  8. db = SQLAlchemy()

models.py

  1. from db import *
  4. class Student(db.Model):
  5.     __tablename__ = 'tb_student2'
  7.     id = db.Column(db.Integer, primary_key=True, comment="主键")
  8.     name = db.Column(db.String(15), index=True, comment="姓名")
  9.     age = db.Column(db.SmallInteger, comment="年龄")
  10.     sex = db.Column(db.Boolean, comment="性别")
  11.     email = db.Column(db.String(128), unique=True, comment="邮箱地址")
  12.     money = db.Column(db.Numeric(10, 2), default=0.0, comment="钱包")
  14.     def to_dict(self):
  15.         return {
  16.             'id': self.id,
  17.             'name': self.name,
  18.             'age': self.age,
  19.             'sex': self.sex,
  20.             'email': self.email,
  21.             'money': float(self.money)
  22.         }
  24.     def __repr__(self):
  25.         return f'<{self.__class__.__name__}: {self.name}>'

然后就是 manage.py，编写了路由与业务代码：

  1. from pathlib import Path
  2. from flask import Flask, jsonify, request, render_template
  3. from config import Config
  4. from models import db, Student
  6. app = Flask(__name__, template_folder='./templates')
  7. app.config.from_object(Config)
  9. db.init_app(app)
  12. @app.route('/', methods=['GET'])
  13. def index():
  14.     """没啥用，勿看"""
  15.     title = Path(__file__).name
  16.     return title
  19. @app.route('/students', methods=['POST'])
  20. def create_student():
  21.     """采集访问的信息，创建学生"""
  22.     sex = request.form.get('sex')
  23.     sex = int(sex) if sex.isdigit() else 0
  24.     student = Student(
  25.         name=request.form.get('name', '未知'),
  26.         age=request.form.get('age', 0),
  27.         sex=bool(sex),
  28.         email=request.form.get('email', ''),
  29.         money=request.form.get('money', 0),
  30.     )
  31.     if request.form.get('id', None) is not None:
  32.         student.id = request.form['id']
  34.     db.session.add(student)
  35.     db.session.commit()
  36.     return jsonify({
  37.         'success': True,
  38.         'data': student.to_dict(),
  39.         'msg': 'success'
  40.     }), 201
  43. @app.route('/students', methods=['DELETE'])
  44. def delete_students():
  45.     """删除学生表的所有记录"""
  46.     db.session.execute(db.delete(Student))
  47.     db.session.commit()
  48.     return jsonify({
  49.         'success': True,
  50.         'data': None,
  51.         'msg': 'success'
  52.     })
  55. @app.route('/students', methods=['GET'])
  56. def get_students():
  57.     # 旧版本 2.x 获取全部数据
  58.     # students = Student.query.all()
  59.     # 新版本 3.1.x 获取全部数据
  60.     students = db.session.execute(db.select(Student).where()).scalars()
  61.     return jsonify({
  62.         'success': True,
  63.         'data': {
  64.             'count': Student.query.count(),
  65.             'students': [student.to_dict() for student in students]
  66.         },
  67.         'msg': 'success'
  68.     })
  71. @app.route('/students/<int:student_id>', methods=['GET'])
  72. def get_student(student_id):
  73.     # 根据主键查询数据，不存在则为 None
  74.     student = db.session.get(Student, student_id)
  75.     if not student:
  76.         return jsonify({
  77.             'success': False,
  78.             'data': None,
  79.             'msg': 'student not found'
  80.         })
  82.     return jsonify({
  83.         'success': True,
  84.         'data': student.to_dict(),
  85.         'msg': 'success'
  86.     })
  89. @app.route('/students/data', methods=['GET'])
  90. def students_data():
  91.     """这里是分页器的使用，不同于我们所使用的 limit 和 offset 需要自己编写"""
  92.     # 不采取数据分页时，大量数据时会导致服务器运存膨胀，这是非常不妥的
  93.     page = request.args.get('page', 1, type=int)
  94.     per_page = request.args.get('size', 3, type=int)
  95.     # 创建分页器对象
  96.     pagination = Student.query.paginate(page=page, per_page=per_page, max_per_page=20)
  97.     print('当前页对象', pagination)
  98.     print('总数据量', pagination.total)
  99.     print('当前页数据列表', pagination.items)
  100.     print('总页码', pagination.pages)
  101.     print()
  102.     print('是否有上一页', pagination.has_prev)
  103.     print('上一页页码', pagination.prev_num)
  104.     print('上一页对象', pagination.prev())
  105.     print('上一页对象的数据列表', pagination.prev().items)
  106.     print()
  107.     print('是否有下一页', pagination.has_next)
  108.     print('下一页页码', pagination.next_num)
  109.     print('下一页对象', pagination.next())
  110.     print('下一页对象的数据列表', pagination.next().items)
  112.     # """前后端分离推荐使用的 json 结果，这里没用到"""
  113.     data = {
  114.         "page": pagination.page,  # 当前页码
  115.         "pages": pagination.pages,  # 总页码
  116.         "has_prev": pagination.has_prev,  # 是否有上一页
  117.         "prev_num": pagination.prev_num,  # 上一页页码
  118.         "has_next": pagination.has_next,  # 是否有下一页
  119.         "next_num": pagination.next_num,  # 下一页页码
  120.         "items": [{
  121.             "id": item.id,
  122.             "name": item.name,
  123.             "age": item.age,
  124.             "sex": item.sex,
  125.             "money": item.money,
  126.         } for item in pagination.items]
  127.     }
  129.     return render_template('list.html', **locals())
  132. if __name__ == '__main__':
  133.     with app.app_context():
  134.         db.drop_all()  # 启动时先删除相关表，后创建相关表
  135.         db.create_all()
  136.     app.run('0.0.0.0', 9527)

最后就是 list.html 这个模板文件，呈现一个分页的演示：

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>Title</title>
  6.     <style>
  7.         body {
  8.             font-family: Arial, sans-serif;
  9.             background-color: #f4f7fa;
  10.             color: #333;
  11.         }
  13.         table {
  14.             border-collapse: collapse;
  15.             margin: 50px auto;
  16.             width: 80%;
  17.             box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);
  18.             background-color: #fff;
  19.         }
  21.         th, td {
  22.             padding: 12px 15px;
  23.             text-align: center;
  24.         }
  26.         th {
  27.             background-color: #007bff;
  28.             color: #fff;
  29.             text-transform: uppercase;
  30.         }
  32.         tr:nth-child(even) {
  33.             background-color: #f2f2f2;
  34.         }
  36.         tr:hover {
  37.             background-color: #e9f5ff;
  38.         }
  40.         .page {
  41.             margin: 20px auto;
  42.             text-align: center;
  43.         }
  45.         .page a, .page span {
  46.             padding: 8px 16px;
  47.             margin: 0 4px;
  48.             color: #007bff;
  49.             background: #fff;
  50.             border: 1px solid #007bff;
  51.             border-radius: 4px;
  52.             text-decoration: none;
  53.             transition: background-color 0.3s, color 0.3s;
  54.         }
  56.         .page a:hover {
  57.             background-color: #007bff;
  58.             color: #fff;
  59.         }
  61.         .page span {
  62.             background-color: #007bff;
  63.             color: #fff;
  64.         }
  65.     </style>
  66. </head>
  67. <body>
  68.     <table border="1" align="center" width="600">
  69.         <tr>
  70.            <th>ID</th>
  71.            <th>Age</th>
  72.            <th>Name</th>
  73.            <th>Sex</th>
  74.            <th>Money</th>
  75.         </tr>
  76.         {% for student in pagination.items %}
  77.         <tr>
  78.            <td>{{ student.id }}</td>
  79.            <td>{{ student.age }}</td>
  80.            <td>{{ student.name }}</td>
  81.            <td>{{ "男" if student.sex else "女" }}</td>
  82.            <td>{{ student.money }}</td>
  83.         </tr>
  84.         {% endfor %}
  85.         <tr align="center">
  86.             <td colspan="5" class="page">
  87.                 {% if pagination.has_prev %}
  88.                 <a href="?page=1">首 页</a>
  89.                 <a href="?page={{ pagination.page - 1 }}">上一页</a>
  90.                 <a href="?page={{ pagination.page - 1 }}">{{ pagination.page - 1 }}</a>
  91.                 {% endif %}
  92.                 <span>{{ pagination.page }}</span>
  93.                 {% if pagination.has_next %}
  94.                 <a href="?page={{ pagination.page + 1 }}">{{ pagination.page + 1 }}</a>
  95.                 <a href="?page={{ pagination.page + 1 }}">下一页</a>
  96.                 <a href="?page={{ pagination.pages }}">尾 页</a>
  97.                 {% endif %}
  98.             </td>
  99.         </tr>
  100.     </table>
  101. </body>
  102. </html>

为了确保能够有一定数量的数据，请你另外新建一个 request.py，用于创建大量数据（如果你知道 faker 的使用，也可以自己弄一些数据），先启动 manage.py，保证后端服务的开启和路由可用，然后直接运行该文件后可添加测试数据：

  1. # request.py
  2. import requests  # pip install requests
  4. students = [  # 虚拟数据，务必当真
  5.     {
  6.         'name': '王毅',
  7.         'age': 21,
  8.         'sex': 1,
  9.         'email': 'wangyi@gmail.com',
  10.         'money': 4488.5
  11.     },
  12.     {
  13.         'name': '张晓',
  14.         'age': 19,
  15.         'sex': 0,
  16.         'email': 'zhangxiao@example.com',
  17.         'money': 2389.75
  18.     },
  19.     {
  20.         'name': '李春阳',
  21.         'age': 23,
  22.         'sex': 1,
  23.         'email': 'lichunyang@outlook.com',
  24.         'money': 6715.32
  25.     },
  26.     {
  27.         'name': '刘瑞',
  28.         'age': 20,
  29.         'sex': 0,
  30.         'email': 'liurui@yahoo.com',
  31.         'money': 3456.89
  32.     },
  33.     {
  34.         'name': '陈欢',
  35.         'age': 22,
  36.         'sex': 1,
  37.         'email': 'chenhuan@gmail.com',
  38.         'money': 5678.12
  39.     },
  40.     {
  41.         'name': '吴娜',
  42.         'age': 18,
  43.         'sex': 0,
  44.         'email': 'wuna@example.org',
  45.         'money': 1234.56
  46.     },
  47.     {
  48.         'name': '赵丹',
  49.         'age': 24,
  50.         'sex': 0,
  51.         'email': 'zhaoda@outlook.com',
  52.         'money': 7890.43
  53.     },
  54.     {
  55.         'name': '孙宇',
  56.         'age': 21,
  57.         'sex': 1,
  58.         'email': 'sunyu@yahoo.co.jp',
  59.         'money': 4567.89
  60.     },
  61.     {
  62.         'name': '黄宇',
  63.         'age': 19,
  64.         'sex': 1,
  65.         'email': 'huangyu@gmail.com',
  66.         'money': 2345.67
  67.     },
  68.     {
  69.         'name': '杨静',
  70.         'age': 22,
  71.         'sex': 0,
  72.         'email': 'yangjing@example.com',
  73.         'money': 6789.01
  74.     }
  75. ]
  76. for student in students:
  77.     response = requests.request('POST', 'http://127.0.0.1:9527/students', data=student)
  78.     print('添加一条记录', response.json())

确定 Flask 项目正常启动，并且上面的数据也完成了注入，如果你发现启动失败了，请检查路由、数据库连接是否有问题，你可能需要一定的 Flask 基础知识。接下来如何访问我们渲染的模板呢？

根据路由视图和设置的访问端口（9527）：

  1. @app.route('/students/data', methods=['GET'])
  2. def students_data():
  3.     ...
  4.     return render_template('list.html', **locals())

我们直接在浏览器访问：http://127.0.0.1:9527/students/data 这个地址即可。

上述案例是演示所用，随意写的，小部分代码参考了某机构的教程代码示例，平台原因无法标注，路由设计也是很随便的，这种代码如果存在版权纠纷，emmm.....，请联系我删除，谢谢。无私开源，只为搞懂后端开发的学习，请勿钻牛角……

原文链接：https://www.cnblogs.com/gupingan/p/18300467

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

Python3热门文章

  • PyQt-Fluent-Widgets：一个 Fluent Design 风格的组件库
  • Python3读取文件的操作详解
  • 口播神器,基于Edge,微软TTS(text-to-speech)文字转语音免费开源库edge-tts实践(Python3.10)
  • 向量数据库Chroma极简教程
  • 笔精墨妙,妙手丹青,微软开源可视化版本的ChatGPT:Visual ChatGPT,人工智能AI聊天发图片,Python3.10实现
  • win10+vs2019 编译webrtc m108
  • 闻其声而知雅意,基于Pytorch(mps/cpu/cuda)的人工智能AI本地语音识别库Whisper(Python3.10)
  • 靶机练习: Vikings
  • Python3 实现将bytes图片转jpg格式
  • MacBook m1芯片采用miniforge安装python3.9的方法示例

    • Python3推荐文章

  • 分页查询及其拓展应用案例
  • adorner 使用示例
  • 使用pyqt5制作简单计分桌面应用
  • cuda性能优化-2.访存优化
  • 通过钩子函数+Traceid实现Flask链路追踪
  • RCTF 2024 WEB wp
  • 【昇腾开发全流程】AscendCL开发板模型推理
  • PVT：特征金字塔在Vision Transormer的首次应用，又快又好 | ICCV 2021
  • 「网络流浅谈」最小割的模型 - E-Syrus
  • 比Selenium更优秀的playwright介绍与未来展望

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号