Mybatis通用Mapper使用详解

JAVA 78 2017-11-07 09:52

对单表进行增删改查是项目中不可避免的需求,Mybatis的通用Mapper插件使这些操作变得简单

添加maven依赖

在对应工程的pom.xml文件中添加

<dependency>
    <groupId>javax.persistence</groupId>
    <artifactId>persistence-api</artifactId>
    <version>1.0</version>
</dependency>
<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper</artifactId>
    <version>3.1.2</version>
</dependency>

配置拦截器

在mybatis-config.xml文件中添加通用Mapper

<plugin interceptor="tk.mybatis.mapper.mapperhelper.MapperInterceptor">
    <!--================================================-->
    <!--可配置参数说明(一般无需修改)-->
    <!--================================================-->
    <!--UUID生成策略-->
    <!--配置UUID生成策略需要使用OGNL表达式-->
    <!--默认值32位长度:@java.util.UUID@randomUUID().toString().replace("-", "")-->
    <!--<property name="UUID" value="@java.util.UUID@randomUUID().toString()"/>-->
    <!--主键自增回写方法,默认值MYSQL,详细说明请看文档-->
    <property name="IDENTITY" value="HSQLDB"/>
    <!--序列的获取规则,使用{num}格式化参数,默认值为{0}.nextval,针对Oracle-->
    <!--可选参数一共3个,对应0,1,2,分别为SequenceName,ColumnName,PropertyName-->
    <property name="seqFormat" value="{0}.nextval"/>
    <!--主键自增回写方法执行顺序,默认AFTER,可选值为(BEFORE|AFTER)-->
    <!--<property name="ORDER" value="AFTER"/>-->
    <!--通用Mapper接口,多个通用接口用逗号隔开-->
    <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
</plugin>

继承通用Mapper<T>,必须指定泛型<T>

public interface ClubMapper extends Mapper<TClub>
{

}

继承了Mapper<T>之后,就拥有了Mapper中的各种通用方法,具体可以查看源码

泛型(表对象实体类)<T>要求

实体类需要按照如下规则和数据库表进行转换,注解全部是JPA中的注解,所以我们在maven中添加了它的jar包依赖

  • 表名默认使用类名,驼峰转下划线,如UserInfo默认对应的表名为user_info
  • 表名可以使用@Table(name = "tableName")进行指定,对不符合第一条默认规则的可以通过这种方式指定表名
  • 字段默认和@Column一样,都会作为表字段,表字段默认为Java对象的Field名字驼峰转下划线形式
  • 可以使用@Column(name = "fieldName")指定不符合第3条规则的字段名
  • 使用@Transient注解可以忽略字段,添加该注解的字段不会作为表字段使用
  • 建议一定是有一个@Id注解作为主键的字段,可以有多个@Id注解的字段作为联合主键
  • 默认情况下,实体类中如果不存在包含@Id注解的字段,所有的字段都会作为主键字段进行使用(这种效率极低)
  • 实体类可以继承使用
  • 由于基本类型,如int作为实体类字段时会有默认值0,而且无法消除,所以实体类中建议不要使用基本类型

Mapper还提供了主键自增的方式

@Id
@GeneratedValue(generator = "JDBC")
@Column(name = "id")
private Integer id;

添加Mapper配置

将继承的Mapper接口添加到mybatis-config.xml文件中

<mappers>
    <mapper class="com.ind4.iss.icp.dao.logic.map.mapper.club.clubMapper" />
</mappers>

具体使用

public List<TClub> queryList() throws CcpException
{
    SqlSession sqlSession = CcpDB.getInstance().getSession();

    try
    {
        ClubMapper mapper = getMapper(sqlSession);
        TClub tClub = new TClub();
        return mapper.select(tClub);
    }
    catch (Exception e)
    {
        CcpLogger.getInstance().error(e, "TClubDAO.queryList, status=" + status);
        throw new CcpException(CcpErrorCode.ERROR_CLUB_DAO_DB_ERROR, e);
    }
    finally
    {
        CcpDB.getInstance().closeSession();
    }
}

private ClubMapper getMapper(SqlSession sqlSession)
{
    return sqlSession.getMapper(ClubMapper.class);
}

参考:Mybatis通用Mapper

文章评论