Mybatis（2） Dao開發

1. 原始Dao開發方式

原始Dao開發方法需要程序員編寫Dao接口和Dao實現類。

 

1.1映射文件

編寫映射文件如下：（也可以使用入門程序完成的映射文件）

<?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">
<!-- namespace：命名空間，用於隔離sql，還有一個很重要的作用，後面會講 -->
<mapper namespace="test">

	<!-- 根據id查詢用戶 -->
	<select id="queryUserById" parameterType="int"
		resultType="cn.itcast.mybatis.pojo.User">
		select * from user where id = #{id}
	</select>

	<!-- 根據username模糊查詢用戶 -->
	<select id="queryUserByUsername" parameterType="string"
		resultType="cn.itcast.mybatis.pojo.User">
		select * from user where username like '%${value}%'
	</select>

	<!-- 保存用戶 -->
	<insert id="saveUser" parameterType="cn.itcast.mybatis.pojo.User">
		<selectKey keyProperty="id" keyColumn="id" order="AFTER"
			resultType="int">
			SELECT LAST_INSERT_ID()
		</selectKey>
		insert into user(username,birthday,sex,address)
		values(#{username},#{birthday},#{sex},#{address})
	</insert>

</mapper>

 

1.2Dao接口

先進行DAO的接口開發，編碼如下：

public interface UserDao {
	/**
	 * 根據id查詢用戶
	 * 
	 * @param id
	 * @return
	 */
	User queryUserById(int id);

	/**
	 * 根據用戶名模糊查詢用戶
	 * 
	 * @param username
	 * @return
	 */
	List<User> queryUserByUsername(String username);

	/**
	 * 保存用戶
	 * 
	 * @param user
	 */
	void saveUser(User user);
}

 1.3Dao實現類

 

編寫的Dao實現類如下

public class UserDaoImpl implements UserDao {
	private SqlSessionFactory sqlSessionFactory;

	public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
		super();
		this.sqlSessionFactory = sqlSessionFactory;
	}

	@Override
	public User queryUserById(int id) {
		// 創建SqlSession
		SqlSession sqlSession = this.sqlSessionFactory.openSession();
		// 執行查詢邏輯
		User user = sqlSession.selectOne("queryUserById", id);
		// 釋放資源
		sqlSession.close();

		return user;
	}

	@Override
	public List<User> queryUserByUsername(String username) {
		// 創建SqlSession
		SqlSession sqlSession = this.sqlSessionFactory.openSession();

		// 執行查詢邏輯
		List<User> list = sqlSession.selectList("queryUserByUsername", username);
		// 釋放資源
		sqlSession.close();
		return list;
	}

	@Override
	public void saveUser(User user) {
		// 創建SqlSession
		SqlSession sqlSession = this.sqlSessionFactory.openSession();

		// 執行保存邏輯
		sqlSession.insert("saveUser", user);
		// 提交事務
		sqlSession.commit();
		// 釋放資源
		sqlSession.close();
	}
}

 

 

1.4Dao測試

創建一個JUnit的測試類，對UserDao進行測試，測試代碼如下：

public class UserDaoTest {
	private SqlSessionFactory sqlSessionFactory;

	@Before
	public void init() throws Exception {
		// 創建SqlSessionFactoryBuilder
		SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
		// 加載SqlMapConfig.xml配置文件
		InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
		// 創建SqlsessionFactory
		this.sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
	}

	@Test
	public void testQueryUserById() {
		// 創建DAO
		UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
		// 執行查詢
		User user = userDao.queryUserById(1);
		System.out.println(user);
	}

	@Test
	public void testQueryUserByUsername() {
		// 創建DAO

		UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
		// 執行查詢
		List<User> list = userDao.queryUserByUsername("張");
		for (User user : list) {
			System.out.println(user);
		}
	}

	@Test
	public void testSaveUser() {
		// 創建DAO
		UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);

		// 創建保存對象
		User user = new User();
		user.setUsername("劉備");
		user.setBirthday(new Date());
		user.setSex("1");
		user.setAddress("蜀國");
		// 執行保存
		userDao.saveUser(user);

		System.out.println(user);
	}
}

 

1. 問題

原始Dao開發中存在以下問題：

1. Dao方法體存在重複代碼：通過SqlSessionFactory創建SqlSession，調用SqlSession的數據庫操作方法
2. 調用sqlSession的數據庫操作方法需要指定statement的id，這裏存在硬編碼，不得於開發維護。

 

2、Mapper動態代理方式（推薦方式）

開發規範

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的類型相同

2.1 UserMapper.xml配置文件內容：

<?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">
<!-- namespace：命名空間，用於隔離sql -->
<!-- 還有一個很重要的作用，使用動態代理開發DAO，1. namespace必須和Mapper接口類路徑一致 -->
<mapper namespace="cn.itcast.mybatis.mapper.UserMapper">
	<!-- 根據用戶id查詢用戶 -->
	<!-- 2. id必須和Mapper接口方法名一致 -->
	<!-- 3. parameterType必須和接口方法參數類型一致 -->
	<!-- 4. resultType必須和接口方法返回值類型一致 -->
	<select id="queryUserById" parameterType="int"
		resultType="cn.itcast.mybatis.pojo.User">
		select * from user where id = #{id}
	</select>

	<!-- 根據用戶名查詢用戶 -->
	<select id="queryUserByUsername" parameterType="string"
		resultType="cn.itcast.mybatis.pojo.User">
		select * from user where username like '%${value}%'
	</select>

	<!-- 保存用戶 -->
	<insert id="saveUser" parameterType="cn.itcast.mybatis.pojo.User">
		<selectKey keyProperty="id" keyColumn="id" order="AFTER"
			resultType="int">
			select last_insert_id()
		</selectKey>
		insert into user(username,birthday,sex,address) values
		(#{username},#{birthday},#{sex},#{address});
	</insert>

</mapper>

2.3UserMapper(接口文件)

public interface UserMapper {
	/**
	 * 根據id查詢
	 * 
	 * @param id
	 * @return
	 */
	User queryUserById(int id);

	/**
	 * 根據用戶名查詢用戶
	 * 
	 * @param username
	 * @return
	 */
	List<User> queryUserByUsername(String username);

	/**
	 * 保存用戶
	 * 
	 * @param user
	 */
	void saveUser(User user);
}

2.4加載UserMapper.xml文件

修改SqlMapConfig.xml文件，添加以下所示的內容：

<!-- 加載映射文件 -->
	<mappers>
		<mapper resource="sqlmap/User.xml" />
		<mapper resource="mapper/UserMapper.xml" />
	</mappers>

 

2.5測試

編寫的測試方法如下：

public class UserMapperTest {
	private SqlSessionFactory sqlSessionFactory;

	@Before
	public void init() throws Exception {
		// 創建SqlSessionFactoryBuilder
		SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
		// 加載SqlMapConfig.xml配置文件
		InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
		// 創建SqlsessionFactory
		this.sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
	}

	@Test
	public void testQueryUserById() {
		// 獲取sqlSession，和spring整合後由spring管理
		SqlSession sqlSession = this.sqlSessionFactory.openSession();

		// 從sqlSession中獲取Mapper接口的代理對象
		UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
		// 執行查詢方法
		User user = userMapper.queryUserById(1);
		System.out.println(user);

		// 和spring整合後由spring管理
		sqlSession.close();
	}

	@Test
	public void testQueryUserByUsername() {
		// 獲取sqlSession，和spring整合後由spring管理
		SqlSession sqlSession = this.sqlSessionFactory.openSession();

		// 從sqlSession中獲取Mapper接口的代理對象
		UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
		// 執行查詢方法
		List<User> list = userMapper.queryUserByUsername("張");
		for (User user : list) {
			System.out.println(user);
		}

		// 和spring整合後由spring管理
		sqlSession.close();
	}

	@Test
	public void testSaveUser() {
		// 獲取sqlSession，和spring整合後由spring管理
		SqlSession sqlSession = this.sqlSessionFactory.openSession();

		// 從sqlSession中獲取Mapper接口的代理對象
		UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
		// 創建保存對象
		User user = new User();
		user.setUsername("劉備");
		user.setBirthday(new Date());
		user.setSex("1");
		user.setAddress("蜀國");
		// 執行查詢方法
		userMapper.saveUser(user);
		System.out.println(user);


		// 和spring整合後由spring管理
		sqlSession.commit();
		sqlSession.close();
	}
}

2.6小結

2.6.1selectOne和selectList

動態代理對象調用sqlSession.selectOne()和sqlSession.selectList()是根據mapper接口方法的返回值決定，如果返回list則調用selectList方法，如果返回單個對象則調用selectOne方法。

2.6.2namespace

mybatis官方推薦使用mapper代理方法開發mapper接口，程序員不用編寫mapper接口實現類，使用mapper代理方法時，輸入參數可以使用pojo包裝對象或map對象，保證dao的通用性。