mybaties-plus入門

目前正在維護的公司的一個項目是一個ssm架構的java項目,dao層的接口有大量數據庫查詢的方法,一個條件變化就要對應一個方法,再加上一些通用的curd方法,對應一張表的dao層方法有時候多達近20個,果斷決定優化一下,通過一番探索,發現了一個mybatis的好伴侶,mybatis-plus,上手容易,簡潔高效,這裏有官方的文檔入口,文檔比較詳細,原本不想在重複文檔內容,可是關上文檔,看着本身改過的項目,仍是打算在腦海裏過一下使用步驟及相關注意事項,順便記錄一下.

　MyBatis-plus有什麼特點

　　　1.代碼生成 2.條件構造器

　　　　對我而言,主要的目的是使用它強大的條件構建器.　　 

快速使用步驟:

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

　　這裏使用了一個條件包裝類EntityWrapper,來進行對sql語句的拼裝,原理也很好理解,上面的代碼中,第一個list查詢的結果就是查詢數據庫中name=wang而且age>16歲的全部記錄並按照age排序.而第二個查詢就是再多加一個分頁的功能.

　　基本上來講,使用EntityWrapper能夠簡單地完成一些條件查詢,但若是查詢方法使用頻率很高的話仍是建議本身寫在UserMapper裏.

　　那麼自定義的mapper方法能不能使用EntityWrapper呢,固然也是能夠的.

　　文檔中給了一個這樣的例子.

　　1.在Mappper中定義:

　　List<User> selectMyPage(RowBounds rowBounds, @Param("ew") Wrapper<T> wrapper);

 　　2.在mapper文件中定義:

<select id="selectMyPage" resultType="User">

　　 SELECT * FROM user ${ew.sqlSegment}

</select>

 　　對於EntityMapper的條件拼接,基本能夠實現sql中經常使用的where,and,or,groupby,orderby等語法,具體構建方法能夠靈活組合.

@Test
public void testTSQL11() { /* * 實體帶查詢使用方法 輸出看結果 */ ew.setEntity(new User(1)); ew.where("name={0}", "'zhangsan'").and("id=1") .orNew("status={0}", "0").or("status=1") .notLike("nlike", "notvalue") .andNew("new=xx").like("hhh", "ddd") .andNew("pwd=11").isNotNull("n1,n2").isNull("n3") .groupBy("x1").groupBy("x2,x3") .having("x1=11").having("x3=433") .orderBy("dd").orderBy("d1,d2"); System.out.println(ew.getSqlSegment()); }