博客

如何实现依赖注入的可配置性？

  • Post category:Python

实现依赖注入的可配置性需要考虑如下几步骤：

  1. 实现配置文件

首先需要在项目中添加一个配置文件，用于存储需要注入的依赖项。根据项目的实际情况，可以使用不同的配置文件格式，例如ini、JSON、YAML等等。以下以JSON格式为例：

{
    "dependencies": {
        "userService": {
            "class": "UserService",
            "arguments": ["$logger"],
            "setters": {
                "setUserDao": {
                    "ref": "userDao"
                }
            }
        },
        "userDao": {
            "class": "UserDao",
            "arguments": ["$logger"]
        },
        "logger": {
            "class": "Logger",
            "arguments": ["log.txt"]
        }
    }
}

在上面的配置文件中，我们定义了三个依赖项：userService、userDao、logger。每个依赖项都有一个class属性指定其类型，以及可选的arguments属性和setters属性。arguments属性是一个数组，用于指定该依赖项的构造函数参数，可以是引用其他依赖项（使用$前缀）。setters属性是一个对象，用于指定该依赖项的setter方法调用，也可以引用其他依赖项（使用ref属性）。

  1. 实现依赖注入容器

接下来需要实现一个依赖注入容器，用于解析配置文件中的依赖项，并生成相应的对象实例。以下是一个简单实现：

import json
import importlib
import inspect

class DependencyInjector:
    def __init__(self, config_path):
        with open(config_path, 'r') as f:
            self.config = json.load(f)

        self.dependency_map = {}

    def get_dependency(self, name):
        if name in self.dependency_map:
            return self.dependency_map[name]

        config = self.config['dependencies'][name]

        class_name = config['class']
        module_name, class_name = class_name.rsplit('.', 1)

        module = importlib.import_module(module_name)

        cls = getattr(module, class_name)

        args = []
        for arg in config.get('arguments', []):
            if arg.startswith('$'):
                arg = self.get_dependency(arg[1:])
            args.append(arg)

        obj = cls(*args)

        for key, val in config.get('setters', {}).items():
            setter = getattr(obj, key)

            if inspect.ismethod(setter):
                if 'ref' in val:
                    val = self.get_dependency(val['ref'])

                setter(val)

        self.dependency_map[name] = obj

        return obj

在上面的代码中，我们定义了一个DependencyInjector类，初始化时读取配置文件，并保存为self.config属性。get_dependency方法接受一个依赖项的名称，然后解析配置文件，生成该依赖项的实例。

  1. 使用依赖注入容器

最后，我们可以在项目中使用DependencyInjector类，实现依赖注入。以下是一个示例：

from dependency_injector import DependencyInjector

class Application:
    def __init__(self, config_path):
        self.injector = DependencyInjector(config_path)

    def run(self):
        dao = self.injector.get_dependency('userDao')
        userService = self.injector.get_dependency('userService')

        user = userService.findById(1)
        print(user)

if __name__ == '__main__':
    app = Application('config.json')
    app.run()

在上面的代码中，我们创建了一个Application类，初始化时创建了一个DependencyInjector实例，并保存为self.injector属性。在run方法中，我们通过injector实例获取了userDao和userService两个实例，并调用userService的findById方法。

通过上述步骤，我们就可以实现一个具有可配置性的依赖注入容器。

Tags: