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. 修改配置文件
1)將mybatis的sqlSessionFactory替換成mybatis-plus的即可,mybatis-plus只做了一些功能的擴展:
<beanid="sqlSessionFactory" class="com.baomidou.mybatisplus.spring.MybatisSqlSessionFactoryBean"> <property name="dataSource" ref="pooledDataSource"/> <!-- 配置實體掃描路徑,多個package可以用分號;逗號,分隔,支持通配符* --> <!-- com.a.b.entity;com.a.c.entity;com.d.*.entity--> <!-- <property name="typeAliasesPackage" value="com.atguigu.crud.bean"/>--><!-- 暫時取消 --> <!-- XML配置 --> <property name="mapperLocations" value="classpath:mapping/**Mapper.xml" /> <!-- MP全局配置 --> <property name="configuration" ref="mybatisConfig"/> <!-- MP全局策略 --> <property name="globalConfig" ref="globalConfig"/> <property name="plugins"> <array> <!-- 分頁插件配置 --> <bean id="paginationInterceptor" class="com.baomidou.mybatisplus.plugins.PaginationInterceptor"> <!-- <property name="sqlParser" ref="自定義解析類、可以沒有" /> --> <property name="localPage" value="true" /><!-- 默認 false 改為 true 開啟了 pageHeper 支持、可以沒有 --> <!-- <property name="dialectClazz" value="自定義方言類、可以沒有" /> --> </bean> <!-- 樂觀鎖插件 --> <bean id="optimisticLockerInterceptor" class="com.baomidou.mybatisplus.plugins.OptimisticLockerInterceptor"></bean> <!-- 性能攔截器,兼打印sql,不生產環境配置 --> <bean id="performanceInterceptor" class="com.baomidou.mybatisplus.plugins.PerformanceInterceptor"> <!-- SQL 執行最大時長,超過自動停止運行,有助於發現問題。 --> <property name="maxTime" value="100"></property> <!-- SQL 是否格式化 --> <property name="format" value="false"></property> </bean> </array> </property> </bean>
2)MP全局配置
<bean id="mybatisConfig" class="com.baomidou.mybatisplus.MybatisConfiguration"> <!-- 駝峰命名規則 --> <property name="mapUnderscoreToCamelCase" value="true"/> <!-- 部分數據庫不識別默認的NULL類型(比如oracle,需要配置該屬性) --> <!-- <property name="jdbcTypeForNull"> <util:constant static-field="org.apache.ibatis.type.JdbcType.NULL"/> </property> --> </bean>
3)MP全局策略
<bean id="globalConfig" class="com.baomidou.mybatisplus.entity.GlobalConfiguration"> <!-- 邏輯刪除,定義下面3個參數 --> <property name="sqlInjector" ref="logicSqlInjector"/> <property name="logicDeleteValue" value="-1"/> <property name="logicNotDeleteValue" value="1"/> <!-- 全局ID類型: AUTO->`0`("數據庫ID自增") INPUT->`1`(用戶輸入ID") ID_WORKER->`2`("全局唯一ID") UUID->`3`("全局唯一ID") --> <property name="idType" value="2"/> <!-- 主鍵Sequence --> <!-- <property name="keyGenerator" ref="keyGenerator"/> --> <!-- 數據庫類型MYSQL->`mysql` ORACLE->`oracle` DB2->`db2` HSQL->`hsql` --> <property name="dbType" value="mysql" /> <!-- 全局表為下劃線命名設置 true --> <property name="dbColumnUnderline" value="true" /> </bean>
4)配置oracle主鍵Sequence,其他類型數據庫,請配置相應的類型
<!-- <bean id="keyGenerator" class="com.baomidou.mybatisplus.incrementer.OracleKeyGenerator"></bean> -->
5)邏輯刪除Sql註入器
<bean id="logicSqlInjector" class="com.baomidou.mybatisplus.mapper.LogicSqlInjector"></bean>
6)配置mybatis掃描mapper接口的路徑,相當於註解@MapperScan,@MapperScan("com.baomidou.mybatisplus.test.h2.entity.mapper")
<bean id="mapperScannerConfigurer" class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <property name="basePackage" value="com.ssmp.dao"></property> </bean>
7)事務控制配置
<!-- 配置事務管理器 --> <bean name="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> <property name="dataSource" ref="pooledDataSource"></property> </bean> <!-- 事務管理屬性 --> <tx:advice id="transactionAdvice" transaction-manager="transactionManager"> <tx:attributes> <tx:method name="insert*" propagation="REQUIRED"/> <tx:method name="update*" propagation="REQUIRED"/> <tx:method name="delete*" propagation="REQUIRED"/> <tx:method name="select*" propagation="SUPPORTS" read-only="true"/> <tx:method name="get*" propagation="SUPPORTS" read-only="true"/> <tx:method name="*" propagation="REQUIRED"/> </tx:attributes> </tx:advice> <!-- 配置切面 --> <aop:config> <aop:pointcut id="transactionPointcut" expression="execution(* com.ssmp.serviceImpl..*.*(..))"/> <aop:advisor pointcut-ref="transactionPointcut" advice-ref="transactionAdvice"/> </aop:config>
至此,配置工作就算大功告成了,接下來通過一個簡單的例子來感受一下它的使用.
三、Java代碼
1. 新建User表
@TableName("user") public class User implements Serializable { private Long id; private String name; private Integer age; @TableField(exist = false) private String state; }
這裏有兩個註解需要註意:
@tableName("user"),指定與數據庫表的關聯,數據庫裏應有一個名為user的表與之對應,並且數據表的列名應該就是User類的屬性;
@TableField(exist = false),對於User類中有而user表中沒有的屬性需要加上這個註解,表示排除User類中的屬性。
2. 新建Dao層接口UserMapper
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
@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的條件構建器
1. 首先看一個條件構建器實例的簡單實用
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裏.
2. 自定義的mapper方法能不能使用EntityWrapper呢?當然可以
在Mappper中定義:
List<User> selectMyPage(RowBounds rowBounds, @Param("ew") Wrapper<T> wrapper);
在mapper文件中定義
<select id="selectMyPage" resultType="User"> SELECT * FROM user ${ew.sqlSegment} </select>
3. EntityMapper的條件拼接
對於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()); }
MyBatis-plus快速入門