Locust class的属性和学习使用（学习总结2）

た入场券 2024-04-19 11:01 86阅读 0赞

## 一、Locust类的属性介绍 ##

### Locust class ###

> locustfile是一个普通的python文件。惟一的要求是它声明至少一个类(我们称它为locust类)，该类继承自该类locust。 Locust 类表示一个用户(或者一个群集的Locust )。Locust 将为每个被模拟的用户生成(孵化)Locust 类的一个实例。Locust 类通常应该定义几个属性。

#### 1、[task\_set][task_set] 属性 ####

> task\_set属性应该指向一个TaskSet类，这个类定义了用户的行为。

### 2、min\_wait 和 max\_wait 属性 ###

> 除了task\_set属性外，通常还需要声明min\_wait和max\_wait属性。这些分别是模拟用户在执行每个任务之间等待的最小时间和最大时间，单位为毫秒。min\_wait和max\_wait默认值为1000，因此，如果没有声明min\_wait和max\_wait，则locust将在每个任务之间始终等待1秒。

### 3、weight 属性（调整执行频率） ###

> 如果文件中存在多个locust类，并且命令行中没有指定locust，则每个新生成的locust将从现有locust中随机选择。否则，你可以像这样从同一个文件中指定要使用哪些locust:  
> $ locust -f locust\_file.py WebUserLocust MobileUserLocust

**WebUserLocust、 MobileUserLocust是用户行为类的执行类。**

如果想要调整执行频率(调整weight 的属性值，例如，网络用户的可能性是移动用户的三倍)：

class WebUser(TaskSet):
    	@task
    	def webuser(self):
    		print('这是网络用户')
    
    class MobileUser(TaskSet):
    	@task
    	def mobileuser(self):
    		print('这是移动用户')
    
    class WebUserLocust(HttpLocust):
        weight = 3
        task_set = WebUser
    
    class MobileUserLocust(HttpLocust):
        weight = 1
    	task_set = MobileUser

### 4、host属性 ###

> host属性是要加载主机的URL前缀(即“https://google.com”)。通常，这是在命令行中指定的，在启动locust时使用 --host选项。如果在locust类中声明一个host属性，那么当命令行上指定 --host时，就会使用这个属性。

--------------------

## 二、TaskSet 类属性介绍 ##

### TaskSet class ###

> 如果Locust类代表一个群集的Locust，可以说TaskSet类代表Locust的大脑。每个Locust类必须有一个指向TaskSet的task\_set属性集。  
> TaskSet就像它的名字一样，是一组任务。这些任务都是普通的python可调用函数——如果我们加载测试一个拍卖网站——可以执行诸如“加载起始页面”、“搜索某些产品”和“出价”之类的操作。  
> 当启动负载测试时，Locust类的每个实例将开始执行它们的TaskSet。然后，每个任务集将选择一个任务并调用它。然后，它将等待数毫秒，在Locust类的min\_wait和max\_wait属性之间随机选择(min\_wait/max\_wait直接在TaskSet下定义的情况下，它将使用自己的值)。然后它将再次选择要调用的新任务，再次等待，等等。

#### 1、声明任务 ####

***(1)使用@task装饰器是为任务集声明任务的方法***

from locust import Locust, TaskSet, task
    
    class MyTaskSet(TaskSet):
        @task
        def my_task(self):
            print("Locust instance (%r) executing my_task" % (self.locust))
    
    class MyLocust(Locust):
        task_set = MyTaskSet

***@task接受一个可选的权重参数，可用于指定任务的执行比率。在下面的例子中，task2的执行量是task1的两倍:***

from locust import Locust, TaskSet, task
    
    class MyTaskSet(TaskSet):
        min_wait = 5000
        max_wait = 15000
    
        @task(3)
        def task1(self):
            print('task1')
    
        @task(6)
        def task2(self):
            print('task2')
    class MyLocust(Locust):
        task_set = MyTaskSet

***(2) tasks 属性（另一种声明任务方式）***

> 使用@task装饰器声明任务是一种方便的方法，通常也是最好的方法。但是，也可以通过设置tasks属性来定义TaskSet的任务(使用@task装饰器实际上只填充tasks属性)。  
> tasks属性要么是python可调用项列表 \[\]，要么是dict\{任务函数名 : int \},这些任务是python可调用项，它们接收一个参数——正在执行任务的TaskSet类实例。下面是一个极其简单的locustfile例子:

from locust import Locust, TaskSet
    
    def my_task(l):
        print('我的第一个任务')
    
    class MyTaskSet(TaskSet):
        tasks = [my_task]    # or  tasks = {my_task:1}
    
    class MyLocust(Locust):
        task_set = MyTaskSet

> 如果将tasks属性指定为列表，那么每次执行任务时，都将从tasks属性中随机选择任务。但是，如果任务是一个以可调用项为键、以int值为值的dict，则将随机选择要执行的任务，但以int值为比值(int值大被执行可能性大)。例:

{my_task: 3, another_task: 1}

#### 2、任务集嵌套 ####

> 任务集的一个非常重要的属性是它们可以嵌套，因为真正的网站通常是用分层的方式构建的，包含多个子部分。因此，嵌套任务集将允许我们定义一个行为，以更现实的方式模拟用户。例如，我们可以用下面的结构来定义任务集:

*  主要用户行为
    
     *  索引页
     *  论坛页面
        
         *  读线程
            
             *  回复
         *  新线程
         *  查看下一页面
     *  浏览类别
        
         *  看电影
         *  滤光片电影
     *  关于页面

--------------------

***嵌套任务集的方法就像使用tasks属性指定任务一样，但不是引用python函数，而是引用另一个任务集:***

class ForumPage(TaskSet):
        @task(20)
        def read_thread(self):
            pass
    
        @task(1)
        def new_thread(self):
            pass
    
        @task(5)
        def stop(self):
            self.interrupt()
    
    class UserBehaviour(TaskSet):
        tasks = {ForumPage:10} # 不是引用python函数，而是另一个任务集
    
        @task
        def index(self):
            pass

在上面的示例中，如果在执行UserBehaviour任务集时选择ForumPage执行，那么ForumPage任务集将开始执行。然后，ForumPage任务集将选择它自己的任务之一，执行它，等待，执行，等待。。。  
关于上面的示例，有一件重要的事情需要注意，那就是在ForumPage的stop方法中调用self.interrupt()。这样做的本质上是停止执行ForumPage任务集，并在userbehavior实例中继续执行。如果在ForumPage中没有对interrupt()方法的调用，Locust在启动ForumPage任务之后就不会停止运行它。但是通过使用中断功能，我们可以与任务权重一起定义模拟用户离开论坛的可能性。

***也可以使用@task装饰器在类中内联声明嵌套的TaskSet，就像声明普通任务一样:***

class MyTaskSet(TaskSet):
        @task
        class SubTaskSet(TaskSet):
            @task
            def my_task(self):
                pass

#### 3、TaskSequence class ####

***TaskSequence类是一个任务集，但是它的任务将按顺序执行。要定义这个顺序，您应该执行以下操作:***

class MyTaskSequence(TaskSequence):
        @seq_task(1)
        def first_task(self):
            pass
    
        @seq_task(2)
        def second_task(self):
            pass
    
        @seq_task(3)
        @task(10)
        def third_task(self):
            pass

在上面的例子中，顺序被定义为执行first\_task、second\_task和third\_task 10次。可以看到，可以使用@task装饰器组合@seq\_task，当然也可以在任务序列中嵌套任务集，反之亦然。

[task_set]: https://docs.locust.io/en/stable/api.html#locust.core.Locust.task_set