# easymybatis

**Repository Path**: weirdor/easymybatis

## Basic Information

- **Project Name**: easymybatis
- **Description**: 一个mybatis增强类库，目标为让mybatis开发更简单。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 34
- **Created**: 2017-09-08
- **Last Updated**: 2022-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 简单介绍
easymybatis是一个mybatis增强类库，目的为简化mybatis的开发，让开发更高效。easymybatis的特性如下：

- 无需编写xml文件即可完成CRUD操作。
- 支持多表查询、聚合查询、分页查询（支持多种数据库）。
- 支持批量添加，指定字段批量添加。
- 支持Dao层访问控制，如某个dao只有查询功能，某个dao有crud功能等。
- 支持自定义sql，sql语句可以写在配置文件中，同样支持mybatis标签。
- 支持mysql，sqlserver，oracle，其它数据库扩展方便（增加一个模板文件即可）。
- 使用方式不变，与Spring集成只改了一处配置。
- 轻量级，无侵入性，可与传统mybatis用法共存。
- 没有修改框架源码(无插件)，采用动态代码生成实现功能。

## 架构组成
easymybatis的架构如下：

![架构](https://git.oschina.net/uploads/images/2017/0905/135741_c7821a5b_332975.png "em_arc.png")

## 运行流程
easymybatis的运行流程图：

![运行流程](https://git.oschina.net/uploads/images/2017/0905/135821_508ba7cc_332975.png "em_flow.png")


1. 服务器启动的时候easymybatis负责扫描Dao.java。
2. 扫描完成后解析出Dao.class以及实体类Entity.class。
3. 代码生成组件根据Dao.class和Entity.class生成mapper文件内容，生成方式由velocity模板指定。
4. 把mapper文件内容转化成Resource对象设置到SqlSessionFactory中。

## 快速上手
- 一. 第一步自行搭建一个mybatis的项目，并且使用spring-mybatis插件
- 二. pom.xml加入easymybatis依赖
```xml
<dependency>
	<groupId>net.oschina.durcframework</groupId>
	<artifactId>easymybatis</artifactId>
	<version>最新版本</version>
</dependency>
```

- 三. 替换org.mybatis.spring.SqlSessionFactoryBean

```xml
<!-- 替换SqlSessionFactoryBean -->
<bean id="sqlSessionFactory"
	class="net.oschina.durcframework.easymybatis.ext.SqlSessionFactoryBeanExt">
	<property name="dataSource" ref="dataSource" />
	<property name="configLocation">
		<value>classpath:mybatis/mybatisConfig.xml</value>
	</property>
	<property name="mapperLocations">
		<list>
			<value>classpath:mybatis/mapper/*.xml</value>
		</list>
	</property>

	<!-- dao所在的包名,跟MapperScannerConfigurer的basePackage一致 
		多个用;隔开
	-->
	<property name="basePackage" value="com.myapp.dao" />
	
</bean>
```

- 四. 新建一个实体类，在实体类中加入JPA注解，因为需要通过注解来解析出数据库的一些信息，注解会在**流程3**中用到

```java
@Table(name = "t_user")
public class TUser {
	@Id
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	private Integer id;
	
	@Column(name = "username")
	private String username;

	// 省略get set
}

```
在实际项目中手动写实体类是不现实的，需要配合代码生成工具，easymybatis对应的代码生成工具链接：
[代码生成器](http://git.oschina.net/durcframework/easymybatis-generator)
。其实这个代码生成工具不是必须的，如果您有一个工具能生成hibernate实体类的话也是可行的。

- 五. 最后新建一个Dao继承CrudDao，表示这个dao具有CRUD功能

```
public interface TUserDao extends CrudDao<TUser> {
}
```

接下来就可进行编码测试了

```java
@Resource
TUserDao dao;

@Test
public void testGet() {
	TUser user = dao.get(3);
	print(user);
}
```

更多例子可参考[TUserDaoTest.java](https://git.oschina.net/durcframework/easymybatis/wikis/pages?title=TUserDaoTest.java&parent=)。重点关注Dao，Query对象即可。


如果您不想从头开始搭项目的话，这里有个搭建好的demo项目可以为您使用。

- [springboot](http://git.oschina.net/durcframework/easymybatis-springboot)
- [springmvc](http://git.oschina.net/durcframework/easymybatis-springmvc)

两个版本，一个是基于springboot，一个是传统springmvc，推荐springboot。

## 意见交流
如果您在使用的过程中遇到问题的话可以加入QQ群328419269进行提问。

## 完整测试用例

```
/**
 * dao测试
 */
public class TUserDaoTest extends EasymybatisSpringbootApplicationTests {

	@Resource
	TUserDao dao;
	@Resource
	TransactionTemplate transactionTemplate;
	
	// 根据主键查询
	@Test
	public void testGet() {
		TUser user = dao.get(3);
		print(user);
	}
	
	// 根据字段查询一条记录
	@Test
	public void testGetByProperty() {
		TUser user = dao.getByProperty("username", "王五");
		print(user);
	}
	
	// 根据条件查询一条记录
	@Test
	public void testGetByExpression() {
		// 查询ID=3的用户
		Query query = Query.build().eq("id", 3);
		
		TUser user = dao.getByExpression(query);
		
		print(user);
	}
	
	// 条件查询
	// 查询username='张三'的用户
	@Test
	public void testFind() {
		Query query = new Query();
		// 添加查询条件
		query.eq("username", "张三");
		
		List<TUser> list = dao.find(query); // 获取结果集
		long count = dao.countTotal(query); // 获取总数
		print("count:" + count);
		for (TUser user : list) {
			System.out.println(user);
		}
	}
	
	// 分页查询
	/*MYSQL语句:
	 * 
	 * SELECT t.`id` , t.`username` , t.`state` , t.`isdel` , t.`remark` , t.`add_time` , t.`money` , t.`left_money` 
	 * FROM `t_user` t 
	 * ORDER BY id DESC 
	 * LIMIT ?,? 
	 * 
	 * Parameters: 2(Integer), 2(Integer)
	 */
	@Test
	public void testPage() {
		Query query = new Query();
		
		query.setPage(2, 2) // 设置pageIndex，pageSize
			.addSort("id", Sort.DESC); // 添加排序
		
		// 查询后的结果，包含总记录数，结果集，总页数等信息
		PageInfo<TUser> pageInfo = QueryUtils.query(dao, query);
		
		List<TUser> rows = pageInfo.getList();
		for (TUser user : rows) {
			System.out.println(user);
		}
	}
	
	// 自定义返回字段查询，只返回两个字段
	// SELECT t.id,t.username FROM `t_user` t LIMIT 0,10
	@Test
	public void testSelfColumns() {
		Query query = new Query();
		// 只返回id,username
		query.setColumns(Arrays.asList("t.id","t.username"));
		
		List<TUser> list = dao.find(query);
		
		for (TUser user : list) {
			System.out.println(user);
		}
	}
	
	// 多表查询,left join
	// 适用场景：获取两张表里面的字段信息返回给前端
	/* 
	 *  MYSQL生成如下sql:
		SELECT 
			t.`id` , t.`username` , t.`state` , t.`isdel` , t.`remark` , t.`add_time` , t.`money` , t.`left_money` 
			, t2.city , t2.address 
		FROM `t_user` t left join user_info t2 on t.id = t2.user_id 
		WHERE t2.id = ?
		ORDER BY id ASC 
		LIMIT ?,?
	 */
	@Test
	public void testJoin() {
		Query query = new Query();
		// 添加第二张表的字段,跟主表字段一起返回
		query.addOtherColumns(
					"t2.city"
					,"t2.address"
		);
		// 左连接查询,主表的alias默认为t
		query.join("left join user_info t2 on t.id = t2.user_id"); 
		//添加条件
		query.eq("t2.id", 2);
		
		query.addSort("t.id");
		
		List<TUser> list = dao.find(query);
		
		System.out.println("==============");
		for (TUser user : list) {
			System.out.println(
				user.getId() 
				+ " " + user.getUsername() 
				// 下面两个字段是第二张表里面的
				+ " " + user.getCity() 
				+ " " + user.getAddress()
			);
		}
		System.out.println("==============");
	}
	
	/*
	 * 聚合查询
	 * 按state分组统计money和,并且按照state升序
	 * 并且money大于200的state
	 * 
	 * SELECT 
	 * 	state AS s , SUM(money) AS m 
	 * FROM `t_user` t 
	 * WHERE money > 0
	 * GROUP BY state 
	 * HAVING m > 200
	 * ORDER BY state asc
	 */
	@Test
	public void testProjection() {

		ProjectionQuery query = new ProjectionQuery();
		// 添加列
		query.addProjection(Projections.column("state", "s"));
		query.addProjection(Projections.sum("money", "m"));
		// 添加where
		query.addExpression(new ValueExpression("money",">",0));
		// 添加group by
		query.addGroupBy("state");
		// 添加having
		query.addHaving(new ValueExpression("SUM(money)", ">" ,200));
		
		query.addSort("state",Sort.DESC);

		List<Map<String, Object>> list = dao.findProjection(query);

		Assert.notEmpty(list);

		print(list);
	}
	
	// 自定义sql，见TUserDao.xml
	// 注意mybatis的mapper必须跟Dao类一致
	@Test
	public void testSelfSql() {
		TUser user = dao.selectByName("张三");
		
		print(user);
	}
	
	// 添加-保存所有字段
	@Test
	public void testInsert() {
		TUser user = new TUser();
		user.setAddTime(new Date());
		user.setIsdel(false);
		user.setLeftMoney(22.1F);
		user.setMoney(new BigDecimal(100.5));
		user.setRemark("备注");
		user.setState((byte)0);
		user.setUsername("张三");
		
		dao.save(user);
		
		print("添加后的主键:" + user.getId());
		print(user);
	}
	
	// 添加-保存非空字段
	@Test
	public void testInsertIgnoreNull() {
		TUser user = new TUser();
		user.setAddTime(new Date());
		user.setIsdel(true);
		user.setMoney(new BigDecimal(100.5));
		user.setState((byte)0);
		user.setUsername("张三notnull");
		user.setLeftMoney(null);
		user.setRemark(null);
		
		dao.saveIgnoreNull(user);
		
		print("添加后的主键:" + user.getId());
		print(user);
	}
	
	// 批量添加
	/*
	 * 支持mysql,sqlserver2008。如需支持其它数据库使用saveMulti方法
	 * INSERT INTO person (id, name, age)
		VALUES
    	(1, 'Kelvin', 22),
    	(2, 'ini_always', 23);
	 */
	@Test
	public void testInsertBatch() {
		List<TUser> users = new ArrayList<>();
		
		for (int i = 0; i < 3; i++) { // 创建3个对象
			TUser user = new TUser();
			user.setUsername("username" + i);
			user.setMoney(new BigDecimal(i));
			user.setRemark("remark" + i);
			user.setState((byte)0);
			user.setIsdel(false);
			user.setAddTime(new Date());
			user.setLeftMoney(200F);
			users.add(user);
		}
		
		int i = dao.saveBatch(users); // 返回成功数
		
		System.out.println("saveBatch --> " + i);
	}
	
	/**
	 * 批量添加,兼容更多数据库版本,采用union all
	 * INSERT INTO [t_user] ( [username] , [state] , [isdel] , [remark] , [add_time] , [money] , [left_money] ) 
	 * SELECT ? , ? , ? , ? , ? , ? , ? 
	 * UNION ALL SELECT ? , ? , ? , ? , ? , ? , ? 
	 * UNION ALL SELECT ? , ? , ? , ? , ? , ? , ? 
	 */
	@Test
	public void testInsertMulti() {
		List<TUser> users = new ArrayList<>();
		
		for (int i = 0; i < 3; i++) { // 创建3个对象
			TUser user = new TUser();
			user.setUsername("username" + i);
			user.setMoney(new BigDecimal(i));
			user.setRemark("remark" + i);
			user.setState((byte)3);
			user.setIsdel(false);
			user.setAddTime(new Date());
			user.setLeftMoney(200F);
			users.add(user);
		}
		
		int i = dao.saveMulti(users); // 返回成功数
		
		System.out.println("saveMulti --> " + i);
	}
	
	// 批量添加指定字段,仅支持msyql，sqlserver2008，如需支持其它数据库使用saveMulti方法
	@Test
	public void testInsertBatchWithColumns() {
		List<TUser> users = new ArrayList<>();
		
		for (int i = 0; i < 3; i++) { // 创建3个对象
			TUser user = new TUser();
			user.setUsername("usernameWithColumns" + i);
			user.setMoney(new BigDecimal(i));
			user.setAddTime(new Date());
			
			users.add(user);
		}
		
		/*
		 * INSERT INTO `t_user` ( username , money , add_time ) 
		 * VALUES ( ? , ? , ? ) , ( ? , ? , ? ) , ( ? , ? , ? ) 
		 */
		int i= dao.saveBatchWithColumns(Arrays.asList(
				new Column("username", "username") // 第一个是数据库字段,第二个是java字段
				,new Column("money", "money")
				,new Column("add_time", "addTime")
				), users);
		
		System.out.println("saveBatchWithColumns --> " + i);
		
	}
	
	/*
	 * // 批量添加指定字段,兼容
	 * INSERT INTO [t_user] ( [username] , [money] , [add_time] ) 
	 * SELECT ? , ? , ? 
	 * UNION ALL SELECT ? , ? , ? 
	 * UNION ALL SELECT ? , ? , ? 
	 */
	@Test
	public void testInsertMultiWithColumns() {
		List<TUser> users = new ArrayList<>();
		
		for (int i = 0; i < 3; i++) { // 创建3个对象
			TUser user = new TUser();
			user.setUsername("usernameWithColumns" + i);
			user.setMoney(new BigDecimal(i));
			user.setAddTime(new Date());
			
			users.add(user);
		}
		
		int i= dao.saveMultiWithColumns(Arrays.asList(
				new Column("username", "username") // 第一个是数据库字段,第二个是java字段
				,new Column("money", "money")
				,new Column("add_time", "addTime")
				), users);
		
		System.out.println("saveMultiWithColumns --> " + i);
	}
	
	// 事务回滚
	@Test
	public void testUpdateTran() {
		TUser user = transactionTemplate.execute(new TransactionCallback<TUser>() {
			@Override
			public TUser doInTransaction(TransactionStatus arg0) {
				try{
					TUser user = dao.get(3);
					user.setUsername("王五1");
					user.setMoney(user.getMoney().add(new BigDecimal(0.1)));
					user.setIsdel(true);
					
					int i = dao.update(user);
					print("testUpdate --> " + i);
					int j = 1/0; // 模拟错误
					return user;
				}catch(Exception e) {
					e.printStackTrace();
					arg0.setRollbackOnly();
					return null;
				}
			}
			
		});
		
		print(user);
	}
	
	// 更新所有字段
	@Test
	public void testUpdate() {
		TUser user = dao.get(3);
		user.setUsername("李四");
		user.setMoney(user.getMoney().add(new BigDecimal(0.1)));
		user.setIsdel(true);
		
		int i = dao.update(user);
		print("testUpdate --> " + i);
	}
	
	// 更新不为null的字段
	/*
	 *UPDATE [t_user] SET [username]=?, [isdel]=? WHERE [id] = ?  
	 */
	@Test
	public void updateIgnoreNull() {
		TUser user = new TUser();
		user.setId(3);
		user.setUsername("王五");
		user.setIsdel(false);
		int i = dao.updateIgnoreNull(user);
		print("updateNotNull --> " + i);
	}
	
	// 根据条件更新
	// UPDATE t_user SET remark = '批量修改备注' WHERE state = 0
	@Test
	public void testUpdateNotNullByExpression() {
		Query query = new Query();
		query.eq("state", 0);
		
		TUser user = new TUser();
		user.setRemark("批量修改备注");
		
		int i = dao.updateIgnoreNullByExpression(user, query);
		print("testUpdateNotNullByExpression --> " + i);
	}
	
	// 删除
	@Test
	public void testDel() {
		TUser user = new TUser();
		user.setId(14);
		int i = dao.del(user);
		print("del --> " + i);
	}
	
	// 根据条件删除
	// DELETE FROM `t_user` WHERE state = ? 
	@Test
	public void delByExpression() {
		Query query = new Query();
		query.eq("state", 3);
		int i = dao.delByExpression(query);
		print("delByExpression --> " + i);
	}
	
}
```