springboot使用@SpringBootTest注解进行单元测试

我会带着你远行 2022-03-18 05:42 809阅读 0赞

# 概述 #

@SpringBootTest注解是SpringBoot自1.4.0版本开始引入的一个用于测试的注解。基本用法如下：

### 1.添加依赖： ###

<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>com.cxh.test</groupId>
      <artifactId>generator</artifactId>
      <version>0.0.1-SNAPSHOT</version>
      
     <parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.5.1.RELEASE</version>
    		<relativePath/> 
    	</parent>
    
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    		<java.version>1.8</java.version>
    	</properties>
      
      <dependencies>
    
    		 
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>springloaded</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-thymeleaf</artifactId>
            </dependency>
            
             
            <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
            	<version>1.3.0</version>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
            	<version>5.0.4</version>
            </dependency>
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid-spring-boot-starter</artifactId>
                <version>1.1.9</version>
            </dependency>
    
            
    	</dependencies>
      <dependencyManagement>
    		<dependencies>
    			<dependency>
    				<groupId>org.springframework.cloud</groupId>
    				<artifactId>spring-cloud-dependencies</artifactId>
    				<version>Camden.SR6</version>
    				<type>pom</type>
    				<scope>import</scope>
    			</dependency>
    		</dependencies>
    	</dependencyManagement>
      <build/>
    </project>

### 2. 编写启动入口类 ###

package com.cxh.study.platform;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    /**
     * 
     * @desciption 
     * @author ChenXiHua
     *
     */
    @SpringBootApplication
    public class GeneratorApp {
    
    	/**
    	 * @param args
    	 */
    	public static void main(String[] args) {
    		SpringApplication.run(GeneratorApp.class, args);
    	}
    
    }

### 3. 编写Controller类 ###

### 4. 编写service类 ###

package com.cxh.study.platform.service;
    
    import java.util.List;
    
    import com.cxh.study.platform.entity.User;
    
    public interface IUserService {
    
    	// 获取所有用户
    	List<User> getAll();
    
    	// 根据id获取用户
    	User getUserById(Integer id);
    }

package com.cxh.study.platform.service.impl;
    
    import java.util.List;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    import com.cxh.study.platform.entity.User;
    import com.cxh.study.platform.mapper.IUserMapper;
    import com.cxh.study.platform.service.IUserService;
    
    @Service("userServiceImpl")
    public class UserServiceImpl implements IUserService {
    	
    	@Autowired
    	private IUserMapper userMapper;
    
    	@Override
    	public List<User> getAll() {
    		return userMapper.getAll();
    	}
    
    	@Override
    	public User getUserById(Integer id) {
    		return userMapper.getUserById(id);
    	}
    
    }

### 5. 编写mapper类 ###

package com.cxh.study.platform.mapper;
    
    import java.util.List;
    
    import org.apache.ibatis.annotations.Mapper;
    
    import com.cxh.study.platform.entity.User;
    
    @Mapper
    public interface IUserMapper {
    	//获取所有用户
    	List<User>getAll();
    	//根据id获取用户
    	User getUserById(Integer id);
    }

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
    <mapper namespace="com.cxh.study.platform.mapper.IUserMapper" >
    	
    	<select id="getAll" resultType="com.cxh.study.platform.entity.User">
    		SELECT * FROM s_user
    	</select>
    	
    	<select id="getUserById" parameterType="java.lang.Integer" resultType="com.cxh.study.platform.entity.User">
    		SELECT * FROM s_user
    		where id=#{id}
    	</select>
    </mapper>

### 6. 编写测试类 ###

package com.cxh.test;
    
    import java.net.URL;
    import java.util.List;
    
    import org.junit.Before;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.context.embedded.LocalServerPort;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.boot.test.web.client.TestRestTemplate;
    import org.springframework.http.ResponseEntity;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import com.cxh.study.platform.GeneratorApp;
    import com.cxh.study.platform.entity.User;
    
    
    /**
     * 
     * @desciption 用户管理测试类
     * @author ChenXiHua
     * @date 2019年2月19日
     *
     */
    @RunWith(SpringRunner.class)
    @SpringBootTest(classes = GeneratorApp.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
    public class UserTest {
    	
    	 /**
         * @LocalServerPort 提供了 @Value("${local.server.port}") 的代替
         */
        @LocalServerPort
        private int port;
    
        private URL base;
    
        @Autowired
        private TestRestTemplate restTemplate;
    
        @Before
        public void setUp() throws Exception {
            String url = String.format("http://localhost:%d/", port);
            System.out.println(String.format("port is : [%d]", port));
            this.base = new URL(url);
        }
    
        /**
         * 向"/test"地址发送请求，并打印返回结果
         * @throws Exception
         */
        //@Test
        public void test1() throws Exception {
    
            ResponseEntity<String> response = this.restTemplate.getForEntity(
                    this.base.toString() + "/test", String.class, "");
            System.out.println(String.format("测试结果为：%s", response.getBody()));
        }
        
        //@Test
        public void getAllTest() throws Exception {
    
            ResponseEntity<List> response = this.restTemplate.getForEntity(
                    this.base.toString() + "/getAll", List.class, "");
            System.out.println(String.format("测试结果为：%s", response.getBody()));
        }
        
        @Test
        public void getUserByIdTest() throws Exception {
    
            ResponseEntity<User> response = this.restTemplate.getForEntity(
                    this.base.toString() + "/getUserById?id=1", User.class, "");
            System.out.println(String.format("测试结果为：%s", response.getBody().toString()));
        }
    
    }

其中，`classes`属性指定启动类，`SpringBootTest.WebEnvironment.RANDOM_PORT`经常和测试类中`@LocalServerPort`一起在注入属性时使用。会随机生成一个端口号。

### 7.测试结果： ###

2019-02-19 16:18:27.933  INFO 6676 --- [           main] com.cxh.test.UserTest                    : Started UserTest in 25.637 seconds (JVM running for 27.647)
    port is : [14067]
    2019-02-19 16:18:31.366  INFO 6676 --- [o-auto-1-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring FrameworkServlet 'dispatcherServlet'
    2019-02-19 16:18:31.367  INFO 6676 --- [o-auto-1-exec-1] o.s.web.servlet.DispatcherServlet        : FrameworkServlet 'dispatcherServlet': initialization started
    2019-02-19 16:18:31.462  INFO 6676 --- [o-auto-1-exec-1] o.s.web.servlet.DispatcherServlet        : FrameworkServlet 'dispatcherServlet': initialization completed in 95 ms
    测试结果为：User [id=1, account=cxh, password=123, type=1, status=1]
    2019-02-19 16:18:35.326  INFO 6676 --- [       Thread-5] ationConfigEmbeddedWebApplicationContext : Closing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@191004a: startup date [Tue Feb 19 16:18:05 CST 2019]; root of context hierarchy
    2019-02-19 16:18:35.376  INFO 6676 --- [       Thread-5] com.alibaba.druid.

### 我的座右铭：不会，我可以学；落后，我可以追赶；跌倒，我可以站起来；我一定行。 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTIyMDQ3Mg_size_16_color_FFFFFF_t_70][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zOTIyMDQ3Mg_size_16_color_FFFFFF_t_70]: /images/20220318/7584c08b785e41fda4ebc75072998741.png