【Selenium学习】Page Object 设计模式

章节目录

前言

一、认识

二、优点

三、实现 Paget Object

1.Paget Object 简单实例

2.改进 Paget Object 封装

总结

---

前言

Page Object 是 UI 自动化测试项目开发实践的最佳设计模式之一，它的主要特点体现在对界面交互细节的封装上，使测试用例更专注于业务的操作，从而提高测试用例的可维护性。

一、认识

        Page Object模式下，应用程序中的每个网页都被表示为一个单独的类或对象。Page Object包含与该页面交互所需的所有方法和属性，例如查找元素、点击按钮、填写表单和检索数据等。

        通过使用Page Objects，测试人员可以创建更有组织和可重用的代码，并减少重复代码的数量。Page Objects还使得更新测试更加容易，如果应用程序的UI发生变化，只需要在相应的Page Object类中进行更改即可。

二、优点

1. 提高可读性

使用Page Objects，测试代码变得更加可读和易于理解。测试人员可以轻松地在Page Objects中编写可读的代码，而无需直接操作浏览器的底层API。这使得测试代码更易于维护和调试，同时也降低了测试代码的复杂度。

2. 提高可维护性

使用Page Objects，测试人员可以将UI元素和测试代码分开，从而提高代码的可维护性。如果UI元素发生了变化，测试人员只需要在相应的Page Object类中进行更改，而无需在测试代码中查找和更新所有与该元素相关的代码。这样可以大大减少代码的维护成本和时间。

3. 提高可扩展性

使用Page Objects，测试人员可以轻松地添加新的测试用例和新的页面。由于每个页面都有一个对应的Page Object类，因此只需创建一个新的Page Object类即可为新页面添加测试用例。这使得测试自动化框架更加灵活和可扩展。

4. 降低重复代码的数量

使用Page Objects，测试人员可以将通用的代码块抽象到Page Objects中，并在需要时重复使用。这可以减少测试代码的重复量，并提高代码的可重用性。此外，这还可以减少测试代码中的错误，并提高测试代码的质量。

三、实现 Paget Object

        下面我们将通过例子介绍这种设计模式的使用。

1.Paget Object 简单实例

        以百度搜索为列，假设我们有如下测试代码：

...

def test_baidu_search_case1(self):
    self.driver.get(self.base_url)
    self.driver.find_element(By.ID, "kw").send_keys("selenium")
    self.driver.find_element(By.ID, "su").click()
def test_baidu_search_case2(self):
    self.driver.get(self.base_url)
    self.driver.find_element(By.ID, "kw").send_keys("unittest")
    self.driver.find_element(By.ID, "su").click()
def test_baidu_search_case3(self):
    self.driver.get(self.base_url)
    self.driver.find_element(By.ID, "kw").send_keys("page object")
    self.driver.find_element(By.ID, "su").click()

...

        这段代码最大的问题就是在三条测试用例中重复使用了元素的定位和操作。这会带来

一个很大的问题，当元素的定位发生变化后，例如，id=kw 失效了，应及时调整定位方法，

这时就需要在三条测试用例当中分别进行修改。

        假设，我们的自动化项目有几百条测试用 例，而 UI 很可能是频繁变化的，那么就会提高自化测试用例的维护成本。

        Page Object 的设计思想上是把元素定位与元素操作进行分层，这样带的来最直接的好

处就是当元素发生变化时，只需维护 page 层的元素定位，而不需要关心在哪些测试用例当

中使用了这些元素。在编写测试用例时，也不需要关心元素是如何定位的。

        创建 baidu_page.py 文件，内容如下:

# _*_ coding:utf-8 _*_
"""
name:zhangxingzai
date:2023/4/3
"""

from selenium.webdriver.common.by import By


class BaiduPage():
    def __init__(self, driver):
        self.driver = driver

    def search_input(self, search_key):
        self.driver.find_element(By.ID, "kw").send_keys(search_key)

    def search_button(self):
        self.driver.find_element_by_id("su").click()

        首先创建 BaiduPage 类，在__init__()初始化方法中接收参数 driver 并赋值给 self.driver。

然后，分别封装 search_input()方法和 search_button()方法，定位并操作元素。这里的封装只

针对一个页面中可能会操作到的元素，原则上是一个元素封装成一个方法。当元素的定位

方法发生改变时，只需维护这里的方法即可，而不需要关心这个方法被哪些测试用例使用了。

# _*_ coding:utf-8 _*_
"""
name:zhangxingzai
date:2023/4/3
"""

import unittest
from selenium import webdriver
from baidu_page import BaiduPage


class TestBaidu(unittest.TestCase):

    def setUp(self):
        self.driver = webdriver.Firefox()
        self.baidu_url = 'https://www.baidu.com'

    def test_baidu_search_case1(self):
        self.driver.get(self.baidu_url)
        bd = BaiduPage(self.driver)
        bd.search_input("selenium")
        bd.search_button()

    def test_baidu_search_case2(self):
        self.driver.get(self.baidu_url)
        bd = BaiduPage(self.driver)
        bd.search_input("unittest")
        bd.search_button()

    def test_baidu_search_case3(self):
        self.driver.get(self.baidu_url)
        bd = BaiduPage(self.driver)
        bd.search_input("page object")
        bd.search_button()

    def tearDown(self):
        self.driver.close()


if __name__ == '__main__':
    unittest.main

        首先在测试中导入 BaiduPage 类，然后在每个测试用例中为 BaiduPage 类传入驱动，

这样就可以轻松地使用它封装的方法来设计具体的测试用例了。这样做的目的就是在测试

用例中消除元素定位。如果你要操作百度输入框，那么只需调用 search_input()方法并传入

搜索关键字即可，并不需要关心百度输入框是如何定位的。

2.改进 Paget Object 封装

        以上代码仍存在一些问题，比如以前一条测试用例只需写 4 到 5 行 代码即可，现在却不得不先在 Page 层针对每个待操作的元素进行封装，然后再到具体的测试用例中引用。为了使 Page 层的封装更加方便，我们做一些改进。

        创建 base.py 文件，内容如下。

# _*_ coding:utf-8 _*_
"""
name:zhangxingzai
date:2023/4/3
"""

from selenium.webdriver.common.by import By


class BasePage:
    """
    基础 Page 层，封装一些常用方法
    """

    def __init__(self, driver):

        self.driver = driver

    # 打开页面
    def open(self, url=None):
        if url is None:
            self.driver.get(self.url)
        else:
            self.driver.get(url)

    # id 定位
    def by_id(self, id_):
        return self.driver.find_element(By.ID, id_)

    # name 定位
    def by_name(self, name):
        return self.driver.find_element(By.NAME, name)

    # class 定位
    def by_class(self, class_name):
        return self.driver.find_element(By.CLASS_NAME, class_name)

    # XPath 定位
    def by_xpath(self, xpath):
        return self.driver.find_element(By.XPATH, xpath)

    # CSS 定位
    def by_css(self, css):
        return self.driver.find_element(By.CSS_SELECTOR, css)

    # 获取 title
    def get_title(self):
        return self.driver.title

    # 获取页面 text，仅使用 XPath 定位
    def get_text(self, xpath):
        return self.by_xpath(xpath).text

    # 执行 JavaScript 脚本
    def js(self, script):
        self.driver.execute_script(script)

        创建 BasePage 类作为所有 Page 类的基类，在 BasePage 类中封装一些方法，这些方法

是我们在做自动化时经常用到的。

        下面修改 baidu_page.py 文件：

# _*_ coding:utf-8 _*_
"""
name:zhangxingzai
date:2023/4/3
"""

from base import BasePage


class BaiduPage(BasePage):
    """百度 Page 层，百度页面封装操作到的元素"""
    url = "https://www.baidu.com"

    def search_input(self, search_key):
        self.by_id("kw").send_keys(search_key)

    def search_button(self):
        self.by_id("su").click()

        在 search_input()和 search_button()方法中使用了父类的 self.by_id()方法来定位元素，比

原生的 Selenium 方法简短了不少。

        在测试用例中，使用 BaiduPage 类及它所继承的父类中的方法：

# _*_ coding:utf-8 _*_
"""
name:zhangxingzai
date:2023/4/3
"""

import unittest
from time import sleep
from selenium import webdriver
from baidu_page import BaiduPage


class TestBaidu(unittest.TestCase):
    @classmethod
    def setUpClass(cls):
        cls.driver = webdriver.Firefox()

    def test_baidu_search_case(self):
        page = BaiduPage(self.driver)
        page.open()
        page.search_input("selenium")
        page.search_button()
        sleep(2)
        self.assertEqual(page.get_title(), "selenium_百度搜索")

    @classmethod
    def tearDownClass(cls):
        cls.driver.quit()


if __name__ == '__main__':
    unittest.main(verbosity=2)

        因为前面封装了元素的定位，所以在编写测试用例时会方便不少，当需要用到哪个 Page

类时，只需将它传入浏览器驱动，就可以使用该类中提供的方法了。

---

总结

Page Object模式是一个非常有用的测试自动化设计模式，可以提高测试代码的可读性、可维护性和可扩展性，同时还可以降低测试代码的复杂度和重复量，提高测试代码的质量和效率。