大家好。在本文中,我将讨论使用Sanic框架构建简单的异步项目。
介绍
Sanic 是一个非常像Flask的开源Python Web服务器和Web框架,GitHub具有超过1万颗星,并且编写得很快。它允许使用async/awaitPython 3.5中添加的语法(更多内容),这使您的代码无阻塞且快速。
该项目的目标是提供一种简单的方法来启动并运行高性能HTTP服务器,并且易于构建,扩展和最终扩展。
要求
在开始之前,让我们安装一些软件包,并确保我们已准备好一切以开发该项目。
先决条件:
- Python3.6 +
- pipenv(您可以使用任何其他软件包安装程序)
- PostgreSQL (对于数据库,也可以是MySQL或SQLite)
包装方式:
- secure是一个轻量级软件包,为Python Web框架添加了可选的安全标头和cookie属性。
- environs是用于解析环境变量的Python库。根据十二要素应用程序方法,它使您可以将配置与代码分开存储。
- sanic-envconfig是一个扩展,可帮助您将命令行和环境变量引入Sanic配置。
- 数据库是一个Python软件包,可让您使用功能强大的SQLAlchemy Core表达式语言进行查询,并提供对PostgreSQL,MySQL和SQLite的支持。
让我们创建一个空目录并在Pipfile那里初始化一个空目录。
pipenv-python python3.6
使用下面的pipenv命令安装所有必需的软件包。
pipenv install sanic secure environs sanic-envconfig
对于数据库:
pipenv install databases[postgresql]
选择是postgresql,mysql,sqlite。
结构
现在,让我们创建一些文件和文件夹,在其中编写实际代码。
├── .env
├── Pipfile
├── Pipfile.lock
├── setup.py
└── project
├── __init__.py
├── __main__.py
├── main.py
├── middlewares.py
├── routes.py
├── settings.py
└── tables.py
我们将使用该setup.py文件使该project文件夹作为包在我们的代码中可用。
from setuptools import setup
setup(
name='project',
)
正在安装…
pipenv install -e
在.env文件中,我们将存储一些全局变量,例如数据库连接URL。
__main__.py是为了使我们的project程序包可从命令行执行而创建的。
pipenv run python -m project
初始化
让我们在__main__.py文件中进行第一个调用。
from project.main import init
init()
这是我们应用程序的开始。现在我们需要init在main.py文件中创建函数。
from sanic import Sanic
app = Sanic(__name__)
def init():
app.run(host='0.0.0.0', port=8000, debug=True)
只需从Sanic类创建应用程序,即可指定host,port和可选的debug关键字参数来运行它。
pipenv run python -m project
这就是在Sanic应用程序中成功输出的外观。如果您在浏览器中打开http://0.0.0.0:8000,则会看到
错误:请求的网址/未找到
我们尚未创建任何路线,所以现在还不可以。我们将在下面添加一些路线。
设定值
现在我们可以修改环境和设置。我们需要在.env文件中添加一些变量,读取它们,然后传递给Sanic应用程序配置。
.env文件。
DEBUG=True
HOST=0.0.0.0
POST=8000
配置…
from sanic import Sanic
from environs import Env
from project.settings import Settings
app = Sanic(__name__)
def init():
env = Env()
env.read_env()
app.config.from_object(Settings)
app.run(
host=app.config.HOST,
port=app.config.PORT,
debug=app.config.DEBUG,
auto_reload=app.config.DEBUG,
)
settings.py文件。
from sanic_envconfig import EnvConfig
class Settings(EnvConfig):
DEBUG: bool = True
HOST: str = '0.0.0.0'
PORT: int = 8000
请注意,我添加了一个可选的auto_reload参数,该参数将激活或停用自动重新加载器。
数据库
现在是时候建立数据库了。
在继续之前,请先对数据库包进行一点说明:
数据库包使用asyncpg 这是PostgreSQL的异步接口库。非常快。参见下面的结果。
我们将使用Sanic的两个侦听器,在其中指定数据库连接和断开连接操作。以下是我们将要使用的侦听器:
- after_server_start
- after_server_stop
main.py文件。
from sanic import Sanic
from databases import Database
from environs import Env
from project.settings import Settings
app = Sanic(__name__)
def setup_database():
app.db = Database(app.config.DB_URL)
@app.listener('after_server_start')
async def connect_to_db(*args, **kwargs):
await app.db.connect()
@app.listener('after_server_stop')
async def disconnect_from_db(*args, **kwargs):
await app.db.disconnect()
def init():
env = Env()
env.read_env()
app.config.from_object(Settings)
setup_database()
app.run(
host=app.config.HOST,
port=app.config.PORT,
debug=app.config.DEBUG,
auto_reload=app.config.DEBUG,
)
再说一遍。我们需要在项目设置和环境中指定DB_URL。
.env文件
DEBUG=True
HOST=0.0.0.0
POST=8000
DB_URL=postgresql://postgres:postgres@localhost/postgres
和settings.py文件
from sanic_envconfig import EnvConfig
class Settings(EnvConfig):
DEBUG: bool = True
HOST: str = '0.0.0.0'
PORT: int = 8000
DB_URL: str = ''
确保DB_URL是正确的并且您的数据库正在运行。现在,您可以使用app.db访问数据库。在下一节中查看更多详细信息。
现在我们已经连接到数据库,我们可以尝试执行一些SQL查询。
让我们使用SQLAlchemy在table.py文件中声明一个表。
import sqlalchemy
metadata = sqlalchemy.MetaData()
books = sqlalchemy.Table(
'books',
metadata,
sqlalchemy.Column('id', sqlalchemy.Integer, primary_key=True),
sqlalchemy.Column('title', sqlalchemy.String(length=100)),
sqlalchemy.Column('author', sqlalchemy.String(length=60)),
)
在这里,我假设您已经有一个迁移的数据库,其中包含一个books表。为了创建数据库迁移,我建议您使用Alembic,它是一种轻量级且易于使用的工具,可以与SQLAlchemy Database Toolkit for Python一起使用。
现在,我们可以使用任何SQLAlchemy核心查询。在下面查看一些示例。
query = books.insert()
values = [
{"title": "No Highway", "author": "Nevil Shute"},
{"title": "The Daffodil", "author": "SkyH. E. Bates"},
]
await app.db.execute_many(query, values)
# 获取多行
query = books.select()
rows = await app.db.fetch_all(query)
# 获取单行
query = books.select()
row = await app.db.fetch_one(query)
路线
现在我们需要设置路线。让我们转到routes.py,添加一条新路线。
from sanic.response import jsonfrom project.tables import books
def setup_routes(app):
@app.route("/books")
async def book_list(request):
query = books.select()
rows = await request.app.db.fetch_all(query)
return json({
'books': [{row['title']: row['author']} for row in rows]
})
当然,我们需要在init中调用setup_routes使其起作用。
from project.routes import setup_routes
app = Sanic(__name__)
def init():
...
app.config.from_object(Settings)
setup_database()
setup_routes(app)
...
正在请求…
$ curl localhost:8000/books
{"books":[{"No Highway":"Nevil Shute"},{"The Daffodil":"SkyH. E. Bates"}]}
中间件
如何检查响应头并查看我们可以在此处添加或修复的内容呢?
$ curl -I localhost:8000
Connection: keep-alive
Keep-Alive: 5
Content-Length: 32
Content-Type: text/plain; charset=utf-8
如您所见,我们需要进行一些安全性改进。缺少一些标头,例如X-XSS-Protection,Strict-Transport-Security … 因此,让我们结合使用中间件和安全软件包来照顾它们。
middlewares.py文件
from secure import SecureHeaders
secure_headers = SecureHeaders()
def setup_middlewares(app):
@app.middleware('response')
async def set_secure_headers(request, response):
secure_headers.sanic(response)
在main.py文件中设置中间件。
from project.middlewares import setup_middlewares
app = Sanic(__name__)
def init():
...
app.config.from_object(Settings)
setup_database()
setup_routes(app)
setup_middlewares(app)
...
结果是:
$ curl -I localhost:8000/books
Connection: keep-alive
Keep-Alive: 5
Strict-Transport-Security: max-age=63072000; includeSubdomains
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Referrer-Policy: no-referrer, strict-origin-when-cross-origin
Pragma: no-cache
Expires: 0
Cache-control: no-cache, no-store, must-revalidate, max-age=0
Content-Length: 32
Content-Type: text/plain; charset=utf-8
正如我在一开始所承诺的,本文的每个部分都有一个github存储库。希望这个小教程可以帮助您入门Sanic。Sanic框架中仍有许多未开发的功能,您可以在文档中找到并查看。
如果您对此有任何想法,请务必发表评论。
如果您觉得这篇文章有帮助,请务必给我点个赞
免责声明:本站所有文章内容,图片,视频等均是来源于用户投稿和互联网及文摘转载整编而成,不代表本站观点,不承担相关法律责任。其著作权各归其原作者或其出版社所有。如发现本站有涉嫌抄袭侵权/违法违规的内容,侵犯到您的权益,请在线联系站长,一经查实,本站将立刻删除。 本文来自网络,若有侵权,请联系删除,如若转载,请注明出处:https://itzsg.com/79999.html