FastAPI如何优雅的连接数据库?

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
RDS MySQL Serverless 高可用系列,价值2615元额度,1个月
云数据库 RDS PostgreSQL,高可用系列 2核4GB
简介: FastAPI如何优雅的连接数据库?

大家好,我是Kuls。

这是《小白学FastAPI》系列的第四篇文章。

在前面一篇文章中,我们有去写一个简单的博客框架,对它的路径、查询参数及路径参数函数等进行了学习。

今天我们来学习FastAPI的数据库连接,当然我们不仅仅只是为了学习这个知识点而学习。

今天K哥也来给大家说说如何去优雅的写一个FastAPI项目。


1.png


这是我今天所要讲解所编写项目的文件格式。

大家可以看到我们会在里面新建一个blog库来存放我们编写博客相关的操作,而不是像前面我们所写的,直接写一个main.py就行了。

那样对于我们编写一个项目是不太好的。

我们编写一个项目可以先创建一个虚拟环境,如果你还不懂虚拟环境是什么,可以去看下我的这篇文章 虚拟环境真的太重要了,很多人还不知道!


$ cd demo3-blog/
$ ls
__init__.py             blog                    requirements.txt
$ python -m venv blogenv
$ ls
__init__.py             blog                    blogenv                 requirements.txt
$ source blogenv/bin/activate


随后创建一个requeriment.txt,里面填写这个项目要使用的第三方库。


fastapi
uvicorn
sqlalchemy
pymysql


执行


pip install -r requeriment.txt


好了,上面其实算是题外话。

今天我们的主角其实是SQLAlchemy,可能之前学过Django或Flask的同学应该接触过SQLAlchemy。

我们看下官网的解释:SQLAlchemy is the Python SQL toolkit and Object Relational Mapper that gives application developers the full power and flexibility of SQL.

简答理解,它是一个sql工具箱,是一个ORM框架。

ORM:对象关系映射,你可以简单理解为 Python中的一个类映射一张数据表。

其实关于SQLAlchemy,里面有很多的知识,我也把它的详细的基础使用方法链接给大家。

官方文档:https://docs.sqlalchemy.org/en/14/orm/tutorial.html

本篇文章中我们也会学习SQLAlchemy。


database.py

还记得我们创建的database.py文件吗?我们将会在这里面编写数据库相关的内容:


from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker
SQLALCHEMY_DATABASE_URL = 'mysql+pymysql://user:password@localhost/fastapi'
engine = create_engine(SQLALCHEMY_DATABASE_URL)
SessionLocal = sessionmaker(bind=engine, autocommit=False, autoflush=False)
Base = declarative_base()


这里我们一行一行来进行分析


engine = create_engine(SQLALCHEMY_DATABASE_URL)'


这一行创建了我们的数据库引擎,我们就是通过这个引擎来创建表等各种操作的。其中的参数就是我们数据库的连接url,fastapi支持的数据库非常的多。

这里提醒一下,如果我们使用的是sqlite数据库,我们需要在create_engine的参数中新增connect_args={"check_same_thread": False}

下面也是官网给出的支持的数据库,这些我们都可以通过sqlalchemy来进行连接。

PostgreSQLMySQLSQLiteOracleMicrosoft SQL Server, etc.

关于具体数据库的url是啥,这里我给出官网,大家可以进行查阅

https://docs.sqlalchemy.org/en/14/core/engines.html


SessionLocal = sessionmaker(bind=engine, autocommit=False, autoflush=False)


这里我们创建的是SessionLocal,后续我们用到会进行讲解。


Base = declarative_base()


通过declarative_base()方法生成的类,该类是我们后面要用到的ORM 模型所要继承的父类。


models.py

既然数据库相关的配置都弄好了,接下来我们编写一个模型。

其实这个模型在我们上一篇文章中就已经编写过了。

但是还是有一些不同


from sqlalchemy import Column, Integer, String, Boolean
from .database import Base
class Blog(Base):
    __tablename__ = 'blog'
    id = Column(Integer, primary_key=True, index=True) # 设置主键和索引
    title = Column(String(32))
    content = Column(String(32))
    pulished = Column(Boolean)


大家可以发现,其实非常的直观和简单,无非就是创建一个类,里面有一些字段变量。

其中的__tablename__表示的是我们待会创建数据表的名称。


schemas.py

这个其实很简单,就是将我们在main.py中所编写的


from pydantic import BaseModel
from typing import Optional
class Blog(BaseModel):
    title: str
    content: str
    published: Optional[bool]


这部分内容搬到了一个新的文件当中,方便我们统一管理。


main.py

其实main.py跟我们上一篇文章的中的main.py差不多,只是多了几行代码:


from fastapi import FastAPI
from .database import engine
from . import schemas,models
from typing import Optional
app = FastAPI()
models.Base.metadata.create_all(engine)
# 博客首页
@app.get('/blog')
def index(limit: int = 10, published: bool = True, sort: Optional[str] = None):
    return {'data': f'我是博客首页,显示{limit}篇内容,并且发布状态为{published},排序顺序是根据{sort}字段'}
@app.get('/blog/unpublished')
def unpublished():
    return {'data': '这里是没有发布的博文列表'}
@app.get('/blog/{id}')
def showblog(id: int):
    return {'data': f'这是id为 {id} 的博文'}
@app.get('/blog/{id}/comments')
def comments(id: int):
    return {'data': f'这是id为{id}的博文评论内容'}
@app.post('/blog')
def new_blog(blog: schemas.Blog):
    return {'data': f'博文标题:{blog.title},博文内容:{blog.content},博文发表状态:{blog.published}'}


其中的create_all()方法就帮助我们创建了数据表


运行

到了这里基本就大功告成。

我们直接运行


2.png


查看数据库,发现我们的数据表已经成功创建。


3.png


总结

好了,今天主要讲了数据库相关的操作以及编写项目时的注意事项。

数据库具体的读写删操作,我们会在后面继续写,也会基于这个blog来写。

因为公众号改版,所以大家一定要记得星标公众号。

整个系列的代码我都放在了github中,大家可以访问下面链接:

https://github.com/hellokuls/fastapi/tree/master

相关实践学习
每个IT人都想学的“Web应用上云经典架构”实战
本实验从Web应用上云这个最基本的、最普遍的需求出发,帮助IT从业者们通过“阿里云Web应用上云解决方案”,了解一个企业级Web应用上云的常见架构,了解如何构建一个高可用、可扩展的企业级应用架构。
MySQL数据库入门学习
本课程通过最流行的开源数据库MySQL带你了解数据库的世界。   相关的阿里云产品:云数据库RDS MySQL 版 阿里云关系型数据库RDS(Relational Database Service)是一种稳定可靠、可弹性伸缩的在线数据库服务,提供容灾、备份、恢复、迁移等方面的全套解决方案,彻底解决数据库运维的烦恼。 了解产品详情: https://www.aliyun.com/product/rds/mysql 
相关文章
|
19天前
|
SQL Java 关系型数据库
Java连接MySQL数据库环境设置指南
请注意,在实际部署时应该避免将敏感信息(如用户名和密码)硬编码在源码文件里面;应该使用配置文件或者环境变量等更为安全可靠地方式管理这些信息。此外,在处理大量数据时考虑使用PreparedStatement而不是Statement可以提高性能并防止SQL注入攻击;同时也要注意正确处理异常情况,并且确保所有打开过得资源都被正确关闭释放掉以防止内存泄漏等问题发生。
61 13
|
21天前
|
SQL 关系型数据库 MySQL
MySQL数据库连接过多(Too many connections)错误处理策略
综上所述,“Too many connections”错误处理策略涉及从具体参数配置到代码层面再到系统与架构设计全方位考量与改进。每项措施都需根据具体环境进行定制化调整,并且在执行任何变更前建议先行测试评估可能带来影响。
359 11
|
6月前
|
关系型数据库 MySQL Java
【YashanDB知识库】原生mysql驱动配置连接崖山数据库
【YashanDB知识库】原生mysql驱动配置连接崖山数据库
【YashanDB知识库】原生mysql驱动配置连接崖山数据库
|
5月前
|
安全 Linux 网络安全
YashanDB数据库服务端SSL连接配置
YashanDB支持通过SSL连接确保数据传输安全,需在服务端生成根证书、服务器证书及DH文件,并将根证书提供给客户端以完成身份验证。服务端配置包括使用OpenSSL工具生成证书、设置SSL参数并重启数据库;客户端则需下载根证书并正确配置环境变量与`yasc_env.ini`文件。注意:启用SSL后,所有客户端必须持有根证书才能连接,且SSL与密码认证独立运行。
|
2月前
|
SQL XML Java
配置Spring框架以连接SQL Server数据库
最后,需要集成Spring配置到应用中,这通常在 `main`方法或者Spring Boot的应用配置类中通过加载XML配置或使用注解来实现。
268 0
|
5月前
|
Oracle 安全 关系型数据库
【Oracle】使用Navicat Premium连接Oracle数据库两种方法
以上就是两种使用Navicat Premium连接Oracle数据库的方法介绍,希望对你有所帮助!
1164 28
|
5月前
|
SQL 数据库连接 数据库
在C++的QT框架中实现SQLite数据库的连接与操作
以上就是在C++的QT框架中实现SQLite数据库的连接与操作的基本步骤。这些步骤包括创建数据库连接、执行SQL命令、处理查询结果和关闭数据库连接。在实际使用中,你可能需要根据具体的需求来修改这些代码。
299 14
|
6月前
|
数据库
【YashanDB知识库】YDC连接数据库报错yasdb return code is zero
【YashanDB知识库】YDC连接数据库报错yasdb return code is zero