java mybatis mapper_mybatis的mapper映射文件

1概述

1.1应用架构

mybatis框架用于支持对关系数据库的操作，该体系的应用架构如下图所示：

在mybatis框架体系中，主要的组件是：SqlSessionFactoryBean和MapperScannerConfigurer。SqlSessionFactoryBean类依赖外部注入的数据源：DataSource。并有两个属性：configLocation和mapperLocations。

ConfigLocation指定了mybatis配置文件的位置；mapperLocations指定了多个mapper映射文件的位置。

MapperSacannerConfigurer依赖SqlSessionFactoryBean，并根据basePackages属性指定的IDao接口类所在的包位置，自动扫描该包路径，为每个IDao类创建一个MapperFactoryBean类。MapperFactoryBean类会为它所对应的IDao接口类创建其具体的实现类实例，并将其注入到service层的业务代码中。

在Spring boot开发中，使用@MapperScan注解代替MapperScannerConfigurer类。它们的效果是一样的。

在使用mybatis框架实现数据库操作的时候，上图红色框部分的内容需要开发人员实现。

数据源是任何实现了javax.sql.datasource接口的类实例。例如：org.apache.tomcat.jdbc.pool.datasource，该数据源对应单库单表操作；或者com.dangdang.ddframe.rdb.sharding.jdbc.core.datasource.ShardingDataSource,该数据源对用分库，分表操作。

IDao为数据操作接口，实现用户的数据操作逻辑。一般分为接口类和po类两部分。

配置文件分为：mybatis配置文件和mapper配置文件。mybatis配置文件主要用来设计po类的别名，方便对po类的引用；mapper配置文件用来管理SQL语句。

1.2主要开发要素

在mybatis开发中，涉及到主要开发要素是:dao接口类，mapper映射文件，以及po类。它们之间的关系如下：

dao接口类中，定义了数据库操作的接口方法，主要包含增，删，改，查等接口方法；po类定义接口方法的参数，可使用po类保存查询结果，或者为insert，update方法提供数据集参数。操作数据库表的SQL语句保存在mapper映射文件中。mapper映射文件分别提供select,insert,update,delete xml元素，分别对应数据库的查询，插入，修改，删除操作。每一个xml元素通过id属性与dao接口类中的方法相互关联。

1.3 mapper文件的结构

mapper映射文件是xml格式的配置文件，由一系列具有层级关系的元素组成。并且通过元素的属性，这些元素之间具有关联关系。具体情况如下图所示：

在mapper映射文件中，主要包含如下配置元素：

mapper元素。该元素是最顶层的配置元素，其属性namespace指向IDao类的全类型名，即：包路径+类名。在mapper元素下面，包含如下子元素：resultMap元素，select元素，insert元素，update元素，delete元素。

resultMap元素。建立数据库表的列名与po类的数据字段之间的映射关系。当po类的数据字段与数据库表不一致的时候，或者承载复杂查询结果的时候，使用resultMap配置；

select元素。用来维护select语句。

insert元素。用来维护insert语句。

update元素。用来维护update语句。

delete元素。用来维护delete语句。

2 文件示例

在开发过程中，需要开发人员配置mapper映射文件，编写Idao类，以及Idao了所依赖的po类。具体示例如下：

2.1 mapper映射文件

mapper配置文件的示例如下：

insert into t_user (f_id,f_name,f_birth,f_salary) values (#{id},#{name},#{birth},#{salary})

insert into t_user (f_id,f_name,f_birth,f_salary) values (#{id},#{name},#{birth},#{salary})

insert into t_user (f_id,f_name,f_birth,f_salary) values

(#{idx},#{item.name},#{item.birth},#{item.salary})

select * from t_user

select count(*) from

t_user

select * from

t_user

select * from t_user

where f_id = #{id}

select * from t_user

where f_id=#{id}

delete from t_user

delete from t_user where

id=#{id}

update t_user set f_name =

#{name} where f_id =

#{id}

2.2 po文件

po文件的示例如下：

packagecom.lifeng.demo.mybatis.dao.dto;importjava.io.Serializable;importjava.text.SimpleDateFormat;importjava.util.Date;public class UserInfo implementsSerializable {private static final long serialVersionUID = 6730890636022435120L;private intid;privateString name;privateDate birth;private doublesalary;public intgetId() {returnid;

}public void setId(intid) {this.id =id;

}publicString getName() {returnname;

}public voidsetName(String name) {this.name =name;

}publicDate getBirth() {returnbirth;

}public voidsetBirth(Date birth) {this.birth =birth;

}public doublegetSalary() {returnsalary;

}public void setSalary(doublesalary) {this.salary =salary;

}

@OverridepublicString toString() {

StringBuilder builder= newStringBuilder();

builder.append("UserInfo = [");

builder.append("id:");

builder.append(this.id);

builder.append(" name:");

builder.append(this.name);if (this.birth != null) {

builder.append(" birth:");

builder.append(new SimpleDateFormat("yyyyMMdd").format(this.birth));

}

builder.append(" salary:");

builder.append(this.salary);returnbuilder.toString();

}

}

2.3 dao文件

Dao接口的示例如下：

packagecom.lifeng.demo.mybatis.dao;importjava.math.BigInteger;importjava.util.Date;importjava.util.List;importjava.util.Map;importorg.apache.ibatis.annotations.MapKey;importorg.apache.ibatis.annotations.Param;importcom.lifeng.demo.mybatis.dao.dto.UserInfo;public interfaceIUserDao {

ListlistUserInfo();intgetUserCount();

UserInfo getUserInfoById(intId);

Map getUserInfoToMap(intid);

@MapKey("f_id")

Map>listUserInfoToMap();intinsertUserInfoByBean(UserInfo userInfo);int insertUserInfo(@Param("id") int id,@Param("name") String userName,@Param("birth") Date birthDay,@Param("salary") doublesalary);int insertUserInfoByBatch(Listls);intupdateUserInfo(UserInfo userInfo);int deleteUserInfoById(intId);intdeleteAll();

}

3 常用元素

3.1 resultMap

使用resultMap配置节，建立po类的数据字段与数据库表的列名之间的映射关系。当po类的数据字段与数据库表的列名不一致的时候，可使用该配置。 resultMap的代码示例如下：

type属性执行po类的全类型名，即：包名+类名。如果在mybatis配置文件中，为po类建立了别名，那么type属性可以引用该别名。

id属性应该全局唯一，它被select元素的resultMap属性引用。

子元素用来建立po数据字段与数据库表主键列之间的映射关系。

子元素用来建立po数据字段与数据库表非主键列之间的映射关系。

property属性用来指定po类的数据字段名。例如：private String name；该定义中的name。

column属性用来指定数据库表的列名。

3.2 select

在mapper文件中，使用select元素来管理select语句。

3.2.1 返回单值

当查询结果返回一个单值的时候，其配置如下：

select count(*) from t_user

使用resultType属性指定返回结果的数据类型，这里可以是java基本数据类型，如：int,String等。

在IDao类中，接口方法定义如下：

int getUserCount();

方法的返回值类型是int，与resultType的值对应；方法的名称是getUserCount与id属性的值对应。

3.2.2 返回单对象

单对象的含义是：查询结果包含多个数据列，但只有一行数据。可以使用javabean或者map来保存查询结果。

3.2.2.1通过javabean返回单对象

通过javabean返回查询结果的配置如下：

select*from t_user

where f_id=#{id}

当po类的数据字段与数据库表的列名完全一致的时候，可使用resultType=po类全类型名，或po类别名 的方式指定查询结果的类型。

当po类的数据字段与数据库表的列名不一致的时候，需要定义resultMap映射。在这种情况下，使用resultMap属性，该属性的值与元素的id属性的值相同。

resultMap与resultType不能同时使用。

在IDao类中，接口方法的定义如下：

UserInfo getUserInfoById(int id)

返回值的类型是UserInfo，通过元素的配置，将该类型映射到userData。在元素中，通过resultMap属性引用userData.

3.2.2.2通过map返回单对象

当查询结果是一个单对象，但是没有定义po类的时候，可使用map来承载查询结果。map的key是数据库表的列名，value是该列对应的值。mapper映射文件的配置如下：

select* from t_user where f_id=#{id}

resultType属性的值设定为hashmap，或者map即可。IDao类中，接口方法定义如下：

Map getUserInfoToMap(int id);

3.2.3返回数据集

数据集的含义是：包含多行数据，每行数据包含多列。

3.2.3.1通过list返回数据集

当查询结果返回一个数据集的时候，mybatis会将查询结果放入list中，然后返回。在这种情况下,resultTpye或者resultMap属性指定的是list列表元素的类型，而非集合本身。mapper映射文件的配置如下：

select*from t_user

resultMap或者resultType可以设定为java bean ，也可设定为map。该配置形式与返回单对象相同，其差别在IDao类中的接口方法定义：

list listUserInfo();

在定义接口方法的时候，需要使用list包装单值对象的类型。

3.2.3.2通过map返回数据集

该方式需要与注解@MapKey配合使用。map的key是：数据库表中的任意一列，一般选具有索引性质的列，如：id，name等。value是：po类的引用，或者另外一个map的引用。mapper配置文件的内容如下：

select*from t_user

在IDao类中，接口方法的定义如下：

@MapKey("f_id")

Map> listUserInfoToMap();

在上面的示例中，value的值是map类型。value的值也可以是po类。在使用po类的时候，mapper映射文件的配置如下：

select*from t_user

在IDao类中，接口方法定义如下：

@MapKey("id")

map listUserInfo();

3.3结论

resultType使用汇总如下，resultType属性的值可以是如下情形：

1.基本数据类型，如：int,String等；

2.class数据类型，如：java bean，这里输入的是全类型名或者别名;

3.map数据类型。包括：单对象和集合两种；

4.集合数据类型，是集合元素的类型，而非集合本身。

resultMap的使用汇总如下：

该属性的值是：元素的id属性的值。只有当po数据字段与数据库表列名不一致的时候，才使用。

3.3 insert

在mybatis中，使用元素来管理insert语句。如果sql语句比较简单，可使用@Insert注解来代替mapper映射文件。

如果需要插入的数据字段比较多，可以使用po类封装这些数据字段，示例如下：

insert into t_user (f_name,f_birth,f_salary) values (#{name},#{birth},#{salary})

IDao类的接口方法定义如下：

int insertUserInfoByBean(UserInfo userInfo);

元素的id属性值是IDao类接口方法的名称。

元素的parameterType属性值可以省略。其值是接口方法参数的类型。如果接口方法的参数是java bean，那么该值是全类型名(即：包名+类名)，或者是类型的别名。

注意：在sql语句中，如：#{name}，#{birth}等参数，其名称：name,birth，必须与接口参数UserInfo的数据字段一致。即：UserInfo的数据字段名称必须是name,birth。否则无法识别。

如果需要插叙的数据字段比较少，那么可以直接传递给参数到接口方法中，mapper映射文件的示例如下：

insert into t_user (f_name,f_birth,f_salary) values (#{name},#{birth},#{salary})

IDao接口类的定义如下：

int insertUserInfo(@Param("name") String userName,@Param("birth") Date birthDay,@Param("salary") double salary);

注解@Param用来指定接口方法的参数名与sql语句中的参数名之间的映射。@Param注解的参数，如：name，必须与sql语句中的参数，如：#{name}中的name 是完全一致的。

如果sql语句比较简单，可以使用注解来代替mapper映射文件，示例如下：

@Insert("{insert into t_user (f_name,f_birth,f_salary) values (#{name},#{birth},#{salary})}")int insertUserInfo(@Param("name") String userName,@Param("birth") Date birthDay,@Param("salary") double salary);

3.4 update

元素用来维护update类型的sql语句。如果该sql语句比较简单，可以使用@Update注解代替mapper映射文件。

3.5 delete

元素用来维护delete类型的sql语句。如果该sql语句比较简单，可以使用@Delete注解来代替mapper映射文件。

3.6 动态sql

使用动态sql来支持复杂的sql语句。在动态sql部分，包含如下xml元素：

if, choose, when, otherwise, trim, where, set, foreach。

3.6.1示例表

以如下表结构示例动态sql：

3.6.2 if语句

根据 username 和 sex 来查询数据。如果username为空，那么将只根据sex来查询；反之只根据username来查询。首先不使用 动态SQL 来书写

select* from user where username=#{username} and sex=#{sex}

上面的查询语句，我们可以发现，如果 #{username} 为空，那么查询结果也是空，如何解决这个问题呢？使用 if 来判断

select*from user whereusername=#{username}

and sex=#{sex}

这样写我们可以看到，如果 sex 等于 null，那么查询语句为 select * from user where username=#{username},但是如果usename 为空呢？那么查询语句为 select * from user where and sex=#{sex}，这是错误的 SQL 语句，如何解决呢？请看下面的 where 语句

3.6.3 if + where 语句

select*from user

username=#{username}

and sex=#{sex}

这个“where”标签会知道如果它包含的标签中有返回值的话，它就插入一个‘where’。此外，如果标签返回的内容是以AND 或OR 开头的，则它会剔除掉。

3.6.3 if + set 语句同理，上面的对于查询 SQL 语句包含 where 关键字，如果在进行更新操作的时候，含有 set 关键词，我们怎么处理呢？

update user u

u.username=#{username},

u.sex=#{sex}

where id=#{id}

这样写，如果第一个条件 username 为空，那么 sql 语句为：update user u set u.sex=? where id=? ； 如果第一个条件不为空，那么 sql 语句为：update user u set u.username = ? ,u.sex = ? where id=?

3.6.4 choose(when,otherwise) 语句

有时候，我们不想用到所有的查询条件，只想选择其中的一个，查询条件有一个满足即可，使用 choose 标签可以解决此类问题，类似于 Java 的 switch 语句

select*from user

id=#{id}

and username=#{username}

and sex=#{sex}

也就是说，这里我们有三个条件，id,username,sex，只能选择一个作为查询条件

如果 id 不为空，那么查询语句为：select * from user where id=?

如果 id 为空，那么看username 是否为空，如果不为空，那么语句为 select * from user where username=?;

如果 username 为空，那么查询语句为 select * from user where sex=?

3.6.5 trim语句

trim标记是一个格式化的标记，可以完成set或者是where标记的功能

①、用 trim 改写上面第二点的 if+where 语句

select*from user

and username=#{username}

and sex=#{sex}

prefix：前缀；prefixoverride：去掉第一个and或者是or。

②、用 trim 改写上面第三点的 if+set 语句

update user u

u.username=#{username},

u.sex=#{sex},

where id=#{id}

suffix：后缀

suffixoverride：去掉最后一个逗号(也可以是其他的标记，就像是上面前缀中的and一样)

3.6.6 SQL片段

有时候可能某个 sql 语句我们用的特别多，为了增加代码的重用性，简化代码，我们需要将这些代码抽取出来，然后使用时直接调用。

比如：假如我们需要经常根据用户名和性别来进行联合查询，那么我们就把这个代码抽取出来，如下：

AND username=#{username}

AND sex=#{sex}

引用 sql 片段

select*from user

注意：①、最好基于 单表来定义 sql 片段，提高片段的可重用性

②、在 sql 片段中不要包括 where

3.6.7 foreach语句

需求：我们需要查询 user 表中 id 分别为1,2,3的用户

sql语句：select * from user where id=1 or id=2 or id=3

select * from user where id in (1,2,3)

①、建立一个 UserVo 类，里面封装一个 List ids 的属性

packagecom.ys.vo;importjava.util.List;public classUserVo {//封装多个用户的id

private Listids;public ListgetIds() {returnids;

}public void setIds(Listids) {this.ids =ids;

}

}

②、我们用 foreach 来改写 select * from user where id=1 or id=2 or id=3

select*from user

id=#{id}

③、我们用 foreach 来改写 select * from user where id in (1,2,3)

select*from user

#{id}