在什么情况下使用@property比较好?

开发 后端
对于习惯于 Java 的人来说,他们可能喜欢显式写出get_xxx和set_xxx方法。但是对于习惯 Python 的人来说,我觉得使用@property会让代码的可读性更好。

我在2016年的时候,写过一篇文章,介绍@property装饰器。4年过去了,本来以为这个装饰器使用起来应该是很自然的事情,但还是有同学不知道在什么场景下可以使用它。

[[352810]]

他们是这样说的:

  1. class People: 
  2.     def __init__(self, name): 
  3.         self.name = name 
  4.         self._work = '还没有找到工作' 
  5.  
  6.     @property 
  7.     def work(self): 
  8.         return self._work 
  9.  
  10.     @work.setter 
  11.     def work(self, value): 
  12.         self._work = value 

运行效果如下图所示:

但实际上,这段代码里面,@property装饰器根本没有任何存在的必要,代码完全可以进一步简化:

  1. class People: 
  2.     def __init__(self, name): 
  3.         self.name = name 
  4.         self.work = '还没有找到工作' 

运行结果完全一样:

那么,使用@property装饰器的意义在哪里呢?

的确,在上面的例子里,@property装饰器没有任何存在的必要,因为这里读取一个对象的属性,仅仅是“返回数据”而已。但有些情况下,不仅仅要读取,还要计算。

我举一个例子,不知道你有没有这样的经历,你刚刚看了一眼手机,发现现在时间是23:10分。30秒以后,你朋友碰巧问你多少点了,你立刻回答:23:10分。他一看手表,还真是。于是惊呼,你怎么不看表就知道时间?

例如我们现在要实现一个ProxyProvider类,它读取 Redis,获取最新的代理 IP,然后随机返回一条。另外有一个程序,会增加新的代理 IP 到 Redis 中。但频率不高。

所以,ProxyProvider这个类,不需要每次获取 IP 的时候都读取数据库,每小时读取一次就可以了。如果不用@property装饰器,你可能会这样写代码:

  1. import time 
  2. import random 
  3.  
  4.  
  5. class ProxyProvider: 
  6.     def __init__(self): 
  7.         self.pool = [] 
  8.         self.last_update_time = 0 
  9.  
  10.     def get_proxy(self): 
  11.         now = time.time() 
  12.         if now - self.last_update_time > 3600 or not self.pool: 
  13.             selfself.pool = self.get_all_proxies_from_redis() 
  14.         return random.choice(self.pool) 

如果你经常看 Java 代码,你会发现大量的这种get_xxx、set_xxx的写法。

于是,调用的时候,要这样调用:

  1. provider = ProxyProvider() 
  2. provider.get_proxy() 

如果用@property,那么代码可以改写为:

  1. import time 
  2. import random 
  3.  
  4.  
  5. class ProxyProvider: 
  6.     def __init__(self): 
  7.         self.pool = [] 
  8.         self.last_update_time = 0 
  9.  
  10.     @property 
  11.     def proxy(self): 
  12.         now = time.time() 
  13.         if now - self.last_update_time > 3600 or not self.pool: 
  14.             selfself.pool = self.get_all_proxies_from_redis() 
  15.         return random.choice(self.pool) 

于是读取的时候,这样写:

  1. provider = ProxyProvider() 
  2. provider.proxy  # 注意这里不加括号 

我们可以看到,整体代码逻辑是一样的,代码里并没有精简。不过在调用的时候,前者是调用一个方法,后者是读取一个属性。

同理,如果要修改数据,不使用@property的时候,需要实现一个set_xxx方法。但是使用了@property装饰一个方法,也可以在设置数据的时候实现一些内部逻辑,例如:

  1. import time 
  2. import random 
  3.  
  4.  
  5. class ProxyProvider: 
  6.     def __init__(self): 
  7.         self.pool = [] 
  8.         self.special_ip = set() 
  9.         self.last_update_time = 0 
  10.  
  11.     @property 
  12.     def proxy(self): 
  13.         now = time.time() 
  14.         if now - self.last_update_time > 3600 or not self.pool: 
  15.             selfself.pool = self.get_all_proxies_from_redis() 
  16.         return random.choice(self.pool + list(self.special)) 
  17.  
  18.     @proxy.setter 
  19.     def proxy(self, value): 
  20.         if not value.startswith('http'): 
  21.             proxy = f'http://{ip}' 
  22.         if proxy in self.special_ip: 
  23.             return 
  24.         self.special_ip.add(proxy) 

而对于调用者来说,这些复杂的检查逻辑都是透明的:

  1. provider = ProxyProvider() 
  2. provider.proxy = '123.45.67.89' 

对于习惯于 Java 的人来说,他们可能喜欢显式写出get_xxx和set_xxx方法。但是对于习惯 Python 的人来说,我觉得使用@property会让代码的可读性更好。

 

责任编辑:赵宁宁 来源: 未闻Code
相关推荐

2013-07-29 14:50:43

API

2015-06-01 06:39:18

JavaJava比C++

2015-06-29 14:23:13

JavaC++慢很多

2023-11-23 23:52:06

options请求浏览器

2014-11-03 09:52:25

DNSUDPTCP

2024-01-09 11:39:47

数字化转型数字优先企业

2013-09-12 10:41:39

VDI部署

2021-06-04 09:17:13

JavaScriptBoolean函数

2010-07-20 12:46:23

SQL Server聚

2022-07-20 08:07:21

数据库分布式数据库

2010-07-13 16:07:26

SQL Server行

2013-09-23 10:05:50

2023-05-18 08:38:13

Java锁机制

2009-03-05 10:55:00

企业无线Wi-Fi

2021-09-14 07:26:25

雪花算法ID

2010-04-14 17:46:10

Oracle数据库

2024-11-07 12:08:27

微服务协议通信

2009-09-15 09:24:42

思科认证考试思科认证

2020-09-24 09:43:59

Http协议options请求

2012-04-25 09:24:40

Android
点赞
收藏

51CTO技术栈公众号