Python中的ORM框架Flask-SQLAlchemy实战

ORM（Object-Relational Mapping）是一种编程技术，它把关系型数据库中的表格数据映射到编程语言中的对象，使得程序开发者可以用面向对象的方式对数据库进行操作。Flask-SQLAlchemy是一款强大的ORM框架，能极大地简化Python程序对于关系型数据库的操作。

本文将会通过一个实例，详细介绍Flask-SQLAlchemy框架的使用方法。

1. 环境配置

在学习Flask-SQLAlchemy之前，我们需要先安装Flask及SQLAlchemy模块。在Python环境下使用pip命令即可安装。

pip install Flask
pip install SQLAlchemy

2. 数据库配置

配置MySQL数据库作为项目的持久化存储，在创建Flask-SQLAlchemy对象时，传递如下参数即可：

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)

第一个参数：flask应用实例第二个参数：数据库连接URI

app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://root:password@localhost:3306/test'

关闭SQLALCHEMY_TRACK_MODIFICATIONS选项，提高程序运行效率

app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

初始化db对象

db = SQLAlchemy(app)

调用app.config来设置Flask应用实例的配置参数，其中SQLALCHEMY_DATABASE_URI参数用于指定连接的数据库类型、用户名、密码、IP地址、端口号、数据库名称等信息。

3. ORM实现

定义数据模型

首先，我们需要定义数据模型，即ORM的映射对象，这里我们以学生信息为例，定义一个Student类：

from datetime import datetime
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

SQLAlchemy ORM设计模型

class Student(db.Model):

# 定义表名
__tablename__ = 'student'
# 定义表结构，其中id为主键，自增长
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
name = db.Column(db.String(20), nullable=False)
gender = db.Column(db.String(2), nullable=False)
birthday = db.Column(db.Date, default=datetime.now())
address = db.Column(db.String(200), nullable=False)

# 类对象序列化成字典
def to_dict(self):
    return {c.name: getattr(self, c.name, None) for c in self.__table__.columns}

在Student类中，我们定义了__tablename__、id、name、gender、birthday、address这些表结构。其中__tablename__用于指定表名，id用于指定主键并自增长，name、gender、birthday、address这些字段用于存储学生姓名、性别、生日和住址的信息。

增删改查操作

接下来，我们实现增删改查操作：

(1) 添加学生信息

@app.route('/add', methods=['POST'])
def add_student():

student = Student()
student.name = request.form.get('name')
student.gender = request.form.get('gender')
student.birthday = datetime.strptime(request.form.get('birthday'), '%Y-%m-%d').date()
student.address = request.form.get('address')
db.session.add(student)
db.session.commit()
return jsonify({'code': 200, 'msg': 'add student success.'})

首先通过request.form.get()获取提交的表单数据，然后创建Student对象并设置属性值，最后通过db.session.add()添加对象到数据库中，并通过db.session.commit()提交事务。

(2) 删除学生信息

@app.route('/delete/<int:id>', methods=['DELETE'])
def delete_student(id):

student = Student.query.get(id)
if student:
    db.session.delete(student)
    db.session.commit()
    return jsonify({'code': 200, 'msg': 'delete student success.'})
else:
    return jsonify({'code': 404, 'msg': 'student not found.'})

传递学生id参数，通过query.get()方法获取到该学生的实例，并使用db.session.delete()方法将其从数据库中删除，并通过db.session.commit()提交事务。

(3) 修改学生信息

@app.route('/update/<int:id>', methods=['PUT'])
def update_student(id):

student = Student.query.get(id)
if student:
    student.name = request.form.get('name')
    student.gender = request.form.get('gender')
    student.birthday = datetime.strptime(request.form.get('birthday'), '%Y-%m-%d').date()
    student.address = request.form.get('address')
    db.session.commit()
    return jsonify({'code': 200, 'msg': 'update student success.'})
else:
    return jsonify({'code': 404, 'msg': 'student not found.'})

同样根据学生id参数获取学生实例，在修改学生信息后，使用db.session.commit()提交事务。

(4) 查询学生信息

@app.route('/search')
def search_student():

students = Student.query.all()
if students:
    return jsonify({'code': 200, 'msg': 'search student success.', 'data': [student.to_dict() for student in students]})
else:
    return jsonify({'code': 404, 'msg': 'student not found.'})

使用query.all()方法查询到Student表中所有的学生信息，并通过list comprehension将学生对象列表转化为字典列表返回。

4. 总结

Flask-SQLAlchemy是一个非常强大的ORM框架，能够使Python编写数据库操作的代码更加简单和易读。本文通过一个实例，深入介绍了Flask-SQLAlchemy的使用方法。

在实际开发中，我们可以按照类似本文的方式进行数据模型的定义和增删改查操作的实现。这些操作的复杂度都很低，运用Flask-SQLAlchemy框架能够让我们在提高开发效率的同时，降低程序维护成本。