Decorator trong Python

Trong bài này chúng ta sẽ tìm hiểu cách dùng Decorator trong Python, dựa vào cấu trúc của nested function ta có thể tạo ra những decorator một cách dễ dàng.

Các hàm trong Python là first-class (lớp đầu tiên), điều này có nghĩa là các hàm sẽ có trạng thái bình đẳng với những đối tượng object khác trong Python. Điều này có nghĩa là các hàm có thể được gán cho biến, được truyền vào như một tham số, được lưu trữ trong các collection.

1. Python decorator là gì?

Python decorator là cách thay đổi hành vi (behavior) của một object callable mà không cần can thiệp và chỉnh sửa object đó. Decorator là một hàm có nhiệm vụ bao bọc một hàm khác (ta tạm gọi là hàm B), hàm B sẽ được gọi bên trong thân của hàm decorator, và đương nhiên lúc này hàm decorator có thể bổ sung những đoạn code phía trên và phía dưới vị trí gọi hàm B.

Hãy lấy một ví dụ cho dễ hiểu: Giả sử bạn viết một hàm in ra các số từ 1 đến 10 như sau:

def showNumbers():
    for i in range( 1, 11):
        print(i, end=' ')

showNumbers()

Nhưng hôm sau bạn muốn in thêm một dòng dấu sao ở phía trên và phía dưới của các số đó nữa thì làm thế nào? Cách đơn giản nhất là sửa lại hàm đó.

def showNumbers():
    print('*********************************')
    for i in range( 1, 11):
        print(i, end=' ')
    print('')
    print('*********************************')

showNumbers()

Nhưng cách làm này sẽ không hiệu quả nếu function showNumbers mình đã sử dụng ở rất nhiều nơi, nếu sửa trực tiếp như vậy sẽ làm ảnh hưởng đến những vị trí đó.

Để giải quyết thì mình sẽ kết hợp với higher order function để tạo ra decorator.

# Đây là hàm decorator
def decoratorFunc(func):
    # Đây là hàm decorator gọi,
    # ta gọi là extend decorated function
    def addStar():
        print("***************************")
        func()
        print('')
        print("***************************")

    return addStar

def showNumbers():
    for i in range( 1, 11):
        print(i, end=' ')


add_star = decoratorFunc(showNumbers)
add_star()

Trong ví dụ này thì hàm decoratorFunc là một decorator, bên trong được gọi đến hàm mở rộng addStar dùng để trang trí thêm mấu dấu sao.

2 Tạo decorator trong Pyhton bằng dấu @

Python cho phép bạn sử dụng dấu @ để đánh dấu một phương thức sẽ được trang trí (decorator) bằng một phương thức khác.

Quay lại ví dụ trên thì mình sẽ viết lại chương trình decorator như sau:

def decoratorFunc(func):
    def addStar():
        print("***************************")
        func()
        print('')
        print("***************************")

    return addStar

@decoratorFunc
def showNumbers():
    for i in range( 1, 11):
        print(i, end=' ')

# Gọi kiểu này đơn giản hơn
showNumbers()

Kết quả trả về là như nhau:

Kể từ bây giờ chúng ta nên sử dụng cách này nhé các bạn, bởi trông chuyên nghiệp và ảo diệu hơn rất nhiều, một người không rành về Python sẽ không thể hiểu là bạn đang code cái gì :3

3. Python decorator với hàm có tham số

Trường hợp hàm showNumbers có tham số thì cách viết như thế nào nhỉ?

Giả sử mình fix lại hàm đó với một tham số n truyền vào, và nội dung sẽ in ra dãy số từ 1 đến n.

def decoratorFunc(func):
    def addStar(n):
        print("***************************")
        func(n)
        print('')
        print("***************************")

    return addStar

@decoratorFunc
def showNumbers(n):
    for i in range( 1, n + 1):
        print(i, end=' ')

# Gọi có tham số truyền vào
showNumbers(20)

Các bạn chú ý nhé, đoạn code trên mình có truyền vào tham số n = 20 nên có hơi chút khác biệt so với các ví dụ ở trên.

4. Multi decorator trong Python

Bạn có thể áp dụng nhiều decorator cho một function.

Ví dụ: Giả sử mình có một hàm

def addStrongTag(func):
    def add(msg):
        print('<strong>')
        func(msg)
        print('</strong>')
    return add

def addSpanTag(func):
    def add(msg):
        print('<span>')
        func(msg)
        print('</span>')
    return add

@addStrongTag
@addSpanTag
def showMessage(msg):
    print(msg)

showMessage("Freetuts.net")

Kết quả:

5. Decorator với class trong Python

Bạn có thể tạo decorator bằng một class với điều kiện trong class đó phải khai báo phương thức __call__ nhé.

class addTag():

    def __init__(self, func):
        self.func = func

    def __call__(self, msg):
        print('<strong>')
        self.func(msg)
        print('</strong>')

@addTag
def showMessage(msg):
    print(msg)

showMessage("freetuts.net")

Kết quả:

<strong>
freetuts.net
</strong>

Kết luận: Qua bài này ta thấy việc sử dụng decorator trong Python thực sự rất hữu ích. Có nhiều trường hợp trong thực tế có thể áp dụng nó như: Chương trình quản lý đăng nhập, quản lý việc hiển thị nội dung ra bên ngoài một trang web ...

Cuối cùng, chúc bạn nắm vững được kỹ thuật decorator này nhé.