SpringBoot2.0实战 | 第十二章：整合MybatisPlus

目标

在第二章：SpringBoot集成SpringBootJPA完成CURD 的代码基础上，
替换 spring-data-jpa 为 mybatis-plus，熟悉在 mybatis-plus 下实现单表数据的CURD编码

操作步骤

添加依赖

引入 Spring Boot Starter 父工程

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.5.RELEASE</version>
</parent>

添加 mybatis-plus 的依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.2.0</version>
</dependency>

添加后的整体依赖如下，在原来的基础上去除了对 spring-boot-starter-data-jpa 的依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-tomcat</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

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

    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>

    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <scope>provided</scope>
    </dependency>

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

    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.2.0</version>
    </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

编码

Entity 层代码

类上添加注解 @TableName，如果表名与实体名不一致，可自行设置
主键添加注解 @TableId，可设置主键生成规则，本例使用 AUTO，表示使用数据库自增
- AUTO 数据库自增
- INPUT 自行输入
- ID_WORKER 分布式全局唯一ID 长整型类型
- UUID 32位UUID字符串
- NONE 无状态(默认值)
- ID_WORKER_STR 分布式全局唯一ID 字符串类型
日期格式添加注解 @DateTimeFormat(pattern = “yyyy-MM-dd”)，用于定义前端入参格式

@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;

}

Repository 层代码

Mybatis-plus 提供的 BaseMapper 接口已经实现了对单表的增删查改操作以及一些其它常用的方法，可以同使用 JPA 接口一样直接调用，而不用去 mybatis 的配置文件中编写 SQL。

创建接口 UserRepository，继承 BaseMapper 接口，内容如下

接口上添加 @Mapper 注解是为了让 mybatis 自行扫描，也可以通过在启动类上添加 @MapperScan 注解进行代替

@Mapper
public interface UserRepository extends BaseMapper<User> {
}

Service 层代码

创建接口 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 层代码

创建 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()));
}

死牛胖子

发布了153 篇原创文章 · 获赞 22 · 访问量 10万+

私信关注