Sanic 项目教程

1. 项目的目录结构及介绍

Sanic 项目的目录结构通常如下：

sanic/
├── sanic/
│   ├── __init__.py
│   ├── app.py
│   ├── config.py
│   ├── routes.py
│   └── static/
│       ├── css/
│       ├── js/
│       └── images/
├── tests/
│   ├── __init__.py
│   └── test_app.py
├── .gitignore
├── README.md
├── requirements.txt
└── run.py

目录结构介绍

• sanic/: 项目的主目录，包含了所有的源代码文件。
  • init.py: 使 sanic 目录成为一个 Python 包。
  • app.py: 项目的启动文件，定义了 Sanic 应用实例。
  • config.py: 项目的配置文件，包含了应用的配置参数。
  • routes.py: 定义了应用的路由和视图函数。
  • static/: 存放静态文件，如 CSS、JavaScript 和图片。
• tests/: 包含项目的测试代码。
  • init.py: 使 tests 目录成为一个 Python 包。
  • test_app.py: 包含测试用例，用于测试应用的功能。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• README.md: 项目的说明文档，通常包含项目的介绍、安装和使用说明。
• requirements.txt: 列出了项目依赖的 Python 包。
• run.py: 项目的启动脚本，用于启动 Sanic 应用。

2. 项目的启动文件介绍

app.py

app.py 是 Sanic 项目的启动文件，定义了 Sanic 应用实例并配置了应用的基本设置。以下是一个简单的 app.py 示例：

from sanic import Sanic
from sanic.response import json

app = Sanic("my-hello-world-app")

@app.route('/')
async def test(request):
    return json({'hello': 'world'})

if __name__ == '__main__':
    app.run(host="0.0.0.0", port=8000)

启动文件介绍

• Sanic 应用实例: app = Sanic("my-hello-world-app") 创建了一个 Sanic 应用实例，并命名为 my-hello-world-app。
• 路由定义: @app.route('/') 定义了一个根路径的路由，当访问根路径时，会调用 test 函数并返回 JSON 格式的响应。
• 启动应用: app.run(host="0.0.0.0", port=8000) 启动应用，监听 0.0.0.0 地址的 8000 端口。

3. 项目的配置文件介绍

config.py

config.py 文件用于配置 Sanic 应用的各种参数，如数据库连接、日志级别、静态文件路径等。以下是一个简单的 config.py 示例：

class Config:
    DEBUG = False
    TESTING = False
    DATABASE_URI = 'sqlite:///database.db'

class ProductionConfig(Config):
    DATABASE_URI = 'mysql://user@localhost/foo'

class DevelopmentConfig(Config):
    DEBUG = True

class TestingConfig(Config):
    TESTING = True
    DATABASE_URI = 'sqlite:///:memory:'

配置文件介绍

• Config 类: 定义了应用的默认配置，如 DEBUG、TESTING 和 DATABASE_URI。
• ProductionConfig 类: 继承自 Config，用于生产环境的配置。
• DevelopmentConfig 类: 继承自 Config，用于开发环境的配置，启用了调试模式。
• TestingConfig 类: 继承自 Config，用于测试环境的配置，启用了测试模式，并使用内存数据库。

通过在 app.py 中导入并使用这些配置类，可以根据不同的环境加载不同的配置：

from sanic import Sanic
from config import DevelopmentConfig

app = Sanic("my-hello-world-app")
app.config.from_object(DevelopmentConfig)

这样，Sanic 应用就可以根据当前环境加载相应的配置。