MyBatis 及 MyBatis Plus 纯注解方式配置(Spring Boot + Postgresql)

说明

当前的版本为

• MyBatis 3.5.9
• MyBatis Plus 3.5.1
• Spring Boot 2.6.4
• Postgresql 42.3.3

与 Spring Boot 结合使用 MyBatis

以下说明Spring Boot下完全以注解方式进行的配置, 覆盖大部分功能场景

项目依赖

需要以下的依赖, 版本由Spring Boot指定, 或者参考上面的版本号

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

配置

1.增加 MapperScan 注解

这个注解可以和@SpringBootApplication放在一起, 也可以放在单独的一个 @Configuration

@SpringBootApplication
@MapperScan(basePackages = "com.yourdomain.demo.commons.impl.mapper")
public class CommonsBoot {
    public static void main(String[] args) {
        SpringApplication.run(CommonsBoot.class, args);
    }
}

2. 准备POJO(PO或者DTO)

public class RoleItemDTO {
    private Integer id;
    private int roleId;
    private int itemId;
    private Date createTime;

    // getters and setters
    // ...
}

3. 准备Mapper

Mapper必须位于 @MapperScan 指定的包路径, 其中 @Repository 用于指定 Bean 名称, 内部用 @Select @Update @Delete @Insert 等编写对应操作的SQL

@Repository("roleItemMapper")
public interface RoleItemMapper {

    @Select("SELECT * FROM test_role_item WHERE role_id = #{roleId}")
    List<RoleItemDTO> listByRoleId(@Param("roleId") int roleId);
}

4. 调用

测试用例

@ExtendWith(SpringExtension.class)
@SpringBootTest
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
public class RoleItemTest {
    private static final Logger log = LoggerFactory.getLogger(RoleItemTest.class);

    @Resource
    private RoleItemMapper roleItemMapper;

    @Test
    @Order(1)
    void insert() {
        RoleItemDTO rc = new RoleItemDTO();
        rc.setItemId(1);
        rc.setRoleId(2);
        rc.setCreateTime(new Date());
        Assertions.assertThat(roleItemMapper.insert(rc)).isEqualTo(1);
        List<RoleItemDTO> dummies = roleItemMapper.listByRoleId(2);
        log.info(JacksonUtil.compress(dummies));
        Assertions.assertThat(dummies).isNotNull();

    }
}

注解使用

典型用例

public interface VillageMapper {
    @R