結構型模式--裝饰器模式

 

在應用開發中如果欲对一个创建对象再度添加额外的功能時，一般則有下面这些可选的不同方法:

• 将功能直接添加到此对象所属的类中，如添加一个新的方法
• 使用组合方式將另一含新功能之對象加入此對象中
• 使用继承方式再於子類中新增功能

如与继承相比，通常应该优先选择组合方式，因为继承关系是静态的，其应用會擴及整个类以及这个类的所有实例。除此之外，修饰器模式可为我们提供第四种可选方法，此模式可支持运行时能够以透明的方式（*即不影响其他对象）动态扩展将功能添加到一个对象中。在许多编程语言中大都採用继承方式来实现修饰器模式功能，但在Python中我们已可使用其内置修饰器特性之语法來作特定改变，可被用于扩展一个类、方法/函数之場合中。修饰器模式和Python內置修饰器之间并沒有等价关系，Python內置修饰器能做的功能实际上比修饰器模式來得多。

示例：

class Coffee:              #基類

    name = ""

    price = 0.0

    def getPrice(self):

        return self.price

 

    def setPrice(self, price):

        self.price = price

 

    def getName(self):

        return self.name

 

     def setName(self, name):

        self.name = name

 

class Latte(Coffee):                     #具体子類1

    def __init__(self):

        self.name = "latte"

        self.price = 30.0

 

class Cappuccino(Coffee):                 #具体子類2

    def __init__(self):

        self.name = " cappuccino "

        self.price = 40.0

除了作基本配置外，一般顧客可對產品附加选择加大或加珍珠，如果選擇加大的话，則需在原价上加5元；加珍珠則原價上加10元。思考要如何解决这样的问题？其實這可藉助装饰器模式来實作，首先要定义装饰器类：

From abc import ABCMeta,abstractmethod

class CoffeeDecorator(metaclass=ABCMeta):    #装饰器抽象基類

          @abstractmethod

def getName(self):

raise ImplementedError

 

          @abstractmethod

def getPrice(self):

raise ImplementedError

 

class LargeDecorator(CoffeeDecorator):           #具体子類1(*針對加大之處理类)

def __init__(self,coffee):                            #傳入要裝飾之coffee物件

self.coffee=coffee

 #接著再依需求對方法作修飾

def getName(self):

return “{}+{}”.format(“Large”, self.coffee.getName())

 

def getPrice(self):

return self.coffee.getPrice()+5

   

class PearlDecorator(CoffeeDecorator):           #具体子類2(*針對加珍珠之處理类)

def __init__(self,coffee):

self.coffee=coffee

 

def getName(self):

return “{}+{}”.format(self.coffee.getName()," Pearl")

 

def getPrice(self):

return self.coffee.getPrice()+10

构建好必要装饰器类后，在實際业务场景中就可對相關Coffee具体子类依需求來进行关联，如以拿鐵（Latte）要加大（Large）且加珍珠（Pearl）而言，可如下處理：

if  __name__=="__main__":

          #原型產品

latte=Latte()

print("Name:%s"%latte.getName())

print("Price:%s"%latte.getPrice())

          #加大

largeLatte=LargeDecorator(latte)

print("Name:%s" % largeLatte.getName())

print("Price:%s" % largeLatte.getPrice())

          #加珍珠

largeLattePearl=LargeDecorator(largeLatte)

print("Name:%s" % largeLattePearl.getName())

print("Price:%s" % largeLattePearl.getPrice())

輸出：

Name:latte

Price:30.0

Name:Large + latte

Price:35.0

Name:Large + latte + Pearl

Price:45.0

運用装饰器模式可在執行時期动态给对象另外添加一些额外功能，故一般於事後要對實例再增添額外功能之作法，採用装饰器模式比其它方式可更为灵活便利。

再則装饰器模式和代理模式非常相似都是置入中間處理類，两者的共同点都是需要具有相同的接口，不同点是代理模式侧重对主类的过程作進一步控制，而装饰模式则侧重对主类增添其它附屬功能。

另對面向切面编程（Aspect Oriented Programming，AOP）而言，通过装饰器模式來实现其功能可更为简洁方便，AOP其義为：如果逻辑过程中經常需要具有重复性的操作行为，此時可把这些行为提取出来形成一個切面以进行统一管理和维护，舉例來說，若開發中經常要在某些地方頻繁打印日志來配合使用，此時就可将打印日志这类操作行為提取出来作为一個切面以进行统一维护。由於Python语法已內置支持装饰器的特性，如下例是採用Python语法內置装饰器特性之直接作法：

def log(func):            #定義decorator

    def wrapper(*args, **kw):

        print('call %s():' % func.__name__)

        return func(*args, **kw)

    return wrapper

 

@log                 #表示調用log定義之decorator並傳入底下函式名稱作為func參數

def now():

    print('2016-12-04')

實際業務場景作法如下：

if  __name__=="__main__":

    now()

輸出：

call now():

2016-12-04

此@log便是装饰器的用法，Python直接支持以@语法作為装饰器的使用。

如果要在前例中某些地方重復加上打印日志之行為，该如何进行AOP之改造呢？可以借助类的静态方法或类別方法来实现，如：

class LogManager:            #定義decorator類

    @staticmethod

    def log(func):

        def wrapper(*args):

            print "Visit Func %s"%func.__name__

            return func(*args)

        return wrapper

接著在要打印日志的地方鍵入@LogManager.log，即可附加具有打印日志信息之功能，以前例實作為例，則只要在Coffee类的方法前加上@LogManager.log即可，而實際業務场景均可保持不变，整理如下：

class LogManager:      #定義decorator類
    @staticmethod
    def log(func):
        def wrapper(*args):
            print("Visit Func %s"%func.__name__)
            return func(*args)
        return wrapper

class Coffee:
    name = ""
    price = 0.0
    type = "COFFEE"

    @LogManager.log
    def getPrice(self):
        return self.price

    def setPrice(self, price):
        self.price = price

    @LogManager.log
    def getName(self):
        return self.name

    def setName(self,name):
        self.name=name

class Latte(Coffee):
    def __init__(self):
        self.name = "latte"
        self.price = 4.0

class Cappucino(Coffee):
    def __init__(self):
        self.name = "cappucino"
        self.price = 5.0

from abc import ABCMeta,abstractmethod
class CoffeeDecorator(metaclass=ABCMeta):
    @abstractmethod
    def getName(self):
        raise ImplementedError

    @abstractmethod
    def getPrice(self):
        raise ImplementedError

class LargeDecorator(CoffeeDecorator):
    def __init__(self, coffee):
        self.coffee = coffee

    # 在提供方法內修飾需求
    def getName(self):
        return “{}+{}”.format(“Large”, self.coffee.getName())

    def getPrice(self):
        return self.coffee.getPrice() + 5


class PearlDecorator(CoffeeDecorator):
    def __init__(self, coffee):
        self.coffee = coffee

    def getName(self):
        return “{}+{}”.format(self.coffee.getName()," Pearl")

    def getPrice(self):
        return self.coffee.getPrice() + 10

實際业务场景如同前可保持不變：
if  __name__=="__main__":

          #原型產品

latte=Latte()

print("Name:%s"%latte.getName())

print("Price:%s"%latte.getPrice())

          #加大

largeLatte=LargeDecorator(latte)

print("Name:%s" % largeLatte.getName())

print("Price:%s" % largeLatte.getPrice())

          #加珍珠

largeLattePearl=LargeDecorator(largeLatte)

print("Name:%s" % largeLattePearl.getName())

print("Price:%s" % largeLattePearl.getPrice())

则打印结果如下：

Visit Func getName

Name:latte

Visit Func getPrice

Price:30.0

Visit Func getName

Name:Large + latte

Visit Func getPrice

Price:35.0

Visit Func getName

Name:Large + Large + latte

Visit Func getPrice

Price:40.0

总结：

装饰器模式是除使用組合或繼承方式来扩展对象行为外之最佳替代方案，Python已进一步扩展装饰器概念並內置在語法中，允许使用其内置的修饰器特性就能直接扩展任意可调用对象（函数、方法或类）的操作行为。
另装饰器模式也是实现横切关注点(AOP)的绝佳方案，因为横切关注点如使用面向对象不太容易实现其编程范式，但配合使用装饰器特性可保持函数简洁，同时又不牺牲性能。

装饰器模式的优缺点

优点：

• 可轻量级扩展对象的其它附屬功能
• Python內置装饰器特性可直接实现AOP之需求，便于在不同位置需重複操作行為作统一管理

缺点:

• 在具装饰器特性其调试和维护上困难度较大