大家好,我是鹏磊。
fastmybatis 是一个 mybatis 开发框架,其宗旨为:简单、快速、有效。零配置快速上手,无需编写 xml 文件即可完成 CRUD 操作。同时支持 mysql、sqlserver、oracle、postgresql、sqlite。
支持自定义 SQL,对于基本的增删改查不需要写 SQL,对于其它特殊 SQL(如统计 SQL )可写在 xml 中,支持与 Spring-Boot 集成,依赖 starter 即可,支持插件编写,支持 ActiveRecord 模式,提供通用 Service,轻量级,无侵入性,是官方 MyBatis 的一种扩展
快速开始(SpringBoot)
新建一个 Spring boot 项目
pom.xml 添加 fastmybatis-spring-boot-starter
<dependency>
<groupId>net.oschina.durcframework</groupId>
<artifactId>fastmybatis-spring-boot-starter</artifactId>
<version>最新版本</version>
</dependency>
增删改查例子
t_user
表,添加对应的实体类 TUser.java
和 Mapper 类TUserMapper.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
// 实现通用接口
@Service
public class UserService implements IService<TUser/*实体类*/, Integer/*主键类型*/> {
}
TUserMapper.java
public interface TUserMapper extends CrudMapper<TUser/*实体类*/, Integer/*主键类型*/> {
}
Mapper方法列表
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) | |
<T> PageInfo<T> pageBySpecifiedColumns(List<String> columns, Query query, Class<T> clazz) | |
PageEasyui<E> pageEasyui(Query query) | |
<T> PageEasyui<T> pageEasyui(Query query, Class<T> clazz) | |
E forceById(I id) | |
int save(E entity) | |
int saveBatch(Collection<E> entitys) | |
int saveIgnoreNull(E entity) | |
int saveMultiSet(Collection<E> entitys) | |
int saveOrUpdate(E entity) | |
int saveOrUpdateIgnoreNull(E entity) | |
int saveUnique(Collection<E> entitys) | |
int saveUnique(Collection<E> entitys, Comparator<E> comparator) | |
int update(E entity) | |
int updateByQuery(E entity, Query query) | |
int updateIgnoreNull(E entity) | |
int updateByMap(Map<String, Object> map, Query query) | |
int delete(E entity) | |
int deleteByColumn(String column, Object value) | |
int deleteById(I id) | |
int deleteByIds(Collection<I> ids) | |
int deleteByQuery(Query query) | |
int forceDelete(E entity) | |
int forceDeleteById(I id) | |
int forceDeleteByQuery(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); // 该条件下总记录数