Python3 @classmethod 函数装饰器 声明一个类方法

@classmethod函数装饰器的主要作用是将一个类的普通方法(需要实例化使用)声明为一个类方法(可以直接使用类名调用)。在类的功能扩展(包括功能的整合以及类的继承)，代码整洁度，后期的可维护性起到一定的帮助。虽然类方法也可以在实例化后，使用实例化对象进行调用，但这是不赞成的，因为这样会容易将它和普通的实例化方法混淆，后期代码不利于维护。具体是否使用以及其是方法方式还需要根据业务的实际需要决定。

它是Python的内置函数，在python文件中直接可以使用。它只能被应用在类(class)中。

语法

class main:

@classmethod

def run(cls, arg1, arg2, ...):

...

参数

cls(必须) - 当前类本身

arg1,arg2 - 自定义参数

实例

§ 实例1 - @classmethod的使用方法

代码及运行结果：

#先声明类

class main:

#普通方法

def set(self, x):

print(x)

#类方法

@classmethod

def run(cls, n):

print(n)

#普通方法需要实例化后才能调用

o = main()

o.set('abc')

#输出

abc

#类方法可以直接使用，不需要实例化

main.run(123)

#输出

123

§ 实例2 - @classmethod的使用场景之代码整合

有时我们可能会遇到一些情况，在创建类的时候只有一种可能性，但是在实际业务发展过程中将演变出多种可能性，这时需要在外部处理好参数，然后再实例化类，将参数传递给类。如果多个模块调用这个类，必然会产生一定的混乱。如果将这个处理过程以一个普通方法的方式编写在类中，又必须先实例化类，然后才能调用，但是这样会导致先触发类的初始化方法__init__()以及__repr__()、__set__()等等。可是我们的类是需要先把参数处理好，然后才能初始化，否则会出问题的，这可能导致整个类的业务逻辑方式改变。造成大量的修改。

代码及运行结果：

#创建一个类

class Date(object):

def __init__(self, year, month, day):

self.year = year

self.month = month

self.day = day

def print_date(self):

print(self.year, self.month, self.day)

#实例化类

data_object = Date('2018','10','31')

#执行输出函数

data_object.print_date()

2018 10 31

#在上面的例子中可以看到类的实例化需要传递‘年月日’三个参数。并且是要求分别传递。那么假设用户不按照要求填写，他填写的2018-10-31这样的一个参数呢？

#我们需要先对参数进行分割处理，然后再实例化类。例如下面的代码：

#分割函数

def from_string(date_as_string):

return map(int, date_as_string.split('-'))

#创建类

class Date(object):

def __init__(self, year, month, day):

self.year = year

self.month = month

self.day = day

def print_date(self):

print(self.year, self.month, self.day)

#先执行分割函数对数据进行处理

year, month, day = from_string('2018-10-31')

#实例化类

data_object = Date(year, month, day)

#执行输出函数

data_object.print_date()

2018 10 31

#这样做视乎可以解决这个问题，但是from_string方法应该是属于类的一部分，现在需要写在外部，就导致了类功能外散，后期不便于管理，以后增加功能的时候会出现问题，所以我们就必须将from_string迁移到类里面去，并且还要在类的实例化之前调用它，我们都知道，一般情况下，如果想调用类中的方法，必须先实例化类，而我们现在的需求是要在实例化之前。这时就需要使用@classmethod咯。代码如下：

#创建一个类

class Date(object):

def __init__(self, year, month, day):

self.year = year

self.month = month

self.day = day

def print_date(self):

print(self.year, self.month, self.day)

#声明类方法

@classmethod

def from_string(cls, date_as_string):

year, month, day = map(int, date_as_string.split('-'))

return cls(year, month, day) #实例化类并返回实例化对象

data_object = Date.from_string('2018-10-31')

#执行输出函数

data_object.print_date()

2018 10 31

#这是一个比较经典的案例，来自于stackoverflow。我暂时没有想到更好的，就先对原案例进行了一些修改并且加上了一些注释。

#使用@classmethod可以有效的防止类功能外散，可以将对属于当前类的功能集中起来，便于管理，并且对类的继承、重载、多态都是有一定的帮助，这个小例子只能算是一个用法说明，在实际的操作中会有更加复杂的用法，还需要以项目的实际业务逻辑来制定。

§ 实例3 - @classmethod使用场景之类的重载

代码及运行结果：

#声明一个类

class main:

#声明类方法

@classmethod

def run(cls):

#调用name方法

cls.name()

#声明name类方法

@classmethod

def name(cls):

print('我是main类的name方法')

#声明子类并继承main类

class main2(main):

#重载基类的name方法

@classmethod

def name(cls):

print('我是main2类的name方法')

main2.run()

#我是main2类的name方法

#输出结果是子类的重载name方法。因为cls指向的永远都是调用那个类。