mybatis框架的总结（二）

小咪咪 2021-06-24 16:09 451阅读 0赞

## ##

### Mapper动态代理方式实现dao： ###

###               Mapper接口开发方法只需要程序员编写Mapper接口（相当于Dao接口），由Mybatis框架根据接口定义创建接口的动态代理对象，代理对象的方法体同上边Dao接口实现类方法。 ###

Mapper接口开发需要遵循以下规范：

1.  Mapper.xml文件中的namespace与mapper接口的类路径相同。
2.  Mapper接口方法名和Mapper.xml中定义的每个statement的id相同 
3.  Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同
4.  Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同

1.  ### Mapper.xml(映射文件) ###

定义mapper映射文件UserMapper.xml，需要修改namespace的值为 UserMapper接口路径。将UserMapper.xml放在classpath 下和mapper处在同一目录 下。

<?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="cn.itcast.mybatis.mapper.UserMapper">
    
    	<select id="findUserById" parameterType="int" resultType="cn.itcast.mybatis.po.User">
    		select * from user where id = #{id}
    	</select>
    
    	<select id="findUserByUsername" parameterType="java.lang.String" 
    			resultType="cn.itcast.mybatis.po.User">
    	   select * from user where username like '%${value}%' 
    	</select>
    
    	<insert id="insertUser" parameterType="cn.itcast.mybatis.po.User">
    	<selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
    		select LAST_INSERT_ID() 
    	</selectKey>
    	  insert into user(username,birthday,sex,address) 
    	  values(#{username},#{birthday},#{sex},#{address})
    	</insert>
    
    </mapper>

### 2、mapper.java接口 ###

接口定义有如下特点：

1.  Mapper接口方法名和Mapper.xml中定义的statement的id相同
2.  Mapper接口方法的输入参数类型和mapper.xml中定义的statement的parameterType的类型相同
3.  Mapper接口方法的输出参数类型和mapper.xml中定义的statement的resultType的类型相同

/**
     * 用户管理mapper
     */
    Public interface UserMapper {
    	//根据用户id查询用户信息
    	public User findUserById(int id) throws Exception;
    	//查询用户列表
    	public List<User> findUserByUsername(String username) throws Exception;
    	//添加用户信息
    	public void insertUser(User user)throws Exception; 
    }

### 3、加载UserMapper.xml文件 ###

修改SqlMapConfig.xml文件：

<mappers>
    
        <mapper resource="mapper/UserMapper.xml"/>
    
      </mappers>

### 3、测试 ###

Public class UserMapperTest extends TestCase {
    
    	private SqlSessionFactory sqlSessionFactory;
    	
    	protected void setUp() throws Exception {
    		//mybatis配置文件
    		String resource = "sqlMapConfig.xml";
    		InputStream inputStream = Resources.getResourceAsStream(resource);
    		//使用SqlSessionFactoryBuilder创建sessionFactory
    		sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    	}
    
    	
    	Public void testFindUserById() throws Exception {
    		//获取session
    		SqlSession session = sqlSessionFactory.openSession();
    		//获取mapper接口的代理对象
    		UserMapper userMapper = session.getMapper(UserMapper.class);
    		//调用代理对象方法
    		User user = userMapper.findUserById(1);
    		System.out.println(user);
    		//关闭session
    		session.close();
    		
    	}
    	@Test
    	public void testFindUserByUsername() throws Exception {
    		SqlSession sqlSession = sqlSessionFactory.openSession();
    		UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    		List<User> list = userMapper.findUserByUsername("张");
    		System.out.println(list.size());
    
    	}
    Public void testInsertUser() throws Exception {
    		//获取session
    		SqlSession session = sqlSessionFactory.openSession();
    		//获取mapper接口的代理对象
    		UserMapper userMapper = session.getMapper(UserMapper.class);
    		//要添加的数据
    		User user = new User();
    		user.setUsername("张三");
    		user.setBirthday(new Date());
    		user.setSex("1");
    		user.setAddress("北京市");
    		//通过mapper接口添加用户
    		userMapper.insertUser(user);
    		//提交
    		session.commit();
    		//关闭session
    		session.close();
    	}
    	
    
    }

### 4、自定义别名： ###

在SqlMapConfig.xml中配置：

### 5、<mapper resource=" " /> ###

使用相对于类路径的资源

如：<mapper resource="sqlmap/User.xml" />

### 6、<mapper class=" " /> ###

使用mapper接口类路径

如：<mapper class="cn.itcast.mybatis.mapper.UserMapper"/>

**注意：此种方法要求mapper接口名称和mapper映射文件名称相同，且放在同一个目录中**

### 7、<package name=""/> ###

注册指定包下的所有mapper接口

如：<package name="cn.itcast.mybatis.mapper"/>

**注意：此种方法要求mapper接口名称和mapper映射文件名称相同，且放在同一个目录中。**

### **8、**parameterType(输入类型) ###

### （1）、 \#\{\}与$\{\} ###

\#\{\}实现的是向prepareStatement中的预处理语句中设置参数值，sql语句中\#\{\}表示一个占位符即?。

<select id="findUserById" parameterType="int" resultType="user">
    		select * from user where id = #{id}
    	</select>

使用占位符\#\{\}可以有效防止sql注入，在使用时不需要关心参数值的类型，mybatis会自动进行java类型和jdbc类型的转换。\#\{\}可以接收简单类型值或pojo属性值，如果parameterType传输单个简单类型值，\#\{\}括号中可以是value或其它名称。

$\{\}和\#\{\}不同，通过$\{\}可以将parameterType 传入的内容拼接在sql中且不进行jdbc类型转换， $\{\}可以接收简单类型值或pojo属性值，如果parameterType传输单个简单类型值，$\{\}括号中只能是value。使用$\{\}不能防止sql注入，但是有时用$\{\}会非常方便，如下的例子：

<select id="selectUserByName" parameterType="string" resultType="user">
    	   select * from user where username like '%${value}%'
    	</select>

### 9、动态sql(重点) ###

通过mybatis提供的各种标签方法实现动态拼接sql。

select \* from user id=\#\{id\}  and username like '%$\{username\}%'

（1）、if

<select id="findUserList" parameterType="user" resultType="user">
    		select * from user 
    		where 1=1 
    		<if test="id!=null and id!=''">
    		and id=#{id}
    		</if>
    		<if test="username!=null and username!=''">
    		and username like '%${username}%'
    		</if>
    	</select>

（2）、Where

<select id="findUserList" parameterType="user" resultType="user">
    		select * from user 
    		<where>
    		<if test="id!=null and id!=''">
    		and id=#{id}
    		</if>
    		<if test="username!=null and username!=''">
    		and username like '%${username}%'
    		</if>
    		</where>
    	</select>

<where />可以自动处理第一个and。

（3）foreach

向sql传递数组或List，mybatis使用foreach解析

（4）、sql片段

Sql中可将重复的sql提取出来，使用时用include引用即可，最终达到sql重用的目的，如下：

将where条件抽取出来：

<sql id="query_user_where">
    	<if test="id!=null and id!=''">
    		and id=#{id}
    	</if>
    	<if test="username!=null and username!=''">
    		and username like '%${username}%'
    	</if>
    </sql>

使用include引用：

<select id="findUserList" parameterType="user" resultType="user">
    		select * from user 
    		<where>
    		<include refid="query_user_where"/>
    		</where>
    	</select>

注意：如果引用其它mapper.xml的sql片段，则在引用时需要加上namespace，如下：<include refid=*"*namespace.sql片段”/>