Spring与Mybatis集成笔记（spring集成mybatis原理）

1. 本文挡是基于之前使用的SpringMvc模式的基础上进行编写的，只描述和之前的差别之处，使用的是Spring4.0.6与Mybatis3.2.6版本，大致使用的jar如下图：

2. 修改applicationContext.xml文件：

<!-- spring和mybatis整合 -->

<bean id="sqlSessionFactoryBean" class="org.mybatis.spring.SqlSessionFactoryBean">

<property name="dataSource" ref="dataSource" />

<!--自动扫描mapping下的xml文件 -->

<property name="mapperLocations" value="classpath:com/ssm/mapping/*.xml" />

<!--加载Mybaits分页插件配置文件 -->

<property name="configLocation" value="classpath:mybatis-config.xml" />

</bean>

<!--配置Dao接口所在包名 -->

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">

<property name="basePackage" value="com.ssm.dao" />

<property name="sqlSessionFactoryBeanName" value="sqlSessionFactoryBean" />

</bean>

3. 增加mybatis-config.xml文件：

<configuration>

<plugins>

<!--com.github.pagehelper为PageHelper类所在包名 -->

<plugin interceptor="com.github.pagehelper.PageHelper">

<!--数据库方言 -->

<property name="dialect" value="oracle" />

<!--该参数默认为false -->

<!--设置为true时，会将RowBounds第一个参数offset当成pageNum页码-->

<!--使用，和startPage中的pageNum效果一样 -->

<property name="offsetAsPageNum" value="true" />

<!--该参数默认为false -->

<!--设置为true时，使用RowBounds分页会进行count查询 -->

<property name="rowBoundsWithCount" value="true" />

<!--设置为true时，如果pageSize=0或者RowBounds.limit = 0就会查询出全-->

<!--部的结果，（相当于没有分页查询，但是返回结果仍然是Page类型） -->

<property name="pageSizeZero" value="true" />

<!-- 3.3.0版本可用 - 分页参数合理化，默认false禁用 -->

<!--启用合理化时，如果pageNum<1会查询第一页，如果pageNum>pages -->

<!--会查询最后一页；禁用合理化时，如果pageNum<1或pageNum>pages -->

<!--会返回空数据 -->

<property name="reasonable" value="false" />

<!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->

<!--增加了一个"params"参数来配置参数映射，用于从Map或-->

<!--ServletRequest中取值，可以配置pageNum,pageSize,count,-->

<!--pageSizeZero,reasonable，不配置映射的用默认值 -->

<!--不理解该含义的前提下，不要随便复制该配置 -->

<property name="params" value="pageNum=start;pageSize=limit;" />

<!-- always总是返回PageInfo类型，check检查返回类型是否-->

<!--为PageInfo,none返回Page-->

<property name="returnPageInfo" value="check" />

</plugin>

</plugins>

</configuration>

4. 增加对数据库表操作的Dao接口，例如：

public interface RoleMapper {

/**

* 通过roleId获取角色信息

* @paramroleId

* @return

*/

public Role getRole(introleId);

/**

* 通过roleId删除角色信息

* @paramroleId

* @return

*/

public int deleteRole(introleId);

/**

* 新增角色信息

* @param role

* @return

*/

public int insertRole(Role role);

/**

* 新增角色信息（字段可选插入）

* @param role

* @return

*/

public int insertSelectiveRole(Role role);

/**

* 更新角色信息

* @param role

* @return

*/

public int updateRole(Role role);

/**

* 更新角色信息（字段可选插入）

* @param role

* @return

*/

public int updateSelectiveRole(Role role);

/**

* 查询角色的权限

* @paramroleId

* @return

*/

public List<Map<String,Object>> queryRoleMenus(introleId);

/**

* 获取角色及权限

* @paramroleId

* @return

*/

public Role getRoleByRoleId(introleId);

/**

* 查询角色信息（字段可选）

* @param role

* @return

*/

public List<Role> querySelectiveRole(Role role);

}

5. 在自动扫描mapping目录增加对数据库表操作的配置文件，下面RoleMapper.xml文件列举了常用对Sql操作的例子：

<mapper namespace="com.ssm.dao.RoleMapper">

<!--配置实体类与数据表映射关系 -->

<resultMap id="RoleMap" type="com.ssm.model.Role">

<id column="ROLEID" property="roleId" jdbcType="INTEGER" />

<result column="ROLENAME" property="roleName" jdbcType="VARCHAR" />

<result column="ROLEFUN_DESC" property="roleFunDesc" jdbcType="VARCHAR" />

<result column="ROLETYPE" property="roleType" jdbcType="INTEGER" />

</resultMap>

<!--配置角色表的所有字段 -->

<sql id="RoleColumns">

ROLEID, ROLENAME, ROLEFUN_DESC, ROLETYPE

</sql>

<!--通过roleId获取角色信息 -->

<select id="getRole" parameterType="java.lang.Integer" resultMap="RoleMap">

SELECT

<include refid="RoleColumns" />

FROM SYS_ROLES WHERE ROLEID = #{roleId,jdbcType=INTEGER}

</select>

<!--通过roleId删除角色信息 -->

<delete id="deleteRole" parameterType="java.lang.Integer">

DELETE FROM SYS_ROLES WHERE ROLEID = #{roleId,jdbcType=INTEGER}

</delete>

<!--新增角色信息 -->

<insert id="insertRole" parameterType="com.ssm.model.Role">

INSERT INTO SYS_ROLES (ROLEID, ROLENAME, ROLEFUN_DESC, ROLETYPE)

VALUES(#{roleId,jdbcType=INTEGER}, #{roleName,jdbcType=VARCHAR}, #{roleFunDesc,jdbcType=VARCHAR}, #{roleType,jdbcType=INTEGER})

</insert>

<!--新增角色信息（字段可选插入） -->

<insert id="insertSelectiveRole" parameterType="com.ssm.model.Role">

INSERT INTO SYS_ROLES

<trim prefix="(" suffix=")" suffixOverrides=",">

<if test="roleId != null">

ROLEID,

</if>

<if test="roleName != null">

ROLENAME,

</if>

<if test="roleFunDesc != null">

ROLEFUN_DESC,

</if>

<if test="roleType != null">

ROLETYPE,

</if>

</trim>

<trim prefix="values (" suffix=")" suffixOverrides=",">

<if test="roleId != null">

#{roleId,jdbcType=INTEGER},

</if>

<if test="roleName != null">

#{roleName,jdbcType=VARCHAR},

</if>

<if test="roleFunDesc != null">

#{roleFunDesc,jdbcType=VARCHAR},

</if>

<if test="roleType != null">

#{roleType,jdbcType=INTEGER},

</if>

</trim>

</insert>

<!--更新角色信息 -->

<update id="updateRole" parameterType="com.ssm.model.Role">

UPDATE SYS_ROLES

SET ROLENAME = #{roleName,jdbcType=VARCHAR},

ROLEFUN_DESC = #{roleFunDesc,jdbcType=VARCHAR},

ROLETYPE = #{roleType,jdbcType=INTEGER}

WHERE ROLEID = #{roleId,jdbcType=INTEGER}

</update>

<!--更新角色信息（字段可选插入） -->

<update id="updateSelectiveRole" parameterType="com.ssm.model.Role">

UPDATE SYS_ROLES

<set>

<if test="roleName != null">

ROLENAME = #{roleName,jdbcType=VARCHAR},

</if>

<if test="roleFunDesc != null">

ROLEFUN_DESC = #{roleFunDesc,jdbcType=VARCHAR},

</if>

<if test="roleType != null">

ROLETYPE = #{roleType,jdbcType=INTEGER},

</if>

</set>

WHERE ROLEID = #{roleId,jdbcType=INTEGER}

</update>

<!--查询角色的权限 -->

<select id="queryRoleMenus" parameterType="java.lang.Integer" resultType="java.util.HashMap">

SELECT A.ROLEID, A.ROLENAME, C.FUNID, C.FUNNAME, C.FUNTYPE, C.URL

FROM SYS_ROLES A, SYS_ROLEFUN B, SYS_FUNLIST C

WHERE A.ROLEID = B.ROLEID AND B.FUNID = C.FUNID

AND A.ROLEID = #{roleId,jdbcType=INTEGER}

ORDER BY A.ROLEID, C.INDEXNUM

</select>

<!--配置实体类与数据表映射关系（包含菜单权限） -->

<resultMap id="RoleMenuMap" type="com.ssm.model.Role">

<id column="ROLEID" property="roleId" jdbcType="INTEGER" />

<result column="ROLENAME" property="roleName" jdbcType="VARCHAR" />

<result column="ROLEFUN_DESC" property="roleFunDesc" jdbcType="VARCHAR" />

<result column="ROLETYPE" property="roleType" jdbcType="INTEGER" />

<collection property="menus" javaType="java.util.List" ofType="com.ssm.model.Menu">

<result column="FUNID" property="funId" jdbcType="VARCHAR" />

<result column="FUNNAME" property="funName" jdbcType="VARCHAR" />

<result column="FUNTYPE" property="funType" jdbcType="INTEGER" />

<result column="PREFUN" property="preFun" jdbcType="VARCHAR" />

<result column="URL" property="url" jdbcType="VARCHAR" />

</collection>

</resultMap>

<!--获取角色及权限 -->

<select id="getRoleByRoleId" resultMap="RoleMenuMap">

SELECT A.ROLEID, A.ROLENAME, A.ROLEFUN_DESC, A.ROLETYPE, C.FUNID, C.FUNNAME, C.FUNTYPE, C.PREFUN, C.URL

FROM SYS_ROLES A, SYS_ROLEFUN B, SYS_FUNLIST C

WHERE A.ROLEID = B.ROLEID AND B.FUNID = C.FUNID

AND A.ROLEID = #{roleId,jdbcType=INTEGER}

ORDER BY A.ROLEID, C.INDEXNUM

</select>

<!--查询角色信息（字段可选） -->

<select id="querySelectiveRole" resultMap="RoleMap">

SELECT

<include refid="RoleColumns" />

FROM SYS_ROLES

<where>

<if test="roleName != null and roleName != ''">

AND ROLENAME LIKE '%'||#{roleName,jdbcType=VARCHAR}||'%'

</if>

<if test="roleType != null">

AND ROLETYPE = #{roleType,jdbcType=INTEGER}

</if>

</where>

ORDER BY ROLEID

</select>

</mapper>

注：<select>、<delete>、<insert>、<update>标签对应数据库的查询、删除、插入、修改操作，id属性对应Dao接口的方法名。

6. 增加Service层接口和实现类：

@Service

public class RoleServiceImpl implements IRoleService {

@Autowired

private RoleMapper roleMapper;

/**

* 通过roleId获取角色信息

* @paramroleId

* @return

*/

public Role getRole(introleId){

returnroleMapper.getRole(roleId);

}

/**

* 通过roleId删除角色信息

* @paramroleId

* @return

*/

public int deleteRole(introleId){

returnroleMapper.deleteRole(roleId);

}

/**

* 新增角色信息

* @param role

* @return

*/

public int insertRole(Role role){

returnroleMapper.insertRole(role);

}

/**

* 新增角色信息（字段可选插入）

* @param role

* @return

*/

public int insertSelectiveRole(Role role){

returnroleMapper.insertSelectiveRole(role);

}

/**

* 更新角色信息

* @param role

* @return

*/

public int updateRole(Role role){

returnroleMapper.updateRole(role);

}

/**

* 更新角色信息（字段可选插入）

* @param role

* @return

*/

public int updateSelectiveRole(Role role){

returnroleMapper.updateSelectiveRole(role);

}

/**

* 查询角色的权限

* @paramroleId

* @return

*/

public List<Map<String,Object>> queryRoleMenus(introleId){

returnroleMapper.queryRoleMenus(roleId);

}

/**

* 获取角色及权限

* @paramroleId

* @return

*/

public Role getRoleByRoleId(introleId){

returnroleMapper.getRoleByRoleId(roleId);

}

/**

* 查询角色信息（字段可选）

* @param role

* @return

*/

public List<Role> querySelectiveRole(Role role){

returnroleMapper.querySelectiveRole(role);

}

}

7. 分页查询举例：

int page = StringUtil.isNotEmpty(params.get("page")) ? Integer.parseInt(params.get("page")) : 0;

int rows = StringUtil.isNotEmpty(params.get("rows")) ? Integer.parseInt(params.get("rows")) : 0;

PageHelper.startPage(page, rows); //分页插件

Role role = new Role();

introleType = StringUtil.isNotEmpty(params.get("roleType")) ? Integer.parseInt(params.get("roleType")) : 0;

role.setRoleName(params.get("roleName"));

role.setRoleType(roleType);

List<Role> list = roleMapper.querySelectiveRole(role);

if(null != list && !list.isEmpty()){

for(inti = 0, len = list.size(); i<len; i++){

Role role = list.get(i);

System.out.println("-"+ i +"->roleId:"+ role.getRoleId() +",roleName:"+ role.getRoleName());

}

PageInfo page = new PageInfo(list);

long total = page.getTotal();

System.out.println("--->总记录数:"+ total);

intpageNum = page.getPageNum();

System.out.println("--->当前页:"+ pageNum);

intpageSize = page.getPageSize();

System.out.println("--->每页显示条数:"+ pageSize);

intstartRow = page.getStartRow();

System.out.println("--->开始行:"+ startRow);

intendRow = page.getEndRow();

System.out.println("--->结束行:"+ endRow);

int pages = page.getPages();

System.out.println("--->总页数:"+ pages);

}

8. Mybatis的*.xml文件SQL编写：

1）<mapper namespace=""></mapper>：用于绑定Dao接口

namespace有两种用法：

第一种：通过SqlSession执行namespace对应的方法，比如：

this.getSqlSession().selectList("com.spsoft.mapper.PilotcostDetails.findAll", obj);

调用PilotcostDetails接口的findAll方法

第二种：namespace对应org.mybatis.spring.mapper.MapperScannerConfigurer配置中basePackage包中的接口，比如：

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">

<property name="basePackage" value="com.spsoft.mapper" />

<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>

</bean>

只需要定义接口com.spsoft.mapper.PilotcostDetails及方法，也可以实现。

2）使用<select id="对应接口中方法名"></select>：查询

<insert id="对应接口中方法名"></insert>：新增

<update id="对应接口中方法名"></update>：更新

<delete id="对应接口中方法名"></delete>：删除

3）使用<if test=''></if>判断字符串是否相等，需按照下面这样写：

select a,b,c from table where 1=1

<if test='flag == "1"'>

and a = #{a}

</if>

字符串比较相等应使用双引号，不能这样写<if test="flag == '1'"></if>，否则表达式中间内容不会执行。

像java中的if..else if..else这种条件判断，在mybatis中使用:

<choose><when test=""></when><when test=""></when><otherwise></otherwise></choose>

4）要使用大于、小于号怎么处理：

方案1：使用<![CDATA[...]]>把语句包括起来

方案2：使用XML转义字符：

< < 小于号

> > 大于号

& & 和

' ’ 单引号

" " 双引号

5）要in多个值或循环变量集合怎么处理：

FIELD IN

<foreach collection="fieldValues" item="item" open="(" separator="," close=")">

#{item}

</foreach>

6）查询返回对象或结果集，对象怎么和表字段关联：

<resultMap id="" type=""></resultMap>

例如：

--定义字段与vo类属性的对应关系

<resultMap id="userResultMap" type="com.spsoft.vo.User">

<id column="USER_ID" property="userId" />

<result column="USER_CODE" property="userCode" />

<result column="USER_NAME" property="userName" />

</resultMap>

--定义表中有哪些字段，用于SQL操作

<sql id="userColumns">

USER_ID, USER_CODE, USER_NAME

</sql>

--获取用户对象

<select id="get" parameterType="java.lang.String" resultMap="userResultMap">

select

<include refid="userColumns" /> --此处解析时会被替换成<sql id="userColumns"></sql>中的内容

from SYS_USER

where USER_ID = #{userId}

</select>

9. 批量插入、更新：

方案一：

<insert id="insertBatch" parameterType="List">

INSERT INTO SYS_USER(USER_CODE,USER_NAME)

<foreach collection="list" item="item" index="index" open="("close=")"separator="union all">

SELECT #{item.userCode}, #{item.userName} FROM DUAL

</foreach>

</insert>

方案二：

@Autowired

private SqlSessionTemplate sqlSessionTemplate;

//获取一个模式为BATCH，自动提交为false的session

SqlSession session = null;

try{

session = sqlSessionTemplate.getSqlSessionFactory().openSession(ExecutorType.BATCH, false);

RoleMapper mapper = session.getMapper(RoleMapper.class);

for(int i = 0, len = paramList.size(); i < len; i++){

Map<String, Object> param = paramList.get(i);

mapper.insertRoleResource(param);

//session.insert("com.spsoft.dao.RoleMapper.insertRoleResource", param);

//session.insert等价于：RoleMapper mapper = session.getMapper(RoleMapper.class);mapper.insertRoleResource(param);

//手动每1000个一提交，提交后无法回滚

if(i % 1000 == 0 || i == len - 1) {

session.commit();

//清理缓存，防止溢出

session.clearCache();

}

}

session.commit();

}catch(Exception e){

if(null != session){

session.rollback(); //回滚数据

}

}finally{

if(null != session){

session.close();

}

}

10. Controller类中注解使用：

1）@RequestMapping：请求访问路径、方式，比如：

@RequestMapping(value = "/rest/forgin/PilotcostDetails/list/page", method = RequestMethod.GET)

2）@RequestBody：用于读取Request请求的body部分数据，使用配置的HttpMessageConverter进行解析，然后将对象绑定到 controller中方法的参数上

常见场景：前台ajax调用Controller的方法，传递json格式参数（data需使用JSON.stringify转换）

3）@ResponseBody：用于将Controller的方法返回的对象，通过HttpMessageConverter转换为指定格式（如json、xml等）后，写入到Response对象的body数据区

4）@PathVariable：用于获取请求url中的变量，比如：

@RequestMapping(value = "/rest/forgin/PilotcostDetails/import/{fileName}/{taxablePeriod}", method = RequestMethod.POST)

通过@PathVariable("fileName") String fileName 获取{fileName}