Sanic学习(三) - 案例

开始做案例之前,先简单了解一下蓝图的概念,蓝图是可用于应用程序内的子路由的对象。蓝图不是向应用程序实例添加路由,而是定义用于添加路由的类似方法,然后以灵活且可插入的方式向应用程序注册。

蓝图对于大型应用程序尤其有用,在这些应用程序中,您的应用程序逻辑可以分为几个组或责任区域。

  • 没错,是不是感觉完全不知道在说什么,我一开始也很懵逼,简单来说,我觉得这差不多就像一个对路由的管理吧,注册蓝图之后可以系统化的向app添加路由,不用一个一个去写去调用,方便不少,后面复杂一些的还有蓝图嵌套等一系列的东西。
  • 特别注意是蓝图定义好之后必须在app中注册,并且如果app和蓝图不在同一文件下的话最好传一个request对象,比如之前讲到的url_for也可以通过request.app.url_for()定义

接下来我们实际操作一下案例,主要是对页面的返回和一些简单的配置

项目结构

  1. 文件目录 docs里面是项目介绍文档README.md,src下就是核心代码相关的文件,tests里面是测试相关的(暂未涉及), requirements.txt是展示依赖的文件


    image.png
  2. src 下面主要是代码块,配置、静态文件、模版、视图块


    image.png
  3. 配置里面是几个配置文件,对工作目录等进行简单配置,静态文件static目录下放置静态文件js、css、images、json,templates目录下按照应用区分单独建立了douban目录,里面是具体模版文件,views里面是视图相关的代码块,init文件对视图进行了引用初始化,这样app主文件中方便调用蓝图

image.png

流程

  1. 配置
    首先来到配置文件,这里的三个文件不用太过在意,主要是为了在实际开发和调试时区分开来配置环境,小练习中只关注config.py即可,简单对时区、基础路径和DEBUG功能进行了配置
    config.py:
#!/usr/bin/env python
import os


class Config():
    """
    Basic config
    """
    # Application config
    TIMEZONE = 'Asia/Shanghai'
    BASE_DIR = os.path.dirname(os.path.dirname(__file__))
    DEBUG = True

  1. 静态文件和模版
    静态文件这一块我找了一份html网页,这里是一些相关的css、js等文件集,大家可以自行找一个网页也可以参考我的
  2. 视图
  • views里面可以按照不同的需求区分开来不同的视图函数,这样方便整理,这里就只是简单实现了一下主页模版返回
  • 先定义一个蓝图

语法

from sanic.response import json
from sanic import Blueprint

bp = Blueprint('my_blueprint')

@bp.route('/')
async def bp_root(request):
    return json({'my': 'blueprint'})

蓝图定义里面可以用prefix添加前缀,之后的路由之前就默认会有一个此前缀,访问是记得也要加上前缀,第一个参数主要是给一个名字(名字无所谓)

index_bp = Blueprint('index_html', url_prefix='html')

定义好蓝图之后可以对蓝图进行静态文件设置以及路由添加,前文讲过的,这里访问前面的路由即是实际访问的后面的文件目录,记得在路由前要加上前缀,此处为html,/html/static/douban/css == /static/douban/css,前面的路由随意定义,尽量简单易懂

index_bp.static('/static/douban', CONFIG.BASE_DIR + '/static/douban')

这两处定义好之后就是对模版返回的代码实现了,但在这之前需要对基础环境(jinja2模版)进行一个配置,这两块代码基本上算是固定写法

# https://github.com/channelcat/sanic/blob/5bb640ca1706a42a012109dc3d811925d7453217/examples/jinja_example/jinja_example.py
# 开启异步特性  要求3.6+
enable_async = sys.version_info >= (3, 6)



# jinjia2 config
env = Environment(
    loader=PackageLoader('views.rss', '../templates'),
    autoescape=select_autoescape(['html', 'xml', 'tpl']),
    enable_async=enable_async
    )


async def template(tpl, **kwargs):
    template = env.get_template(tpl)
    rendered_template = await template.render_async(**kwargs)
    return html(rendered_template)

返回一个页面还是比较简单,和其他的框架基本类似,return模版文件即可,sanic是异步框架,前文讲过,所以很多地方遵循固定操作即可,函数定义的时候的async和这里返回模版时调用的await,前面的配置初始化了templates目录路径,所以这里直接定位到了templates下,直接按照里面的路径编写即可

@index_bp.route("/")
async def index(request):
    return await template('douban/index.html')

完整代码块

douban.py:

from sanic import Sanic
from sanic.response import json, text, html
from jinja2 import Environment, PackageLoader, select_autoescape
from sanic import Blueprint
from sanic.response import html
import sys
from src.config import CONFIG



index_bp = Blueprint('index_html', url_prefix='html')
index_bp.static('/static/douban', CONFIG.BASE_DIR + '/static/douban')


# https://github.com/channelcat/sanic/blob/5bb640ca1706a42a012109dc3d811925d7453217/examples/jinja_example/jinja_example.py
# 开启异步特性  要求3.6+
enable_async = sys.version_info >= (3, 6)



# jinjia2 config
env = Environment(
    loader=PackageLoader('views.rss', '../templates'),
    autoescape=select_autoescape(['html', 'xml', 'tpl']),
    enable_async=enable_async
    )


async def template(tpl, **kwargs):
    template = env.get_template(tpl)
    rendered_template = await template.render_async(**kwargs)
    return html(rendered_template)



@index_bp.route("/")
async def index(request):
    return await template('douban/index.html')
  1. 之后在views里面的init.py文件中对蓝图进行引用,类似一个蓝图初始化,之后就方便在app中直接调用蓝图进行注册
    init.py:
from .douban import index_bp
  1. 运行文件
    主文件里面就只是简单的引用、注册、运行即可
    run.py:
# !/usr/bin/env python
import sys

from sanic import Sanic

sys.path.append('../')
from src.views import index_bp

app = Sanic(__name__)

app.blueprint(index_bp)

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=80)
  1. 页面文件引用
    最后需要去模版文件内对css、js等文件进行引用,否则页面就只是一个空壳,简单显示一下一些文件的引用
    index.html
<link rel="stylesheet" href="/html/static/douban/css/reset.css">
<link rel="stylesheet" href="/html/static/douban/css/index.css">

......
......
......

<ul class="slider-wrapper">
        <li class="item" data-title="这位上神!速速到我的本子里来">
            <!--<a href="#" class="pic"><img src="/html/static/douban/images/cont/slider_img1.jpg" alt="#"></a>-->
            <a href="#" class="pic"><img src="/html/static/douban/images/cont/slider_img1.jpg" alt="#"></a>
        </li>
        <li class="item" data-title="想换上新衣去旅行!" data-author="by 占秋">
          <a href="#" class="pic"><img src="/html/static/douban/images/cont/slider_img2.jpg" alt="#"></a>
        </li>
        <li class="item" data-title="你的书写工具需要一个庇护所" data-author="by Moollly">
          <a href="#" class="pic"><img src="/html/static/douban/images/cont/slider_img3.jpg" alt="#"></a>
        </li>
        <li class="item" data-title="气温起伏,一件外套保护你" data-author="by 郑南音">
          <a href="#" class="pic"><img src="/html/static/douban/images/cont/slider_img4.jpg" alt="#"></a>
        </li>
        <li class="item" data-title="鲜为人知的泰国小众小城——董里">
          <a href="#" class="pic"><img src="/html/static/douban/images/cont/slider_img5.jpg" alt="#"></a>
        </li>
      </ul>

我们运行run.py之后去页面上展示

image.png

扩展

有留心的同学应该会注意到前面文件目录里面的json文件,views里面可以对数据处理然后返回给前台进行展示,直接在return里面将字典数据传入即可,在页面内也可以通过模版语法({{}}、{% for %}等)进行展示,这里初衷是想打开json文件,将json文件转为dict直接传给html,但是我的文件格式好像出了点问题,可能是之前爬取的时候保存有错误,逻辑很简单,大致就是这样(这是我另一个练习里面的例子):

    async def get(self, request, **kwargs):
        poker_glossary = open("/opt/app/static/json/poker.json", encoding='utf-8')
        glossary_total = json.load(poker_glossary)
        return await template("douban/index.html", glossary_total=glossary_total)
  • 看懂了的同学们建议去练练,小编也是初学,很多地方还在摸索,欢迎大家指教
  • 完整代码详情参考我的Github
  • 更多内容可参考:
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,293评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,604评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,958评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,729评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,719评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,630评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,000评论 3 397
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,665评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,909评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,400评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,986评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,594评论 18 139
  • 22年12月更新:个人网站关停,如果仍旧对旧教程有兴趣参考 Github 的markdown内容[https://...
    tangyefei阅读 35,159评论 22 257
  • 什么是蓝图? 一个蓝图定义了视图,模板,静态文件以及可以用于应用程序的其它元素的集合。例如,让我们假设下我们有一个...
    邪恶的Sheldon阅读 1,191评论 0 1
  • 江歌案还在审理之中,辩护律师提出的新证据也让案情扑朔迷离。但不管凶手判不判死刑,也无论刘鑫到底会受到怎样的惩罚,善...
    包西亚阅读 367评论 0 0
  • 写在前面的话。 昨天一实在没有心情也没有时间写作,心情很糟糕很颓废。奔波了一天之后回来就草草的躺在床上,合衣睡去...
    谢兔子阅读 175评论 0 0