一日一技：使用装饰器实现类属性的懒加载

青南

发布于 2019-05-27 16:57:28

6010

发布于 2019-05-27 16:57:28

假设我们有一个工具类MongoUtil，它的作用是封装一些数据库操作。例如：

import pymongo


class MongoUtil:    def __init__(self):        connect = pymongo.MongoClient()        db = connect.tieba        self.post = db.post        self.user = db.user
    def write_post(self, post):        # 处理post信息        self.post.insert_one(post)
    def read_user_info(self):        rows = self.user.find()        # 读取user信息并处理        # ...

我们发现这样写有一个问题——类在初始化的时候，就会创建数据库的链接。但我们并不是在类刚刚初始化时就读写数据库。

为了让数据库在第一次使用时再创建连接，我们就要实现懒加载机制：

import pymongo
class MongoUtil:    def __init__(self):        connect = pymongo.MongoClient()        self.db = connect.tieba        self.post = None        self.user = None
    def write_post(self, post):        # 处理post信息        if not self.post:            self.post = self.db.post        self.post.insert_one(post)
    def read_user_info(self):        if not self.user:            self.user = self.db.user        rows = self.user.find()        # 读取user信息并处理        # ...

这样写确实实现了懒加载，但每一个操作都需要判断当前是否连接到了对应的集合中。这样就会出现大量的重复代码。

为了解决这个问题，我们可以使用装饰器实现一个懒加载机制：

import pymongo
class lazy:    def __init__(self, func):        self.func = func
    def __get__(self, instance, cls):        if instance is None:            return self        else:            value = self.func(instance)            setattr(instance, self.func.__name__, value)            return value
class MongoUtil:    def __init__(self):        connect = pymongo.MongoClient()        self.db = connect.tieba
    @lazy    def post(self):        return self.db.post
    @lazy    def user(self):        return self.db.user
    def write_post(self, post):        # 处理post信息        self.post.insert_one(post)
    def read_user_info(self):        rows = self.user.find()        # 读取user信息并处理        # ...

我们实现了一个装饰器类 lazy来装饰两个类属性 post和 user。当 self.post第一次被调用时，它会正常连接集合，当第二次或以上访问 self.post时，就会直接使用第一次返回的对象，不会再次连接MongoDB的集合。 self.user同理。

我们来测试一下，如下图所示。

可以看到，第二次调用 self.post时，并没有打印出 第一次访问self.post，因为第二次会直接使用之前的缓存。

最后，特别说明：本文使用MongoDB举例只是为了说明基于装饰器的类属性懒加载的代码写法。而实际上， pymongo已经自动实现了懒加载机制，当我们直接 connect.tieba.post时，它并不会真的去连接MongoDB，只有当我们要增删改查集合里面的数据时，pymongo才会创建连接。

本文参与腾讯云自媒体分享计划，分享自微信公众号。

原始发表：2019-05-24，如有侵权请联系 cloudcommunity@tencent.com 删除

mongodb