MyBatis的sql映射文件（CRUD和主键id生成）

一个好的讲解mybatis的博客地址http://www.jianshu.com/nb/5226994

官方文档：http://www.mybatis.org/mybatis-3/zh/sqlmap-xml.html

Mapper XML 文件

MyBatis 的真正强大在于它的映射语句，也是它的魔力所在。由于它的异常强大，映射器的 XML 文件就显得相对简单。如果拿它跟具有相同功能的 JDBC 代码进行对比，你会立即发现省掉了将近 95% 的代码。MyBatis 就是针对 SQL 构建的，并且比普通的方法做的更好。

SQL 映射文件有很少的几个顶级元素（按照它们应该被定义的顺序）：

• cache – 给定命名空间的缓存配置。
• cache-ref – 其他命名空间缓存配置的引用。
• resultMap – 是最复杂也是最强大的元素，用来描述如何从数据库结果集中来加载对象。
• parameterMap – 已废弃！老式风格的参数映射。内联参数是首选,这个元素可能在将来被移除，这里不会记录。
• sql – 可被其他语句引用的可重用语句块。
• insert – 映射插入语句
• update – 映射更新语句
• delete – 映射删除语句
• select – 映射查询语句

全局映射文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
	<!-- 1. 导入资源文件 -->
	<properties resource="application.properties"></properties>
	<settings>
		<!-- 开启自动驼峰命名规则映射,即从经典数据库列名 A_COLUMN 到POJO类属性名 aColumn的类似映射。 -->
		<setting name="mapUnderscoreToCamelCase" value="true"/>
	</settings>	

 	<!-- 2. 配置数据库的连接环境（default为id的值），即默认加载的数据库环境	 -->
	<environments default="mysql">
		<environment id="mysql"> 				<!-- 配置具体的数据库环境    id唯一	 -->
			<transactionManager type="JDBC" />  <!-- 指定使用的事务处理管理器 -->
			<dataSource type="POOLED">  		<!-- 指定使用的数据源连接池		 -->
				<property name="driver" value="${jdbc.driverClass}" />
				<property name="url" value="${jdbc.url}" />
				<property name="username" value="${jdbc.user}" />
				<property name="password" value="${jdbc.password}" />
			</dataSource>
		</environment>
		<environment id="oracle"> 				
			<transactionManager type="JDBC" />  
			<dataSource type="POOLED">  		
				<property name="driver" value="${oracle.driverClass}" />
				<property name="url" value="${oracle.url}" />
				<property name="username" value="${oracle.user}" />
				<property name="password" value="${oracle.password}" />
			</dataSource>
		</environment>
	</environments>
	
	<!-- 3. 引入mapper映射文件 -->
	<mappers>
		<package name="cn.jq.mybatis.dao" /> 
	</mappers>
</configuration>

application.properties 文件

jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis_demo?useUnicode=true&characterEncoding=utf8&useSSL=true
jdbc.user=root
jdbc.password=123456

oracle.driverClass=oracle.jdbc.OracleDriver
oracle.url=jdbc:oracle:thin:@localhost:1521:orcl
oracle.user=scott
oracle.password=tiger

一、简单增删改查操作

1、 映射接口实现类

public interface UserMapper {
	/**
	 * 
	 * 根据id查询一条记录
	 * @param id
	 * @return
	 */
	//@Select("select * from t_user where id = #{id}")
	public User getUser(Integer id);

	/**
	 * 查询数据库中的记录总条数
	 * @return
	 */
	public int selectCount();

	/**
	 * 新增一条记录
	 * @param user
	 * @return 数据库受影响的行数
	 */
	public int insertUser(User user);

	/**
	 * 删除一条记录
	 * @param id
	 * @return 数据库受影响的行数
	 */
	public int deleteUser(Integer id);
	
	/**
	 * 修改一条记录
	 * @param user
	 * @return 数据库受影响的行数>=1 返回true 否则返回false
	 */
	public boolean updateUser(User user);
	
	/**
	 * 查询所有记录
	 * @return List<User>
	 */
	public List<User> selectUserAll();
}

2、sql映射文件

<?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 - 命名空间对应映射接口的全限定名 -->
<mapper namespace="cn.jq.mybatis.dao.UserMapper">
	<!-- id - 对应接口中的方法名
	     resultType - 从这条语句中返回的期望类型的类完全限定名或别名 
	     parameterType - 传入这条语句的参数类的完全限定名或别名  -->
	<select id="getUser" resultType="cn.jq.mybatis.model.User">
		select * from t_user where id = #{id}
	</select>

	<select id="selectCount" resultType="int">
		select count(*) from t_user
	</select>
	
	<insert id="insertUser" parameterType="cn.jq.mybatis.model.User">
		insert into t_user(username,pazzword,state,reg_date) values(#{username},#{pazzword},#{state},#{regDate})
	</insert>
	
	<delete id="deleteUser" parameterType="int">
		delete from t_user where id=#{id}
	</delete>
	
	<update id="updateUser" parameterType="cn.jq.mybatis.model.User">
		update t_user set username=#{username},pazzword=#{pazzword},state=#{state},reg_date=#{regDate} where id=#{id}
	</update>
	
	<!--  返回类型为集合时，resultType只需指定List中单行记录的类型即可
	     resultType - 从这条语句中返回的期望类型的类完全限定名或别名 -->
	<select id="selectUserAll" resultType="cn.jq.mybatis.model.User">
		select * from t_user
	</select>	
</mapper>

3、测试类

	@Test
	public void test() throws IOException {
		//1. 创建SqlSessionFacotry工厂类对象，根据读取全局配置文件
		Resources.setCharset(Charset.forName("utf-8"));//设置编码格式
		InputStream inputStream = Resources.getResourceAsStream("mybatis.xml");
		SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
		
		//2. 打开数据库连接会话
		SqlSession session = sqlSessionFactory.openSession();
		
		try {
			//3.通过会话操作sql 返回的是代理对象 jdk动态代理
			UserMapper userMapper = session.getMapper(UserMapper.class);
			
			//查询一条记录
			User user = userMapper.getUser(2);
			//查询数据库中的记录总条数
			int  count = userMapper.selectCount();
			//查询所有记录
			List<User> userlist = userMapper.selectUserAll();
			System.out.println(count);
			System.out.println(user);
			System.out.println(Arrays.asList(userlist));
			
			//新增一条记录
			User user2 = new User("李四", "123456", 1, new Date());
			int i = userMapper.insertUser(user2);
		        System.out.println("成功新增"+i+"条数据");
			session.commit(); //提交事务
			
			//修改一条记录
			User user3 = new User();
			user3.setId(3);
			user3.setUsername("li33");
			user3.setPazzword("li33qq");
			user3.setState(0);
			user3.setRegDate(new Date());
			boolean b = userMapper.updateUser(user3);
			session.commit();
			System.out.println("成功修改"+b+"条数据");
			
			//删除一条记录
			int n = userMapper.deleteUser(13);
			session.commit();
			System.out.println("成功删除"+n+"条数据");
			
			System.out.println(userMapper.selectCount());
			
		} finally {
			//关闭会话
			session.close();
		}						
	}
----
3
User [id=2, username=user, pazzword=3be7f713d9321e812231bb838448385d, state=1, regDate=Mon Oct 15 00:00:00 CST 2018]
[[User [id=1, username=admin, pazzword=172eee54aa664e9dd0536b063796e54e, state=1, regDate=Sun Oct 14 00:00:00 CST 2018], User [id=2, username=user, pazzword=3be7f713d9321e812231bb838448385d, state=1, regDate=Mon Oct 15 00:00:00 CST 2018], User [id=3, username=阿斯达, pazzword=d0dbbe3c3b4d61ef587448bbdc103de7, state=1, regDate=Tue Oct 23 00:00:00 CST 2018]]]
成功新增1条数据
成功修改true条数据
成功删除1条数据
4

   

注意：CRUD是可以直接设置返回值的，int, long, boolean 和 void 都可以是返回值类型，int 和long返回影响数据库条数，boolean影响的条数大于1返回true，否则返回false.

标签属性：

属性	描述
id	在命名空间中唯一的标识符，可以被用来引用这条语句。
parameterType	将会传入这条语句的参数类的完全限定名或别名。这个属性是可选的，因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数，默认值为 unset。
parameterMap	这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。
resultType	从这条语句中返回的期望类型的类的完全限定名或别名。注意如果是集合情形，那应该是集合可以包含的类型，而不能是集合本身。使用 resultType 或 resultMap，但不能同时使用。
resultMap	外部 resultMap 的命名引用。结果集的映射是 MyBatis 最强大的特性，对其有一个很好的理解的话，许多复杂映射的情形都能迎刃而解。使用 resultMap 或 resultType，但不能同时使用。
flushCache	将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：false。
useCache	将其设置为 true，将会导致本条语句的结果被二级缓存，默认值：对 select 元素为 true。
timeout	这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）。
fetchSize	这是尝试影响驱动程序每次批量返回的结果行数和这个设置值相等。默认值为 unset（依赖驱动）。
statementType	STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED。
resultSetType	FORWARD_ONLY，SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一个，默认值为 unset （依赖驱动）。
databaseId	如果配置了 databaseIdProvider，MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句；如果带或者不带的语句都有，则不带的会被忽略。
resultOrdered	这个设置仅针对嵌套结果 select 语句适用：如果为 true，就是假设包含了嵌套结果集或是分组了，这样的话当返回一个主结果行的时候，就不会发生有对前面结果集的引用的情况。这就使得在获取嵌套的结果集的时候不至于导致内存不够用。默认值：false。
resultSets	这个设置仅对多结果集的情况适用，它将列出语句执行后返回的结果集并每个结果集给一个名称，名称是逗号分隔的。
useGeneratedKeys	（仅对 insert 和 update 有用）这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键（比如：像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段），默认值：false。
keyProperty	（仅对 insert 和 update 有用）唯一标记一个属性，MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值，默认：unset。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
keyColumn	（仅对 insert 和 update 有用）通过生成的键值设置表中的列名，这个设置仅在某些数据库（像 PostgreSQL）是必须的，当主键列不是表中的第一列的时候需要设置。如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。
order	这可以被设置为 BEFORE 或 AFTER。如果设置为 BEFORE，那么它会首先选择主键，设置 keyProperty 然后执行插入语句。如果设置为 AFTER，那么先执行插入语句，然后是 selectKey 元素 - 这和像 Oracle 的数据库相似，在插入语句内部可能有嵌入索引调用。

二、获取新增记录生成主键id值

1、Mysql生成主键id

       数据库支持自动生成主键的字段（比如 MySQL 和 SQL Server），设置 useGeneratedKeys=”true”，然后再把 keyProperty 设置到目标属性上就OK。

	 <!-- mysql数据库 ：数据库本身有自动生成主键的方式
  	         useGeneratedKeys - true 设置使用数据库本身的功能设置主键
  	         keyProperty - 设置在model对象中主键列对应的属性名称(结果自动存放在该属性中) 区分大小写的  -->
	<insert id="insertUser" parameterType="cn.jq.mybatis.model.User" useGeneratedKeys="true" keyProperty="id" databaseId="mysql">
		insert into t_user
			(username,pazzword,state,reg_date) 
		values
			(#{username},#{pazzword},#{state},#{regDate})
	</insert>

提交事务之前可以获取到自动生成id主键的值，若不设置获取不到

			//新增一条记录
			User user2 = new User("李四", "123456", 1, new Date());
			int i = userMapper.insertUser(user2);
			System.out.println("成功新增"+i+"条数据" + user2.getId()); //成功新增1条数据16
			session.commit(); //提交事务

2、oracle 使用序列生成主键id

       对于不支持自动生成类型的数据库或可能不支持自动生成主键的 JDBC 驱动， 如oracle 使用序列

  1）建表 和 建序列

CREATE TABLE t_user (
  ID NUMBER NOT NULL,
  username varchar(255) NOT NULL,
  pazzword varchar(255) NOT NULL,
  state NUMBER DEFAULT NULL,
  reg_date DATE DEFAULT NULL,
  PRIMARY KEY (ID)
);

CREATE SEQUENCE seq_userid
		START WITH 1
		INCREMENT BY 1
		MAXVALUE 999999
		NOCYCLE
		NOCACHE ;

  2）sql映射文件

  注意： 要把全局映射文件的连接环境切换为 oracle ， 引入 oracle 依赖 

        <dependency>
            <groupId>com.oracle</groupId>
            <artifactId>ojdbc6</artifactId>
            <version>12.1.0.1-atlassian-hosted</version>
        </dependency>

<environments default="oracle">

	<insert id="insertUser" parameterType="cn.jq.mybatis.model.User">
		<!-- 1.先将序列中的值查询出来 存放在model对象中 新增语句中直接使用该model的属性即可 
  			order - before 该语句在新增语句之前执行
  			keyProperty - 查询结果存放在model对象中的那个属性中(insert中直接使用属性即可)  
  		
  		oracle数据库中 允许为null的列 参数中可设置jdbcType
  			jdbcType的类型在org.apache.ibatis.type.JdbcType枚举中定义的
  	-->
		<selectKey order="BEFORE" keyProperty="id" resultType="int">
			select seq_userid.nextval id from dual
		</selectKey>
		insert into t_user
			(id,username,pazzword,state,reg_date) 
		values
			(#{id},#{username},#{pazzword},#{state,jdbcType=NUMERIC},#{regDate,jdbcType=DATE})
	</insert>

  3）测试类

			User user2 = new User("李四", "123456", 1, new Date());
			int i = userMapper.insertUser(user2);
			System.out.println("成功新增"+i+"条数据" + user2.getId()); //成功新增1条数据1
			session.commit(); //提交事务