# fastmybatis

**Repository Path**: signupg/fastmybatis

## Basic Information

- **Project Name**: fastmybatis
- **Description**: 一个mybatis开发框架，其宗旨为：简单、快速、有效
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://durcframework.gitee.io/fastmybatis/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 139
- **Created**: 2021-08-18
- **Last Updated**: 2021-08-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# fastmybatis

![maven](https://img.shields.io/maven-central/v/net.oschina.durcframework/fastmybatis-core)

fastmybatis是一个mybatis开发框架，其宗旨为：简单、快速、有效。

- 零配置快速上手
- 无需编写xml文件即可完成CRUD操作
- 支持mysql、sqlserver、oracle、postgresql、sqlite
- 支持自定义sql，对于基本的增删改查不需要写SQL，对于其它特殊SQL（如统计SQL）可写在xml中
- 支持与spring-boot集成，依赖starter即可
- 支持插件编写
- 轻量级，无侵入性，是官方mybatis的一种扩展

[fastmybatis与MyBatis generator对比](https://gitee.com/durcframework/fastmybatis/wikis/pages?title=fastmybatis%E4%B8%8EMyBatis%20generator%E5%AF%B9%E6%AF%94&parent=)


# 快速开始（springboot）

- 新建一个springboot项目
- pom.xml添加fastmybatis-spring-boot-starter

```
<dependency>
    <groupId>net.oschina.durcframework</groupId>
    <artifactId>fastmybatis-spring-boot-starter</artifactId>
    <version>最新版本（见changelog.md）</version>
</dependency>
```
- 假设数据库有张`t_user`表，添加对应的实体类`TUser.java`和Mapper`TUserMapper.java`
- 在`application.propertis`中配置数据库连接
- 编写测试用例

```
@Autowired
TUserMapper mapper;
    
// 根据主键查询
@Test
public void testGetById() {
    TUser user = mapper.getById(3);
    System.out.println(user);
}
```

# Mapper方法列表

```
/**
 * 根据主键查询
 * 
 * @param id
 * @return 返回实体对象，没有返回null
 */
T getById(I id);

/**
 * 根据条件查找单条记录
 * @param query 查询条件
 * @return 返回实体对象，没有返回null
 */
T getByQuery(@Param("query")Query query);

/**
 * 根据字段查询一条记录
 * @param column 数据库字段名
 * @param value 字段值
 * @return 返回实体对象，没有返回null
 */
T getByColumn(@Param("column")String column,@Param("value")Object value);

/**
 * 查询总记录数
 * 
 * @param query 查询条件
 * @return 返回总记录数
 */
long getCount(@Param("query")Query query);  

/**
 * 根据字段查询集合
 * @param column 数据库字段名
 * @param value 字段值
 * @return 返回实体对象集合，没有返回空集合
 */
List<T> listByColumn(@Param("column")String column, @Param("value")Object value);

/**
 * 分页查询
 * @param query 查询条件
 * @return 返回分页信息
 */
PageInfo<T> page(Query query)

/**
 * 条件查询
 * 
 * @param query 查询条件
 * @return 返回实体对象集合，没有返回空集合
 */
List<T> list(@Param("query")Query query);

/**
 * 查询指定字段结果，返回实体类集合
 * @param columns 指定字段
 * @param query 查询条件
 * @return 返回实体类集合，没有则返回空list
 */
List<E> listBySpecifiedColumns(List<String> columns, Query query) 

/**
 * 新增,新增所有字段
 * 
 * @param entity
 * @return 受影响行数
 */
int save(T entity);

/**
 * 新增（忽略null数据）
 * @param entity
 * @return 受影响行数
 */
int saveIgnoreNull(T entity);

/**
 * 批量添加,只支持mysql,sqlserver2008及以上数据库.<br>
 * <strong>若要兼容其它版本数据库,请使用saveMulti()方法</strong>
 * @param entitys
 * @return
 */
int saveBatch(@Param("entitys")List<T> entitys);

/**
 * 批量保存,兼容更多的数据库版本.<br>
 * 此方式采用union all的方式批量insert,如果是mysql或sqlserver2008及以上推荐saveBatch()方法.
 * 
 * @param entitys
 * @return 受影响行数
 */
int saveMulti(@Param("entitys") List<T> entitys);

/**
 * 修改,修改所有字段
 * 
 * @param entity
 * @return 受影响行数
 */
int update(T entity);

/**
 * 根据主键更新不为null的字段
 * 
 * @param entity
 * @return 受影响行数
 */
int updateIgnoreNull(T entity);

/**
 * 根据条件批量更新
 * 
 * @param entity 待更新的数据，可以是实体类，也可以是Map{@literal<String,Object>}
 * @param query 更新条件
 * @return 受影响行数
 */
int updateByQuery(@Param("entity") Object entity, @Param("query") Query query);

/**
 * 删除
 * 
 * @param entity
 * @return 受影响行数
 */
int delete(T entity);

/**
 * 根据id删除
 * 
 * @param id 主键id
 * @return 受影响行数
 */
int deleteById(I id);

/**
 * 根据条件删除
 * 
 * @param query
 * @return 受影响行数
 */
int deleteByQuery(@Param("query")Query query);
```

# Query查询对象

```
查询姓名为张三，并且年龄为22岁的用户：
Query query = new Query().eq("username","张三").eq("age",22);
List<User> users = mapper.list(query);

查询年龄为10,20,30的用户：
Query query = new Query().in("age",Arrays.asList(10,20,30));
List<User> users = mapper.list(query);

查询注册日期大于2017-11-11的用户：
Date regDate = ...
Query query = new Query().gt("reg_date",regDate);
List<User> users = mapper.list(query);

查询性别为男的，年龄大于等于20岁的用户，按年龄降序：
Query query = new Query().eq("gender",1).ge("age",20).orderby("age",Sort.DESC);
List<User> users = mapper.list(query);

分页查询：
Query query = new Query().eq("age",10).page(1,10); // 第一页，每页10条数据
List<User> users = mapper.list(query);

查询总记录数：
Query query = new Query().eq("age",10).page(1,10); // 第一页，每页10条数据
long total = mapper.getCount(query); // 该条件下总记录数
```

- 完整的测试用例，[点击前往](https://gitee.com/durcframework/fastmybatis/wikis/pages?title=%E5%AE%8C%E6%95%B4%E6%B5%8B%E8%AF%95%E7%94%A8%E4%BE%8B&parent=)

# 工程介绍

- [fastmybatis-core](https://gitee.com/durcframework/fastmybatis/tree/master/fastmybatis-core)：框架源代码
- [fastmybatis-demo](https://gitee.com/durcframework/fastmybatis/tree/master/fastmybatis-demo)：对应demo（推荐运行：fastmybatis-demo-springboot）
- [fastmybatis-generator](https://gitee.com/durcframework/fastmybatis/tree/master/fastmybatis-generator)：代码生成工具，方便生成实体类和Mapper（可生成lombok风格实体类）
- [fastmybatis-spring-boot-starter](https://gitee.com/durcframework/fastmybatis/tree/master/fastmybatis-spring-boot-starter)：springboot对应的的starter
- [fastmybatis-doc](https://gitee.com/durcframework/fastmybatis/tree/master/fastmybatis-doc)：开发文档离线版

利用 [code-gen](https://gitee.com/durcframework/code-gen) 生成代码，详见：[code-gen模板](https://gitee.com/durcframework/code-gen/wikis/pages?sort_id=3410052&doc_id=27724)

# 意见交流

Q群167643071

# 相关文档

- [开发文档](https://durcframework.gitee.io/fastmybatis/)
- [fastmybatis与MyBatis generator对比](https://gitee.com/durcframework/fastmybatis/wikis/pages?title=fastmybatis%E4%B8%8EMyBatis%20generator%E5%AF%B9%E6%AF%94&parent=)
- [WIKI](https://gitee.com/durcframework/fastmybatis/wikis/pages)