如何优雅地使用MyBatis-plus
mybatis
Mybatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
但mybatis有个比较头疼的一个问题是sql工作量很大，尤其是字段多的时候。虽然说单表的增删改查操作可以通过mybatis generator工具来生成（或者自己写模板工具生成），但项目开发的过程中总免不了要新添加新字段，这些工具就没多大作用，所以要么把新字段写到原来的所有增删改查的sql中，要么删了重新生成。这是个痛苦的过程，特别是当你重复了很多次之后。
mybatis-plus
而mybatis-plus这样一个框架，一种集mybatis与hibernate的优点一起的框架。它提供了hibernate的单表CRUD操作的方便同时，又保留了mybatis的特性。
先来看看官方怎么解释mybatis-plus的：
Mybatis-Plus（简称MP）是一个Mybatis的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
快速使用步骤:
1.添加pom文件依赖
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity</artifactId>
<version>1.7</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>2.0.1</version>
</dependency>
注意:mybatis-plus会自动维护mybatis以及mybatis-spring的依赖,所以不需要引入后两者,避免发生版本冲突.
2.修改配置文件
将mybatis的sqlSessionFactory替换成mybatis-plus的即可,mybatis-plus只做了一些功能的扩展:
<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean"> <property name="dataSource" ref="dataSource"/> <!-- 自动扫描Mapping.xml文件 --> <property name="mapperLocations" value="classpath:mybatis/*/*.xml"/> <property name="configLocation" value="classpath:mybatis/mybatis-config.xml"/> <property name="typeAliasesPackage" value="com.baomidou.springmvc.model.*"/> <property name="plugins"> <array> <!-- 分页插件配置 --> <bean id="paginationInterceptor" class="com.baomidou.mybatisplus.plugins.PaginationInterceptor"> <property name="dialectType" value="mysql"/> </bean> </array> </property> <!-- 全局配置注入 --> <property name="globalConfig" ref="globalConfig" /> </bean>
在上面的配置中,除了mybatis的常规配置,多了一个分页插件的配置和全局配置,mybatis-plus提供了很方便的使用分页的插件,还有一个全局配置如下:
<bean id="globalConfig" class="com.baomidou.mybatisplus.entity.GlobalConfiguration">
<!--
AUTO->`0`("数据库ID自增")
INPUT->`1`(用户输入ID")
ID_WORKER->`2`("全局唯一ID")
UUID->`3`("全局唯一ID")
-->
<property name="idType" value="2" />
<!--
MYSQL->`mysql`
ORACLE->`oracle`
DB2->`db2`
H2->`h2`
HSQL->`hsql`
SQLITE->`sqlite`
POSTGRE->`postgresql`
SQLSERVER2005->`sqlserver2005`
SQLSERVER->`sqlserver`
-->
<!-- Oracle需要添加该项 -->
<!-- <property name="dbType" value="oracle" /> -->
<!-- 全局表为下划线命名设置 true -->
<property name="dbColumnUnderline" value="true" />
</bean>至此,配置工作就算大功告成了,接下来通过一个简单的例子来感受一下它的使用.
1.新建一个User表:
@TableName("user")
public class User implements Serializable {
/** 用户ID */
private Long id;
/** 用户名 */
private String name;
/** 用户年龄 */
private Integer age;
@TableField(exist = false)
private String state;
}这里有两个注解需要注意,第一是@tableName("user"),它是指定与数据库表的关联,这里的注解意味着你的数据库里应该有一个名为user的表与之对应,并且数据表的列名应该就是User类的属性,对于User类中有而user表中没有的属性需要加第二个注解@TableField(exist = false),表示排除User类中的属性.
2.新建Dao层接口UserMapper:
/**
* User 表数据库控制层接口
*/
public interface UserMapper extends BaseMapper<User> {
@Select("selectUserList")
List<User> selectUserList(Pagination page,String state);
}dao接口需要实现Basemapper,这样就能够使用封装好的很多通用方法,另外也可以自己编写方法,@select注解引用自第三步的UserMapper文件
3.新建UserMapper配置文件:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.baomidou.springmvc.mapper.system.UserMapper">
<!-- 通用查询结果列-->
<sql id="Base_Column_List">
id, name, age
</sql>
<select id="selectUserList" resultType="User">
SELECT * FROM sys_user WHERE state=#{state}
</select>
</mapper>4.新建service层类UserService:
/**
*
* User 表数据服务层接口实现类
*
*/
@Service
public class UserService extends ServiceImpl<UserMapper, User>{
public Page<User> selectUserPage(Page<User> page, String state) {
page.setRecords(baseMapper.selectUserList(page,state));
return page;
}
}UserService继承了ServiceImpl类,mybatis-plus通过这种方式为我们注入了UserMapper,这样可以使用service层默认为我们提供的很多方法,也可以调用我们自己在dao层编写的操作数据库的方法.Page类是mybatis-plus提供分页功能的一个model,继承了Pagination,这样我们也不需要自己再编写一个Page类,直接使用即可.
5,新建controller层UserController
@Controller
public class UserController extends BaseController {
@Autowired
private IUserService userService;
@ResponseBody
@RequestMapping("/page")
public Object selectPage(Model model){
Page page=new Page(1,10);
page = userService.selectUserPage(page, "NORMAL");
return page;
}以上就完成了一个基本的功能,下面来看一下它的条件构建器.
mybatis-plus的条件构建器
首先看一个条件构建器实例的简单实用.
public void test(){
EntityWrapper ew=new EntityWrapper();
ew.setEntity(new User());
String name="wang";
Integer age=16;
ew.where("name = {0}",name).andNew("age > {0}",age).orderBy("age");
List<User> list = userService.selectList(ew);
Page page2 = userService.selectPage(page, ew);
}