SpringBoot系列(十)单元测试

系统管理员 2022-05-31 08:06 190阅读 0赞

## 一、环境 ##

在SpringBoot环境中添加单元测试maven依赖，依赖如下：

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

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

## 二、关键注解介绍 ##

>  *  @RunWith(SpringJUnit4ClassRunner.class)，这是JUnit的注解，通过这个注解让SpringJUnit4ClassRunner这个类提供Spring测试上下文。
>  *  @SpringApplicationConfiguration(classes = 启动类.class)，这是Spring Boot注解，为了进行集成测试，需要通过这个注解加载和配置Spring应用上下文。这是一个元注解（meta-annoation），它包含了@ContextConfiguration( loader = SpringApplicationContextLoader.class)这个注解，测试框架通过这个注解使用Spring Boot框架的SpringApplicationContextLoader加载器创建应用上下文。
> 
> @WebAppConfiguration 表明是WEB应用环境，不能和@WebIntegrationTest一起使用
> 
>  *  @WebIntegrationTest(“server.port:0”)，这个注解表示当前的测试是集成测试（integration test），因此需要初始化完整的上下文并启动应用程序。这个注解一般和@SpringApplicationConfiguration一起出现。server.port:0指的是让Spring Boot在随机端口上启动Tomcat服务，随后在测试中程序通过@Value(“$\{local.server.port\}”)获得这个端口号，并赋值给port变量。当在Jenkins或其他持续集成服务器上运行测试程序时，这种随机获取端口的能力可以提供测试程序的并行性。
>  *  @SpringBootTest(classes = AppApplication.class, webEnvironment = SpringBootTest.WebEnvironment.MOCK) 指定启动类，web环境

*  WebEnvironment.MOCK—提供一个Mock的Servlet环境，内置的Servlet容器并没有真实的启动，主要搭配使用@AutoConfigureMockMvc
 *  WebEnvironment.RANDOM\_PORT — 提供一个真实的Servlet环境，也就是说会启动内置容器，然后使用的是随机端口
 *  WebEnvironment.DEFINED\_PORT — 这个配置也是提供一个真实的Servlet环境，使用的默认的端口，如果没有配置就是8080
 *  WebEnvironment.NONE — 这是个神奇的配置，跟Mock一样也不提供真实的Servlet环境。

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

**推荐使用方式：**

在SpringBOOT项目创建的时候，会自动在测试启动类上标有以下注解（SpringBoot版本1.5.9）：

@RunWith(SpringRunner.class)  
@SpringBootTest

@Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @BootstrapWith(SpringBootTestContextBootstrapper.class)
    public @interface SpringBootTest { 
        @AliasFor("properties")
        String[] value() default {};
    
        @AliasFor("value")
        String[] properties() default {};
    
        Class<?>[] classes() default {};
    
        SpringBootTest.WebEnvironment webEnvironment() default SpringBootTest.WebEnvironment.MOCK;
    
        public static enum WebEnvironment {
            MOCK(false),
            RANDOM_PORT(true),
            DEFINED_PORT(true),
            NONE(false);
    
            private final boolean embedded;
    
            private WebEnvironment(boolean embedded) {
                this.embedded = embedded;
            }
    
            public boolean isEmbedded() {
                return this.embedded;
            }
        }
    }

所以完整如下:

package com.jd.m.tg;
    
    import com.jd.m.tg.model.CustomerProperties;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest(classes = MTgApplication.class)
    public class MTgApplicationTests {
    
        @Autowired
        private CustomerProperties customerProperties;
    
        @Test
        public void testJimDb() {
            System.out.println(customerProperties);
    
        }
    
    }

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

**Junit基本注解介绍：**

//在所有测试方法前执行一次，一般在其中写上整体初始化的代码 
    @BeforeClass
    
    //在所有测试方法后执行一次，一般在其中写上销毁和释放资源的代码 
    @AfterClass
    
    //在每个测试方法前执行，一般用来初始化方法（比如我们在测试别的方法时，类中与其他测试方法共享的值已经被改变，为了保证测试结果的有效性，我们会在@Before注解的方法中重置数据） 
    @Before
    
    //在每个测试方法后执行，在方法执行完成后要做的事情 
    @After
    
    // 测试方法执行超过1000毫秒后算超时，测试将失败 
    @Test(timeout = 1000)
    
    // 测试方法期望得到的异常类，如果方法执行没有抛出指定的异常，则测试失败 
    @Test(expected = Exception.class)
    
    // 执行测试时将忽略掉此方法，如果用于修饰类，则忽略整个类 
    @Ignore(“not ready yet”) 
    @Test

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

## 三、打包测试 ##

正常情况下我们写了5个测试类，我们需要一个一个执行。 打包测试，就是新增一个类，然后将我们写好的其他测试类配置在一起，然后直接运行这个类就达到同时运行其他几个测试的目的。

代码如下：

@RunWith(Suite.class) 
    @SuiteClasses({ATest.class, BTest.class, CTest.class}) 
    public class ABCSuite {
        // 类中不需要编写代码
    }

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

## 四、不同环境的测试 ##

@ActiveProfiles(profiles = "test") 在测试类上面指定profiles，可以改变当前spring 的profile，来达到多环境的测试

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

## 五、MockMvc 模拟外部环境测试 ##

@RunWith(SpringRunner.class.class)  
    @SpringBootTest(classes = AppApplication.class, webEnvironment = SpringBootTest.WebEnvironment.MOCK)
    public class AppApplication{   
    
        @Autowired  
        private WebApplicationContext context;  
    
        private MockMvc mockMvc;   
    
        @Before   
        public void setupMockMvc() throws Exception {   
            mockMvc = MockMvcBuilders.webAppContextSetup(context).build();   
        }  
    
    
        /*** * 测试添加用户接口 * @throws Exception */  
        @Test  
        public void testAddUser() throws Exception {  
            //构造添加的用户信息 
            UserInfo userInfo = new UserInfo();  
            userInfo.setName("testuser2");  
            userInfo.setAge(29);  
            userInfo.setAddress("北京");  
            ObjectMapper mapper = new ObjectMapper();  
    
            //调用接口，传入添加的用户参数 
            mockMvc.perform(post("/user/adduser")  
                    .contentType(MediaType.APPLICATION_JSON_UTF8)  
                    .content(mapper.writeValueAsString(userInfo)))  
            //判断返回值，是否达到预期，测试示例中的返回值的结构如下{"errcode":0,"errmsg":"OK","p2pdata":null} 
            .andExpect(status().isOk())  
            .andExpect(content().contentType(MediaType.APPLICATION_JSON_UTF8))  
            //使用jsonPath解析返回值，判断具体的内容 
            .andExpect(jsonPath("$.errcode", is(0)))  
            .andExpect(jsonPath("$.p2pdata", notNullValue()))  
            .andExpect(jsonPath("$.p2pdata.id", not(0)))  
            .andExpect(jsonPath("$.p2pdata.name", is("testuser2")));  
        }  
    }

参考文章：[http://blog.csdn.net/catoop/article/details/50752964][http_blog.csdn.net_catoop_article_details_50752964]  
[http://blog.csdn.net/king\_is\_everyone/article/details/53229929][http_blog.csdn.net_king_is_everyone_article_details_53229929]

[http_blog.csdn.net_catoop_article_details_50752964]: http://blog.csdn.net/catoop/article/details/50752964
[http_blog.csdn.net_king_is_everyone_article_details_53229929]: http://blog.csdn.net/king_is_everyone/article/details/53229929