通用mapper有什么好处呢?以往我们使用mapper文件都是自己写sql语句,针对的是单个实体,也就是每个实体都有其对应的mapper文件。使用通用mapper给我们带来了极大的方便,它不需要mapper.xml文件,只需我们调用相应的接口,引入jar包再进行简单的配置就好了。下面是使用中的一些总结。
首先我们要创建自己的接口来继承Mapper<T>,其中的T必须实现,也就是必须指定类型:
import com.github.abel533.mapper.Mapper;
@Repository("courseDao")
public interface CourseDao extends Mapper<Course>{}
这样我们就拥有了Mapper中的通用方法
如果是maven项目,在pom文件中添加如下依赖即可:
<!-- 通用Mapper -->
<dependency>
<groupId>com.github.abel533</groupId>
<artifactId>mapper</artifactId>
<version>2.3.4</version>
</dependency>
接下来就是修改mybatis配置文件,我们的配置文件都是通过spring来管理的,在网上查到一些资料,如果使用spring管理,直接在配置文件中按照如下配置即可:
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource"/>
<property name="mapperLocations">
<array>
<value>classpath:mapper/*.xml</value>
</array>
</property>
<property name="typeAliasesPackage" value="com.dmsd.itoo.video.entity"/>
<property name="plugins">
<array>
<-- 主要看这里 -->
<bean class="com.isea533.mybatis.mapperhelper.MapperInterceptor"/>
</array>
</property>
</bean>
注意typeAliasesPackage的value对应的是你自己的实体的类名。
按照上述配置mybatis配置文件总是报如下错误:
org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.builder.BuilderException: Error invoking SqlProvider method (com.github.abel533.mapper.MapperProvider.dynamicSQL). Cause: java.lang.InstantiationException: com.github.abel533.mapper.MapperProvider
查询无果,换另一种方式,将mybatis的配置文件单独抽出,在spring中进行引用,如下
spring-mybatis配置文件:
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<property name="mapperLocations" value="classpath:mapper/*.xml" />
<property name="typeAliasesPackage" value="com.dmsd.itoo.video.entity" />
<!-- mybatis全局配置文件 -->
<property name="configLocation" value="classpath:spring/mybatis-config.xml"
/>
</bean>
mybatis-config.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<plugins>
<!-- 通用Maper -->
<plugin interceptor="com.github.abel533.mapperhelper.MapperInterceptor">
<!-- 主键自增回写方法,默认值MYSQL,详细说明请看文档 -->
<property name="IDENTITY" value="MYSQL" />
<!-- 通用Mapper接口,多个通用接口用逗号隔开 -->
<property name="mappers" value="com.github.abel533.mapper.Mapper" />
</plugin>
</plugins>
</configuration>
运行,ok
注意
泛型(实体类)<T>的类型必须符合要求
实体类按照如下规则和数据库表进行转换,注解全部是JPA中的注解:
-
表名默认使用类名,驼峰转下划线,如UserInfo默认对应的表名为user_info.
-
表名可以使用@Table(name = "tableName")进行指定,对不符合第一条默认规则的可以通过这种方式指定表名.
-
字段默认和@Column一样,都会作为表字段,表字段默认为Java对象的Field名字驼峰转下划线形式.
-
可以使用@Column(name = "fieldName")指定不符合第3条规则的字段名
-
使用@Transient注解可以忽略字段,添加该注解的字段不会作为表字段使用.
-
建议一定是有一个@Id注解作为主键的字段,可以有多个@Id注解的字段作为联合主键.
-
默认情况下,实体类中如果不存在包含@Id注解的字段,所有的字段都会作为主键字段进行使用(这种效率极低).
-
实体类可以继承使用,可以参考测试代码中的com.github.abel533.model.UserLogin2类.
-
由于基本类型,如int作为实体类字段时会有默认值0,而且无法消除,所以实体类中建议不要使用基本类型.
除了上面提到的这些,Mapper还提供了序列(支持Oracle)、UUID(任意数据库,字段长度32)、主键自增(类似Mysql,Hsqldb)三种方式,其中序列和UUID可以配置多个,主键自增只能配置一个。
补充:
后来找到了通过spring管理mybatis的方法,不需要单独抽出mybatis的配置文件,修改spring-mybatis.xml如下:
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<property name="mapperLocations" value="classpath:mapper/*.xml" />
<property name="typeAliasesPackage" value="com.dmsd.itoo.video.entity" />
<property name="plugins">
<array>
<bean class="com.github.abel533.mapperhelper.MapperInterceptor">
<property name="properties">
<value>
mappers=com.github.abel533.mapper.Mapper
IDENTITY=MYSQL
notEmpty=true
</value>
</property>
</bean>
</array>
</property>
<!-- mybatis全局配置文件 -->
<!-- <property name="configLocation" value="classpath:spring/mybatis-config.xml"></property> -->
</bean>