基于Spring Boot框架开发的一个Mock

背景:在项目后端接口开发还未完成,我们无法进行自动化接口用例的调试,希望与开发同步完成接口自动化用例的编写及调试,待项目转测后,可以直接跑自动化用例,提高测试效率.

选用的maven + Spring Boot框架,代码的示例自己随便构造的, 由于实际项目接口没有做cookie的校验, 所以示例接口没有添加cookie和做cookie校验,后续有需求再研究...直接上代码

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>LMock</groupId>
    <artifactId>spring-boot-LMock</artifactId>
    <version>1.0.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.2.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.14</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.49</version>
        </dependency>
    </dependencies>


</project>

resources目录下面的配置文件application.properties, 注意:该文件要utf8编码格式,不然中文会乱码

server.port=${port:8889}

#userInfo
u.name=张三
u.sex=男
u.age=20
u.addr=北京市紫禁城
u.status=0
u.uid=123456789

#loginInfo
login.account=[e-mail],[e-mail]
login.pwd=123456

#responsemsg
ERROR.CODE.1001={"resultCode": 1001, "msg": "用户名或者密码错误"}

入口程序:Application.java

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;

@SpringBootApplication
@ComponentScan("com.lmock")
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

javabean的类, LoginInfo.java  UserInfo.java

package com.lmock.bean;

import lombok.Data;

@Data
public class UserInfo {
    private String name;
    private String sex;
    private int age;
    private String addr;
    private int status;
    private String uid;

    @Override
    public String toString() {
        return "{\"name\": \"" + name +
                "\", \"sex\": \"" + sex +
                "\", \"age\": " + age +
                ", \"addr\": \"" + addr +
                "\", \"status\": " + status +
                ", \"uid\": \"" + uid +
                "\"}";
    }
}

package com.lmock.bean;

import lombok.Data;

@Data
public class LoginInfo {
    private String account;
    private String pwd;
}

配置文件数据处理类, ReadConfig.java

package com.lmock.data;

import com.lmock.bean.UserInfo;

import java.io.UnsupportedEncodingException;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import java.util.ResourceBundle;

public class ReadConfig {
    private static ResourceBundle bundle = ResourceBundle.getBundle("application", Locale.PRC);

    public static String login_account = bundle.getString("login.account");
    public static List<String> login_account_list = Arrays.asList(login_account.split(","));
    public static String login_pwd = bundle.getString("login.pwd");
    public static String ERROR_CODE_1001 = transcoding("ERROR.CODE.1001");

    public String readUserInfo() {
        UserInfo ui = new UserInfo();
        ui.setName(transcoding("u.name"));
        ui.setSex(transcoding("u.sex"));
        ui.setAge(Integer.parseInt(transcoding("u.age")));
        ui.setAddr(transcoding("u.addr"));
        ui.setStatus(Integer.parseInt(transcoding("u.status")));
        ui.setUid(transcoding("u.uid"));
        return ui.toString();
    }

    private static String transcoding(String key) {
        try {
            return new String(bundle.getString(key).getBytes("ISO-8859-1"), "UTF8");
        } catch (UnsupportedEncodingException e) {
            return bundle.getString(key);
        }
    }

}

接口实现类, PostDemo.java

package com.lmock.server;

import com.lmock.bean.LoginInfo;
import com.lmock.bean.UserInfo;
import com.lmock.data.ReadConfig;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class PostDemo {
    @RequestMapping(value = "/v1/getUserInfo", method = RequestMethod.POST)
    public String getUserInfo(@RequestBody LoginInfo loginInfo){
        UserInfo ui;
        if(loginInfo.getAccount().equals("[e-mail]") && loginInfo.getPwd().equals("123456")){
            ui = new UserInfo();
            ui.setName("张三");
            ui.setAge(20);
            ui.setAddr("北京市紫禁城");
            ui.setSex("男");
            ui.setStatus(0);
            ui.setUid("123456789");
            return ui.toString();
        }
        return "{\"resultCode\": 1001, \"msg\": \"用户名或者密码错误\"}";
    }

    @RequestMapping(value = "/v2/getUserInfo", method = RequestMethod.POST)
    public String getUserInfoWithConfig(@RequestBody LoginInfo loginInfo){
        if(ReadConfig.login_account_list.contains(loginInfo.getAccount()) && loginInfo.getPwd().equals(ReadConfig.login_pwd)){
                return new ReadConfig().readUserInfo();
        }
        return ReadConfig.ERROR_CODE_1001;
    }
}

最后决定用V2的方式写Mock, 这样接口参数校验的逻辑写好后, 只需要修改properties配置文件数据即可, 这样就可以当作一个测试桩, 也可以把桩要返回的数据写成json文件,这里没有去研究了, 个人觉得写成配置文件也挺好的,特别是需要多个数据, 可以利用List

启动Mock后,接口请求的效果