分清staticmethod 和 classmethod 的适用场景（由浅入深介绍）

背景

最近在看sentences_transformers的源码，在cross_encoder部分中的有的代码，看到了使用classmethod。没看懂是啥意思。后来查了很多博客，博客也都写的乱七八糟的。太复杂了。这里就是分享一个入门教程。

为什么要使用类

我个人的感觉是使用类：

1. 可以保证我的数据变量都在同一个对象里面，不会污染到主环境。
2. 将所有的函数，数据流都放在一个类里面，可以让我们代码看着更加简单。
3. 所有的方法都放在一个类里面，可以复用到别的地方。

我其实用类也就是为了上面几点，别的我真的想不起来了。不想搞那么花里胡哨的复杂的概念。

step1

我们将所有的小函数都放在一个类里面之后，我们想要使用它应该怎么做？ 正常的方法应该是，先初始化一个类，然后在调用函数。类似这样的代码：

# 创建一个类
class MyCalculate:
    def __init__(self):
        pass

    def add_tiny(self, a, b):
        return a ** b

# 想要使用类 要先初始化这个类
mycalcuate = MyCalculate()

# 调用这个类的函数
mycalcuate.add_tiny(a=2, b=10)

#> 1024

step2

上面很麻烦，因为我们要吧一个类先初始化，然后才能使用。能不能直接使用这个类的函数呢。答案是可以的。可以这么做。

class MyCalculate:
    def __init__(self):
        pass

    @staticmethod
    def add_tiny(a, b):
        return a**b

# 不需要初始化，直接就可以使用函数了
MyCalculate.add_tiny(2, 10)

上面这么做就是非常简单，@staticmethod可以帮助我们直接就能使用这个类的函数。

step3

这个时候又有新需求来了，就是我们怎么在add_tiny函数里面调用这个类的别的函数。你要知道，有时候有的计算可不是简单的就是a**b。 这个时候其实使用@staticmethod也是依然可以的。具体可以这么做：

class MyCalculate:
    def __init__(self):
        pass

    def complex_fun1(self, a, b):
        """这是一个非常复杂的函数 wow~~~"""
        return a ** b

    @staticmethod
    def add_tiny(a, b):
        return MyCalculate().complex_fun1(a, b)  # 注意这里是MyCalculate()开头的，而且还有括号，一定要注意奥～

# 不需要初始化，直接就可以使用函数了
MyCalculate.add_tiny(2, 10)

step4

上面的代码确实很不错，但是万一有一天，你突然把你这个类的MyCalculate改掉了，芜湖～～。那么你肯定会运行错误，为什么？因为你把类的名字改掉了，但是你没有通知add_tiny函数啊！！！。也要把add_tiny函数里面的MyCalculate改掉才行。代码如下：

class MyCalculate_2:
    def __init__(self):
        pass

    def complex_fun1(self, a, b):
        """这是一个非常复杂的函数 wow~~~"""
        return a ** b

    @staticmethod
    def add_tiny(a, b):
        return MyCalculate_2().complex_fun1(a, b)  # 注意这里是MyCalculate_2()改名字了！！！一定要注意奥～

# 不需要初始化，直接就可以使用函数了
MyCalculate.add_tiny(2, 10)

step5

步骤4是不是很烦，改了类的名字，我还要在别的地方修改这个名字，那我只是为了不需要初始化、直接使用函数这个简单的小功能，而去花这么多时间去改别的名字。实在是不值得。其实这个时候，classmethod诞生了。

class MyCalculate:
    def __init__(self):
        pass

    def basefun1(self, a, b):
        """这是一个非常复杂的函数 wow~~~"""
        return a ** b

    @classmethod
    def add_tiny(cls, a,b):
        return cls().basefun1(a, b) # 注意这里是使用cls来替换了！！！，而且add_tiny的第一个参数是cls


MyCalculate.add_tiny(2, 10)

上面代码好在了：当你不想初始化类而直接使用函数时；当你要在函数里面直接调用同一类下别的函数时，可以很方便的、优雅的调用！！！。就是这么简单。

参考链接：

上面由浅入深，一步一步讲解其实已经足够了，大家如果希望了解更多，可以看看下面的链接，或许可以学习到更多的知识。

1. https://blog.csdn.net/qq_30708445/article/details/89552569

2. https://shliang.blog.csdn.net/article/details/84828022