手把手教你Locust压测实践

做了半年压测，期间接触了不少压测工具，今天就分享下上周刚上手的locust压测工具，简单易于上手，看完本文应该都能用它来压测普通接口了。

1、概述

Locust是一款通过Python语言来编写压测脚本，且使用简单的分布式负载测试工具，完全基于事件，即一个locust节点也可以在一个进程中支持数千并发用户，不使用回调，通过gevent使用轻量级过程（即在自己的进程内运行）。

其中gevent是第三方库，通过greenlet实现协程，greenlet是python的并行处理的一个库。python 有一个非常有名的库叫做 stackless ，用来做并发处理， 主要是弄了个叫做tasklet的微线程的东西， 而greenlet 跟stackless的最大区别是greenlet需要你自己来处理线程切换， 就是说，你需要自己指定现在执行哪个greenlet再执行哪个greenlet。

2、特点

①、不需要编写笨重的UI或者臃肿的XML代码，基于协程而不是回调，脚本编写简单易读；

②、有一个基于web简洁的HTML+JS的UI用户界面，可以实时显示相关的测试结果；

③、支持分布式测试，用户界面基于网络，因此具有跨平台且易于扩展的特点；

④、所有繁琐的I / O和协同程序都被委托给gevent，替代其他工具的局限性；

3、locust与jmeter的区别

4、locust的局限性

locust的局限性在于，目前其本身对测试过程的监控和测试结果展示，不如jmeter全面和详细，需要进行二次开发才能满足需求越来越复杂的性能测试需要。

运行大规模测试时，建议在Linux机器上执行，因为gevent在Windows下的性能很差。

5、测试脚本demo
下面的demo 是基于locust最新的v2.1.0版本，笔者在学习时，发现网上很多blog资料都已经过时了，所以在这里特别说明一下版本，因为2.1.0版本的API和脚本编写跟之前版本有较大差异。
最新版本可以参考官方的文档：https://docs.locust.io/en/stable/writing-a-locustfile.html

# 该demo适用于：locust v2.1.0
from locust import HttpUser, task, between, events
from locust.runners import MasterRunner

debug = False

@events.init.add_listener
def on_locust_init(environment, **kwargs):
    if isinstance(environment.runner, MasterRunner):
        print("I'm on master node")
    else:
        print("I'm on a worker or standalone node")

# 压测开始的时候执行
@events.test_start.add_listener
def on_test_start(environment, **kwargs):
    print("test is starting")

# 压测结束的时候执行
@events.test_stop.add_listener
def on_test_stop(environment, **kwargs):
    print("test is ending")

class HttpDemo(HttpUser):
    wait_time = between(0, 10)
    host = 'http://test.yourdns.com/api/query/12345'  # 示例地址是脱敏过的

    def on_start(self):
        # 每次任务开始的时候执行
        print("task start")

    def on_stop(self):
        # 每次任务执行完时执行
        print("task stop")

    '''例子'''

    @task
    def test(self):

        header = {
            "User-Agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.36"}
        req = self.client.get(self.host, headers=header, verify=False)  # self.client调用get和post方法，和requests一样

        if req.status_code == 200: #这里的校验逻辑可以按需求写
            print("success")
        else:
            print("fails")

if __name__ == "__main__":
    # 调试模式，1s执行一次
    if debug:
        from locust.env import Environment
        my_env = Environment(user_classes=[HttpDemo])
        HttpDemo(my_env).run()
    else:
        import os
        #os.system("locust -f http_demo.py --host=http://lotcheck.woa.com")  # web console
        os.system("locust -f http_demo.py --host=http://test.yourdns.com HttpDemo --headless -u 1 -r 2 --run-time 10s")  # commandline启动