Spring项目最简单的方式用单元测试来测接口

写在前面

记录一下我的测试类测接口的代码,尤其是通用代码,不用写第二遍了。
测接口,也可以用postman,但我这次想很多个接口一起测,刚好单元测试写的也很少,就锻炼下自己。
用的是RestTemplate来发请求,顺便封装了下成通用代码。

代码

贴一下通用代码


import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.ResponseEntity;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriComponentsBuilder;

import java.lang.reflect.Array;
import java.util.Map;

import static org.springframework.http.MediaType.APPLICATION_JSON;

public abstract   class CtrlBaseTest {

    protected   final  static String baseUrl =  "http://localhost:8701/";

    public   String baseId =  "{{base_id_admin_test1}}";

    protected   HttpHeaders headers;

    private static RestTemplate restTemplate = new RestTemplate();

    static{

    }

    public CtrlBaseTest(String baseId) {
        this.baseId = baseId;
        headers = new HttpHeaders();
        headers.set("base_id",this.baseId);
    }
    
    /**
     *
     * @param method
     * @param restSuffix   请求url的后缀。如完成请求url是http://localhost:8701/test。则这里是test
     * @param params       get的传参或post/put的 body中的参数
     * @return
     */
    public String getResult(HttpMethod method, String restSuffix, Map<String,Object> params ){

        String finalUrl = baseUrl + restSuffix; //最终发起调用的url
        HttpEntity httpEntity = null;
        if(method==HttpMethod.GET && !params.isEmpty()){
            finalUrl =  bulidUrl(finalUrl,params);
            httpEntity = new HttpEntity(headers);
        }
        if(method==HttpMethod.POST){
            headers.setContentType(APPLICATION_JSON);
            httpEntity = new HttpEntity(params,headers);
        }

        ResponseEntity<String> response = restTemplate.exchange(finalUrl ,
                method,
                httpEntity,
                String.class,params);
        System.out.println( String.format("do Http ==> methodType:%s url:%s ",method.name(),finalUrl));
        return response.getBody();
    }

    private String bulidUrl(String originalUrl ,Map<String,Object> params ){
        //url需要用占位符的方式
        MultiValueMap<String, String> urlParams = new LinkedMultiValueMap<>();
        params.forEach((key,value)->{
            if(isArray(value)){
                //
                int length= Array.getLength(value) ;//如果是数组 那么获取数组的长度
                for(int i=0;i<length;i++)   //  进行循环
                {
                    Object o = Array.get(value, i);
                    urlParams.add(key,String.valueOf(o));
                }
            } else{
                urlParams.add(key,String.valueOf(value));
            }
        });
        UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(originalUrl);
        return  builder.queryParams(urlParams).build().encode().toUri().toString();
    }

    /**
     * @return 是否为数组对象,如果为{@code null} 返回false
     */
    public static boolean isArray(Object obj) {
        if (null == obj) {
            return false;
        }
        return obj.getClass().isArray();
    }
}

然后具体使用就是先启动项目,然后自己写个测试类,继承上面的通用代码,也可以不继承,随便你。
反正如果继承,注意重写构造方法,要修改baseUrl及header的逻辑,如果有要headers的话。我这边封装了一个默认上传1个base_id的请求头。
在这个测试类里写要测试的代码即可发起http请求。注意:

  • 这个类只要打上@RunWith(SpringJUnit4ClassRunner.class)即可.相当于起到1个客户端的作用,不需要打@SpringBootTest(classes = {Run.class})这个注解
本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
THE END
分享
二维码
< <上一篇
下一篇>>