mybatis-flex

English | 简体中文

# MyBatis-Flex is an elegant Mybatis Enhancement Framework.

## Features 1. MyBatis-Flex is very lightweight, and it only depends on Mybatis and no other third-party dependencies 2. Basic CRUD operator and paging query of Entity class 3. Row mapping support, you can add, delete, modify and query the database without entity classes 4. Support multiple databases, and expand through dialects flexibly 5. Support combined primary keys and different primary key content generation strategies 6. Extremely friendly SQL query, IDE automatically prompts and no worries about mistakes 7. More little surprises 8. JSpecify nullness annotations for API hints (no checker included) ## hello world(Without Spring) **step 1: write entity class** ```java @Table("tb_account") public class Account { @Id(keyType = KeyType.Auto) private Long id; private String userName; private Date birthday; private int sex; // getter setter } ``` **step 2: write mapper class(it needs extends BaseMapper)** ```java public interface AccountMapper extends BaseMapper { // only Mapper interface define } ``` **step 3: start query data** e.g. 1: query by primary key ``` … ``` e.g.2: query list ```java // use QueryWrapper to build query conditions QueryWrapper query = QueryWrapper.create() .select() .from(ACCOUNT) .where(ACCOUNT.ID.ge(100)) .and(ACCOUNT.USER_NAME.like("zhang").or(ACCOUNT.USER_NAME.like("li"))); // execute SQL： // SELECT * FROM tb_account // WHERE tb_account.id >= 100 // AND (tb_account.user_name LIKE '%zhang%' OR tb_account.user_name LIKE '%li%' ) List accounts = mapper.selectListByQuery(query); ``` e.g.3: paging query ```java // use QueryWrapper to build query conditions QueryWrapper query = QueryWrapper.create() .select() .from(ACCOUNT) .where(ACCOUNT.ID.ge(100)) .and(ACCOUNT.USER_NAME.like("zhang").or(ACCOUNT.USER_NAME.like("li"))) .orderBy(ACCOUNT.ID.desc()); // execute SQL： // SELECT * FROM tb_account // WHERE tb_account.id >= 100 // AND (tb_account.user_name LIKE '%zhang%' OR tb_account.user_name LIKE '%li%' ) // ORDER BY tb_account.id DESC // LIMIT 40,10 Page accountPage = mapper.paginate(5, 10, query); ``` ## QueryWrapper Samples ### select * ```java QueryWrapper query = new QueryWrapper(); query.select().from(ACCOUNT) // SQL: // SELECT * FROM tb_account ``` ### select columns ```java QueryWrapper query = new QueryWrapper(); query.select(ACCOUNT.ID,ACCOUNT.USER_NAME).from(ACCOUNT) // SQL: // SELECT tb_account.id, tb_account.user_name // FROM tb_account ``` ```java QueryWrapper query = new QueryWrapper() .select(ACCOUNT.ID , ACCOUNT.USER_NAME , ARTICLE.ID.as("articleId") , ARTICLE.TITLE) .from(ACCOUNT.as("a"), ARTICLE.as("b")) .where(ACCOUNT.ID.eq(ARTICLE.ACCOUNT_ID)); // SQL: // SELECT a.id, a.user_name, b.id AS articleId, b.title // FROM tb_account AS a, tb_article AS b // WHERE a.id = b.account_id ``` ### select functions ```java QueryWrapper query = new QueryWrapper() .select( ACCOUNT.ID, ACCOUNT.USER_NAME, max(ACCOUNT.BIRTHDAY), avg(ACCOUNT.SEX).as("sex_avg") ).from(ACCOUNT); // SQL: // SELECT tb_account.id, tb_account.user_name, // MAX(tb_account.birthday), // AVG(tb_account.sex) AS sex_avg // FROM tb_account ``` ### where ```java QueryWrapper queryWrapper = QueryWrapper.create() .select() .from(ACCOUNT) .where(ACCOUNT.ID.ge(100)) .and(ACCOUNT.USER_NAME.like("michael")); // SQL: // SELECT * FROM tb_account // WHERE tb_account.id >= ? // AND tb_account.user_name LIKE ? ``` ### exists, not exists ```java QueryWrapper queryWrapper = QueryWrapper.create() .select() .from(ACCOUNT) .where(ACCOUNT.ID.ge(100)) .and( exists( selectOne().from(ARTICLE).where(ARTICLE.ID.ge(100)) ) ); // SQL: // SELECT * FROM tb_account // WHERE tb_account.id >= ? // AND EXIST ( // SELECT 1 FROM tb_article WHERE tb_article.id >= ? // ) ``` ### and (...) or (...) ```java QueryWrapper queryWrapper = QueryWrapper.create() .select() .from(ACCOUNT) .where(ACCOUNT.ID.ge(100)) .and(ACCOUNT.SEX.eq(1).or(ACCOUNT.SEX.eq(2))) .or(ACCOUNT.AGE.in(18,19,20).or(ACCOUNT.USER_NAME.like("michael"))); // SQL: // SELECT * FROM tb_account // WHERE tb_account.id >= ? // AND (tb_account.sex = ? OR tb_account.sex = ? ) // OR (tb_account.age IN (?,?,?) OR tb_account.user_name LIKE ? ) ``` ### group by ```java QueryWrapper queryWrapper = QueryWrapper.create() .select() .from(ACCOUNT) .groupBy(ACCOUNT.USER_NAME); // SQL: // SELECT * FROM tb_account // GROUP BY tb_account.user_name ``` ### having ```java QueryWrapper queryWrapper = QueryWrapper.create() .select() .from(ACCOUNT) .groupBy(ACCOUNT.USER_NAME) .having(ACCOUNT.AGE.between(18,25)); // SQL: // SELECT * FROM tb_account // GROUP BY tb_account.user_name // HAVING tb_account.age BETWEEN ? AND ? ``` ### orderBy ```java QueryWrapper queryWrapper = QueryWrapper.create() .select() .from(ACCOUNT) .orderBy(ACCOUNT.AGE.asc(), ACCOUNT.USER_NAME.desc().nullsLast()); // SQL: // SELECT * FROM tb_account // ORDER BY age ASC, user_name DESC NULLS LAST ``` ### join ```java QueryWrapper queryWrapper = QueryWrapper.create() .select() .from(ACCOUNT) .leftJoin(ARTICLE).on(ACCOUNT.ID.eq(ARTICLE.ACCOUNT_ID)) .where(ACCOUNT.AGE.ge(10)); // SQL: // SELECT * FROM tb_account // LEFT JOIN tb_article // ON tb_account.id = tb_article.account_id // WHERE tb_account.age >= ? ``` ### limit... offset ``` … ``` ### Questions？ **1. How to generate "ACCOUNT" class for QueryWrapper by Account.java ?** Build the project by IDE, or execute maven build command: `mvn clean package` ## More Samples 1. [Mybatis-Flex Only (Native)](./mybatis-flex-test/mybatis-flex-native-test) 2. [Mybatis-Flex with Spring](./mybatis-flex-test/mybatis-flex-spring-test) 3. [Mybatis-Flex with Spring boot](./mybatis-flex-test/mybatis-flex-spring-boot-test) ## Wechat Group