SpringBoot Using @ SpringBootTest Annotations to Develop Unit Test Tutorials
- 2021-10-13 07:29:28
- OfStack
Directory overview 1. Add dependencies: 2. Write startup entry classes 3. Write Controller classes 4. Write service classes 5. Write mapper classes 6. Write test classes 7. Test results:
Overview
The @ SpringBootTest annotation is a test annotation that SpringBoot has introduced since version 1.4. 0. The basic usage is as follows:
1. Add dependencies:
<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/> <!-- lookup parent from repository -->
</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>
<!-- spring boot web Dependency -->
<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>
<!-- Effective immediately after modification, hot deployment -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>springloaded</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
</dependency>
<!-- View -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!-- mybatis Dependency -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
<!-- mysql Dependency -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.0.4</version>
</dependency>
<!-- alibaba Adj. druid Database connection pool -->
<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. Write a startup entry class
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. Write the Controller class
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);
}
}
4. Write the service class
package com.cxh.study.platform.service;
import java.util.List;
import com.cxh.study.platform.entity.User;
public interface IUserService {
// Get All Users
List<User> getAll();
// According to id Get users
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. Write the mapper class
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 {
// Get All Users
List<User>getAll();
// According to id Get users
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" >
<!-- Get All Users -->
<select id="getAll" resultType="com.cxh.study.platform.entity.User">
SELECT * FROM s_user
</select>
<!-- According to id Get a single user -->
<select id="getUserById" parameterType="java.lang.Integer" resultType="com.cxh.study.platform.entity.User">
SELECT * FROM s_user
where id=#{id}
</select>
</mapper>
6. Write test classes
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 User management test class
* @author ChenXiHua
* @date 2019 Year 2 Month 19 Day
*
*/
@RunWith(SpringRunner.class)
@SpringBootTest(classes = GeneratorApp.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class UserTest {
/**
* @LocalServerPort Provides @Value("${local.server.port}") Substitution of
*/
@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);
}
/**
* Toward "/test" Send the request to the address and print the return result
* @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(" The test results are: %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(" The test results are: %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(" The test results are: %s", response.getBody().toString()));
}
}Where the classes attribute specifies the startup class, SpringBootTest. WebEnvironment. RANDOM_PORT is often used when injecting attributes from @ LocalServerPort1 in the test class. A port number is randomly generated.
7. Test results:
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
The test results are: 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