MybatisPlus 是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
Swagger官网:https://mp.baomidou.com/
在 第二章:SpringBoot集成SpringBootJPA完成CURD 的代码基础上,
替换 spring-data-jpa 为 mybatis-plus,熟悉在 mybatis-plus 下实现单表数据的CURD编码
引入 Spring Boot Starter 父工程
<parent>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-parentartifactId>
<version>2.0.5.RELEASEversion>
parent>
添加 mybatis-plus
的依赖
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-boot-starterartifactId>
<version>3.2.0version>
dependency>
添加后的整体依赖如下,在原来的基础上去除了对 spring-boot-starter-data-jpa
的依赖
<dependencies>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-tomcatartifactId>
exclusion>
exclusions>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-undertowartifactId>
dependency>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<scope>providedscope>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-boot-starterartifactId>
<version>3.2.0version>
dependency>
dependencies>
配置文件 application.yml 中配置数据源,mybatis-plus 也有很多可配置项,具体参考官方文档
spring:
datasource:
url: jdbc:mysql://192.168.247.130:3306/test?characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&&useSSL=false
username: app
password: 123456
AUTO
,表示使用数据库自增
@Data
@TableName("user")
public class User {
@TableId(type = IdType.AUTO)
private Long id;
private String name;
private Integer sex;
@JsonFormat(pattern = "yyyy-MM-dd",timezone = "GMT+8")
private LocalDate birthday;
private Integer level;
}
Mybatis-plus 提供的 BaseMapper 接口已经实现了对单表的增删查改操作以及一些其它常用的方法,可以同使用 JPA 接口一样直接调用,而不用去 mybatis 的配置文件中编写 SQL。
创建接口 UserRepository,继承 BaseMapper 接口,内容如下
@Mapper
public interface UserRepository extends BaseMapper<User> {
}
创建接口 UserService,继承 mybatis-plus 提供的 IService 通用接口,IService 中已经实现了基础的 CURD 方法
public interface UserService extends IService<User> {
}
创建实现类 UserServiceImpl,继承 mybatis-plus 提供的 ServiceImpl 类,ServiceImpl 类实现了 IService 接口
@Service
public class UserServiceImpl extends ServiceImpl<UserRepository, User> implements UserService {
}
创建 controller 类,实现增删查改交换接口
@RestController
@Slf4j
@AllArgsConstructor
public class UserController {
private UserService userService;
@PostMapping("/register")
public User register(@RequestBody User user) {
userService.save(user);
return user;
}
@PostMapping("/delete")
public List<User> delete(Long id) {
userService.removeById(id);
return userService.list();
}
@PostMapping("/list")
public List<User> list() {
return userService.list();
}
@PostMapping("/update")
public List<User> update(User user) {
userService.updateById(user);
return userService.list();
}
}
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
编写测试用例(只写的新增的用例,其它的请自行补充)
@RunWith(SpringRunner.class)
@WebAppConfiguration
@SpringBootTest(classes = Application.class)
public class UserTest {
private MockMvc mvc;
@Autowired
private WebApplicationContext webApplicationContext;
@Before
public void setUp() {
mvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
}
@Test
public void test1() throws Exception {
MvcResult mvcResult = mvc.perform(
MockMvcRequestBuilders
.post("/register")
.contentType(MediaType.APPLICATION_JSON_UTF8)
.content("{\"mobile\":\"13700000001\",\"upwd\":\"123456\"}")
)
// .andExpect(status().isOk());
// .andExpect(content().string("hello"))
.andDo(MockMvcResultHandlers.print())
.andReturn();
Assert.assertEquals(200, mvcResult.getResponse().getStatus());
}
}
本章源码 : https://gitee.com/gongm_24/spring-boot-tutorial.git
Mybatis-plus 在 mybatis 的基础上实现通用 Mapper 以及通用 Service,极大地简化了开发过程,让开发人员从 SQL 组装中脱离出来,专心处理业务逻辑
创建自动加载类 MybatisConfiguartion,并注册 PaginationInterceptor 类,即可自动加载分页查询
@Configuration
public class MybatisConfiguartion {
/**
* 配置分页插件
*/
@Bean
@ConditionalOnClass(BaseMapper.class)
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
}
创建 PageBO 用于接收分页入参
@Data
public class PageBO {
/**
* 当前页数
*/
private int pageNum = 1;
/**
* 每页显示记录数
*/
private int pageSize = 20;
}
在 Controller 中添加分页查询方法
@PostMapping("/search")
public IPage<User> search(PageBO bo) {
return userService.page(new Page<>(bo.getPageNum(), bo.getPageSize()));
}