MyBatis-Flex 开发技能

MyBatis-Flex 是一个优雅的 MyBatis 增强框架，具有轻量、灵活、强大的特点。

文档索引

> 各模块详细文档见 references/ 目录

快速开始

<!-- 2.x: starter, 3.x: boot3-starter, 4.x: boot4-starter + jdbc -->
<dependency>
    <groupId>com.mybatis-flex</groupId>
    <artifactId>mybatis-flex-spring-boot-starter</artifactId>
    <version>1.11.7</version>
</dependency>
<dependency>
    <groupId>com.mybatis-flex</groupId>
    <artifactId>mybatis-flex-processor</artifactId>
    <version>1.11.7</version>
    <scope>provided</scope>
</dependency>

@SpringBootApplication
@MapperScan("com.your.package.mapper")
public class Application {}

> 详见 codegen-and-apt.md

Entity 速查

@Table(value = "tb_account", dataSource = "ds2")
public class Account {
    @Id(keyType = KeyType.Auto)
    private Long id;
    @Column(value = "user_name")
    private String userName;
    @Column(isLogicDelete = true)
    private Boolean isDelete;
    @Column(version = true)
    private Integer version;
    @Column(tenantId = true)
    private Long tenantId;
    @ColumnMask(Masks.MOBILE_PHONE)
    private String phone;
}

> 详见 entity-annotations.md

QueryWrapper 查询

import static com.your.package.entity.table.AccountTableDef.ACCOUNT;

QueryWrapper query = QueryWrapper.create()
    .select(ACCOUNT.ID, ACCOUNT.USER_NAME)
    .from(ACCOUNT)
    .where(ACCOUNT.AGE.ge(18))
    .and(ACCOUNT.USER_NAME.like("张"))
    .orderBy(ACCOUNT.ID.desc());

// 动态条件
query.where(ACCOUNT.AGE.ge(18).when(age != null))
    .and(ACCOUNT.USER_NAME.like(name, If::hasText));

> 详见 querywrapper-advanced.md

BaseMapper CRUD

public interface AccountMapper extends BaseMapper<Account> {}

accountMapper.insert(account);
accountMapper.selectOneById(1L);
accountMapper.selectListByQuery(query);
accountMapper.paginate(1, 10, query);
accountMapper.deleteById(1L);

// 部分字段更新
Account entity = UpdateEntity.of(Account.class, 100L);
entity.setAge(20);
accountMapper.update(entity);

> 详见 db-row-and-basemapper.md

关联查询

@RelationOneToOne(selfField = "id", targetField = "accountId")
private IDCard idCard;

@RelationOneToMany(selfField = "id", targetField = "accountId")
private List<Book> books;

@RelationManyToMany(joinTable = "tb_role_mapping",
    joinSelfColumn = "account_id", joinTargetColumn = "role_id")
private List<Role> roles;

> 详见 relations-query.md

Service 层

public interface IAccountService extends IService<Account> {}

@Component
public class AccountServiceImpl extends ServiceImpl<AccountMapper, Account>
        implements IAccountService {}

accountService.save(account);
accountService.removeById(1L);
accountService.list(ACCOUNT.AGE.ge(18));
accountService.page(new Page<>(1, 10), query);

> 详见 service-layer.md

高级特性

> 详见 advanced-features.md

最佳实践

推荐: Lambda语法、APT表定义类、分页传totalRow、when()动态条件

避免: setRaw()字符串拼接（SQL注入）、Java项目引入Kotlin模块