Bottle-Inject 0.1.3

Bottle依赖注入

Bottle框架已经在某种程度上实现了依赖注入：您的路由的URL参数被注入到处理函数的关键字参数中。其他一些插件（实际上，大多数插件）也这样做：它们注入数据库连接、认证上下文、会话对象等。此插件使您无需为每个要注入的依赖项编写新的插件即可使用此概念。它还可以在您允许的情况下，以根本的方式改变您使用Bottle和编写应用程序的方式。如果做得正确，依赖注入可以极大地减少应用程序的复杂性，并提高测试性和可读性。但让我们从简单的事情开始，从一个简单的例子开始

app = Bottle()
injector = app.install(bottle.ext.inject.Plugin())

@injector.provider('db')
def get_db_handle():
    return my_database_connection.cursor()

@app.route('/random_quote')
def random_quote(db):
    row = db.execute('SELECT quote FROM quotes ORDER BY RANDOM() LIMIT 1').fetchone()
    return row['quote']

前两行没有什么新东西。我们只是创建了一个Bottle应用程序并将其安装到其中。下一个块更有趣。与Bottle将处理函数绑定到URL路径的方式类似，注入器将提供者绑定到注入点。在这种情况下，我们将提供者‘get_db_handle’绑定到名为‘db’的注入点。每当通过我们的注入器调用函数并且有一个同名参数时，它将从我们的提供者那里接收一个新的数据库游标。您可以在下面的几行中看到这一点。因为所有处理程序回调都由我们的注入器插件管理，所以您只需要接受一个‘db’参数，它就会被插件自动注入。如果您定义一个不接受‘db’参数的路由，则不会发生任何事情。该路由永远不会为该路由创建数据库游标。

这个小小的例子很好地展示了依赖注入的好处

• 您可以直接通过传递伪造或测试数据库对象来单元测试‘random_quote()’函数。无需为测试设置整个应用程序。

• 没有使用全局变量或全局状态。该函数可以在不同的上下文中再次使用而无需麻烦。

• 您不需要在每个定义bottle应用路由的模块中导入get_db_handle。

• 您可以更改‘get_db_handle’的实现，这将影响您应用程序的每个路由。无需搜索/替换您的代码库。

• 少打字。在重要的事情上偷懒。

高级用法

def my_func(
    db                 # Positional arguments are always recognized as injection points with the same name.
    a = 'value'        # Keyword arguments with default values are not recognized.
    b = inject('db')   # Here we explicitly define an injection point. The name of the argument is no longer
                       #  important.
    c: inject('db')    # In Python 3 you can use the annotation syntax. (recommended)
):
    pass

# Python 2
def func(name = inject('param', key='value'),
         file = inject('file', field='upload')):
    pass

# Python 3
def func(name: inject('param', key='name'),
         file: inject('file', field='upload')):
    pass

什么是“依赖注入”？

“依赖注入”这个术语只是简单概念的华丽名称：代码的调用者应该提供代码运行所需的全部依赖项。换句话说：一个函数或对象不应该需要伸手，而是提供它所需的一切。

一个小例子可能最能说明。以下代码不遵循依赖注入范式

db = my_database_connection.cursor()

def do_stuff():
    db.execute('...')

do_stuff()

现在，使用依赖注入

def do_stuff(db):
    db.execute('...')

do_stuff(my_database_connection.cursor())

唯一的区别是我们现在明确地将数据库连接句柄传递给函数，而不是让函数从全局命名空间中获取它。基本上就是这样。现在您可以轻松地通过传递一个假数据库连接或测试数据库的连接来测试do_stuff，在具有不同数据库的其他上下文中重复使用它，并且可能的副作用不再隐藏在代码中。

缺点是您需要打更多的字，需要传递很多东西，但这正是该插件为您做的事情：它管理依赖项并在需要的地方注入它们。

变更