README.md · amell/fastmybatis

# fastmybatis

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

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

- 零配置快速上手，无需依赖Spring
- 无需编写xml文件即可完成增删改查操作
- 支持mysql、sqlserver、oracle、postgresql、sqlite、StarRocks（原DorisDB）
- 支持自定义sql，对于基本的增删改查不需要写SQL，对于其它特殊SQL（如统计SQL）可写在xml中
- 支持与spring-boot集成，依赖starter即可
- 支持插件编写
- 支持ActiveRecord模式
- 支持多租户
- 提供通用Service
- API丰富，多达40+方法，满足日常开发需求
- 轻量级，无侵入性，是官方mybatis的一种扩展

[fastmybatis与MyBatis generator对比](https://gitee.com/durcframework/fastmybatis/wikis/pages?sort_id=437962&doc_id=117805)

# 快速开始（无Spring）

maven依赖：

```xml
<dependency>
    <groupId>net.oschina.durcframework</groupId>
    <artifactId>fastmybatis-core</artifactId>
    <version>最新版本</version>
</dependency>
```

```java
public static void main(String[] args) {
    // 启动加载
    Fastmybatis.create()
        // 指定mybatis-config.xml文件classpath路径
        .configLocation("mybatis/mybatis-config.xml")
        // 指定mybatis sql文件classpath目录
        .mapperLocations("mybatis/mapper")
        // 指定Mapper接口package
        .basePackage("com.myapp.dao")
        .load();

// 使用mapper
    TUser user = Mappers.run(TUserMapper.class, mapper -> {
        return mapper.getById(6);
    });
    System.out.println(user);
}
```

更多例子参考：[fastmybatis-demo-standard](./fastmybatis-demo/fastmybatis-demo-standard)

# 快速开始（springboot）

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

```
<dependency>
    <groupId>net.oschina.durcframework</groupId>
    <artifactId>fastmybatis-spring-boot-starter</artifactId>
    <version>最新版本</version>
</dependency>
```

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

- 增删改查例子

假设数据库有张`t_user`表，添加对应的实体类`TUser.java`和Mapper类`TUserMapper.java`

```java
/**
 * 增删改查例子
 */
@RestController
public class CrudController {

@Autowired
    private UserService userService;

/**
     * 分页查询
     * http://localhost:8080/user/page?id=10
     * http://localhost:8080/user/page?pageIndex=1&pageSize=5
     *
     * @param param
     * @return
     */
    @GetMapping("/user/page")
    public Result<PageInfo<TUser>> page(UserParam param) {
        Query query = param.toQuery();
        PageInfo<TUser> pageInfo = userService.page(query);
        return Result.ok(pageInfo);
    }

/**
     * 新增记录，这里为了方便演示用了GET方法，实际上应该使用POST
     * http://localhost:8080/user/save?username=jim
     *
     * @param user
     * @return
     */
    @GetMapping("/user/save")
    public Result<Integer> save(TUser user) {
        userService.saveIgnoreNull(user);
        // 返回添加后的主键值
        return Result.ok(user.getId());
    }

/**
     * 修改记录，这里为了方便演示用了GET方法，实际上应该使用POST
     * http://localhost:8080/user/update?id=10&username=jim
     *
     * @param user 表单数据
     * @return
     */
    @GetMapping("/user/update")
    public Result<?> update(TUser user) {
        userService.updateIgnoreNull(user);
        return Result.ok();
    }

/**
     * 删除记录，这里为了方便演示用了GET方法，实际上应该使用DELETE
     * http://localhost:8080/user/delete?id=10
     *
     * @param id 主键id
     * @return
     */
    @GetMapping("/user/delete")
    public Result<?> delete(Integer id) {
        userService.deleteById(id);
        return Result.ok();
    }
}
```

- UserService.java

```java
// 实现通用接口
@Service
public class UserService implements CommonService<TUser/*实体类*/, Integer/*主键类型*/, TUserMapper/*Mapper*/> {

}
```

- TUserMapper.java

```java
public interface TUserMapper extends CrudMapper<TUser/*实体类*/, Integer/*主键类型*/> {

}
```

service和mapper不用写一行代码就能实现各种数据库操作，非常方便。

<details>
<summary>Mapper方法列表</summary>

| 方法                                                                                          | 说明                                          | 
|:--------------------------------------------------------------------------------------------|:--------------------------------------------|
| `E getByColumn(String column, Object value)`                                                | 根据字段查询一条记录                                  |
| `E getById(I id)`                                                                           | 根据主键查询                                      |
| `E getByQuery(Query query)`                                                                 | 根据条件查找单条记录                                  |
| `E getBySpecifiedColumns(List<String> columns, Query query)`                                | 查询单条数据并返回指定字段                               |
| `<T> T getBySpecifiedColumns(List<String> columns, Query query, Class<T> clazz)`            | 查询单条数据返回指定字段并转换到指定类中                        | 
| `<T> T getColumnValue(String column, Query query, Class<T> clazz)`                          | 查询某一行某个字段值                                  | 
| `long getCount(Query query)`                                                                | 查询总记录数                                      |    
| `List<E> list(Query query)`                                                                 | 查询结果集                                       |     
| `List<E> listByArray(String column, Object[] values)`                                       | 根据多个字段值查询结果集                                | 
| `List<E> listByCollection(String column, Collection<?> values)`                             | 根据字段多个值查询结果集                                | 
| `List<E> listByColumn(String column, Object value)`                                         | 根据字段查询结果集                                   |   
| `List<E> listByIds(Collection<I> ids)`                                                      | 根据多个主键查询                                    |    
| `List<E> listBySpecifiedColumns(List<String> columns, Query query)`                         | 查询返回指定的列，返回实体类集合                            |
| `<T> List<T> listBySpecifiedColumns(List<String> columns, Query query, Class<T> clazz)`     | 查询返回指定的列，返指定类集合                             | 
| `<T> List<T> listColumnValues(String column, Query query, Class<T> clazz)`                  | 查询指定列，返指定列集合                                |   
| `PageInfo<E> page(Query query)`                                                             | 分页查询                                        |         
| `<R> PageInfo<R> page(Query query, Function<E, R> converter)`                               | 查询结果集，并转换结果集中的记录，转换处理每一行                    |
| `<R> PageInfo<R> page(Query query, Supplier<R> target, Consumer<R> format)`                 | 查询结果集，并转换结果集中的记录，并对记录进行额外处理                 |
| `<T> PageInfo<T> page(Query query, Supplier<T> target)`                                     | 查询结果集，并转换结果集中的记录                            |       
| `<R> PageInfo<R> pageAndConvert(Query query, Function<List<E>, List<R>> converter)`         | 查询结果集，并转换结果集中的记录，转换处理list                   |    
| `<T> PageInfo<T> pageBySpecifiedColumns(List<String> columns, Query query, Class<T> clazz)` | 查询返回指定的列，返回分页数据                             |        
| `PageEasyui<E> pageEasyui(Query query)`                                                     | 查询返回easyui结果集                               |             
| `<T> PageEasyui<T> pageEasyui(Query query, Class<T> clazz)`                                 | 查询返回easyui结果集，并转换结果集中的记录                    |      
| `E forceById(I id)`                                                                         | 根据主键查询强制查询，忽略逻辑删除字段                         |     
| `int save(E entity)`                                                                        | 保存，保存所有字段                                   |           
| `int saveBatch(Collection<E> entitys)`                                                      | 批量保存                                        |              
| `int saveIgnoreNull(E entity)`                                                              | 保存，忽略null字段                                 |            
| `int saveMultiSet(Collection<E> entitys)`                                                   | 批量保存,兼容更多的数据库版本,忽略重复行，此方式采用union的方式批量insert |
| `int saveOrUpdate(E entity)`                                                                | 保存或修改，当数据库存在记录执行UPDATE，否则执行INSERT           |     
| `int saveOrUpdateIgnoreNull(E entity)`                                                      | 保存或修改，忽略null字段，当数据库存在记录执行UPDATE，否则执行INSERT  |    
| `int saveUnique(Collection<E> entitys)`                                                     | 批量保存，去除重复行，通过对象是否相对判断重复数据，实体类需要实现equals方法   |
| `int saveUnique(Collection<E> entitys, Comparator<E> comparator)`                           | 批量保存，去除重复行，指定比较器判断                          |           
| `int update(E entity)`                                                                      | 更新，更新所有字段                                   |                 
| `int updateByQuery(E entity, Query query)`                                                  | 根据条件更新                                      |                   
| `int updateIgnoreNull(E entity)`                                                            | 更新，忽略null字段                                 |                  
| `int updateByMap(Map<String, Object> map, Query query)`                                     | 根据条件更新，map中的数据转化成update语句set部分，key为数据库字段名   |      
| `int delete(E entity)`                                                                      | 删除，在有逻辑删除字段的情况下，做UPDATE操作                   | 
| `int deleteByColumn(String column, Object value)`                                           | 根据指定字段值删除，在有逻辑删除字段的情况下，做UPDATE操作            |
| `int deleteById(I id)`                                                                      | 根据id删除，在有逻辑删除字段的情况下，做UPDATE操作               |   
| `int deleteByIds(Collection<I> ids)`                                                        | 根据多个主键id删除，在有逻辑删除字段的情况下，做UPDATE操作           | 
| `int deleteByQuery(Query query)`                                                            | 根据条件删除，在有逻辑删除字段的情况下，做UPDATE操作               |  
| `int forceDelete(E entity)`                                                                 | 强制删除（底层根据id删除），忽略逻辑删除字段，执行DELETE语句          |
| `int forceDeleteById(I id)`                                                                 | 根据id强制删除，忽略逻辑删除字段，执行DELETE语句                |    
| `int forceDeleteByQuery(Query query)`                                                       | 根据条件强制删除，忽略逻辑删除字段，执行DELETE语句                |   
| `<K> Map<K, E> getMap(Query query, Function<E, K> keyGetter)`                               | 查询结果并转换成Map对象                               |
| `<T extends TreeNode<T, I>> List<T> listTreeData(Query query, I rootId)`                    | 查询列表并将结果转换成树结构                              |

</details>

# 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);

分页查询：
PageInfo<TUser> pageInfo = mapper.page(query);

List<TUser> list = pageInfo.getList(); // 结果集
long total = pageInfo.getTotal(); // 总记录数
int pageCount = pageInfo.getPageCount(); // 共几页
```

or条件查询：

```java
// WHERE id = ? OR username = ?
Query query = new Query()
    .eq("id", 6)
    .orEq("username", "jim");
```

子条件查询示例：

```java
// WHERE (id = ? OR id between ? and ?) AND ( money > ? OR state = ? )
Query query = new Query()
    .and(q -> q.eq("id", 3).orBetween("id", 4, 10))
    .and(q -> q.gt("money", 1).orEq("state", 1));

// WHERE ( id = ? AND username = ? ) OR ( money > ? AND state = ? )
Query query = new Query()
    .and(q -> q.eq("id", 3).eq("username", "jim"))
    .or(q -> q.gt("money", 1).eq("state", 1));
```

# 工程介绍

- [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-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) 生成代码

# 相关文档

- [开发文档](https://durcframework.gitee.io/fastmybatis/)
- [fastmybatis与MyBatis generator对比](https://gitee.com/durcframework/fastmybatis/wikis/pages?sort_id=437962&doc_id=117805)

amell/fastmybatis

简介

发行版

贡献者

近期动态

amell/fastmybatis .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

amell/fastmybatis