点击python编程从入门到实践，置顶 公众号重磅 python入门资料，第一时间送达前端
读完须要10分钟python
速读仅需 4 分钟数据库
/ python 生产实战 python 大型项目神器实战 /编程
在 fastapi 中有一个强大而且简单易懂的系统：依赖注入系统api
1缓存
什么是依赖注入安全
依赖注入首先意味着在程序中咱们的代码能够声明一些它必须依赖的项：咱们称之为 dependencies，也就是依赖项。而后，在实际运行中，fastapi 会把全部须要的依赖项提供给你的代码，称之为注入依赖项。微信
一句话简单解释:本来接受各类参数来构造一个对象，如今只接受一个参数这个参数是已经实例化的对象，对象的『依赖』是注入进来的，而和它的构造方式解耦了。构造它这个『控制』操做也交给了第三方。cookie
1.1闭包
依赖注入适用场景列举：
1.业务逻辑复用
2.共享数据库链接
3.安全机制、权限校验、角色管理等
全部上述使用场景，借助于依赖注入可提升代码复用率，减小代码重复。
2
依赖注入实现方案
在看具体的实现依赖注入以前咱们先从流程上来理解一下整个数据流转。当一个新的请求到来的时候，实际的调用流程以下:
1.调用依赖项函数(传递合适的参数)
2.获得依赖项目函数的返回结果
3.把返回结果传递给路由函数中对应的参数
4.路由函数中业务流数据处理
5.获取的数据返回给客户端/前端
2.1
函数级依赖项
# -*- encoding: utf-8 -*-from fastapi import Depends, FastAPIapp = FastAPI()async def common_paras(request_source: str = None, page: int = 0, limit: int = 100): return {"request_source": request_source, "page": page, "limit": limit}@app.get("/items/info")async def read_items_info(commons: dict = Depends(common_paras)): return commons@app.get("/users/info")async def read_users_info(commons: dict = Depends(common_paras)): return commons
2.2
类级依赖项
# -*- encoding: utf-8 -*-from fastapi import Depends, FastAPIapp = FastAPI()fake_items_db = [{"user_name": "HaiShiNiu"}, {"user_name": "WangXiaoXiao"}, {"user_name": "ZhongCen"}]class CommonQueryParams: def __init__(self, request_source: str = None, page: int = 0, limit: int = 100): self.request_source = request_source self.page = page self.limit = limit@app.get("/items/info")async def read_items(commons: CommonQueryParams = Depends(CommonQueryParams)): response = {} if commons.request_source: response.update({"q": commons.q}) items = fake_items_db[commons.page : commons.page + commons.limit] response.update({"items": items}) return response
2.3
递归依赖项
# -*- encoding: utf-8 -*-from fastapi import Cookie, Depends, FastAPIapp = FastAPI()def query_extractor(q11: str, q12: str): return q11 + q12def query_or_cookie_extractor(q2: str = Depends(query_extractor), last_query: str = Cookie(None)): if not q2: return last_query return q2@app.get("/items/")async def read_query(query_or_default: str = Depends(query_or_cookie_extractor)):return {"q_or_cookie": query_or_default}
注意:有些场景是须要对依赖项的屡次调用的状况。
若是某个依赖项在同一个路径操做中被声明了屡次，例如，多个依赖项都有一个共同的子依赖项，那么 fastapi 默认在每一次请求中只会调用这个依赖项一次。fastapi 会把这个依赖项的返回值缓存起来，而后把这个值传递给须要的依赖项，而不是在同一个请求中屡次调用这个依赖项。在有些场景下，咱们并不须要缓存这个依赖项的返回值，而是须要屡次调用，那么咱们可使用参数 use_cache=False 来禁止依赖项的缓存。
async def needy_dependency(fresh_value: str = Depends(get_value, use_cache=False)): return {"fresh_value": fresh_value}
2.4
基于路径操做装饰器依赖项
在有些状况下，咱们并不须要依赖项的返回值，但仍然须要依赖项被执行。在这种状况下，咱们能够经过路径操做装饰器来操做依赖项的一个列表。路径操做装饰器接收一个可选的参数 dependencies，参数内容是 Depends()列表。
# -*- encoding: utf-8 -*-from fastapi import Depends, FastAPI, Header, HTTPExceptionapp = FastAPI()async def verify_token(x_token: str = Header(...)): if x_token != "token": raise HTTPException(status_code=400, detail="X-Token header invalid")async def verify_key(x_key: str = Header(...)): if x_key != "key": raise HTTPException(status_code=400, detail="X-Key header invalid") return x_key@app.get("/items/info", dependencies=[Depends(verify_token), Depends(verify_key)])async def read_items_info(): return [{"function_name": "Foo"}, {"function_name": "Bar"}]
这些依赖项与普通依赖项的执行相同，但他们的返回值(若是有)不会被传递给路径操做函数。咱们能够重复使用已经声明的依赖项，不管他们是否有返回值，都不会影响依赖项的执行。
2.5
带有 yield 功能依赖项
fastapi 支持依赖项在请求结束后作一些额外的工做。要实现这个功能，咱们须要用 yield 代替 return，而后其后添加一些额外的工做。咱们举个例子:建立一个数据库连接，而后在请求结束后关闭这个连接。固然处理这个 case 的解决方案也是有不少的，本次咱们就基于使用 yield 功能的依赖项进行实现
# -*- encoding: utf-8 -*-async def get_db_info(): """ 获取数据库链接信息 """ # 建立连接 db = DBSession() try: yield db # 数据库使用 finally: db.close() # 关闭数据库连接
简单说明一下:yield db 后面的值 db 会注入给路径操做或者其余依赖项。yield db 后面的代码在 response 提交以后才会执行。使用 try 语句来捕获可能发生的异常。为了确保不管是否有异常发生都能执行退出逻辑，咱们这里在 finally 语句中执行退出逻辑。可是要注意，若是尝试在 yield 后面抛出 HTTPException，不会起到任何做用。yield 以后的退出代码是在异常处理器以后被执行的，所以没法捕捉异常的发生。
2.6
可参数化依赖项
咱们前面使用的依赖项都是固定的函数或者类，但有时想在依赖项中设置不一样的参数，同时又不用声明不一样的函数或类。此时可利用一个可调用的类实例来实现这个功能。注意:类自己就是可调用的，而它的实例须要实现一个特定类方法才是可调用的：call
一句话介绍 call：call 是 Python 的一个黑魔法方法，核心功能是经过对象实例能够直接触发 call 中的逻辑，在 Tornado 源码中这种用法不少，有兴趣的同窗能够看看我在公众号中的关于 Tornado 的专栏文章。
# -*- encoding: utf-8 -*-from fastapi import Depends, FastAPIapp = FastAPI()class FixedContentQueryCheck(object): def __init__(self, fixed_content: str): self.fixed_content = fixed_content def __call__(self, q: str = ""): if q: return self.fixed_content in q return Falsechecker = FixedContentQueryCheck("bar")@app.get("/query-checker/")async def read_query_check(fixed_content_included: bool = Depends(checker)): return {"fixed_content_in_query": fixed_content_included}
3
总结
1.简单介绍了一下什么是依赖注入以及使用场景
2.咱们系统的梳理了实现依赖注入的各类方式供你们在生产环境中进行使用
原创不易，只愿能帮助那些须要这些内容的同行或刚入行的小伙伴，你的每次 点赞、分享 都是我继续创做下去的动力，我但愿能在推广 python 技术的道路上尽我一份力量，欢迎在评论区向我提问，我都会一一解答，记得一键三连支持一下哦！
加入python学习交流微信群，请后台回复「入群」
往期推荐
大型fastapi项目实战 靠 python 中间件解决方案涨薪了
大型fastapi项目实战 高并发请求神器之aiohttp(下)
大型fastapi项目实战 高并发请求神器之aiohttp(上) [建议收藏]
本文分享自微信公众号 - python编程军火库（PythonCoder1024）。
若有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一块儿分享。